babylon.module.d.ts 5.7 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. readonly observers: Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Extracts text content from a DOM element hierarchy
  290. * @param element defines the root element
  291. * @returns a string
  292. */
  293. static GetDOMTextContent(element: HTMLElement): string;
  294. }
  295. }
  296. declare module "babylonjs/Misc/logger" {
  297. /**
  298. * Logger used througouht the application to allow configuration of
  299. * the log level required for the messages.
  300. */
  301. export class Logger {
  302. /**
  303. * No log
  304. */
  305. static readonly NoneLogLevel: number;
  306. /**
  307. * Only message logs
  308. */
  309. static readonly MessageLogLevel: number;
  310. /**
  311. * Only warning logs
  312. */
  313. static readonly WarningLogLevel: number;
  314. /**
  315. * Only error logs
  316. */
  317. static readonly ErrorLogLevel: number;
  318. /**
  319. * All logs
  320. */
  321. static readonly AllLogLevel: number;
  322. private static _LogCache;
  323. /**
  324. * Gets a value indicating the number of loading errors
  325. * @ignorenaming
  326. */
  327. static errorsCount: number;
  328. /**
  329. * Callback called when a new log is added
  330. */
  331. static OnNewCacheEntry: (entry: string) => void;
  332. private static _AddLogEntry;
  333. private static _FormatMessage;
  334. private static _LogDisabled;
  335. private static _LogEnabled;
  336. private static _WarnDisabled;
  337. private static _WarnEnabled;
  338. private static _ErrorDisabled;
  339. private static _ErrorEnabled;
  340. /**
  341. * Log a message to the console
  342. */
  343. static Log: (message: string) => void;
  344. /**
  345. * Write a warning message to the console
  346. */
  347. static Warn: (message: string) => void;
  348. /**
  349. * Write an error message to the console
  350. */
  351. static Error: (message: string) => void;
  352. /**
  353. * Gets current log cache (list of logs)
  354. */
  355. static readonly LogCache: string;
  356. /**
  357. * Clears the log cache
  358. */
  359. static ClearLogCache(): void;
  360. /**
  361. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  362. */
  363. static LogLevels: number;
  364. }
  365. }
  366. declare module "babylonjs/Misc/typeStore" {
  367. /** @hidden */
  368. export class _TypeStore {
  369. /** @hidden */
  370. static RegisteredTypes: {
  371. [key: string]: Object;
  372. };
  373. /** @hidden */
  374. static GetClass(fqdn: string): any;
  375. }
  376. }
  377. declare module "babylonjs/Misc/stringTools" {
  378. /**
  379. * Helper to manipulate strings
  380. */
  381. export class StringTools {
  382. /**
  383. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  384. * @param str Source string
  385. * @param suffix Suffix to search for in the source string
  386. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  387. */
  388. static EndsWith(str: string, suffix: string): boolean;
  389. /**
  390. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  391. * @param str Source string
  392. * @param suffix Suffix to search for in the source string
  393. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  394. */
  395. static StartsWith(str: string, suffix: string): boolean;
  396. /**
  397. * Decodes a buffer into a string
  398. * @param buffer The buffer to decode
  399. * @returns The decoded string
  400. */
  401. static Decode(buffer: Uint8Array | Uint16Array): string;
  402. /**
  403. * Encode a buffer to a base64 string
  404. * @param buffer defines the buffer to encode
  405. * @returns the encoded string
  406. */
  407. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  408. }
  409. }
  410. declare module "babylonjs/Misc/deepCopier" {
  411. /**
  412. * Class containing a set of static utilities functions for deep copy.
  413. */
  414. export class DeepCopier {
  415. /**
  416. * Tries to copy an object by duplicating every property
  417. * @param source defines the source object
  418. * @param destination defines the target object
  419. * @param doNotCopyList defines a list of properties to avoid
  420. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  421. */
  422. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  423. }
  424. }
  425. declare module "babylonjs/Misc/precisionDate" {
  426. /**
  427. * Class containing a set of static utilities functions for precision date
  428. */
  429. export class PrecisionDate {
  430. /**
  431. * Gets either window.performance.now() if supported or Date.now() else
  432. */
  433. static readonly Now: number;
  434. }
  435. }
  436. declare module "babylonjs/Misc/devTools" {
  437. /** @hidden */
  438. export class _DevTools {
  439. static WarnImport(name: string): string;
  440. }
  441. }
  442. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  443. /**
  444. * Interface used to define the mechanism to get data from the network
  445. */
  446. export interface IWebRequest {
  447. /**
  448. * Returns client's response url
  449. */
  450. responseURL: string;
  451. /**
  452. * Returns client's status
  453. */
  454. status: number;
  455. /**
  456. * Returns client's status as a text
  457. */
  458. statusText: string;
  459. }
  460. }
  461. declare module "babylonjs/Misc/webRequest" {
  462. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  463. import { Nullable } from "babylonjs/types";
  464. /**
  465. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  466. */
  467. export class WebRequest implements IWebRequest {
  468. private _xhr;
  469. /**
  470. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  471. * i.e. when loading files, where the server/service expects an Authorization header
  472. */
  473. static CustomRequestHeaders: {
  474. [key: string]: string;
  475. };
  476. /**
  477. * Add callback functions in this array to update all the requests before they get sent to the network
  478. */
  479. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  480. private _injectCustomRequestHeaders;
  481. /**
  482. * Gets or sets a function to be called when loading progress changes
  483. */
  484. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  485. /**
  486. * Returns client's state
  487. */
  488. readonly readyState: number;
  489. /**
  490. * Returns client's status
  491. */
  492. readonly status: number;
  493. /**
  494. * Returns client's status as a text
  495. */
  496. readonly statusText: string;
  497. /**
  498. * Returns client's response
  499. */
  500. readonly response: any;
  501. /**
  502. * Returns client's response url
  503. */
  504. readonly responseURL: string;
  505. /**
  506. * Returns client's response as text
  507. */
  508. readonly responseText: string;
  509. /**
  510. * Gets or sets the expected response type
  511. */
  512. responseType: XMLHttpRequestResponseType;
  513. /** @hidden */
  514. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  515. /** @hidden */
  516. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  517. /**
  518. * Cancels any network activity
  519. */
  520. abort(): void;
  521. /**
  522. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  523. * @param body defines an optional request body
  524. */
  525. send(body?: Document | BodyInit | null): void;
  526. /**
  527. * Sets the request method, request URL
  528. * @param method defines the method to use (GET, POST, etc..)
  529. * @param url defines the url to connect with
  530. */
  531. open(method: string, url: string): void;
  532. /**
  533. * Sets the value of a request header.
  534. * @param name The name of the header whose value is to be set
  535. * @param value The value to set as the body of the header
  536. */
  537. setRequestHeader(name: string, value: string): void;
  538. /**
  539. * Get the string containing the text of a particular header's value.
  540. * @param name The name of the header
  541. * @returns The string containing the text of the given header name
  542. */
  543. getResponseHeader(name: string): Nullable<string>;
  544. }
  545. }
  546. declare module "babylonjs/Misc/fileRequest" {
  547. import { Observable } from "babylonjs/Misc/observable";
  548. /**
  549. * File request interface
  550. */
  551. export interface IFileRequest {
  552. /**
  553. * Raised when the request is complete (success or error).
  554. */
  555. onCompleteObservable: Observable<IFileRequest>;
  556. /**
  557. * Aborts the request for a file.
  558. */
  559. abort: () => void;
  560. }
  561. }
  562. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  563. /**
  564. * Define options used to create a render target texture
  565. */
  566. export class RenderTargetCreationOptions {
  567. /**
  568. * Specifies is mipmaps must be generated
  569. */
  570. generateMipMaps?: boolean;
  571. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  572. generateDepthBuffer?: boolean;
  573. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  574. generateStencilBuffer?: boolean;
  575. /** Defines texture type (int by default) */
  576. type?: number;
  577. /** Defines sampling mode (trilinear by default) */
  578. samplingMode?: number;
  579. /** Defines format (RGBA by default) */
  580. format?: number;
  581. }
  582. }
  583. declare module "babylonjs/Instrumentation/timeToken" {
  584. import { Nullable } from "babylonjs/types";
  585. /**
  586. * @hidden
  587. **/
  588. export class _TimeToken {
  589. _startTimeQuery: Nullable<WebGLQuery>;
  590. _endTimeQuery: Nullable<WebGLQuery>;
  591. _timeElapsedQuery: Nullable<WebGLQuery>;
  592. _timeElapsedQueryEnded: boolean;
  593. }
  594. }
  595. declare module "babylonjs/Engines/constants" {
  596. /** Defines the cross module used constants to avoid circular dependncies */
  597. export class Constants {
  598. /** Defines that alpha blending is disabled */
  599. static readonly ALPHA_DISABLE: number;
  600. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  601. static readonly ALPHA_ADD: number;
  602. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  603. static readonly ALPHA_COMBINE: number;
  604. /** Defines that alpha blending to DEST - SRC * DEST */
  605. static readonly ALPHA_SUBTRACT: number;
  606. /** Defines that alpha blending to SRC * DEST */
  607. static readonly ALPHA_MULTIPLY: number;
  608. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  609. static readonly ALPHA_MAXIMIZED: number;
  610. /** Defines that alpha blending to SRC + DEST */
  611. static readonly ALPHA_ONEONE: number;
  612. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  613. static readonly ALPHA_PREMULTIPLIED: number;
  614. /**
  615. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  616. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  617. */
  618. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  619. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  620. static readonly ALPHA_INTERPOLATE: number;
  621. /**
  622. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  623. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  624. */
  625. static readonly ALPHA_SCREENMODE: number;
  626. /**
  627. * Defines that alpha blending to SRC + DST
  628. * Alpha will be set to SRC ALPHA + DST ALPHA
  629. */
  630. static readonly ALPHA_ONEONE_ONEONE: number;
  631. /**
  632. * Defines that alpha blending to SRC * DST ALPHA + DST
  633. * Alpha will be set to 0
  634. */
  635. static readonly ALPHA_ALPHATOCOLOR: number;
  636. /**
  637. * Defines that alpha blending to SRC * (1 - DST) + DST * (1 - SRC)
  638. */
  639. static readonly ALPHA_REVERSEONEMINUS: number;
  640. /**
  641. * Defines that alpha blending to SRC + DST * (1 - SRC ALPHA)
  642. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  643. */
  644. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  645. /**
  646. * Defines that alpha blending to SRC + DST
  647. * Alpha will be set to SRC ALPHA
  648. */
  649. static readonly ALPHA_ONEONE_ONEZERO: number;
  650. /** Defines that alpha blending equation a SUM */
  651. static readonly ALPHA_EQUATION_ADD: number;
  652. /** Defines that alpha blending equation a SUBSTRACTION */
  653. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  654. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  655. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  656. /** Defines that alpha blending equation a MAX operation */
  657. static readonly ALPHA_EQUATION_MAX: number;
  658. /** Defines that alpha blending equation a MIN operation */
  659. static readonly ALPHA_EQUATION_MIN: number;
  660. /**
  661. * Defines that alpha blending equation a DARKEN operation:
  662. * It takes the min of the src and sums the alpha channels.
  663. */
  664. static readonly ALPHA_EQUATION_DARKEN: number;
  665. /** Defines that the ressource is not delayed*/
  666. static readonly DELAYLOADSTATE_NONE: number;
  667. /** Defines that the ressource was successfully delay loaded */
  668. static readonly DELAYLOADSTATE_LOADED: number;
  669. /** Defines that the ressource is currently delay loading */
  670. static readonly DELAYLOADSTATE_LOADING: number;
  671. /** Defines that the ressource is delayed and has not started loading */
  672. static readonly DELAYLOADSTATE_NOTLOADED: number;
  673. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  674. static readonly NEVER: number;
  675. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  676. static readonly ALWAYS: number;
  677. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  678. static readonly LESS: number;
  679. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  680. static readonly EQUAL: number;
  681. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  682. static readonly LEQUAL: number;
  683. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  684. static readonly GREATER: number;
  685. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  686. static readonly GEQUAL: number;
  687. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  688. static readonly NOTEQUAL: number;
  689. /** Passed to stencilOperation to specify that stencil value must be kept */
  690. static readonly KEEP: number;
  691. /** Passed to stencilOperation to specify that stencil value must be replaced */
  692. static readonly REPLACE: number;
  693. /** Passed to stencilOperation to specify that stencil value must be incremented */
  694. static readonly INCR: number;
  695. /** Passed to stencilOperation to specify that stencil value must be decremented */
  696. static readonly DECR: number;
  697. /** Passed to stencilOperation to specify that stencil value must be inverted */
  698. static readonly INVERT: number;
  699. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  700. static readonly INCR_WRAP: number;
  701. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  702. static readonly DECR_WRAP: number;
  703. /** Texture is not repeating outside of 0..1 UVs */
  704. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  705. /** Texture is repeating outside of 0..1 UVs */
  706. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  707. /** Texture is repeating and mirrored */
  708. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  709. /** ALPHA */
  710. static readonly TEXTUREFORMAT_ALPHA: number;
  711. /** LUMINANCE */
  712. static readonly TEXTUREFORMAT_LUMINANCE: number;
  713. /** LUMINANCE_ALPHA */
  714. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  715. /** RGB */
  716. static readonly TEXTUREFORMAT_RGB: number;
  717. /** RGBA */
  718. static readonly TEXTUREFORMAT_RGBA: number;
  719. /** RED */
  720. static readonly TEXTUREFORMAT_RED: number;
  721. /** RED (2nd reference) */
  722. static readonly TEXTUREFORMAT_R: number;
  723. /** RG */
  724. static readonly TEXTUREFORMAT_RG: number;
  725. /** RED_INTEGER */
  726. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  727. /** RED_INTEGER (2nd reference) */
  728. static readonly TEXTUREFORMAT_R_INTEGER: number;
  729. /** RG_INTEGER */
  730. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  731. /** RGB_INTEGER */
  732. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  733. /** RGBA_INTEGER */
  734. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  735. /** UNSIGNED_BYTE */
  736. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  737. /** UNSIGNED_BYTE (2nd reference) */
  738. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  739. /** FLOAT */
  740. static readonly TEXTURETYPE_FLOAT: number;
  741. /** HALF_FLOAT */
  742. static readonly TEXTURETYPE_HALF_FLOAT: number;
  743. /** BYTE */
  744. static readonly TEXTURETYPE_BYTE: number;
  745. /** SHORT */
  746. static readonly TEXTURETYPE_SHORT: number;
  747. /** UNSIGNED_SHORT */
  748. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  749. /** INT */
  750. static readonly TEXTURETYPE_INT: number;
  751. /** UNSIGNED_INT */
  752. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  753. /** UNSIGNED_SHORT_4_4_4_4 */
  754. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  755. /** UNSIGNED_SHORT_5_5_5_1 */
  756. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  757. /** UNSIGNED_SHORT_5_6_5 */
  758. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  759. /** UNSIGNED_INT_2_10_10_10_REV */
  760. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  761. /** UNSIGNED_INT_24_8 */
  762. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  763. /** UNSIGNED_INT_10F_11F_11F_REV */
  764. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  765. /** UNSIGNED_INT_5_9_9_9_REV */
  766. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  767. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  768. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  769. /** nearest is mag = nearest and min = nearest and mip = linear */
  770. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  771. /** Bilinear is mag = linear and min = linear and mip = nearest */
  772. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  773. /** Trilinear is mag = linear and min = linear and mip = linear */
  774. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  775. /** nearest is mag = nearest and min = nearest and mip = linear */
  776. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  777. /** Bilinear is mag = linear and min = linear and mip = nearest */
  778. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  779. /** Trilinear is mag = linear and min = linear and mip = linear */
  780. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  781. /** mag = nearest and min = nearest and mip = nearest */
  782. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  783. /** mag = nearest and min = linear and mip = nearest */
  784. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  785. /** mag = nearest and min = linear and mip = linear */
  786. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  787. /** mag = nearest and min = linear and mip = none */
  788. static readonly TEXTURE_NEAREST_LINEAR: number;
  789. /** mag = nearest and min = nearest and mip = none */
  790. static readonly TEXTURE_NEAREST_NEAREST: number;
  791. /** mag = linear and min = nearest and mip = nearest */
  792. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  793. /** mag = linear and min = nearest and mip = linear */
  794. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  795. /** mag = linear and min = linear and mip = none */
  796. static readonly TEXTURE_LINEAR_LINEAR: number;
  797. /** mag = linear and min = nearest and mip = none */
  798. static readonly TEXTURE_LINEAR_NEAREST: number;
  799. /** Explicit coordinates mode */
  800. static readonly TEXTURE_EXPLICIT_MODE: number;
  801. /** Spherical coordinates mode */
  802. static readonly TEXTURE_SPHERICAL_MODE: number;
  803. /** Planar coordinates mode */
  804. static readonly TEXTURE_PLANAR_MODE: number;
  805. /** Cubic coordinates mode */
  806. static readonly TEXTURE_CUBIC_MODE: number;
  807. /** Projection coordinates mode */
  808. static readonly TEXTURE_PROJECTION_MODE: number;
  809. /** Skybox coordinates mode */
  810. static readonly TEXTURE_SKYBOX_MODE: number;
  811. /** Inverse Cubic coordinates mode */
  812. static readonly TEXTURE_INVCUBIC_MODE: number;
  813. /** Equirectangular coordinates mode */
  814. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  815. /** Equirectangular Fixed coordinates mode */
  816. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  817. /** Equirectangular Fixed Mirrored coordinates mode */
  818. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  819. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  820. static readonly SCALEMODE_FLOOR: number;
  821. /** Defines that texture rescaling will look for the nearest power of 2 size */
  822. static readonly SCALEMODE_NEAREST: number;
  823. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  824. static readonly SCALEMODE_CEILING: number;
  825. /**
  826. * The dirty texture flag value
  827. */
  828. static readonly MATERIAL_TextureDirtyFlag: number;
  829. /**
  830. * The dirty light flag value
  831. */
  832. static readonly MATERIAL_LightDirtyFlag: number;
  833. /**
  834. * The dirty fresnel flag value
  835. */
  836. static readonly MATERIAL_FresnelDirtyFlag: number;
  837. /**
  838. * The dirty attribute flag value
  839. */
  840. static readonly MATERIAL_AttributesDirtyFlag: number;
  841. /**
  842. * The dirty misc flag value
  843. */
  844. static readonly MATERIAL_MiscDirtyFlag: number;
  845. /**
  846. * The all dirty flag value
  847. */
  848. static readonly MATERIAL_AllDirtyFlag: number;
  849. /**
  850. * Returns the triangle fill mode
  851. */
  852. static readonly MATERIAL_TriangleFillMode: number;
  853. /**
  854. * Returns the wireframe mode
  855. */
  856. static readonly MATERIAL_WireFrameFillMode: number;
  857. /**
  858. * Returns the point fill mode
  859. */
  860. static readonly MATERIAL_PointFillMode: number;
  861. /**
  862. * Returns the point list draw mode
  863. */
  864. static readonly MATERIAL_PointListDrawMode: number;
  865. /**
  866. * Returns the line list draw mode
  867. */
  868. static readonly MATERIAL_LineListDrawMode: number;
  869. /**
  870. * Returns the line loop draw mode
  871. */
  872. static readonly MATERIAL_LineLoopDrawMode: number;
  873. /**
  874. * Returns the line strip draw mode
  875. */
  876. static readonly MATERIAL_LineStripDrawMode: number;
  877. /**
  878. * Returns the triangle strip draw mode
  879. */
  880. static readonly MATERIAL_TriangleStripDrawMode: number;
  881. /**
  882. * Returns the triangle fan draw mode
  883. */
  884. static readonly MATERIAL_TriangleFanDrawMode: number;
  885. /**
  886. * Stores the clock-wise side orientation
  887. */
  888. static readonly MATERIAL_ClockWiseSideOrientation: number;
  889. /**
  890. * Stores the counter clock-wise side orientation
  891. */
  892. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  893. /**
  894. * Nothing
  895. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  896. */
  897. static readonly ACTION_NothingTrigger: number;
  898. /**
  899. * On pick
  900. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  901. */
  902. static readonly ACTION_OnPickTrigger: number;
  903. /**
  904. * On left pick
  905. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  906. */
  907. static readonly ACTION_OnLeftPickTrigger: number;
  908. /**
  909. * On right pick
  910. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_OnRightPickTrigger: number;
  913. /**
  914. * On center pick
  915. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnCenterPickTrigger: number;
  918. /**
  919. * On pick down
  920. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnPickDownTrigger: number;
  923. /**
  924. * On double pick
  925. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnDoublePickTrigger: number;
  928. /**
  929. * On pick up
  930. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnPickUpTrigger: number;
  933. /**
  934. * On pick out.
  935. * This trigger will only be raised if you also declared a OnPickDown
  936. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  937. */
  938. static readonly ACTION_OnPickOutTrigger: number;
  939. /**
  940. * On long press
  941. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  942. */
  943. static readonly ACTION_OnLongPressTrigger: number;
  944. /**
  945. * On pointer over
  946. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  947. */
  948. static readonly ACTION_OnPointerOverTrigger: number;
  949. /**
  950. * On pointer out
  951. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPointerOutTrigger: number;
  954. /**
  955. * On every frame
  956. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnEveryFrameTrigger: number;
  959. /**
  960. * On intersection enter
  961. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnIntersectionEnterTrigger: number;
  964. /**
  965. * On intersection exit
  966. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnIntersectionExitTrigger: number;
  969. /**
  970. * On key down
  971. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnKeyDownTrigger: number;
  974. /**
  975. * On key up
  976. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnKeyUpTrigger: number;
  979. /**
  980. * Billboard mode will only apply to Y axis
  981. */
  982. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  983. /**
  984. * Billboard mode will apply to all axes
  985. */
  986. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  987. /**
  988. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  989. */
  990. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  991. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  992. * Test order :
  993. * Is the bounding sphere outside the frustum ?
  994. * If not, are the bounding box vertices outside the frustum ?
  995. * It not, then the cullable object is in the frustum.
  996. */
  997. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  998. /** Culling strategy : Bounding Sphere Only.
  999. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1000. * It's also less accurate than the standard because some not visible objects can still be selected.
  1001. * Test : is the bounding sphere outside the frustum ?
  1002. * If not, then the cullable object is in the frustum.
  1003. */
  1004. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1005. /** Culling strategy : Optimistic Inclusion.
  1006. * This in an inclusion test first, then the standard exclusion test.
  1007. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1008. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1009. * Anyway, it's as accurate as the standard strategy.
  1010. * Test :
  1011. * Is the cullable object bounding sphere center in the frustum ?
  1012. * If not, apply the default culling strategy.
  1013. */
  1014. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1015. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1016. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1017. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1018. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1019. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1020. * Test :
  1021. * Is the cullable object bounding sphere center in the frustum ?
  1022. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1023. */
  1024. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1025. /**
  1026. * No logging while loading
  1027. */
  1028. static readonly SCENELOADER_NO_LOGGING: number;
  1029. /**
  1030. * Minimal logging while loading
  1031. */
  1032. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1033. /**
  1034. * Summary logging while loading
  1035. */
  1036. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1037. /**
  1038. * Detailled logging while loading
  1039. */
  1040. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1041. }
  1042. }
  1043. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1044. import { Nullable } from "babylonjs/types";
  1045. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1046. /**
  1047. * This represents the required contract to create a new type of texture loader.
  1048. */
  1049. export interface IInternalTextureLoader {
  1050. /**
  1051. * Defines wether the loader supports cascade loading the different faces.
  1052. */
  1053. supportCascades: boolean;
  1054. /**
  1055. * This returns if the loader support the current file information.
  1056. * @param extension defines the file extension of the file being loaded
  1057. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1058. * @param fallback defines the fallback internal texture if any
  1059. * @param isBase64 defines whether the texture is encoded as a base64
  1060. * @param isBuffer defines whether the texture data are stored as a buffer
  1061. * @returns true if the loader can load the specified file
  1062. */
  1063. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  1064. /**
  1065. * Transform the url before loading if required.
  1066. * @param rootUrl the url of the texture
  1067. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1068. * @returns the transformed texture
  1069. */
  1070. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  1071. /**
  1072. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  1073. * @param rootUrl the url of the texture
  1074. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1075. * @returns the fallback texture
  1076. */
  1077. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  1078. /**
  1079. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  1080. * @param data contains the texture data
  1081. * @param texture defines the BabylonJS internal texture
  1082. * @param createPolynomials will be true if polynomials have been requested
  1083. * @param onLoad defines the callback to trigger once the texture is ready
  1084. * @param onError defines the callback to trigger in case of error
  1085. */
  1086. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1087. /**
  1088. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  1089. * @param data contains the texture data
  1090. * @param texture defines the BabylonJS internal texture
  1091. * @param callback defines the method to call once ready to upload
  1092. */
  1093. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1094. }
  1095. }
  1096. declare module "babylonjs/Engines/IPipelineContext" {
  1097. /**
  1098. * Class used to store and describe the pipeline context associated with an effect
  1099. */
  1100. export interface IPipelineContext {
  1101. /**
  1102. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1103. */
  1104. isAsync: boolean;
  1105. /**
  1106. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1107. */
  1108. isReady: boolean;
  1109. /** @hidden */
  1110. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1111. }
  1112. }
  1113. declare module "babylonjs/Meshes/dataBuffer" {
  1114. /**
  1115. * Class used to store gfx data (like WebGLBuffer)
  1116. */
  1117. export class DataBuffer {
  1118. /**
  1119. * Gets or sets the number of objects referencing this buffer
  1120. */
  1121. references: number;
  1122. /** Gets or sets the size of the underlying buffer */
  1123. capacity: number;
  1124. /**
  1125. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1126. */
  1127. is32Bits: boolean;
  1128. /**
  1129. * Gets the underlying buffer
  1130. */
  1131. readonly underlyingResource: any;
  1132. }
  1133. }
  1134. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1135. /** @hidden */
  1136. export interface IShaderProcessor {
  1137. attributeProcessor?: (attribute: string) => string;
  1138. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1139. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1140. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1141. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1142. lineProcessor?: (line: string, isFragment: boolean) => string;
  1143. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1144. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1145. }
  1146. }
  1147. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1148. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1149. /** @hidden */
  1150. export interface ProcessingOptions {
  1151. defines: string[];
  1152. indexParameters: any;
  1153. isFragment: boolean;
  1154. shouldUseHighPrecisionShader: boolean;
  1155. supportsUniformBuffers: boolean;
  1156. shadersRepository: string;
  1157. includesShadersStore: {
  1158. [key: string]: string;
  1159. };
  1160. processor?: IShaderProcessor;
  1161. version: string;
  1162. platformName: string;
  1163. lookForClosingBracketForUniformBuffer?: boolean;
  1164. }
  1165. }
  1166. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1167. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1168. /** @hidden */
  1169. export class ShaderCodeNode {
  1170. line: string;
  1171. children: ShaderCodeNode[];
  1172. additionalDefineKey?: string;
  1173. additionalDefineValue?: string;
  1174. isValid(preprocessors: {
  1175. [key: string]: string;
  1176. }): boolean;
  1177. process(preprocessors: {
  1178. [key: string]: string;
  1179. }, options: ProcessingOptions): string;
  1180. }
  1181. }
  1182. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1183. /** @hidden */
  1184. export class ShaderCodeCursor {
  1185. private _lines;
  1186. lineIndex: number;
  1187. readonly currentLine: string;
  1188. readonly canRead: boolean;
  1189. lines: string[];
  1190. }
  1191. }
  1192. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1193. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1194. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1195. /** @hidden */
  1196. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1197. process(preprocessors: {
  1198. [key: string]: string;
  1199. }, options: ProcessingOptions): string;
  1200. }
  1201. }
  1202. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1203. /** @hidden */
  1204. export class ShaderDefineExpression {
  1205. isTrue(preprocessors: {
  1206. [key: string]: string;
  1207. }): boolean;
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1213. /** @hidden */
  1214. export class ShaderCodeTestNode extends ShaderCodeNode {
  1215. testExpression: ShaderDefineExpression;
  1216. isValid(preprocessors: {
  1217. [key: string]: string;
  1218. }): boolean;
  1219. }
  1220. }
  1221. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1222. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1223. /** @hidden */
  1224. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1225. define: string;
  1226. not: boolean;
  1227. constructor(define: string, not?: boolean);
  1228. isTrue(preprocessors: {
  1229. [key: string]: string;
  1230. }): boolean;
  1231. }
  1232. }
  1233. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1237. leftOperand: ShaderDefineExpression;
  1238. rightOperand: ShaderDefineExpression;
  1239. isTrue(preprocessors: {
  1240. [key: string]: string;
  1241. }): boolean;
  1242. }
  1243. }
  1244. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1245. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1246. /** @hidden */
  1247. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1248. leftOperand: ShaderDefineExpression;
  1249. rightOperand: ShaderDefineExpression;
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1259. define: string;
  1260. operand: string;
  1261. testValue: string;
  1262. constructor(define: string, operand: string, testValue: string);
  1263. isTrue(preprocessors: {
  1264. [key: string]: string;
  1265. }): boolean;
  1266. }
  1267. }
  1268. declare module "babylonjs/Offline/IOfflineProvider" {
  1269. /**
  1270. * Class used to enable access to offline support
  1271. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1272. */
  1273. export interface IOfflineProvider {
  1274. /**
  1275. * Gets a boolean indicating if scene must be saved in the database
  1276. */
  1277. enableSceneOffline: boolean;
  1278. /**
  1279. * Gets a boolean indicating if textures must be saved in the database
  1280. */
  1281. enableTexturesOffline: boolean;
  1282. /**
  1283. * Open the offline support and make it available
  1284. * @param successCallback defines the callback to call on success
  1285. * @param errorCallback defines the callback to call on error
  1286. */
  1287. open(successCallback: () => void, errorCallback: () => void): void;
  1288. /**
  1289. * Loads an image from the offline support
  1290. * @param url defines the url to load from
  1291. * @param image defines the target DOM image
  1292. */
  1293. loadImage(url: string, image: HTMLImageElement): void;
  1294. /**
  1295. * Loads a file from offline support
  1296. * @param url defines the URL to load from
  1297. * @param sceneLoaded defines a callback to call on success
  1298. * @param progressCallBack defines a callback to call when progress changed
  1299. * @param errorCallback defines a callback to call on error
  1300. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1301. */
  1302. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1303. }
  1304. }
  1305. declare module "babylonjs/Misc/filesInputStore" {
  1306. /**
  1307. * Class used to help managing file picking and drag'n'drop
  1308. * File Storage
  1309. */
  1310. export class FilesInputStore {
  1311. /**
  1312. * List of files ready to be loaded
  1313. */
  1314. static FilesToLoad: {
  1315. [key: string]: File;
  1316. };
  1317. }
  1318. }
  1319. declare module "babylonjs/Misc/retryStrategy" {
  1320. import { WebRequest } from "babylonjs/Misc/webRequest";
  1321. /**
  1322. * Class used to define a retry strategy when error happens while loading assets
  1323. */
  1324. export class RetryStrategy {
  1325. /**
  1326. * Function used to defines an exponential back off strategy
  1327. * @param maxRetries defines the maximum number of retries (3 by default)
  1328. * @param baseInterval defines the interval between retries
  1329. * @returns the strategy function to use
  1330. */
  1331. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1332. }
  1333. }
  1334. declare module "babylonjs/Misc/baseError" {
  1335. /**
  1336. * @ignore
  1337. * Application error to support additional information when loading a file
  1338. */
  1339. export abstract class BaseError extends Error {
  1340. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1341. }
  1342. }
  1343. declare module "babylonjs/Misc/fileTools" {
  1344. import { WebRequest } from "babylonjs/Misc/webRequest";
  1345. import { Nullable } from "babylonjs/types";
  1346. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1347. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1348. import { BaseError } from "babylonjs/Misc/baseError";
  1349. /** @ignore */
  1350. export class LoadFileError extends BaseError {
  1351. request?: WebRequest;
  1352. file?: File;
  1353. /**
  1354. * Creates a new LoadFileError
  1355. * @param message defines the message of the error
  1356. * @param request defines the optional web request
  1357. * @param file defines the optional file
  1358. */
  1359. constructor(message: string, object?: WebRequest | File);
  1360. }
  1361. /** @ignore */
  1362. export class RequestFileError extends BaseError {
  1363. request: WebRequest;
  1364. /**
  1365. * Creates a new LoadFileError
  1366. * @param message defines the message of the error
  1367. * @param request defines the optional web request
  1368. */
  1369. constructor(message: string, request: WebRequest);
  1370. }
  1371. /** @ignore */
  1372. export class ReadFileError extends BaseError {
  1373. file: File;
  1374. /**
  1375. * Creates a new ReadFileError
  1376. * @param message defines the message of the error
  1377. * @param file defines the optional file
  1378. */
  1379. constructor(message: string, file: File);
  1380. }
  1381. /**
  1382. * @hidden
  1383. */
  1384. export class FileTools {
  1385. /**
  1386. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1387. */
  1388. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1389. /**
  1390. * Gets or sets the base URL to use to load assets
  1391. */
  1392. static BaseUrl: string;
  1393. /**
  1394. * Default behaviour for cors in the application.
  1395. * It can be a string if the expected behavior is identical in the entire app.
  1396. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1397. */
  1398. static CorsBehavior: string | ((url: string | string[]) => string);
  1399. /**
  1400. * Gets or sets a function used to pre-process url before using them to load assets
  1401. */
  1402. static PreprocessUrl: (url: string) => string;
  1403. /**
  1404. * Removes unwanted characters from an url
  1405. * @param url defines the url to clean
  1406. * @returns the cleaned url
  1407. */
  1408. private static _CleanUrl;
  1409. /**
  1410. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1411. * @param url define the url we are trying
  1412. * @param element define the dom element where to configure the cors policy
  1413. */
  1414. static SetCorsBehavior(url: string | string[], element: {
  1415. crossOrigin: string | null;
  1416. }): void;
  1417. /**
  1418. * Loads an image as an HTMLImageElement.
  1419. * @param input url string, ArrayBuffer, or Blob to load
  1420. * @param onLoad callback called when the image successfully loads
  1421. * @param onError callback called when the image fails to load
  1422. * @param offlineProvider offline provider for caching
  1423. * @param mimeType optional mime type
  1424. * @returns the HTMLImageElement of the loaded image
  1425. */
  1426. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1427. /**
  1428. * Reads a file from a File object
  1429. * @param file defines the file to load
  1430. * @param onSuccess defines the callback to call when data is loaded
  1431. * @param onProgress defines the callback to call during loading process
  1432. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1433. * @param onError defines the callback to call when an error occurs
  1434. * @returns a file request object
  1435. */
  1436. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1437. /**
  1438. * Loads a file from a url
  1439. * @param url url to load
  1440. * @param onSuccess callback called when the file successfully loads
  1441. * @param onProgress callback called while file is loading (if the server supports this mode)
  1442. * @param offlineProvider defines the offline provider for caching
  1443. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1444. * @param onError callback called when the file fails to load
  1445. * @returns a file request object
  1446. */
  1447. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1448. /**
  1449. * Loads a file
  1450. * @param url url to load
  1451. * @param onSuccess callback called when the file successfully loads
  1452. * @param onProgress callback called while file is loading (if the server supports this mode)
  1453. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1454. * @param onError callback called when the file fails to load
  1455. * @param onOpened callback called when the web request is opened
  1456. * @returns a file request object
  1457. */
  1458. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1459. /**
  1460. * Checks if the loaded document was accessed via `file:`-Protocol.
  1461. * @returns boolean
  1462. */
  1463. static IsFileURL(): boolean;
  1464. }
  1465. }
  1466. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1467. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1468. /** @hidden */
  1469. export class ShaderProcessor {
  1470. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1471. private static _ProcessPrecision;
  1472. private static _ExtractOperation;
  1473. private static _BuildSubExpression;
  1474. private static _BuildExpression;
  1475. private static _MoveCursorWithinIf;
  1476. private static _MoveCursor;
  1477. private static _EvaluatePreProcessors;
  1478. private static _PreparePreProcessors;
  1479. private static _ProcessShaderConversion;
  1480. private static _ProcessIncludes;
  1481. }
  1482. }
  1483. declare module "babylonjs/Maths/math.like" {
  1484. import { float, int, DeepImmutable } from "babylonjs/types";
  1485. /**
  1486. * @hidden
  1487. */
  1488. export interface IColor4Like {
  1489. r: float;
  1490. g: float;
  1491. b: float;
  1492. a: float;
  1493. }
  1494. /**
  1495. * @hidden
  1496. */
  1497. export interface IColor3Like {
  1498. r: float;
  1499. g: float;
  1500. b: float;
  1501. }
  1502. /**
  1503. * @hidden
  1504. */
  1505. export interface IVector4Like {
  1506. x: float;
  1507. y: float;
  1508. z: float;
  1509. w: float;
  1510. }
  1511. /**
  1512. * @hidden
  1513. */
  1514. export interface IVector3Like {
  1515. x: float;
  1516. y: float;
  1517. z: float;
  1518. }
  1519. /**
  1520. * @hidden
  1521. */
  1522. export interface IVector2Like {
  1523. x: float;
  1524. y: float;
  1525. }
  1526. /**
  1527. * @hidden
  1528. */
  1529. export interface IMatrixLike {
  1530. toArray(): DeepImmutable<Float32Array>;
  1531. updateFlag: int;
  1532. }
  1533. /**
  1534. * @hidden
  1535. */
  1536. export interface IViewportLike {
  1537. x: float;
  1538. y: float;
  1539. width: float;
  1540. height: float;
  1541. }
  1542. /**
  1543. * @hidden
  1544. */
  1545. export interface IPlaneLike {
  1546. normal: IVector3Like;
  1547. d: float;
  1548. normalize(): void;
  1549. }
  1550. }
  1551. declare module "babylonjs/Materials/iEffectFallbacks" {
  1552. import { Effect } from "babylonjs/Materials/effect";
  1553. /**
  1554. * Interface used to define common properties for effect fallbacks
  1555. */
  1556. export interface IEffectFallbacks {
  1557. /**
  1558. * Removes the defines that should be removed when falling back.
  1559. * @param currentDefines defines the current define statements for the shader.
  1560. * @param effect defines the current effect we try to compile
  1561. * @returns The resulting defines with defines of the current rank removed.
  1562. */
  1563. reduce(currentDefines: string, effect: Effect): string;
  1564. /**
  1565. * Removes the fallback from the bound mesh.
  1566. */
  1567. unBindMesh(): void;
  1568. /**
  1569. * Checks to see if more fallbacks are still availible.
  1570. */
  1571. hasMoreFallbacks: boolean;
  1572. }
  1573. }
  1574. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1575. /**
  1576. * Class used to evalaute queries containing `and` and `or` operators
  1577. */
  1578. export class AndOrNotEvaluator {
  1579. /**
  1580. * Evaluate a query
  1581. * @param query defines the query to evaluate
  1582. * @param evaluateCallback defines the callback used to filter result
  1583. * @returns true if the query matches
  1584. */
  1585. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1586. private static _HandleParenthesisContent;
  1587. private static _SimplifyNegation;
  1588. }
  1589. }
  1590. declare module "babylonjs/Misc/tags" {
  1591. /**
  1592. * Class used to store custom tags
  1593. */
  1594. export class Tags {
  1595. /**
  1596. * Adds support for tags on the given object
  1597. * @param obj defines the object to use
  1598. */
  1599. static EnableFor(obj: any): void;
  1600. /**
  1601. * Removes tags support
  1602. * @param obj defines the object to use
  1603. */
  1604. static DisableFor(obj: any): void;
  1605. /**
  1606. * Gets a boolean indicating if the given object has tags
  1607. * @param obj defines the object to use
  1608. * @returns a boolean
  1609. */
  1610. static HasTags(obj: any): boolean;
  1611. /**
  1612. * Gets the tags available on a given object
  1613. * @param obj defines the object to use
  1614. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1615. * @returns the tags
  1616. */
  1617. static GetTags(obj: any, asString?: boolean): any;
  1618. /**
  1619. * Adds tags to an object
  1620. * @param obj defines the object to use
  1621. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1622. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1623. */
  1624. static AddTagsTo(obj: any, tagsString: string): void;
  1625. /**
  1626. * @hidden
  1627. */
  1628. static _AddTagTo(obj: any, tag: string): void;
  1629. /**
  1630. * Removes specific tags from a specific object
  1631. * @param obj defines the object to use
  1632. * @param tagsString defines the tags to remove
  1633. */
  1634. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1635. /**
  1636. * @hidden
  1637. */
  1638. static _RemoveTagFrom(obj: any, tag: string): void;
  1639. /**
  1640. * Defines if tags hosted on an object match a given query
  1641. * @param obj defines the object to use
  1642. * @param tagsQuery defines the tag query
  1643. * @returns a boolean
  1644. */
  1645. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1646. }
  1647. }
  1648. declare module "babylonjs/Maths/math.scalar" {
  1649. /**
  1650. * Scalar computation library
  1651. */
  1652. export class Scalar {
  1653. /**
  1654. * Two pi constants convenient for computation.
  1655. */
  1656. static TwoPi: number;
  1657. /**
  1658. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1659. * @param a number
  1660. * @param b number
  1661. * @param epsilon (default = 1.401298E-45)
  1662. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1663. */
  1664. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1665. /**
  1666. * Returns a string : the upper case translation of the number i to hexadecimal.
  1667. * @param i number
  1668. * @returns the upper case translation of the number i to hexadecimal.
  1669. */
  1670. static ToHex(i: number): string;
  1671. /**
  1672. * Returns -1 if value is negative and +1 is value is positive.
  1673. * @param value the value
  1674. * @returns the value itself if it's equal to zero.
  1675. */
  1676. static Sign(value: number): number;
  1677. /**
  1678. * Returns the value itself if it's between min and max.
  1679. * Returns min if the value is lower than min.
  1680. * Returns max if the value is greater than max.
  1681. * @param value the value to clmap
  1682. * @param min the min value to clamp to (default: 0)
  1683. * @param max the max value to clamp to (default: 1)
  1684. * @returns the clamped value
  1685. */
  1686. static Clamp(value: number, min?: number, max?: number): number;
  1687. /**
  1688. * the log2 of value.
  1689. * @param value the value to compute log2 of
  1690. * @returns the log2 of value.
  1691. */
  1692. static Log2(value: number): number;
  1693. /**
  1694. * Loops the value, so that it is never larger than length and never smaller than 0.
  1695. *
  1696. * This is similar to the modulo operator but it works with floating point numbers.
  1697. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1698. * With t = 5 and length = 2.5, the result would be 0.0.
  1699. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1700. * @param value the value
  1701. * @param length the length
  1702. * @returns the looped value
  1703. */
  1704. static Repeat(value: number, length: number): number;
  1705. /**
  1706. * Normalize the value between 0.0 and 1.0 using min and max values
  1707. * @param value value to normalize
  1708. * @param min max to normalize between
  1709. * @param max min to normalize between
  1710. * @returns the normalized value
  1711. */
  1712. static Normalize(value: number, min: number, max: number): number;
  1713. /**
  1714. * Denormalize the value from 0.0 and 1.0 using min and max values
  1715. * @param normalized value to denormalize
  1716. * @param min max to denormalize between
  1717. * @param max min to denormalize between
  1718. * @returns the denormalized value
  1719. */
  1720. static Denormalize(normalized: number, min: number, max: number): number;
  1721. /**
  1722. * Calculates the shortest difference between two given angles given in degrees.
  1723. * @param current current angle in degrees
  1724. * @param target target angle in degrees
  1725. * @returns the delta
  1726. */
  1727. static DeltaAngle(current: number, target: number): number;
  1728. /**
  1729. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1730. * @param tx value
  1731. * @param length length
  1732. * @returns The returned value will move back and forth between 0 and length
  1733. */
  1734. static PingPong(tx: number, length: number): number;
  1735. /**
  1736. * Interpolates between min and max with smoothing at the limits.
  1737. *
  1738. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1739. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1740. * @param from from
  1741. * @param to to
  1742. * @param tx value
  1743. * @returns the smooth stepped value
  1744. */
  1745. static SmoothStep(from: number, to: number, tx: number): number;
  1746. /**
  1747. * Moves a value current towards target.
  1748. *
  1749. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1750. * Negative values of maxDelta pushes the value away from target.
  1751. * @param current current value
  1752. * @param target target value
  1753. * @param maxDelta max distance to move
  1754. * @returns resulting value
  1755. */
  1756. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1757. /**
  1758. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1759. *
  1760. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1761. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1762. * @param current current value
  1763. * @param target target value
  1764. * @param maxDelta max distance to move
  1765. * @returns resulting angle
  1766. */
  1767. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1768. /**
  1769. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1770. * @param start start value
  1771. * @param end target value
  1772. * @param amount amount to lerp between
  1773. * @returns the lerped value
  1774. */
  1775. static Lerp(start: number, end: number, amount: number): number;
  1776. /**
  1777. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1778. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1779. * @param start start value
  1780. * @param end target value
  1781. * @param amount amount to lerp between
  1782. * @returns the lerped value
  1783. */
  1784. static LerpAngle(start: number, end: number, amount: number): number;
  1785. /**
  1786. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1787. * @param a start value
  1788. * @param b target value
  1789. * @param value value between a and b
  1790. * @returns the inverseLerp value
  1791. */
  1792. static InverseLerp(a: number, b: number, value: number): number;
  1793. /**
  1794. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1795. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1796. * @param value1 spline value
  1797. * @param tangent1 spline value
  1798. * @param value2 spline value
  1799. * @param tangent2 spline value
  1800. * @param amount input value
  1801. * @returns hermite result
  1802. */
  1803. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1804. /**
  1805. * Returns a random float number between and min and max values
  1806. * @param min min value of random
  1807. * @param max max value of random
  1808. * @returns random value
  1809. */
  1810. static RandomRange(min: number, max: number): number;
  1811. /**
  1812. * This function returns percentage of a number in a given range.
  1813. *
  1814. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1815. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1816. * @param number to convert to percentage
  1817. * @param min min range
  1818. * @param max max range
  1819. * @returns the percentage
  1820. */
  1821. static RangeToPercent(number: number, min: number, max: number): number;
  1822. /**
  1823. * This function returns number that corresponds to the percentage in a given range.
  1824. *
  1825. * PercentToRange(0.34,0,100) will return 34.
  1826. * @param percent to convert to number
  1827. * @param min min range
  1828. * @param max max range
  1829. * @returns the number
  1830. */
  1831. static PercentToRange(percent: number, min: number, max: number): number;
  1832. /**
  1833. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1834. * @param angle The angle to normalize in radian.
  1835. * @return The converted angle.
  1836. */
  1837. static NormalizeRadians(angle: number): number;
  1838. }
  1839. }
  1840. declare module "babylonjs/Maths/math.constants" {
  1841. /**
  1842. * Constant used to convert a value to gamma space
  1843. * @ignorenaming
  1844. */
  1845. export const ToGammaSpace: number;
  1846. /**
  1847. * Constant used to convert a value to linear space
  1848. * @ignorenaming
  1849. */
  1850. export const ToLinearSpace = 2.2;
  1851. /**
  1852. * Constant used to define the minimal number value in Babylon.js
  1853. * @ignorenaming
  1854. */
  1855. let Epsilon: number;
  1856. export { Epsilon };
  1857. }
  1858. declare module "babylonjs/Maths/math.viewport" {
  1859. /**
  1860. * Class used to represent a viewport on screen
  1861. */
  1862. export class Viewport {
  1863. /** viewport left coordinate */
  1864. x: number;
  1865. /** viewport top coordinate */
  1866. y: number;
  1867. /**viewport width */
  1868. width: number;
  1869. /** viewport height */
  1870. height: number;
  1871. /**
  1872. * Creates a Viewport object located at (x, y) and sized (width, height)
  1873. * @param x defines viewport left coordinate
  1874. * @param y defines viewport top coordinate
  1875. * @param width defines the viewport width
  1876. * @param height defines the viewport height
  1877. */
  1878. constructor(
  1879. /** viewport left coordinate */
  1880. x: number,
  1881. /** viewport top coordinate */
  1882. y: number,
  1883. /**viewport width */
  1884. width: number,
  1885. /** viewport height */
  1886. height: number);
  1887. /**
  1888. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1889. * @param renderWidth defines the rendering width
  1890. * @param renderHeight defines the rendering height
  1891. * @returns a new Viewport
  1892. */
  1893. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1894. /**
  1895. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1896. * @param renderWidth defines the rendering width
  1897. * @param renderHeight defines the rendering height
  1898. * @param ref defines the target viewport
  1899. * @returns the current viewport
  1900. */
  1901. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1902. /**
  1903. * Returns a new Viewport copied from the current one
  1904. * @returns a new Viewport
  1905. */
  1906. clone(): Viewport;
  1907. }
  1908. }
  1909. declare module "babylonjs/Misc/arrayTools" {
  1910. /**
  1911. * Class containing a set of static utilities functions for arrays.
  1912. */
  1913. export class ArrayTools {
  1914. /**
  1915. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1916. * @param size the number of element to construct and put in the array
  1917. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1918. * @returns a new array filled with new objects
  1919. */
  1920. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1921. }
  1922. }
  1923. declare module "babylonjs/Maths/math.vector" {
  1924. import { Viewport } from "babylonjs/Maths/math.viewport";
  1925. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  1926. import { IPlaneLike } from "babylonjs/Maths/math.like";
  1927. /**
  1928. * Class representing a vector containing 2 coordinates
  1929. */
  1930. export class Vector2 {
  1931. /** defines the first coordinate */
  1932. x: number;
  1933. /** defines the second coordinate */
  1934. y: number;
  1935. /**
  1936. * Creates a new Vector2 from the given x and y coordinates
  1937. * @param x defines the first coordinate
  1938. * @param y defines the second coordinate
  1939. */
  1940. constructor(
  1941. /** defines the first coordinate */
  1942. x?: number,
  1943. /** defines the second coordinate */
  1944. y?: number);
  1945. /**
  1946. * Gets a string with the Vector2 coordinates
  1947. * @returns a string with the Vector2 coordinates
  1948. */
  1949. toString(): string;
  1950. /**
  1951. * Gets class name
  1952. * @returns the string "Vector2"
  1953. */
  1954. getClassName(): string;
  1955. /**
  1956. * Gets current vector hash code
  1957. * @returns the Vector2 hash code as a number
  1958. */
  1959. getHashCode(): number;
  1960. /**
  1961. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  1962. * @param array defines the source array
  1963. * @param index defines the offset in source array
  1964. * @returns the current Vector2
  1965. */
  1966. toArray(array: FloatArray, index?: number): Vector2;
  1967. /**
  1968. * Copy the current vector to an array
  1969. * @returns a new array with 2 elements: the Vector2 coordinates.
  1970. */
  1971. asArray(): number[];
  1972. /**
  1973. * Sets the Vector2 coordinates with the given Vector2 coordinates
  1974. * @param source defines the source Vector2
  1975. * @returns the current updated Vector2
  1976. */
  1977. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  1978. /**
  1979. * Sets the Vector2 coordinates with the given floats
  1980. * @param x defines the first coordinate
  1981. * @param y defines the second coordinate
  1982. * @returns the current updated Vector2
  1983. */
  1984. copyFromFloats(x: number, y: number): Vector2;
  1985. /**
  1986. * Sets the Vector2 coordinates with the given floats
  1987. * @param x defines the first coordinate
  1988. * @param y defines the second coordinate
  1989. * @returns the current updated Vector2
  1990. */
  1991. set(x: number, y: number): Vector2;
  1992. /**
  1993. * Add another vector with the current one
  1994. * @param otherVector defines the other vector
  1995. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  1996. */
  1997. add(otherVector: DeepImmutable<Vector2>): Vector2;
  1998. /**
  1999. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2000. * @param otherVector defines the other vector
  2001. * @param result defines the target vector
  2002. * @returns the unmodified current Vector2
  2003. */
  2004. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2005. /**
  2006. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2007. * @param otherVector defines the other vector
  2008. * @returns the current updated Vector2
  2009. */
  2010. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2011. /**
  2012. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2013. * @param otherVector defines the other vector
  2014. * @returns a new Vector2
  2015. */
  2016. addVector3(otherVector: Vector3): Vector2;
  2017. /**
  2018. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2019. * @param otherVector defines the other vector
  2020. * @returns a new Vector2
  2021. */
  2022. subtract(otherVector: Vector2): Vector2;
  2023. /**
  2024. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2025. * @param otherVector defines the other vector
  2026. * @param result defines the target vector
  2027. * @returns the unmodified current Vector2
  2028. */
  2029. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2030. /**
  2031. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2032. * @param otherVector defines the other vector
  2033. * @returns the current updated Vector2
  2034. */
  2035. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2036. /**
  2037. * Multiplies in place the current Vector2 coordinates by the given ones
  2038. * @param otherVector defines the other vector
  2039. * @returns the current updated Vector2
  2040. */
  2041. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2042. /**
  2043. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2044. * @param otherVector defines the other vector
  2045. * @returns a new Vector2
  2046. */
  2047. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2048. /**
  2049. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2050. * @param otherVector defines the other vector
  2051. * @param result defines the target vector
  2052. * @returns the unmodified current Vector2
  2053. */
  2054. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2055. /**
  2056. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2057. * @param x defines the first coordinate
  2058. * @param y defines the second coordinate
  2059. * @returns a new Vector2
  2060. */
  2061. multiplyByFloats(x: number, y: number): Vector2;
  2062. /**
  2063. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2064. * @param otherVector defines the other vector
  2065. * @returns a new Vector2
  2066. */
  2067. divide(otherVector: Vector2): Vector2;
  2068. /**
  2069. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2070. * @param otherVector defines the other vector
  2071. * @param result defines the target vector
  2072. * @returns the unmodified current Vector2
  2073. */
  2074. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2075. /**
  2076. * Divides the current Vector2 coordinates by the given ones
  2077. * @param otherVector defines the other vector
  2078. * @returns the current updated Vector2
  2079. */
  2080. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2081. /**
  2082. * Gets a new Vector2 with current Vector2 negated coordinates
  2083. * @returns a new Vector2
  2084. */
  2085. negate(): Vector2;
  2086. /**
  2087. * Multiply the Vector2 coordinates by scale
  2088. * @param scale defines the scaling factor
  2089. * @returns the current updated Vector2
  2090. */
  2091. scaleInPlace(scale: number): Vector2;
  2092. /**
  2093. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2094. * @param scale defines the scaling factor
  2095. * @returns a new Vector2
  2096. */
  2097. scale(scale: number): Vector2;
  2098. /**
  2099. * Scale the current Vector2 values by a factor to a given Vector2
  2100. * @param scale defines the scale factor
  2101. * @param result defines the Vector2 object where to store the result
  2102. * @returns the unmodified current Vector2
  2103. */
  2104. scaleToRef(scale: number, result: Vector2): Vector2;
  2105. /**
  2106. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2107. * @param scale defines the scale factor
  2108. * @param result defines the Vector2 object where to store the result
  2109. * @returns the unmodified current Vector2
  2110. */
  2111. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2112. /**
  2113. * Gets a boolean if two vectors are equals
  2114. * @param otherVector defines the other vector
  2115. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2116. */
  2117. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2118. /**
  2119. * Gets a boolean if two vectors are equals (using an epsilon value)
  2120. * @param otherVector defines the other vector
  2121. * @param epsilon defines the minimal distance to consider equality
  2122. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2123. */
  2124. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2125. /**
  2126. * Gets a new Vector2 from current Vector2 floored values
  2127. * @returns a new Vector2
  2128. */
  2129. floor(): Vector2;
  2130. /**
  2131. * Gets a new Vector2 from current Vector2 floored values
  2132. * @returns a new Vector2
  2133. */
  2134. fract(): Vector2;
  2135. /**
  2136. * Gets the length of the vector
  2137. * @returns the vector length (float)
  2138. */
  2139. length(): number;
  2140. /**
  2141. * Gets the vector squared length
  2142. * @returns the vector squared length (float)
  2143. */
  2144. lengthSquared(): number;
  2145. /**
  2146. * Normalize the vector
  2147. * @returns the current updated Vector2
  2148. */
  2149. normalize(): Vector2;
  2150. /**
  2151. * Gets a new Vector2 copied from the Vector2
  2152. * @returns a new Vector2
  2153. */
  2154. clone(): Vector2;
  2155. /**
  2156. * Gets a new Vector2(0, 0)
  2157. * @returns a new Vector2
  2158. */
  2159. static Zero(): Vector2;
  2160. /**
  2161. * Gets a new Vector2(1, 1)
  2162. * @returns a new Vector2
  2163. */
  2164. static One(): Vector2;
  2165. /**
  2166. * Gets a new Vector2 set from the given index element of the given array
  2167. * @param array defines the data source
  2168. * @param offset defines the offset in the data source
  2169. * @returns a new Vector2
  2170. */
  2171. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2172. /**
  2173. * Sets "result" from the given index element of the given array
  2174. * @param array defines the data source
  2175. * @param offset defines the offset in the data source
  2176. * @param result defines the target vector
  2177. */
  2178. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2179. /**
  2180. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2181. * @param value1 defines 1st point of control
  2182. * @param value2 defines 2nd point of control
  2183. * @param value3 defines 3rd point of control
  2184. * @param value4 defines 4th point of control
  2185. * @param amount defines the interpolation factor
  2186. * @returns a new Vector2
  2187. */
  2188. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2189. /**
  2190. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  2191. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2192. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2193. * @param value defines the value to clamp
  2194. * @param min defines the lower limit
  2195. * @param max defines the upper limit
  2196. * @returns a new Vector2
  2197. */
  2198. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2199. /**
  2200. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2201. * @param value1 defines the 1st control point
  2202. * @param tangent1 defines the outgoing tangent
  2203. * @param value2 defines the 2nd control point
  2204. * @param tangent2 defines the incoming tangent
  2205. * @param amount defines the interpolation factor
  2206. * @returns a new Vector2
  2207. */
  2208. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2209. /**
  2210. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2211. * @param start defines the start vector
  2212. * @param end defines the end vector
  2213. * @param amount defines the interpolation factor
  2214. * @returns a new Vector2
  2215. */
  2216. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2217. /**
  2218. * Gets the dot product of the vector "left" and the vector "right"
  2219. * @param left defines first vector
  2220. * @param right defines second vector
  2221. * @returns the dot product (float)
  2222. */
  2223. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2224. /**
  2225. * Returns a new Vector2 equal to the normalized given vector
  2226. * @param vector defines the vector to normalize
  2227. * @returns a new Vector2
  2228. */
  2229. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2230. /**
  2231. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2232. * @param left defines 1st vector
  2233. * @param right defines 2nd vector
  2234. * @returns a new Vector2
  2235. */
  2236. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2237. /**
  2238. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2239. * @param left defines 1st vector
  2240. * @param right defines 2nd vector
  2241. * @returns a new Vector2
  2242. */
  2243. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2244. /**
  2245. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2246. * @param vector defines the vector to transform
  2247. * @param transformation defines the matrix to apply
  2248. * @returns a new Vector2
  2249. */
  2250. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2251. /**
  2252. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2253. * @param vector defines the vector to transform
  2254. * @param transformation defines the matrix to apply
  2255. * @param result defines the target vector
  2256. */
  2257. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2258. /**
  2259. * Determines if a given vector is included in a triangle
  2260. * @param p defines the vector to test
  2261. * @param p0 defines 1st triangle point
  2262. * @param p1 defines 2nd triangle point
  2263. * @param p2 defines 3rd triangle point
  2264. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2265. */
  2266. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2267. /**
  2268. * Gets the distance between the vectors "value1" and "value2"
  2269. * @param value1 defines first vector
  2270. * @param value2 defines second vector
  2271. * @returns the distance between vectors
  2272. */
  2273. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2274. /**
  2275. * Returns the squared distance between the vectors "value1" and "value2"
  2276. * @param value1 defines first vector
  2277. * @param value2 defines second vector
  2278. * @returns the squared distance between vectors
  2279. */
  2280. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2281. /**
  2282. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2283. * @param value1 defines first vector
  2284. * @param value2 defines second vector
  2285. * @returns a new Vector2
  2286. */
  2287. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2288. /**
  2289. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2290. * @param p defines the middle point
  2291. * @param segA defines one point of the segment
  2292. * @param segB defines the other point of the segment
  2293. * @returns the shortest distance
  2294. */
  2295. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2296. }
  2297. /**
  2298. * Classed used to store (x,y,z) vector representation
  2299. * A Vector3 is the main object used in 3D geometry
  2300. * It can represent etiher the coordinates of a point the space, either a direction
  2301. * Reminder: js uses a left handed forward facing system
  2302. */
  2303. export class Vector3 {
  2304. /**
  2305. * Defines the first coordinates (on X axis)
  2306. */
  2307. x: number;
  2308. /**
  2309. * Defines the second coordinates (on Y axis)
  2310. */
  2311. y: number;
  2312. /**
  2313. * Defines the third coordinates (on Z axis)
  2314. */
  2315. z: number;
  2316. private static _UpReadOnly;
  2317. private static _ZeroReadOnly;
  2318. /**
  2319. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2320. * @param x defines the first coordinates (on X axis)
  2321. * @param y defines the second coordinates (on Y axis)
  2322. * @param z defines the third coordinates (on Z axis)
  2323. */
  2324. constructor(
  2325. /**
  2326. * Defines the first coordinates (on X axis)
  2327. */
  2328. x?: number,
  2329. /**
  2330. * Defines the second coordinates (on Y axis)
  2331. */
  2332. y?: number,
  2333. /**
  2334. * Defines the third coordinates (on Z axis)
  2335. */
  2336. z?: number);
  2337. /**
  2338. * Creates a string representation of the Vector3
  2339. * @returns a string with the Vector3 coordinates.
  2340. */
  2341. toString(): string;
  2342. /**
  2343. * Gets the class name
  2344. * @returns the string "Vector3"
  2345. */
  2346. getClassName(): string;
  2347. /**
  2348. * Creates the Vector3 hash code
  2349. * @returns a number which tends to be unique between Vector3 instances
  2350. */
  2351. getHashCode(): number;
  2352. /**
  2353. * Creates an array containing three elements : the coordinates of the Vector3
  2354. * @returns a new array of numbers
  2355. */
  2356. asArray(): number[];
  2357. /**
  2358. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2359. * @param array defines the destination array
  2360. * @param index defines the offset in the destination array
  2361. * @returns the current Vector3
  2362. */
  2363. toArray(array: FloatArray, index?: number): Vector3;
  2364. /**
  2365. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2366. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2367. */
  2368. toQuaternion(): Quaternion;
  2369. /**
  2370. * Adds the given vector to the current Vector3
  2371. * @param otherVector defines the second operand
  2372. * @returns the current updated Vector3
  2373. */
  2374. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2375. /**
  2376. * Adds the given coordinates to the current Vector3
  2377. * @param x defines the x coordinate of the operand
  2378. * @param y defines the y coordinate of the operand
  2379. * @param z defines the z coordinate of the operand
  2380. * @returns the current updated Vector3
  2381. */
  2382. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2383. /**
  2384. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2385. * @param otherVector defines the second operand
  2386. * @returns the resulting Vector3
  2387. */
  2388. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2389. /**
  2390. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2391. * @param otherVector defines the second operand
  2392. * @param result defines the Vector3 object where to store the result
  2393. * @returns the current Vector3
  2394. */
  2395. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2396. /**
  2397. * Subtract the given vector from the current Vector3
  2398. * @param otherVector defines the second operand
  2399. * @returns the current updated Vector3
  2400. */
  2401. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2402. /**
  2403. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2404. * @param otherVector defines the second operand
  2405. * @returns the resulting Vector3
  2406. */
  2407. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2408. /**
  2409. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2410. * @param otherVector defines the second operand
  2411. * @param result defines the Vector3 object where to store the result
  2412. * @returns the current Vector3
  2413. */
  2414. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2415. /**
  2416. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2417. * @param x defines the x coordinate of the operand
  2418. * @param y defines the y coordinate of the operand
  2419. * @param z defines the z coordinate of the operand
  2420. * @returns the resulting Vector3
  2421. */
  2422. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2423. /**
  2424. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2425. * @param x defines the x coordinate of the operand
  2426. * @param y defines the y coordinate of the operand
  2427. * @param z defines the z coordinate of the operand
  2428. * @param result defines the Vector3 object where to store the result
  2429. * @returns the current Vector3
  2430. */
  2431. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2432. /**
  2433. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2434. * @returns a new Vector3
  2435. */
  2436. negate(): Vector3;
  2437. /**
  2438. * Multiplies the Vector3 coordinates by the float "scale"
  2439. * @param scale defines the multiplier factor
  2440. * @returns the current updated Vector3
  2441. */
  2442. scaleInPlace(scale: number): Vector3;
  2443. /**
  2444. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2445. * @param scale defines the multiplier factor
  2446. * @returns a new Vector3
  2447. */
  2448. scale(scale: number): Vector3;
  2449. /**
  2450. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2451. * @param scale defines the multiplier factor
  2452. * @param result defines the Vector3 object where to store the result
  2453. * @returns the current Vector3
  2454. */
  2455. scaleToRef(scale: number, result: Vector3): Vector3;
  2456. /**
  2457. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2458. * @param scale defines the scale factor
  2459. * @param result defines the Vector3 object where to store the result
  2460. * @returns the unmodified current Vector3
  2461. */
  2462. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2463. /**
  2464. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2465. * @param otherVector defines the second operand
  2466. * @returns true if both vectors are equals
  2467. */
  2468. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2469. /**
  2470. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2471. * @param otherVector defines the second operand
  2472. * @param epsilon defines the minimal distance to define values as equals
  2473. * @returns true if both vectors are distant less than epsilon
  2474. */
  2475. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2476. /**
  2477. * Returns true if the current Vector3 coordinates equals the given floats
  2478. * @param x defines the x coordinate of the operand
  2479. * @param y defines the y coordinate of the operand
  2480. * @param z defines the z coordinate of the operand
  2481. * @returns true if both vectors are equals
  2482. */
  2483. equalsToFloats(x: number, y: number, z: number): boolean;
  2484. /**
  2485. * Multiplies the current Vector3 coordinates by the given ones
  2486. * @param otherVector defines the second operand
  2487. * @returns the current updated Vector3
  2488. */
  2489. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2490. /**
  2491. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2492. * @param otherVector defines the second operand
  2493. * @returns the new Vector3
  2494. */
  2495. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2496. /**
  2497. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2498. * @param otherVector defines the second operand
  2499. * @param result defines the Vector3 object where to store the result
  2500. * @returns the current Vector3
  2501. */
  2502. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2503. /**
  2504. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2505. * @param x defines the x coordinate of the operand
  2506. * @param y defines the y coordinate of the operand
  2507. * @param z defines the z coordinate of the operand
  2508. * @returns the new Vector3
  2509. */
  2510. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2511. /**
  2512. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2513. * @param otherVector defines the second operand
  2514. * @returns the new Vector3
  2515. */
  2516. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2517. /**
  2518. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2519. * @param otherVector defines the second operand
  2520. * @param result defines the Vector3 object where to store the result
  2521. * @returns the current Vector3
  2522. */
  2523. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2524. /**
  2525. * Divides the current Vector3 coordinates by the given ones.
  2526. * @param otherVector defines the second operand
  2527. * @returns the current updated Vector3
  2528. */
  2529. divideInPlace(otherVector: Vector3): Vector3;
  2530. /**
  2531. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2532. * @param other defines the second operand
  2533. * @returns the current updated Vector3
  2534. */
  2535. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2536. /**
  2537. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2538. * @param other defines the second operand
  2539. * @returns the current updated Vector3
  2540. */
  2541. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2542. /**
  2543. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2544. * @param x defines the x coordinate of the operand
  2545. * @param y defines the y coordinate of the operand
  2546. * @param z defines the z coordinate of the operand
  2547. * @returns the current updated Vector3
  2548. */
  2549. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2550. /**
  2551. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2552. * @param x defines the x coordinate of the operand
  2553. * @param y defines the y coordinate of the operand
  2554. * @param z defines the z coordinate of the operand
  2555. * @returns the current updated Vector3
  2556. */
  2557. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2558. /**
  2559. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2560. * Check if is non uniform within a certain amount of decimal places to account for this
  2561. * @param epsilon the amount the values can differ
  2562. * @returns if the the vector is non uniform to a certain number of decimal places
  2563. */
  2564. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2565. /**
  2566. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2567. */
  2568. readonly isNonUniform: boolean;
  2569. /**
  2570. * Gets a new Vector3 from current Vector3 floored values
  2571. * @returns a new Vector3
  2572. */
  2573. floor(): Vector3;
  2574. /**
  2575. * Gets a new Vector3 from current Vector3 floored values
  2576. * @returns a new Vector3
  2577. */
  2578. fract(): Vector3;
  2579. /**
  2580. * Gets the length of the Vector3
  2581. * @returns the length of the Vector3
  2582. */
  2583. length(): number;
  2584. /**
  2585. * Gets the squared length of the Vector3
  2586. * @returns squared length of the Vector3
  2587. */
  2588. lengthSquared(): number;
  2589. /**
  2590. * Normalize the current Vector3.
  2591. * Please note that this is an in place operation.
  2592. * @returns the current updated Vector3
  2593. */
  2594. normalize(): Vector3;
  2595. /**
  2596. * Reorders the x y z properties of the vector in place
  2597. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2598. * @returns the current updated vector
  2599. */
  2600. reorderInPlace(order: string): this;
  2601. /**
  2602. * Rotates the vector around 0,0,0 by a quaternion
  2603. * @param quaternion the rotation quaternion
  2604. * @param result vector to store the result
  2605. * @returns the resulting vector
  2606. */
  2607. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2608. /**
  2609. * Rotates a vector around a given point
  2610. * @param quaternion the rotation quaternion
  2611. * @param point the point to rotate around
  2612. * @param result vector to store the result
  2613. * @returns the resulting vector
  2614. */
  2615. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2616. /**
  2617. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2618. * The cross product is then orthogonal to both current and "other"
  2619. * @param other defines the right operand
  2620. * @returns the cross product
  2621. */
  2622. cross(other: Vector3): Vector3;
  2623. /**
  2624. * Normalize the current Vector3 with the given input length.
  2625. * Please note that this is an in place operation.
  2626. * @param len the length of the vector
  2627. * @returns the current updated Vector3
  2628. */
  2629. normalizeFromLength(len: number): Vector3;
  2630. /**
  2631. * Normalize the current Vector3 to a new vector
  2632. * @returns the new Vector3
  2633. */
  2634. normalizeToNew(): Vector3;
  2635. /**
  2636. * Normalize the current Vector3 to the reference
  2637. * @param reference define the Vector3 to update
  2638. * @returns the updated Vector3
  2639. */
  2640. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  2641. /**
  2642. * Creates a new Vector3 copied from the current Vector3
  2643. * @returns the new Vector3
  2644. */
  2645. clone(): Vector3;
  2646. /**
  2647. * Copies the given vector coordinates to the current Vector3 ones
  2648. * @param source defines the source Vector3
  2649. * @returns the current updated Vector3
  2650. */
  2651. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2652. /**
  2653. * Copies the given floats to the current Vector3 coordinates
  2654. * @param x defines the x coordinate of the operand
  2655. * @param y defines the y coordinate of the operand
  2656. * @param z defines the z coordinate of the operand
  2657. * @returns the current updated Vector3
  2658. */
  2659. copyFromFloats(x: number, y: number, z: number): Vector3;
  2660. /**
  2661. * Copies the given floats to the current Vector3 coordinates
  2662. * @param x defines the x coordinate of the operand
  2663. * @param y defines the y coordinate of the operand
  2664. * @param z defines the z coordinate of the operand
  2665. * @returns the current updated Vector3
  2666. */
  2667. set(x: number, y: number, z: number): Vector3;
  2668. /**
  2669. * Copies the given float to the current Vector3 coordinates
  2670. * @param v defines the x, y and z coordinates of the operand
  2671. * @returns the current updated Vector3
  2672. */
  2673. setAll(v: number): Vector3;
  2674. /**
  2675. * Get the clip factor between two vectors
  2676. * @param vector0 defines the first operand
  2677. * @param vector1 defines the second operand
  2678. * @param axis defines the axis to use
  2679. * @param size defines the size along the axis
  2680. * @returns the clip factor
  2681. */
  2682. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2683. /**
  2684. * Get angle between two vectors
  2685. * @param vector0 angle between vector0 and vector1
  2686. * @param vector1 angle between vector0 and vector1
  2687. * @param normal direction of the normal
  2688. * @return the angle between vector0 and vector1
  2689. */
  2690. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2691. /**
  2692. * Returns a new Vector3 set from the index "offset" of the given array
  2693. * @param array defines the source array
  2694. * @param offset defines the offset in the source array
  2695. * @returns the new Vector3
  2696. */
  2697. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2698. /**
  2699. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2700. * This function is deprecated. Use FromArray instead
  2701. * @param array defines the source array
  2702. * @param offset defines the offset in the source array
  2703. * @returns the new Vector3
  2704. */
  2705. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2706. /**
  2707. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2708. * @param array defines the source array
  2709. * @param offset defines the offset in the source array
  2710. * @param result defines the Vector3 where to store the result
  2711. */
  2712. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2713. /**
  2714. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2715. * This function is deprecated. Use FromArrayToRef instead.
  2716. * @param array defines the source array
  2717. * @param offset defines the offset in the source array
  2718. * @param result defines the Vector3 where to store the result
  2719. */
  2720. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2721. /**
  2722. * Sets the given vector "result" with the given floats.
  2723. * @param x defines the x coordinate of the source
  2724. * @param y defines the y coordinate of the source
  2725. * @param z defines the z coordinate of the source
  2726. * @param result defines the Vector3 where to store the result
  2727. */
  2728. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2729. /**
  2730. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2731. * @returns a new empty Vector3
  2732. */
  2733. static Zero(): Vector3;
  2734. /**
  2735. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2736. * @returns a new unit Vector3
  2737. */
  2738. static One(): Vector3;
  2739. /**
  2740. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2741. * @returns a new up Vector3
  2742. */
  2743. static Up(): Vector3;
  2744. /**
  2745. * Gets a up Vector3 that must not be updated
  2746. */
  2747. static readonly UpReadOnly: DeepImmutable<Vector3>;
  2748. /**
  2749. * Gets a zero Vector3 that must not be updated
  2750. */
  2751. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  2752. /**
  2753. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2754. * @returns a new down Vector3
  2755. */
  2756. static Down(): Vector3;
  2757. /**
  2758. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2759. * @returns a new forward Vector3
  2760. */
  2761. static Forward(): Vector3;
  2762. /**
  2763. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2764. * @returns a new forward Vector3
  2765. */
  2766. static Backward(): Vector3;
  2767. /**
  2768. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2769. * @returns a new right Vector3
  2770. */
  2771. static Right(): Vector3;
  2772. /**
  2773. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2774. * @returns a new left Vector3
  2775. */
  2776. static Left(): Vector3;
  2777. /**
  2778. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2779. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2780. * @param vector defines the Vector3 to transform
  2781. * @param transformation defines the transformation matrix
  2782. * @returns the transformed Vector3
  2783. */
  2784. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2785. /**
  2786. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2787. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2788. * @param vector defines the Vector3 to transform
  2789. * @param transformation defines the transformation matrix
  2790. * @param result defines the Vector3 where to store the result
  2791. */
  2792. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2793. /**
  2794. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  2795. * This method computes tranformed coordinates only, not transformed direction vectors
  2796. * @param x define the x coordinate of the source vector
  2797. * @param y define the y coordinate of the source vector
  2798. * @param z define the z coordinate of the source vector
  2799. * @param transformation defines the transformation matrix
  2800. * @param result defines the Vector3 where to store the result
  2801. */
  2802. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2803. /**
  2804. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  2805. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2806. * @param vector defines the Vector3 to transform
  2807. * @param transformation defines the transformation matrix
  2808. * @returns the new Vector3
  2809. */
  2810. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2811. /**
  2812. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  2813. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2814. * @param vector defines the Vector3 to transform
  2815. * @param transformation defines the transformation matrix
  2816. * @param result defines the Vector3 where to store the result
  2817. */
  2818. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2819. /**
  2820. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  2821. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2822. * @param x define the x coordinate of the source vector
  2823. * @param y define the y coordinate of the source vector
  2824. * @param z define the z coordinate of the source vector
  2825. * @param transformation defines the transformation matrix
  2826. * @param result defines the Vector3 where to store the result
  2827. */
  2828. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2829. /**
  2830. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  2831. * @param value1 defines the first control point
  2832. * @param value2 defines the second control point
  2833. * @param value3 defines the third control point
  2834. * @param value4 defines the fourth control point
  2835. * @param amount defines the amount on the spline to use
  2836. * @returns the new Vector3
  2837. */
  2838. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  2839. /**
  2840. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  2841. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2842. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2843. * @param value defines the current value
  2844. * @param min defines the lower range value
  2845. * @param max defines the upper range value
  2846. * @returns the new Vector3
  2847. */
  2848. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  2849. /**
  2850. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  2851. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2852. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2853. * @param value defines the current value
  2854. * @param min defines the lower range value
  2855. * @param max defines the upper range value
  2856. * @param result defines the Vector3 where to store the result
  2857. */
  2858. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  2859. /**
  2860. * Checks if a given vector is inside a specific range
  2861. * @param v defines the vector to test
  2862. * @param min defines the minimum range
  2863. * @param max defines the maximum range
  2864. */
  2865. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  2866. /**
  2867. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  2868. * @param value1 defines the first control point
  2869. * @param tangent1 defines the first tangent vector
  2870. * @param value2 defines the second control point
  2871. * @param tangent2 defines the second tangent vector
  2872. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  2873. * @returns the new Vector3
  2874. */
  2875. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  2876. /**
  2877. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  2878. * @param start defines the start value
  2879. * @param end defines the end value
  2880. * @param amount max defines amount between both (between 0 and 1)
  2881. * @returns the new Vector3
  2882. */
  2883. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  2884. /**
  2885. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  2886. * @param start defines the start value
  2887. * @param end defines the end value
  2888. * @param amount max defines amount between both (between 0 and 1)
  2889. * @param result defines the Vector3 where to store the result
  2890. */
  2891. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  2892. /**
  2893. * Returns the dot product (float) between the vectors "left" and "right"
  2894. * @param left defines the left operand
  2895. * @param right defines the right operand
  2896. * @returns the dot product
  2897. */
  2898. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  2899. /**
  2900. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  2901. * The cross product is then orthogonal to both "left" and "right"
  2902. * @param left defines the left operand
  2903. * @param right defines the right operand
  2904. * @returns the cross product
  2905. */
  2906. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2907. /**
  2908. * Sets the given vector "result" with the cross product of "left" and "right"
  2909. * The cross product is then orthogonal to both "left" and "right"
  2910. * @param left defines the left operand
  2911. * @param right defines the right operand
  2912. * @param result defines the Vector3 where to store the result
  2913. */
  2914. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  2915. /**
  2916. * Returns a new Vector3 as the normalization of the given vector
  2917. * @param vector defines the Vector3 to normalize
  2918. * @returns the new Vector3
  2919. */
  2920. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  2921. /**
  2922. * Sets the given vector "result" with the normalization of the given first vector
  2923. * @param vector defines the Vector3 to normalize
  2924. * @param result defines the Vector3 where to store the result
  2925. */
  2926. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  2927. /**
  2928. * Project a Vector3 onto screen space
  2929. * @param vector defines the Vector3 to project
  2930. * @param world defines the world matrix to use
  2931. * @param transform defines the transform (view x projection) matrix to use
  2932. * @param viewport defines the screen viewport to use
  2933. * @returns the new Vector3
  2934. */
  2935. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  2936. /** @hidden */
  2937. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  2938. /**
  2939. * Unproject from screen space to object space
  2940. * @param source defines the screen space Vector3 to use
  2941. * @param viewportWidth defines the current width of the viewport
  2942. * @param viewportHeight defines the current height of the viewport
  2943. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2944. * @param transform defines the transform (view x projection) matrix to use
  2945. * @returns the new Vector3
  2946. */
  2947. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  2948. /**
  2949. * Unproject from screen space to object space
  2950. * @param source defines the screen space Vector3 to use
  2951. * @param viewportWidth defines the current width of the viewport
  2952. * @param viewportHeight defines the current height of the viewport
  2953. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2954. * @param view defines the view matrix to use
  2955. * @param projection defines the projection matrix to use
  2956. * @returns the new Vector3
  2957. */
  2958. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  2959. /**
  2960. * Unproject from screen space to object space
  2961. * @param source defines the screen space Vector3 to use
  2962. * @param viewportWidth defines the current width of the viewport
  2963. * @param viewportHeight defines the current height of the viewport
  2964. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2965. * @param view defines the view matrix to use
  2966. * @param projection defines the projection matrix to use
  2967. * @param result defines the Vector3 where to store the result
  2968. */
  2969. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2970. /**
  2971. * Unproject from screen space to object space
  2972. * @param sourceX defines the screen space x coordinate to use
  2973. * @param sourceY defines the screen space y coordinate to use
  2974. * @param sourceZ defines the screen space z coordinate to use
  2975. * @param viewportWidth defines the current width of the viewport
  2976. * @param viewportHeight defines the current height of the viewport
  2977. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2978. * @param view defines the view matrix to use
  2979. * @param projection defines the projection matrix to use
  2980. * @param result defines the Vector3 where to store the result
  2981. */
  2982. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2983. /**
  2984. * Gets the minimal coordinate values between two Vector3
  2985. * @param left defines the first operand
  2986. * @param right defines the second operand
  2987. * @returns the new Vector3
  2988. */
  2989. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2990. /**
  2991. * Gets the maximal coordinate values between two Vector3
  2992. * @param left defines the first operand
  2993. * @param right defines the second operand
  2994. * @returns the new Vector3
  2995. */
  2996. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2997. /**
  2998. * Returns the distance between the vectors "value1" and "value2"
  2999. * @param value1 defines the first operand
  3000. * @param value2 defines the second operand
  3001. * @returns the distance
  3002. */
  3003. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3004. /**
  3005. * Returns the squared distance between the vectors "value1" and "value2"
  3006. * @param value1 defines the first operand
  3007. * @param value2 defines the second operand
  3008. * @returns the squared distance
  3009. */
  3010. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3011. /**
  3012. * Returns a new Vector3 located at the center between "value1" and "value2"
  3013. * @param value1 defines the first operand
  3014. * @param value2 defines the second operand
  3015. * @returns the new Vector3
  3016. */
  3017. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3018. /**
  3019. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3020. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3021. * to something in order to rotate it from its local system to the given target system
  3022. * Note: axis1, axis2 and axis3 are normalized during this operation
  3023. * @param axis1 defines the first axis
  3024. * @param axis2 defines the second axis
  3025. * @param axis3 defines the third axis
  3026. * @returns a new Vector3
  3027. */
  3028. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3029. /**
  3030. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3031. * @param axis1 defines the first axis
  3032. * @param axis2 defines the second axis
  3033. * @param axis3 defines the third axis
  3034. * @param ref defines the Vector3 where to store the result
  3035. */
  3036. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3037. }
  3038. /**
  3039. * Vector4 class created for EulerAngle class conversion to Quaternion
  3040. */
  3041. export class Vector4 {
  3042. /** x value of the vector */
  3043. x: number;
  3044. /** y value of the vector */
  3045. y: number;
  3046. /** z value of the vector */
  3047. z: number;
  3048. /** w value of the vector */
  3049. w: number;
  3050. /**
  3051. * Creates a Vector4 object from the given floats.
  3052. * @param x x value of the vector
  3053. * @param y y value of the vector
  3054. * @param z z value of the vector
  3055. * @param w w value of the vector
  3056. */
  3057. constructor(
  3058. /** x value of the vector */
  3059. x: number,
  3060. /** y value of the vector */
  3061. y: number,
  3062. /** z value of the vector */
  3063. z: number,
  3064. /** w value of the vector */
  3065. w: number);
  3066. /**
  3067. * Returns the string with the Vector4 coordinates.
  3068. * @returns a string containing all the vector values
  3069. */
  3070. toString(): string;
  3071. /**
  3072. * Returns the string "Vector4".
  3073. * @returns "Vector4"
  3074. */
  3075. getClassName(): string;
  3076. /**
  3077. * Returns the Vector4 hash code.
  3078. * @returns a unique hash code
  3079. */
  3080. getHashCode(): number;
  3081. /**
  3082. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3083. * @returns the resulting array
  3084. */
  3085. asArray(): number[];
  3086. /**
  3087. * Populates the given array from the given index with the Vector4 coordinates.
  3088. * @param array array to populate
  3089. * @param index index of the array to start at (default: 0)
  3090. * @returns the Vector4.
  3091. */
  3092. toArray(array: FloatArray, index?: number): Vector4;
  3093. /**
  3094. * Adds the given vector to the current Vector4.
  3095. * @param otherVector the vector to add
  3096. * @returns the updated Vector4.
  3097. */
  3098. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3099. /**
  3100. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3101. * @param otherVector the vector to add
  3102. * @returns the resulting vector
  3103. */
  3104. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3105. /**
  3106. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3107. * @param otherVector the vector to add
  3108. * @param result the vector to store the result
  3109. * @returns the current Vector4.
  3110. */
  3111. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3112. /**
  3113. * Subtract in place the given vector from the current Vector4.
  3114. * @param otherVector the vector to subtract
  3115. * @returns the updated Vector4.
  3116. */
  3117. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3118. /**
  3119. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3120. * @param otherVector the vector to add
  3121. * @returns the new vector with the result
  3122. */
  3123. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3124. /**
  3125. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3126. * @param otherVector the vector to subtract
  3127. * @param result the vector to store the result
  3128. * @returns the current Vector4.
  3129. */
  3130. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3131. /**
  3132. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3133. */
  3134. /**
  3135. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3136. * @param x value to subtract
  3137. * @param y value to subtract
  3138. * @param z value to subtract
  3139. * @param w value to subtract
  3140. * @returns new vector containing the result
  3141. */
  3142. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3143. /**
  3144. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3145. * @param x value to subtract
  3146. * @param y value to subtract
  3147. * @param z value to subtract
  3148. * @param w value to subtract
  3149. * @param result the vector to store the result in
  3150. * @returns the current Vector4.
  3151. */
  3152. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3153. /**
  3154. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3155. * @returns a new vector with the negated values
  3156. */
  3157. negate(): Vector4;
  3158. /**
  3159. * Multiplies the current Vector4 coordinates by scale (float).
  3160. * @param scale the number to scale with
  3161. * @returns the updated Vector4.
  3162. */
  3163. scaleInPlace(scale: number): Vector4;
  3164. /**
  3165. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3166. * @param scale the number to scale with
  3167. * @returns a new vector with the result
  3168. */
  3169. scale(scale: number): Vector4;
  3170. /**
  3171. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3172. * @param scale the number to scale with
  3173. * @param result a vector to store the result in
  3174. * @returns the current Vector4.
  3175. */
  3176. scaleToRef(scale: number, result: Vector4): Vector4;
  3177. /**
  3178. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3179. * @param scale defines the scale factor
  3180. * @param result defines the Vector4 object where to store the result
  3181. * @returns the unmodified current Vector4
  3182. */
  3183. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3184. /**
  3185. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3186. * @param otherVector the vector to compare against
  3187. * @returns true if they are equal
  3188. */
  3189. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3190. /**
  3191. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3192. * @param otherVector vector to compare against
  3193. * @param epsilon (Default: very small number)
  3194. * @returns true if they are equal
  3195. */
  3196. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3197. /**
  3198. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3199. * @param x x value to compare against
  3200. * @param y y value to compare against
  3201. * @param z z value to compare against
  3202. * @param w w value to compare against
  3203. * @returns true if equal
  3204. */
  3205. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3206. /**
  3207. * Multiplies in place the current Vector4 by the given one.
  3208. * @param otherVector vector to multiple with
  3209. * @returns the updated Vector4.
  3210. */
  3211. multiplyInPlace(otherVector: Vector4): Vector4;
  3212. /**
  3213. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3214. * @param otherVector vector to multiple with
  3215. * @returns resulting new vector
  3216. */
  3217. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3218. /**
  3219. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3220. * @param otherVector vector to multiple with
  3221. * @param result vector to store the result
  3222. * @returns the current Vector4.
  3223. */
  3224. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3225. /**
  3226. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3227. * @param x x value multiply with
  3228. * @param y y value multiply with
  3229. * @param z z value multiply with
  3230. * @param w w value multiply with
  3231. * @returns resulting new vector
  3232. */
  3233. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3234. /**
  3235. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3236. * @param otherVector vector to devide with
  3237. * @returns resulting new vector
  3238. */
  3239. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3240. /**
  3241. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3242. * @param otherVector vector to devide with
  3243. * @param result vector to store the result
  3244. * @returns the current Vector4.
  3245. */
  3246. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3247. /**
  3248. * Divides the current Vector3 coordinates by the given ones.
  3249. * @param otherVector vector to devide with
  3250. * @returns the updated Vector3.
  3251. */
  3252. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3253. /**
  3254. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3255. * @param other defines the second operand
  3256. * @returns the current updated Vector4
  3257. */
  3258. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3259. /**
  3260. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3261. * @param other defines the second operand
  3262. * @returns the current updated Vector4
  3263. */
  3264. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3265. /**
  3266. * Gets a new Vector4 from current Vector4 floored values
  3267. * @returns a new Vector4
  3268. */
  3269. floor(): Vector4;
  3270. /**
  3271. * Gets a new Vector4 from current Vector3 floored values
  3272. * @returns a new Vector4
  3273. */
  3274. fract(): Vector4;
  3275. /**
  3276. * Returns the Vector4 length (float).
  3277. * @returns the length
  3278. */
  3279. length(): number;
  3280. /**
  3281. * Returns the Vector4 squared length (float).
  3282. * @returns the length squared
  3283. */
  3284. lengthSquared(): number;
  3285. /**
  3286. * Normalizes in place the Vector4.
  3287. * @returns the updated Vector4.
  3288. */
  3289. normalize(): Vector4;
  3290. /**
  3291. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3292. * @returns this converted to a new vector3
  3293. */
  3294. toVector3(): Vector3;
  3295. /**
  3296. * Returns a new Vector4 copied from the current one.
  3297. * @returns the new cloned vector
  3298. */
  3299. clone(): Vector4;
  3300. /**
  3301. * Updates the current Vector4 with the given one coordinates.
  3302. * @param source the source vector to copy from
  3303. * @returns the updated Vector4.
  3304. */
  3305. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3306. /**
  3307. * Updates the current Vector4 coordinates with the given floats.
  3308. * @param x float to copy from
  3309. * @param y float to copy from
  3310. * @param z float to copy from
  3311. * @param w float to copy from
  3312. * @returns the updated Vector4.
  3313. */
  3314. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3315. /**
  3316. * Updates the current Vector4 coordinates with the given floats.
  3317. * @param x float to set from
  3318. * @param y float to set from
  3319. * @param z float to set from
  3320. * @param w float to set from
  3321. * @returns the updated Vector4.
  3322. */
  3323. set(x: number, y: number, z: number, w: number): Vector4;
  3324. /**
  3325. * Copies the given float to the current Vector3 coordinates
  3326. * @param v defines the x, y, z and w coordinates of the operand
  3327. * @returns the current updated Vector3
  3328. */
  3329. setAll(v: number): Vector4;
  3330. /**
  3331. * Returns a new Vector4 set from the starting index of the given array.
  3332. * @param array the array to pull values from
  3333. * @param offset the offset into the array to start at
  3334. * @returns the new vector
  3335. */
  3336. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3337. /**
  3338. * Updates the given vector "result" from the starting index of the given array.
  3339. * @param array the array to pull values from
  3340. * @param offset the offset into the array to start at
  3341. * @param result the vector to store the result in
  3342. */
  3343. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3344. /**
  3345. * Updates the given vector "result" from the starting index of the given Float32Array.
  3346. * @param array the array to pull values from
  3347. * @param offset the offset into the array to start at
  3348. * @param result the vector to store the result in
  3349. */
  3350. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3351. /**
  3352. * Updates the given vector "result" coordinates from the given floats.
  3353. * @param x float to set from
  3354. * @param y float to set from
  3355. * @param z float to set from
  3356. * @param w float to set from
  3357. * @param result the vector to the floats in
  3358. */
  3359. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3360. /**
  3361. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3362. * @returns the new vector
  3363. */
  3364. static Zero(): Vector4;
  3365. /**
  3366. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3367. * @returns the new vector
  3368. */
  3369. static One(): Vector4;
  3370. /**
  3371. * Returns a new normalized Vector4 from the given one.
  3372. * @param vector the vector to normalize
  3373. * @returns the vector
  3374. */
  3375. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3376. /**
  3377. * Updates the given vector "result" from the normalization of the given one.
  3378. * @param vector the vector to normalize
  3379. * @param result the vector to store the result in
  3380. */
  3381. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3382. /**
  3383. * Returns a vector with the minimum values from the left and right vectors
  3384. * @param left left vector to minimize
  3385. * @param right right vector to minimize
  3386. * @returns a new vector with the minimum of the left and right vector values
  3387. */
  3388. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3389. /**
  3390. * Returns a vector with the maximum values from the left and right vectors
  3391. * @param left left vector to maximize
  3392. * @param right right vector to maximize
  3393. * @returns a new vector with the maximum of the left and right vector values
  3394. */
  3395. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3396. /**
  3397. * Returns the distance (float) between the vectors "value1" and "value2".
  3398. * @param value1 value to calulate the distance between
  3399. * @param value2 value to calulate the distance between
  3400. * @return the distance between the two vectors
  3401. */
  3402. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3403. /**
  3404. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3405. * @param value1 value to calulate the distance between
  3406. * @param value2 value to calulate the distance between
  3407. * @return the distance between the two vectors squared
  3408. */
  3409. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3410. /**
  3411. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3412. * @param value1 value to calulate the center between
  3413. * @param value2 value to calulate the center between
  3414. * @return the center between the two vectors
  3415. */
  3416. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3417. /**
  3418. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3419. * This methods computes transformed normalized direction vectors only.
  3420. * @param vector the vector to transform
  3421. * @param transformation the transformation matrix to apply
  3422. * @returns the new vector
  3423. */
  3424. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3425. /**
  3426. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3427. * This methods computes transformed normalized direction vectors only.
  3428. * @param vector the vector to transform
  3429. * @param transformation the transformation matrix to apply
  3430. * @param result the vector to store the result in
  3431. */
  3432. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3433. /**
  3434. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3435. * This methods computes transformed normalized direction vectors only.
  3436. * @param x value to transform
  3437. * @param y value to transform
  3438. * @param z value to transform
  3439. * @param w value to transform
  3440. * @param transformation the transformation matrix to apply
  3441. * @param result the vector to store the results in
  3442. */
  3443. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3444. /**
  3445. * Creates a new Vector4 from a Vector3
  3446. * @param source defines the source data
  3447. * @param w defines the 4th component (default is 0)
  3448. * @returns a new Vector4
  3449. */
  3450. static FromVector3(source: Vector3, w?: number): Vector4;
  3451. }
  3452. /**
  3453. * Class used to store quaternion data
  3454. * @see https://en.wikipedia.org/wiki/Quaternion
  3455. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  3456. */
  3457. export class Quaternion {
  3458. /** defines the first component (0 by default) */
  3459. x: number;
  3460. /** defines the second component (0 by default) */
  3461. y: number;
  3462. /** defines the third component (0 by default) */
  3463. z: number;
  3464. /** defines the fourth component (1.0 by default) */
  3465. w: number;
  3466. /**
  3467. * Creates a new Quaternion from the given floats
  3468. * @param x defines the first component (0 by default)
  3469. * @param y defines the second component (0 by default)
  3470. * @param z defines the third component (0 by default)
  3471. * @param w defines the fourth component (1.0 by default)
  3472. */
  3473. constructor(
  3474. /** defines the first component (0 by default) */
  3475. x?: number,
  3476. /** defines the second component (0 by default) */
  3477. y?: number,
  3478. /** defines the third component (0 by default) */
  3479. z?: number,
  3480. /** defines the fourth component (1.0 by default) */
  3481. w?: number);
  3482. /**
  3483. * Gets a string representation for the current quaternion
  3484. * @returns a string with the Quaternion coordinates
  3485. */
  3486. toString(): string;
  3487. /**
  3488. * Gets the class name of the quaternion
  3489. * @returns the string "Quaternion"
  3490. */
  3491. getClassName(): string;
  3492. /**
  3493. * Gets a hash code for this quaternion
  3494. * @returns the quaternion hash code
  3495. */
  3496. getHashCode(): number;
  3497. /**
  3498. * Copy the quaternion to an array
  3499. * @returns a new array populated with 4 elements from the quaternion coordinates
  3500. */
  3501. asArray(): number[];
  3502. /**
  3503. * Check if two quaternions are equals
  3504. * @param otherQuaternion defines the second operand
  3505. * @return true if the current quaternion and the given one coordinates are strictly equals
  3506. */
  3507. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3508. /**
  3509. * Clone the current quaternion
  3510. * @returns a new quaternion copied from the current one
  3511. */
  3512. clone(): Quaternion;
  3513. /**
  3514. * Copy a quaternion to the current one
  3515. * @param other defines the other quaternion
  3516. * @returns the updated current quaternion
  3517. */
  3518. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3519. /**
  3520. * Updates the current quaternion with the given float coordinates
  3521. * @param x defines the x coordinate
  3522. * @param y defines the y coordinate
  3523. * @param z defines the z coordinate
  3524. * @param w defines the w coordinate
  3525. * @returns the updated current quaternion
  3526. */
  3527. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3528. /**
  3529. * Updates the current quaternion from the given float coordinates
  3530. * @param x defines the x coordinate
  3531. * @param y defines the y coordinate
  3532. * @param z defines the z coordinate
  3533. * @param w defines the w coordinate
  3534. * @returns the updated current quaternion
  3535. */
  3536. set(x: number, y: number, z: number, w: number): Quaternion;
  3537. /**
  3538. * Adds two quaternions
  3539. * @param other defines the second operand
  3540. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3541. */
  3542. add(other: DeepImmutable<Quaternion>): Quaternion;
  3543. /**
  3544. * Add a quaternion to the current one
  3545. * @param other defines the quaternion to add
  3546. * @returns the current quaternion
  3547. */
  3548. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3549. /**
  3550. * Subtract two quaternions
  3551. * @param other defines the second operand
  3552. * @returns a new quaternion as the subtraction result of the given one from the current one
  3553. */
  3554. subtract(other: Quaternion): Quaternion;
  3555. /**
  3556. * Multiplies the current quaternion by a scale factor
  3557. * @param value defines the scale factor
  3558. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3559. */
  3560. scale(value: number): Quaternion;
  3561. /**
  3562. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3563. * @param scale defines the scale factor
  3564. * @param result defines the Quaternion object where to store the result
  3565. * @returns the unmodified current quaternion
  3566. */
  3567. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3568. /**
  3569. * Multiplies in place the current quaternion by a scale factor
  3570. * @param value defines the scale factor
  3571. * @returns the current modified quaternion
  3572. */
  3573. scaleInPlace(value: number): Quaternion;
  3574. /**
  3575. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3576. * @param scale defines the scale factor
  3577. * @param result defines the Quaternion object where to store the result
  3578. * @returns the unmodified current quaternion
  3579. */
  3580. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3581. /**
  3582. * Multiplies two quaternions
  3583. * @param q1 defines the second operand
  3584. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3585. */
  3586. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3587. /**
  3588. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3589. * @param q1 defines the second operand
  3590. * @param result defines the target quaternion
  3591. * @returns the current quaternion
  3592. */
  3593. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3594. /**
  3595. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3596. * @param q1 defines the second operand
  3597. * @returns the currentupdated quaternion
  3598. */
  3599. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3600. /**
  3601. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3602. * @param ref defines the target quaternion
  3603. * @returns the current quaternion
  3604. */
  3605. conjugateToRef(ref: Quaternion): Quaternion;
  3606. /**
  3607. * Conjugates in place (1-q) the current quaternion
  3608. * @returns the current updated quaternion
  3609. */
  3610. conjugateInPlace(): Quaternion;
  3611. /**
  3612. * Conjugates in place (1-q) the current quaternion
  3613. * @returns a new quaternion
  3614. */
  3615. conjugate(): Quaternion;
  3616. /**
  3617. * Gets length of current quaternion
  3618. * @returns the quaternion length (float)
  3619. */
  3620. length(): number;
  3621. /**
  3622. * Normalize in place the current quaternion
  3623. * @returns the current updated quaternion
  3624. */
  3625. normalize(): Quaternion;
  3626. /**
  3627. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3628. * @param order is a reserved parameter and is ignore for now
  3629. * @returns a new Vector3 containing the Euler angles
  3630. */
  3631. toEulerAngles(order?: string): Vector3;
  3632. /**
  3633. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3634. * @param result defines the vector which will be filled with the Euler angles
  3635. * @param order is a reserved parameter and is ignore for now
  3636. * @returns the current unchanged quaternion
  3637. */
  3638. toEulerAnglesToRef(result: Vector3): Quaternion;
  3639. /**
  3640. * Updates the given rotation matrix with the current quaternion values
  3641. * @param result defines the target matrix
  3642. * @returns the current unchanged quaternion
  3643. */
  3644. toRotationMatrix(result: Matrix): Quaternion;
  3645. /**
  3646. * Updates the current quaternion from the given rotation matrix values
  3647. * @param matrix defines the source matrix
  3648. * @returns the current updated quaternion
  3649. */
  3650. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3651. /**
  3652. * Creates a new quaternion from a rotation matrix
  3653. * @param matrix defines the source matrix
  3654. * @returns a new quaternion created from the given rotation matrix values
  3655. */
  3656. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3657. /**
  3658. * Updates the given quaternion with the given rotation matrix values
  3659. * @param matrix defines the source matrix
  3660. * @param result defines the target quaternion
  3661. */
  3662. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3663. /**
  3664. * Returns the dot product (float) between the quaternions "left" and "right"
  3665. * @param left defines the left operand
  3666. * @param right defines the right operand
  3667. * @returns the dot product
  3668. */
  3669. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3670. /**
  3671. * Checks if the two quaternions are close to each other
  3672. * @param quat0 defines the first quaternion to check
  3673. * @param quat1 defines the second quaternion to check
  3674. * @returns true if the two quaternions are close to each other
  3675. */
  3676. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3677. /**
  3678. * Creates an empty quaternion
  3679. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3680. */
  3681. static Zero(): Quaternion;
  3682. /**
  3683. * Inverse a given quaternion
  3684. * @param q defines the source quaternion
  3685. * @returns a new quaternion as the inverted current quaternion
  3686. */
  3687. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3688. /**
  3689. * Inverse a given quaternion
  3690. * @param q defines the source quaternion
  3691. * @param result the quaternion the result will be stored in
  3692. * @returns the result quaternion
  3693. */
  3694. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3695. /**
  3696. * Creates an identity quaternion
  3697. * @returns the identity quaternion
  3698. */
  3699. static Identity(): Quaternion;
  3700. /**
  3701. * Gets a boolean indicating if the given quaternion is identity
  3702. * @param quaternion defines the quaternion to check
  3703. * @returns true if the quaternion is identity
  3704. */
  3705. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3706. /**
  3707. * Creates a quaternion from a rotation around an axis
  3708. * @param axis defines the axis to use
  3709. * @param angle defines the angle to use
  3710. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3711. */
  3712. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3713. /**
  3714. * Creates a rotation around an axis and stores it into the given quaternion
  3715. * @param axis defines the axis to use
  3716. * @param angle defines the angle to use
  3717. * @param result defines the target quaternion
  3718. * @returns the target quaternion
  3719. */
  3720. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3721. /**
  3722. * Creates a new quaternion from data stored into an array
  3723. * @param array defines the data source
  3724. * @param offset defines the offset in the source array where the data starts
  3725. * @returns a new quaternion
  3726. */
  3727. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3728. /**
  3729. * Create a quaternion from Euler rotation angles
  3730. * @param x Pitch
  3731. * @param y Yaw
  3732. * @param z Roll
  3733. * @returns the new Quaternion
  3734. */
  3735. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3736. /**
  3737. * Updates a quaternion from Euler rotation angles
  3738. * @param x Pitch
  3739. * @param y Yaw
  3740. * @param z Roll
  3741. * @param result the quaternion to store the result
  3742. * @returns the updated quaternion
  3743. */
  3744. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3745. /**
  3746. * Create a quaternion from Euler rotation vector
  3747. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3748. * @returns the new Quaternion
  3749. */
  3750. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3751. /**
  3752. * Updates a quaternion from Euler rotation vector
  3753. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3754. * @param result the quaternion to store the result
  3755. * @returns the updated quaternion
  3756. */
  3757. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  3758. /**
  3759. * Creates a new quaternion from the given Euler float angles (y, x, z)
  3760. * @param yaw defines the rotation around Y axis
  3761. * @param pitch defines the rotation around X axis
  3762. * @param roll defines the rotation around Z axis
  3763. * @returns the new quaternion
  3764. */
  3765. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  3766. /**
  3767. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  3768. * @param yaw defines the rotation around Y axis
  3769. * @param pitch defines the rotation around X axis
  3770. * @param roll defines the rotation around Z axis
  3771. * @param result defines the target quaternion
  3772. */
  3773. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  3774. /**
  3775. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  3776. * @param alpha defines the rotation around first axis
  3777. * @param beta defines the rotation around second axis
  3778. * @param gamma defines the rotation around third axis
  3779. * @returns the new quaternion
  3780. */
  3781. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  3782. /**
  3783. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  3784. * @param alpha defines the rotation around first axis
  3785. * @param beta defines the rotation around second axis
  3786. * @param gamma defines the rotation around third axis
  3787. * @param result defines the target quaternion
  3788. */
  3789. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  3790. /**
  3791. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  3792. * @param axis1 defines the first axis
  3793. * @param axis2 defines the second axis
  3794. * @param axis3 defines the third axis
  3795. * @returns the new quaternion
  3796. */
  3797. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  3798. /**
  3799. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  3800. * @param axis1 defines the first axis
  3801. * @param axis2 defines the second axis
  3802. * @param axis3 defines the third axis
  3803. * @param ref defines the target quaternion
  3804. */
  3805. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  3806. /**
  3807. * Interpolates between two quaternions
  3808. * @param left defines first quaternion
  3809. * @param right defines second quaternion
  3810. * @param amount defines the gradient to use
  3811. * @returns the new interpolated quaternion
  3812. */
  3813. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3814. /**
  3815. * Interpolates between two quaternions and stores it into a target quaternion
  3816. * @param left defines first quaternion
  3817. * @param right defines second quaternion
  3818. * @param amount defines the gradient to use
  3819. * @param result defines the target quaternion
  3820. */
  3821. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  3822. /**
  3823. * Interpolate between two quaternions using Hermite interpolation
  3824. * @param value1 defines first quaternion
  3825. * @param tangent1 defines the incoming tangent
  3826. * @param value2 defines second quaternion
  3827. * @param tangent2 defines the outgoing tangent
  3828. * @param amount defines the target quaternion
  3829. * @returns the new interpolated quaternion
  3830. */
  3831. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3832. }
  3833. /**
  3834. * Class used to store matrix data (4x4)
  3835. */
  3836. export class Matrix {
  3837. private static _updateFlagSeed;
  3838. private static _identityReadOnly;
  3839. private _isIdentity;
  3840. private _isIdentityDirty;
  3841. private _isIdentity3x2;
  3842. private _isIdentity3x2Dirty;
  3843. /**
  3844. * Gets the update flag of the matrix which is an unique number for the matrix.
  3845. * It will be incremented every time the matrix data change.
  3846. * You can use it to speed the comparison between two versions of the same matrix.
  3847. */
  3848. updateFlag: number;
  3849. private readonly _m;
  3850. /**
  3851. * Gets the internal data of the matrix
  3852. */
  3853. readonly m: DeepImmutable<Float32Array>;
  3854. /** @hidden */
  3855. _markAsUpdated(): void;
  3856. /** @hidden */
  3857. private _updateIdentityStatus;
  3858. /**
  3859. * Creates an empty matrix (filled with zeros)
  3860. */
  3861. constructor();
  3862. /**
  3863. * Check if the current matrix is identity
  3864. * @returns true is the matrix is the identity matrix
  3865. */
  3866. isIdentity(): boolean;
  3867. /**
  3868. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  3869. * @returns true is the matrix is the identity matrix
  3870. */
  3871. isIdentityAs3x2(): boolean;
  3872. /**
  3873. * Gets the determinant of the matrix
  3874. * @returns the matrix determinant
  3875. */
  3876. determinant(): number;
  3877. /**
  3878. * Returns the matrix as a Float32Array
  3879. * @returns the matrix underlying array
  3880. */
  3881. toArray(): DeepImmutable<Float32Array>;
  3882. /**
  3883. * Returns the matrix as a Float32Array
  3884. * @returns the matrix underlying array.
  3885. */
  3886. asArray(): DeepImmutable<Float32Array>;
  3887. /**
  3888. * Inverts the current matrix in place
  3889. * @returns the current inverted matrix
  3890. */
  3891. invert(): Matrix;
  3892. /**
  3893. * Sets all the matrix elements to zero
  3894. * @returns the current matrix
  3895. */
  3896. reset(): Matrix;
  3897. /**
  3898. * Adds the current matrix with a second one
  3899. * @param other defines the matrix to add
  3900. * @returns a new matrix as the addition of the current matrix and the given one
  3901. */
  3902. add(other: DeepImmutable<Matrix>): Matrix;
  3903. /**
  3904. * Sets the given matrix "result" to the addition of the current matrix and the given one
  3905. * @param other defines the matrix to add
  3906. * @param result defines the target matrix
  3907. * @returns the current matrix
  3908. */
  3909. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  3910. /**
  3911. * Adds in place the given matrix to the current matrix
  3912. * @param other defines the second operand
  3913. * @returns the current updated matrix
  3914. */
  3915. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  3916. /**
  3917. * Sets the given matrix to the current inverted Matrix
  3918. * @param other defines the target matrix
  3919. * @returns the unmodified current matrix
  3920. */
  3921. invertToRef(other: Matrix): Matrix;
  3922. /**
  3923. * add a value at the specified position in the current Matrix
  3924. * @param index the index of the value within the matrix. between 0 and 15.
  3925. * @param value the value to be added
  3926. * @returns the current updated matrix
  3927. */
  3928. addAtIndex(index: number, value: number): Matrix;
  3929. /**
  3930. * mutiply the specified position in the current Matrix by a value
  3931. * @param index the index of the value within the matrix. between 0 and 15.
  3932. * @param value the value to be added
  3933. * @returns the current updated matrix
  3934. */
  3935. multiplyAtIndex(index: number, value: number): Matrix;
  3936. /**
  3937. * Inserts the translation vector (using 3 floats) in the current matrix
  3938. * @param x defines the 1st component of the translation
  3939. * @param y defines the 2nd component of the translation
  3940. * @param z defines the 3rd component of the translation
  3941. * @returns the current updated matrix
  3942. */
  3943. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3944. /**
  3945. * Adds the translation vector (using 3 floats) in the current matrix
  3946. * @param x defines the 1st component of the translation
  3947. * @param y defines the 2nd component of the translation
  3948. * @param z defines the 3rd component of the translation
  3949. * @returns the current updated matrix
  3950. */
  3951. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3952. /**
  3953. * Inserts the translation vector in the current matrix
  3954. * @param vector3 defines the translation to insert
  3955. * @returns the current updated matrix
  3956. */
  3957. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  3958. /**
  3959. * Gets the translation value of the current matrix
  3960. * @returns a new Vector3 as the extracted translation from the matrix
  3961. */
  3962. getTranslation(): Vector3;
  3963. /**
  3964. * Fill a Vector3 with the extracted translation from the matrix
  3965. * @param result defines the Vector3 where to store the translation
  3966. * @returns the current matrix
  3967. */
  3968. getTranslationToRef(result: Vector3): Matrix;
  3969. /**
  3970. * Remove rotation and scaling part from the matrix
  3971. * @returns the updated matrix
  3972. */
  3973. removeRotationAndScaling(): Matrix;
  3974. /**
  3975. * Multiply two matrices
  3976. * @param other defines the second operand
  3977. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  3978. */
  3979. multiply(other: DeepImmutable<Matrix>): Matrix;
  3980. /**
  3981. * Copy the current matrix from the given one
  3982. * @param other defines the source matrix
  3983. * @returns the current updated matrix
  3984. */
  3985. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  3986. /**
  3987. * Populates the given array from the starting index with the current matrix values
  3988. * @param array defines the target array
  3989. * @param offset defines the offset in the target array where to start storing values
  3990. * @returns the current matrix
  3991. */
  3992. copyToArray(array: Float32Array, offset?: number): Matrix;
  3993. /**
  3994. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  3995. * @param other defines the second operand
  3996. * @param result defines the matrix where to store the multiplication
  3997. * @returns the current matrix
  3998. */
  3999. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4000. /**
  4001. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4002. * @param other defines the second operand
  4003. * @param result defines the array where to store the multiplication
  4004. * @param offset defines the offset in the target array where to start storing values
  4005. * @returns the current matrix
  4006. */
  4007. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  4008. /**
  4009. * Check equality between this matrix and a second one
  4010. * @param value defines the second matrix to compare
  4011. * @returns true is the current matrix and the given one values are strictly equal
  4012. */
  4013. equals(value: DeepImmutable<Matrix>): boolean;
  4014. /**
  4015. * Clone the current matrix
  4016. * @returns a new matrix from the current matrix
  4017. */
  4018. clone(): Matrix;
  4019. /**
  4020. * Returns the name of the current matrix class
  4021. * @returns the string "Matrix"
  4022. */
  4023. getClassName(): string;
  4024. /**
  4025. * Gets the hash code of the current matrix
  4026. * @returns the hash code
  4027. */
  4028. getHashCode(): number;
  4029. /**
  4030. * Decomposes the current Matrix into a translation, rotation and scaling components
  4031. * @param scale defines the scale vector3 given as a reference to update
  4032. * @param rotation defines the rotation quaternion given as a reference to update
  4033. * @param translation defines the translation vector3 given as a reference to update
  4034. * @returns true if operation was successful
  4035. */
  4036. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4037. /**
  4038. * Gets specific row of the matrix
  4039. * @param index defines the number of the row to get
  4040. * @returns the index-th row of the current matrix as a new Vector4
  4041. */
  4042. getRow(index: number): Nullable<Vector4>;
  4043. /**
  4044. * Sets the index-th row of the current matrix to the vector4 values
  4045. * @param index defines the number of the row to set
  4046. * @param row defines the target vector4
  4047. * @returns the updated current matrix
  4048. */
  4049. setRow(index: number, row: Vector4): Matrix;
  4050. /**
  4051. * Compute the transpose of the matrix
  4052. * @returns the new transposed matrix
  4053. */
  4054. transpose(): Matrix;
  4055. /**
  4056. * Compute the transpose of the matrix and store it in a given matrix
  4057. * @param result defines the target matrix
  4058. * @returns the current matrix
  4059. */
  4060. transposeToRef(result: Matrix): Matrix;
  4061. /**
  4062. * Sets the index-th row of the current matrix with the given 4 x float values
  4063. * @param index defines the row index
  4064. * @param x defines the x component to set
  4065. * @param y defines the y component to set
  4066. * @param z defines the z component to set
  4067. * @param w defines the w component to set
  4068. * @returns the updated current matrix
  4069. */
  4070. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4071. /**
  4072. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4073. * @param scale defines the scale factor
  4074. * @returns a new matrix
  4075. */
  4076. scale(scale: number): Matrix;
  4077. /**
  4078. * Scale the current matrix values by a factor to a given result matrix
  4079. * @param scale defines the scale factor
  4080. * @param result defines the matrix to store the result
  4081. * @returns the current matrix
  4082. */
  4083. scaleToRef(scale: number, result: Matrix): Matrix;
  4084. /**
  4085. * Scale the current matrix values by a factor and add the result to a given matrix
  4086. * @param scale defines the scale factor
  4087. * @param result defines the Matrix to store the result
  4088. * @returns the current matrix
  4089. */
  4090. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4091. /**
  4092. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4093. * @param ref matrix to store the result
  4094. */
  4095. toNormalMatrix(ref: Matrix): void;
  4096. /**
  4097. * Gets only rotation part of the current matrix
  4098. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4099. */
  4100. getRotationMatrix(): Matrix;
  4101. /**
  4102. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4103. * @param result defines the target matrix to store data to
  4104. * @returns the current matrix
  4105. */
  4106. getRotationMatrixToRef(result: Matrix): Matrix;
  4107. /**
  4108. * Toggles model matrix from being right handed to left handed in place and vice versa
  4109. */
  4110. toggleModelMatrixHandInPlace(): void;
  4111. /**
  4112. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4113. */
  4114. toggleProjectionMatrixHandInPlace(): void;
  4115. /**
  4116. * Creates a matrix from an array
  4117. * @param array defines the source array
  4118. * @param offset defines an offset in the source array
  4119. * @returns a new Matrix set from the starting index of the given array
  4120. */
  4121. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4122. /**
  4123. * Copy the content of an array into a given matrix
  4124. * @param array defines the source array
  4125. * @param offset defines an offset in the source array
  4126. * @param result defines the target matrix
  4127. */
  4128. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4129. /**
  4130. * Stores an array into a matrix after having multiplied each component by a given factor
  4131. * @param array defines the source array
  4132. * @param offset defines the offset in the source array
  4133. * @param scale defines the scaling factor
  4134. * @param result defines the target matrix
  4135. */
  4136. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  4137. /**
  4138. * Gets an identity matrix that must not be updated
  4139. */
  4140. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  4141. /**
  4142. * Stores a list of values (16) inside a given matrix
  4143. * @param initialM11 defines 1st value of 1st row
  4144. * @param initialM12 defines 2nd value of 1st row
  4145. * @param initialM13 defines 3rd value of 1st row
  4146. * @param initialM14 defines 4th value of 1st row
  4147. * @param initialM21 defines 1st value of 2nd row
  4148. * @param initialM22 defines 2nd value of 2nd row
  4149. * @param initialM23 defines 3rd value of 2nd row
  4150. * @param initialM24 defines 4th value of 2nd row
  4151. * @param initialM31 defines 1st value of 3rd row
  4152. * @param initialM32 defines 2nd value of 3rd row
  4153. * @param initialM33 defines 3rd value of 3rd row
  4154. * @param initialM34 defines 4th value of 3rd row
  4155. * @param initialM41 defines 1st value of 4th row
  4156. * @param initialM42 defines 2nd value of 4th row
  4157. * @param initialM43 defines 3rd value of 4th row
  4158. * @param initialM44 defines 4th value of 4th row
  4159. * @param result defines the target matrix
  4160. */
  4161. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  4162. /**
  4163. * Creates new matrix from a list of values (16)
  4164. * @param initialM11 defines 1st value of 1st row
  4165. * @param initialM12 defines 2nd value of 1st row
  4166. * @param initialM13 defines 3rd value of 1st row
  4167. * @param initialM14 defines 4th value of 1st row
  4168. * @param initialM21 defines 1st value of 2nd row
  4169. * @param initialM22 defines 2nd value of 2nd row
  4170. * @param initialM23 defines 3rd value of 2nd row
  4171. * @param initialM24 defines 4th value of 2nd row
  4172. * @param initialM31 defines 1st value of 3rd row
  4173. * @param initialM32 defines 2nd value of 3rd row
  4174. * @param initialM33 defines 3rd value of 3rd row
  4175. * @param initialM34 defines 4th value of 3rd row
  4176. * @param initialM41 defines 1st value of 4th row
  4177. * @param initialM42 defines 2nd value of 4th row
  4178. * @param initialM43 defines 3rd value of 4th row
  4179. * @param initialM44 defines 4th value of 4th row
  4180. * @returns the new matrix
  4181. */
  4182. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  4183. /**
  4184. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4185. * @param scale defines the scale vector3
  4186. * @param rotation defines the rotation quaternion
  4187. * @param translation defines the translation vector3
  4188. * @returns a new matrix
  4189. */
  4190. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4191. /**
  4192. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4193. * @param scale defines the scale vector3
  4194. * @param rotation defines the rotation quaternion
  4195. * @param translation defines the translation vector3
  4196. * @param result defines the target matrix
  4197. */
  4198. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4199. /**
  4200. * Creates a new identity matrix
  4201. * @returns a new identity matrix
  4202. */
  4203. static Identity(): Matrix;
  4204. /**
  4205. * Creates a new identity matrix and stores the result in a given matrix
  4206. * @param result defines the target matrix
  4207. */
  4208. static IdentityToRef(result: Matrix): void;
  4209. /**
  4210. * Creates a new zero matrix
  4211. * @returns a new zero matrix
  4212. */
  4213. static Zero(): Matrix;
  4214. /**
  4215. * Creates a new rotation matrix for "angle" radians around the X axis
  4216. * @param angle defines the angle (in radians) to use
  4217. * @return the new matrix
  4218. */
  4219. static RotationX(angle: number): Matrix;
  4220. /**
  4221. * Creates a new matrix as the invert of a given matrix
  4222. * @param source defines the source matrix
  4223. * @returns the new matrix
  4224. */
  4225. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4226. /**
  4227. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4228. * @param angle defines the angle (in radians) to use
  4229. * @param result defines the target matrix
  4230. */
  4231. static RotationXToRef(angle: number, result: Matrix): void;
  4232. /**
  4233. * Creates a new rotation matrix for "angle" radians around the Y axis
  4234. * @param angle defines the angle (in radians) to use
  4235. * @return the new matrix
  4236. */
  4237. static RotationY(angle: number): Matrix;
  4238. /**
  4239. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4240. * @param angle defines the angle (in radians) to use
  4241. * @param result defines the target matrix
  4242. */
  4243. static RotationYToRef(angle: number, result: Matrix): void;
  4244. /**
  4245. * Creates a new rotation matrix for "angle" radians around the Z axis
  4246. * @param angle defines the angle (in radians) to use
  4247. * @return the new matrix
  4248. */
  4249. static RotationZ(angle: number): Matrix;
  4250. /**
  4251. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4252. * @param angle defines the angle (in radians) to use
  4253. * @param result defines the target matrix
  4254. */
  4255. static RotationZToRef(angle: number, result: Matrix): void;
  4256. /**
  4257. * Creates a new rotation matrix for "angle" radians around the given axis
  4258. * @param axis defines the axis to use
  4259. * @param angle defines the angle (in radians) to use
  4260. * @return the new matrix
  4261. */
  4262. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4263. /**
  4264. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4265. * @param axis defines the axis to use
  4266. * @param angle defines the angle (in radians) to use
  4267. * @param result defines the target matrix
  4268. */
  4269. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4270. /**
  4271. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4272. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4273. * @param from defines the vector to align
  4274. * @param to defines the vector to align to
  4275. * @param result defines the target matrix
  4276. */
  4277. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4278. /**
  4279. * Creates a rotation matrix
  4280. * @param yaw defines the yaw angle in radians (Y axis)
  4281. * @param pitch defines the pitch angle in radians (X axis)
  4282. * @param roll defines the roll angle in radians (X axis)
  4283. * @returns the new rotation matrix
  4284. */
  4285. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4286. /**
  4287. * Creates a rotation matrix and stores it in a given matrix
  4288. * @param yaw defines the yaw angle in radians (Y axis)
  4289. * @param pitch defines the pitch angle in radians (X axis)
  4290. * @param roll defines the roll angle in radians (X axis)
  4291. * @param result defines the target matrix
  4292. */
  4293. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4294. /**
  4295. * Creates a scaling matrix
  4296. * @param x defines the scale factor on X axis
  4297. * @param y defines the scale factor on Y axis
  4298. * @param z defines the scale factor on Z axis
  4299. * @returns the new matrix
  4300. */
  4301. static Scaling(x: number, y: number, z: number): Matrix;
  4302. /**
  4303. * Creates a scaling matrix and stores it in a given matrix
  4304. * @param x defines the scale factor on X axis
  4305. * @param y defines the scale factor on Y axis
  4306. * @param z defines the scale factor on Z axis
  4307. * @param result defines the target matrix
  4308. */
  4309. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4310. /**
  4311. * Creates a translation matrix
  4312. * @param x defines the translation on X axis
  4313. * @param y defines the translation on Y axis
  4314. * @param z defines the translationon Z axis
  4315. * @returns the new matrix
  4316. */
  4317. static Translation(x: number, y: number, z: number): Matrix;
  4318. /**
  4319. * Creates a translation matrix and stores it in a given matrix
  4320. * @param x defines the translation on X axis
  4321. * @param y defines the translation on Y axis
  4322. * @param z defines the translationon Z axis
  4323. * @param result defines the target matrix
  4324. */
  4325. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4326. /**
  4327. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4328. * @param startValue defines the start value
  4329. * @param endValue defines the end value
  4330. * @param gradient defines the gradient factor
  4331. * @returns the new matrix
  4332. */
  4333. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4334. /**
  4335. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4336. * @param startValue defines the start value
  4337. * @param endValue defines the end value
  4338. * @param gradient defines the gradient factor
  4339. * @param result defines the Matrix object where to store data
  4340. */
  4341. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4342. /**
  4343. * Builds a new matrix whose values are computed by:
  4344. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4345. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4346. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4347. * @param startValue defines the first matrix
  4348. * @param endValue defines the second matrix
  4349. * @param gradient defines the gradient between the two matrices
  4350. * @returns the new matrix
  4351. */
  4352. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4353. /**
  4354. * Update a matrix to values which are computed by:
  4355. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4356. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4357. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4358. * @param startValue defines the first matrix
  4359. * @param endValue defines the second matrix
  4360. * @param gradient defines the gradient between the two matrices
  4361. * @param result defines the target matrix
  4362. */
  4363. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4364. /**
  4365. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4366. * This function works in left handed mode
  4367. * @param eye defines the final position of the entity
  4368. * @param target defines where the entity should look at
  4369. * @param up defines the up vector for the entity
  4370. * @returns the new matrix
  4371. */
  4372. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4373. /**
  4374. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4375. * This function works in left handed mode
  4376. * @param eye defines the final position of the entity
  4377. * @param target defines where the entity should look at
  4378. * @param up defines the up vector for the entity
  4379. * @param result defines the target matrix
  4380. */
  4381. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4382. /**
  4383. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4384. * This function works in right handed mode
  4385. * @param eye defines the final position of the entity
  4386. * @param target defines where the entity should look at
  4387. * @param up defines the up vector for the entity
  4388. * @returns the new matrix
  4389. */
  4390. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4391. /**
  4392. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4393. * This function works in right handed mode
  4394. * @param eye defines the final position of the entity
  4395. * @param target defines where the entity should look at
  4396. * @param up defines the up vector for the entity
  4397. * @param result defines the target matrix
  4398. */
  4399. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4400. /**
  4401. * Create a left-handed orthographic projection matrix
  4402. * @param width defines the viewport width
  4403. * @param height defines the viewport height
  4404. * @param znear defines the near clip plane
  4405. * @param zfar defines the far clip plane
  4406. * @returns a new matrix as a left-handed orthographic projection matrix
  4407. */
  4408. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4409. /**
  4410. * Store a left-handed orthographic projection to a given matrix
  4411. * @param width defines the viewport width
  4412. * @param height defines the viewport height
  4413. * @param znear defines the near clip plane
  4414. * @param zfar defines the far clip plane
  4415. * @param result defines the target matrix
  4416. */
  4417. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4418. /**
  4419. * Create a left-handed orthographic projection matrix
  4420. * @param left defines the viewport left coordinate
  4421. * @param right defines the viewport right coordinate
  4422. * @param bottom defines the viewport bottom coordinate
  4423. * @param top defines the viewport top coordinate
  4424. * @param znear defines the near clip plane
  4425. * @param zfar defines the far clip plane
  4426. * @returns a new matrix as a left-handed orthographic projection matrix
  4427. */
  4428. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4429. /**
  4430. * Stores a left-handed orthographic projection into a given matrix
  4431. * @param left defines the viewport left coordinate
  4432. * @param right defines the viewport right coordinate
  4433. * @param bottom defines the viewport bottom coordinate
  4434. * @param top defines the viewport top coordinate
  4435. * @param znear defines the near clip plane
  4436. * @param zfar defines the far clip plane
  4437. * @param result defines the target matrix
  4438. */
  4439. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4440. /**
  4441. * Creates a right-handed orthographic projection matrix
  4442. * @param left defines the viewport left coordinate
  4443. * @param right defines the viewport right coordinate
  4444. * @param bottom defines the viewport bottom coordinate
  4445. * @param top defines the viewport top coordinate
  4446. * @param znear defines the near clip plane
  4447. * @param zfar defines the far clip plane
  4448. * @returns a new matrix as a right-handed orthographic projection matrix
  4449. */
  4450. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4451. /**
  4452. * Stores a right-handed orthographic projection into a given matrix
  4453. * @param left defines the viewport left coordinate
  4454. * @param right defines the viewport right coordinate
  4455. * @param bottom defines the viewport bottom coordinate
  4456. * @param top defines the viewport top coordinate
  4457. * @param znear defines the near clip plane
  4458. * @param zfar defines the far clip plane
  4459. * @param result defines the target matrix
  4460. */
  4461. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4462. /**
  4463. * Creates a left-handed perspective projection matrix
  4464. * @param width defines the viewport width
  4465. * @param height defines the viewport height
  4466. * @param znear defines the near clip plane
  4467. * @param zfar defines the far clip plane
  4468. * @returns a new matrix as a left-handed perspective projection matrix
  4469. */
  4470. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4471. /**
  4472. * Creates a left-handed perspective projection matrix
  4473. * @param fov defines the horizontal field of view
  4474. * @param aspect defines the aspect ratio
  4475. * @param znear defines the near clip plane
  4476. * @param zfar defines the far clip plane
  4477. * @returns a new matrix as a left-handed perspective projection matrix
  4478. */
  4479. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4480. /**
  4481. * Stores a left-handed perspective projection into a given matrix
  4482. * @param fov defines the horizontal field of view
  4483. * @param aspect defines the aspect ratio
  4484. * @param znear defines the near clip plane
  4485. * @param zfar defines the far clip plane
  4486. * @param result defines the target matrix
  4487. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4488. */
  4489. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4490. /**
  4491. * Creates a right-handed perspective projection matrix
  4492. * @param fov defines the horizontal field of view
  4493. * @param aspect defines the aspect ratio
  4494. * @param znear defines the near clip plane
  4495. * @param zfar defines the far clip plane
  4496. * @returns a new matrix as a right-handed perspective projection matrix
  4497. */
  4498. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4499. /**
  4500. * Stores a right-handed perspective projection into a given matrix
  4501. * @param fov defines the horizontal field of view
  4502. * @param aspect defines the aspect ratio
  4503. * @param znear defines the near clip plane
  4504. * @param zfar defines the far clip plane
  4505. * @param result defines the target matrix
  4506. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4507. */
  4508. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4509. /**
  4510. * Stores a perspective projection for WebVR info a given matrix
  4511. * @param fov defines the field of view
  4512. * @param znear defines the near clip plane
  4513. * @param zfar defines the far clip plane
  4514. * @param result defines the target matrix
  4515. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4516. */
  4517. static PerspectiveFovWebVRToRef(fov: {
  4518. upDegrees: number;
  4519. downDegrees: number;
  4520. leftDegrees: number;
  4521. rightDegrees: number;
  4522. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4523. /**
  4524. * Computes a complete transformation matrix
  4525. * @param viewport defines the viewport to use
  4526. * @param world defines the world matrix
  4527. * @param view defines the view matrix
  4528. * @param projection defines the projection matrix
  4529. * @param zmin defines the near clip plane
  4530. * @param zmax defines the far clip plane
  4531. * @returns the transformation matrix
  4532. */
  4533. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4534. /**
  4535. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4536. * @param matrix defines the matrix to use
  4537. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4538. */
  4539. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  4540. /**
  4541. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4542. * @param matrix defines the matrix to use
  4543. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4544. */
  4545. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  4546. /**
  4547. * Compute the transpose of a given matrix
  4548. * @param matrix defines the matrix to transpose
  4549. * @returns the new matrix
  4550. */
  4551. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4552. /**
  4553. * Compute the transpose of a matrix and store it in a target matrix
  4554. * @param matrix defines the matrix to transpose
  4555. * @param result defines the target matrix
  4556. */
  4557. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4558. /**
  4559. * Computes a reflection matrix from a plane
  4560. * @param plane defines the reflection plane
  4561. * @returns a new matrix
  4562. */
  4563. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4564. /**
  4565. * Computes a reflection matrix from a plane
  4566. * @param plane defines the reflection plane
  4567. * @param result defines the target matrix
  4568. */
  4569. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4570. /**
  4571. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4572. * @param xaxis defines the value of the 1st axis
  4573. * @param yaxis defines the value of the 2nd axis
  4574. * @param zaxis defines the value of the 3rd axis
  4575. * @param result defines the target matrix
  4576. */
  4577. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4578. /**
  4579. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4580. * @param quat defines the quaternion to use
  4581. * @param result defines the target matrix
  4582. */
  4583. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4584. }
  4585. /**
  4586. * @hidden
  4587. */
  4588. export class TmpVectors {
  4589. static Vector2: Vector2[];
  4590. static Vector3: Vector3[];
  4591. static Vector4: Vector4[];
  4592. static Quaternion: Quaternion[];
  4593. static Matrix: Matrix[];
  4594. }
  4595. }
  4596. declare module "babylonjs/Maths/math.path" {
  4597. import { DeepImmutable, Nullable } from "babylonjs/types";
  4598. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4599. /**
  4600. * Defines potential orientation for back face culling
  4601. */
  4602. export enum Orientation {
  4603. /**
  4604. * Clockwise
  4605. */
  4606. CW = 0,
  4607. /** Counter clockwise */
  4608. CCW = 1
  4609. }
  4610. /** Class used to represent a Bezier curve */
  4611. export class BezierCurve {
  4612. /**
  4613. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4614. * @param t defines the time
  4615. * @param x1 defines the left coordinate on X axis
  4616. * @param y1 defines the left coordinate on Y axis
  4617. * @param x2 defines the right coordinate on X axis
  4618. * @param y2 defines the right coordinate on Y axis
  4619. * @returns the interpolated value
  4620. */
  4621. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4622. }
  4623. /**
  4624. * Defines angle representation
  4625. */
  4626. export class Angle {
  4627. private _radians;
  4628. /**
  4629. * Creates an Angle object of "radians" radians (float).
  4630. * @param radians the angle in radians
  4631. */
  4632. constructor(radians: number);
  4633. /**
  4634. * Get value in degrees
  4635. * @returns the Angle value in degrees (float)
  4636. */
  4637. degrees(): number;
  4638. /**
  4639. * Get value in radians
  4640. * @returns the Angle value in radians (float)
  4641. */
  4642. radians(): number;
  4643. /**
  4644. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  4645. * @param a defines first vector
  4646. * @param b defines second vector
  4647. * @returns a new Angle
  4648. */
  4649. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4650. /**
  4651. * Gets a new Angle object from the given float in radians
  4652. * @param radians defines the angle value in radians
  4653. * @returns a new Angle
  4654. */
  4655. static FromRadians(radians: number): Angle;
  4656. /**
  4657. * Gets a new Angle object from the given float in degrees
  4658. * @param degrees defines the angle value in degrees
  4659. * @returns a new Angle
  4660. */
  4661. static FromDegrees(degrees: number): Angle;
  4662. }
  4663. /**
  4664. * This represents an arc in a 2d space.
  4665. */
  4666. export class Arc2 {
  4667. /** Defines the start point of the arc */
  4668. startPoint: Vector2;
  4669. /** Defines the mid point of the arc */
  4670. midPoint: Vector2;
  4671. /** Defines the end point of the arc */
  4672. endPoint: Vector2;
  4673. /**
  4674. * Defines the center point of the arc.
  4675. */
  4676. centerPoint: Vector2;
  4677. /**
  4678. * Defines the radius of the arc.
  4679. */
  4680. radius: number;
  4681. /**
  4682. * Defines the angle of the arc (from mid point to end point).
  4683. */
  4684. angle: Angle;
  4685. /**
  4686. * Defines the start angle of the arc (from start point to middle point).
  4687. */
  4688. startAngle: Angle;
  4689. /**
  4690. * Defines the orientation of the arc (clock wise/counter clock wise).
  4691. */
  4692. orientation: Orientation;
  4693. /**
  4694. * Creates an Arc object from the three given points : start, middle and end.
  4695. * @param startPoint Defines the start point of the arc
  4696. * @param midPoint Defines the midlle point of the arc
  4697. * @param endPoint Defines the end point of the arc
  4698. */
  4699. constructor(
  4700. /** Defines the start point of the arc */
  4701. startPoint: Vector2,
  4702. /** Defines the mid point of the arc */
  4703. midPoint: Vector2,
  4704. /** Defines the end point of the arc */
  4705. endPoint: Vector2);
  4706. }
  4707. /**
  4708. * Represents a 2D path made up of multiple 2D points
  4709. */
  4710. export class Path2 {
  4711. private _points;
  4712. private _length;
  4713. /**
  4714. * If the path start and end point are the same
  4715. */
  4716. closed: boolean;
  4717. /**
  4718. * Creates a Path2 object from the starting 2D coordinates x and y.
  4719. * @param x the starting points x value
  4720. * @param y the starting points y value
  4721. */
  4722. constructor(x: number, y: number);
  4723. /**
  4724. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4725. * @param x the added points x value
  4726. * @param y the added points y value
  4727. * @returns the updated Path2.
  4728. */
  4729. addLineTo(x: number, y: number): Path2;
  4730. /**
  4731. * Adds _numberOfSegments_ segments according to the arc definition (middle point coordinates, end point coordinates, the arc start point being the current Path2 last point) to the current Path2.
  4732. * @param midX middle point x value
  4733. * @param midY middle point y value
  4734. * @param endX end point x value
  4735. * @param endY end point y value
  4736. * @param numberOfSegments (default: 36)
  4737. * @returns the updated Path2.
  4738. */
  4739. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  4740. /**
  4741. * Closes the Path2.
  4742. * @returns the Path2.
  4743. */
  4744. close(): Path2;
  4745. /**
  4746. * Gets the sum of the distance between each sequential point in the path
  4747. * @returns the Path2 total length (float).
  4748. */
  4749. length(): number;
  4750. /**
  4751. * Gets the points which construct the path
  4752. * @returns the Path2 internal array of points.
  4753. */
  4754. getPoints(): Vector2[];
  4755. /**
  4756. * Retreives the point at the distance aways from the starting point
  4757. * @param normalizedLengthPosition the length along the path to retreive the point from
  4758. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  4759. */
  4760. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  4761. /**
  4762. * Creates a new path starting from an x and y position
  4763. * @param x starting x value
  4764. * @param y starting y value
  4765. * @returns a new Path2 starting at the coordinates (x, y).
  4766. */
  4767. static StartingAt(x: number, y: number): Path2;
  4768. }
  4769. /**
  4770. * Represents a 3D path made up of multiple 3D points
  4771. */
  4772. export class Path3D {
  4773. /**
  4774. * an array of Vector3, the curve axis of the Path3D
  4775. */
  4776. path: Vector3[];
  4777. private _curve;
  4778. private _distances;
  4779. private _tangents;
  4780. private _normals;
  4781. private _binormals;
  4782. private _raw;
  4783. /**
  4784. * new Path3D(path, normal, raw)
  4785. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  4786. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  4787. * @param path an array of Vector3, the curve axis of the Path3D
  4788. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  4789. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  4790. */
  4791. constructor(
  4792. /**
  4793. * an array of Vector3, the curve axis of the Path3D
  4794. */
  4795. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean);
  4796. /**
  4797. * Returns the Path3D array of successive Vector3 designing its curve.
  4798. * @returns the Path3D array of successive Vector3 designing its curve.
  4799. */
  4800. getCurve(): Vector3[];
  4801. /**
  4802. * Returns an array populated with tangent vectors on each Path3D curve point.
  4803. * @returns an array populated with tangent vectors on each Path3D curve point.
  4804. */
  4805. getTangents(): Vector3[];
  4806. /**
  4807. * Returns an array populated with normal vectors on each Path3D curve point.
  4808. * @returns an array populated with normal vectors on each Path3D curve point.
  4809. */
  4810. getNormals(): Vector3[];
  4811. /**
  4812. * Returns an array populated with binormal vectors on each Path3D curve point.
  4813. * @returns an array populated with binormal vectors on each Path3D curve point.
  4814. */
  4815. getBinormals(): Vector3[];
  4816. /**
  4817. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  4818. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  4819. */
  4820. getDistances(): number[];
  4821. /**
  4822. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  4823. * @param path path which all values are copied into the curves points
  4824. * @param firstNormal which should be projected onto the curve
  4825. * @returns the same object updated.
  4826. */
  4827. update(path: Vector3[], firstNormal?: Nullable<Vector3>): Path3D;
  4828. private _compute;
  4829. private _getFirstNonNullVector;
  4830. private _getLastNonNullVector;
  4831. private _normalVector;
  4832. }
  4833. /**
  4834. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  4835. * A Curve3 is designed from a series of successive Vector3.
  4836. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  4837. */
  4838. export class Curve3 {
  4839. private _points;
  4840. private _length;
  4841. /**
  4842. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  4843. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  4844. * @param v1 (Vector3) the control point
  4845. * @param v2 (Vector3) the end point of the Quadratic Bezier
  4846. * @param nbPoints (integer) the wanted number of points in the curve
  4847. * @returns the created Curve3
  4848. */
  4849. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4850. /**
  4851. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  4852. * @param v0 (Vector3) the origin point of the Cubic Bezier
  4853. * @param v1 (Vector3) the first control point
  4854. * @param v2 (Vector3) the second control point
  4855. * @param v3 (Vector3) the end point of the Cubic Bezier
  4856. * @param nbPoints (integer) the wanted number of points in the curve
  4857. * @returns the created Curve3
  4858. */
  4859. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4860. /**
  4861. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  4862. * @param p1 (Vector3) the origin point of the Hermite Spline
  4863. * @param t1 (Vector3) the tangent vector at the origin point
  4864. * @param p2 (Vector3) the end point of the Hermite Spline
  4865. * @param t2 (Vector3) the tangent vector at the end point
  4866. * @param nbPoints (integer) the wanted number of points in the curve
  4867. * @returns the created Curve3
  4868. */
  4869. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4870. /**
  4871. * Returns a Curve3 object along a CatmullRom Spline curve :
  4872. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  4873. * @param nbPoints (integer) the wanted number of points between each curve control points
  4874. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  4875. * @returns the created Curve3
  4876. */
  4877. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  4878. /**
  4879. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  4880. * A Curve3 is designed from a series of successive Vector3.
  4881. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  4882. * @param points points which make up the curve
  4883. */
  4884. constructor(points: Vector3[]);
  4885. /**
  4886. * @returns the Curve3 stored array of successive Vector3
  4887. */
  4888. getPoints(): Vector3[];
  4889. /**
  4890. * @returns the computed length (float) of the curve.
  4891. */
  4892. length(): number;
  4893. /**
  4894. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  4895. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  4896. * curveA and curveB keep unchanged.
  4897. * @param curve the curve to continue from this curve
  4898. * @returns the newly constructed curve
  4899. */
  4900. continue(curve: DeepImmutable<Curve3>): Curve3;
  4901. private _computeLength;
  4902. }
  4903. }
  4904. declare module "babylonjs/Animations/easing" {
  4905. /**
  4906. * This represents the main contract an easing function should follow.
  4907. * Easing functions are used throughout the animation system.
  4908. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4909. */
  4910. export interface IEasingFunction {
  4911. /**
  4912. * Given an input gradient between 0 and 1, this returns the corrseponding value
  4913. * of the easing function.
  4914. * The link below provides some of the most common examples of easing functions.
  4915. * @see https://easings.net/
  4916. * @param gradient Defines the value between 0 and 1 we want the easing value for
  4917. * @returns the corresponding value on the curve defined by the easing function
  4918. */
  4919. ease(gradient: number): number;
  4920. }
  4921. /**
  4922. * Base class used for every default easing function.
  4923. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4924. */
  4925. export class EasingFunction implements IEasingFunction {
  4926. /**
  4927. * Interpolation follows the mathematical formula associated with the easing function.
  4928. */
  4929. static readonly EASINGMODE_EASEIN: number;
  4930. /**
  4931. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  4932. */
  4933. static readonly EASINGMODE_EASEOUT: number;
  4934. /**
  4935. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  4936. */
  4937. static readonly EASINGMODE_EASEINOUT: number;
  4938. private _easingMode;
  4939. /**
  4940. * Sets the easing mode of the current function.
  4941. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  4942. */
  4943. setEasingMode(easingMode: number): void;
  4944. /**
  4945. * Gets the current easing mode.
  4946. * @returns the easing mode
  4947. */
  4948. getEasingMode(): number;
  4949. /**
  4950. * @hidden
  4951. */
  4952. easeInCore(gradient: number): number;
  4953. /**
  4954. * Given an input gradient between 0 and 1, this returns the corresponding value
  4955. * of the easing function.
  4956. * @param gradient Defines the value between 0 and 1 we want the easing value for
  4957. * @returns the corresponding value on the curve defined by the easing function
  4958. */
  4959. ease(gradient: number): number;
  4960. }
  4961. /**
  4962. * Easing function with a circle shape (see link below).
  4963. * @see https://easings.net/#easeInCirc
  4964. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4965. */
  4966. export class CircleEase extends EasingFunction implements IEasingFunction {
  4967. /** @hidden */
  4968. easeInCore(gradient: number): number;
  4969. }
  4970. /**
  4971. * Easing function with a ease back shape (see link below).
  4972. * @see https://easings.net/#easeInBack
  4973. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4974. */
  4975. export class BackEase extends EasingFunction implements IEasingFunction {
  4976. /** Defines the amplitude of the function */
  4977. amplitude: number;
  4978. /**
  4979. * Instantiates a back ease easing
  4980. * @see https://easings.net/#easeInBack
  4981. * @param amplitude Defines the amplitude of the function
  4982. */
  4983. constructor(
  4984. /** Defines the amplitude of the function */
  4985. amplitude?: number);
  4986. /** @hidden */
  4987. easeInCore(gradient: number): number;
  4988. }
  4989. /**
  4990. * Easing function with a bouncing shape (see link below).
  4991. * @see https://easings.net/#easeInBounce
  4992. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4993. */
  4994. export class BounceEase extends EasingFunction implements IEasingFunction {
  4995. /** Defines the number of bounces */
  4996. bounces: number;
  4997. /** Defines the amplitude of the bounce */
  4998. bounciness: number;
  4999. /**
  5000. * Instantiates a bounce easing
  5001. * @see https://easings.net/#easeInBounce
  5002. * @param bounces Defines the number of bounces
  5003. * @param bounciness Defines the amplitude of the bounce
  5004. */
  5005. constructor(
  5006. /** Defines the number of bounces */
  5007. bounces?: number,
  5008. /** Defines the amplitude of the bounce */
  5009. bounciness?: number);
  5010. /** @hidden */
  5011. easeInCore(gradient: number): number;
  5012. }
  5013. /**
  5014. * Easing function with a power of 3 shape (see link below).
  5015. * @see https://easings.net/#easeInCubic
  5016. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5017. */
  5018. export class CubicEase extends EasingFunction implements IEasingFunction {
  5019. /** @hidden */
  5020. easeInCore(gradient: number): number;
  5021. }
  5022. /**
  5023. * Easing function with an elastic shape (see link below).
  5024. * @see https://easings.net/#easeInElastic
  5025. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5026. */
  5027. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5028. /** Defines the number of oscillations*/
  5029. oscillations: number;
  5030. /** Defines the amplitude of the oscillations*/
  5031. springiness: number;
  5032. /**
  5033. * Instantiates an elastic easing function
  5034. * @see https://easings.net/#easeInElastic
  5035. * @param oscillations Defines the number of oscillations
  5036. * @param springiness Defines the amplitude of the oscillations
  5037. */
  5038. constructor(
  5039. /** Defines the number of oscillations*/
  5040. oscillations?: number,
  5041. /** Defines the amplitude of the oscillations*/
  5042. springiness?: number);
  5043. /** @hidden */
  5044. easeInCore(gradient: number): number;
  5045. }
  5046. /**
  5047. * Easing function with an exponential shape (see link below).
  5048. * @see https://easings.net/#easeInExpo
  5049. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5050. */
  5051. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5052. /** Defines the exponent of the function */
  5053. exponent: number;
  5054. /**
  5055. * Instantiates an exponential easing function
  5056. * @see https://easings.net/#easeInExpo
  5057. * @param exponent Defines the exponent of the function
  5058. */
  5059. constructor(
  5060. /** Defines the exponent of the function */
  5061. exponent?: number);
  5062. /** @hidden */
  5063. easeInCore(gradient: number): number;
  5064. }
  5065. /**
  5066. * Easing function with a power shape (see link below).
  5067. * @see https://easings.net/#easeInQuad
  5068. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5069. */
  5070. export class PowerEase extends EasingFunction implements IEasingFunction {
  5071. /** Defines the power of the function */
  5072. power: number;
  5073. /**
  5074. * Instantiates an power base easing function
  5075. * @see https://easings.net/#easeInQuad
  5076. * @param power Defines the power of the function
  5077. */
  5078. constructor(
  5079. /** Defines the power of the function */
  5080. power?: number);
  5081. /** @hidden */
  5082. easeInCore(gradient: number): number;
  5083. }
  5084. /**
  5085. * Easing function with a power of 2 shape (see link below).
  5086. * @see https://easings.net/#easeInQuad
  5087. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5088. */
  5089. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5090. /** @hidden */
  5091. easeInCore(gradient: number): number;
  5092. }
  5093. /**
  5094. * Easing function with a power of 4 shape (see link below).
  5095. * @see https://easings.net/#easeInQuart
  5096. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5097. */
  5098. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5099. /** @hidden */
  5100. easeInCore(gradient: number): number;
  5101. }
  5102. /**
  5103. * Easing function with a power of 5 shape (see link below).
  5104. * @see https://easings.net/#easeInQuint
  5105. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5106. */
  5107. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5108. /** @hidden */
  5109. easeInCore(gradient: number): number;
  5110. }
  5111. /**
  5112. * Easing function with a sin shape (see link below).
  5113. * @see https://easings.net/#easeInSine
  5114. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5115. */
  5116. export class SineEase extends EasingFunction implements IEasingFunction {
  5117. /** @hidden */
  5118. easeInCore(gradient: number): number;
  5119. }
  5120. /**
  5121. * Easing function with a bezier shape (see link below).
  5122. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5123. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5124. */
  5125. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5126. /** Defines the x component of the start tangent in the bezier curve */
  5127. x1: number;
  5128. /** Defines the y component of the start tangent in the bezier curve */
  5129. y1: number;
  5130. /** Defines the x component of the end tangent in the bezier curve */
  5131. x2: number;
  5132. /** Defines the y component of the end tangent in the bezier curve */
  5133. y2: number;
  5134. /**
  5135. * Instantiates a bezier function
  5136. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5137. * @param x1 Defines the x component of the start tangent in the bezier curve
  5138. * @param y1 Defines the y component of the start tangent in the bezier curve
  5139. * @param x2 Defines the x component of the end tangent in the bezier curve
  5140. * @param y2 Defines the y component of the end tangent in the bezier curve
  5141. */
  5142. constructor(
  5143. /** Defines the x component of the start tangent in the bezier curve */
  5144. x1?: number,
  5145. /** Defines the y component of the start tangent in the bezier curve */
  5146. y1?: number,
  5147. /** Defines the x component of the end tangent in the bezier curve */
  5148. x2?: number,
  5149. /** Defines the y component of the end tangent in the bezier curve */
  5150. y2?: number);
  5151. /** @hidden */
  5152. easeInCore(gradient: number): number;
  5153. }
  5154. }
  5155. declare module "babylonjs/Maths/math.color" {
  5156. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5157. /**
  5158. * Class used to hold a RBG color
  5159. */
  5160. export class Color3 {
  5161. /**
  5162. * Defines the red component (between 0 and 1, default is 0)
  5163. */
  5164. r: number;
  5165. /**
  5166. * Defines the green component (between 0 and 1, default is 0)
  5167. */
  5168. g: number;
  5169. /**
  5170. * Defines the blue component (between 0 and 1, default is 0)
  5171. */
  5172. b: number;
  5173. /**
  5174. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5175. * @param r defines the red component (between 0 and 1, default is 0)
  5176. * @param g defines the green component (between 0 and 1, default is 0)
  5177. * @param b defines the blue component (between 0 and 1, default is 0)
  5178. */
  5179. constructor(
  5180. /**
  5181. * Defines the red component (between 0 and 1, default is 0)
  5182. */
  5183. r?: number,
  5184. /**
  5185. * Defines the green component (between 0 and 1, default is 0)
  5186. */
  5187. g?: number,
  5188. /**
  5189. * Defines the blue component (between 0 and 1, default is 0)
  5190. */
  5191. b?: number);
  5192. /**
  5193. * Creates a string with the Color3 current values
  5194. * @returns the string representation of the Color3 object
  5195. */
  5196. toString(): string;
  5197. /**
  5198. * Returns the string "Color3"
  5199. * @returns "Color3"
  5200. */
  5201. getClassName(): string;
  5202. /**
  5203. * Compute the Color3 hash code
  5204. * @returns an unique number that can be used to hash Color3 objects
  5205. */
  5206. getHashCode(): number;
  5207. /**
  5208. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5209. * @param array defines the array where to store the r,g,b components
  5210. * @param index defines an optional index in the target array to define where to start storing values
  5211. * @returns the current Color3 object
  5212. */
  5213. toArray(array: FloatArray, index?: number): Color3;
  5214. /**
  5215. * Returns a new Color4 object from the current Color3 and the given alpha
  5216. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5217. * @returns a new Color4 object
  5218. */
  5219. toColor4(alpha?: number): Color4;
  5220. /**
  5221. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5222. * @returns the new array
  5223. */
  5224. asArray(): number[];
  5225. /**
  5226. * Returns the luminance value
  5227. * @returns a float value
  5228. */
  5229. toLuminance(): number;
  5230. /**
  5231. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5232. * @param otherColor defines the second operand
  5233. * @returns the new Color3 object
  5234. */
  5235. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5236. /**
  5237. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5238. * @param otherColor defines the second operand
  5239. * @param result defines the Color3 object where to store the result
  5240. * @returns the current Color3
  5241. */
  5242. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5243. /**
  5244. * Determines equality between Color3 objects
  5245. * @param otherColor defines the second operand
  5246. * @returns true if the rgb values are equal to the given ones
  5247. */
  5248. equals(otherColor: DeepImmutable<Color3>): boolean;
  5249. /**
  5250. * Determines equality between the current Color3 object and a set of r,b,g values
  5251. * @param r defines the red component to check
  5252. * @param g defines the green component to check
  5253. * @param b defines the blue component to check
  5254. * @returns true if the rgb values are equal to the given ones
  5255. */
  5256. equalsFloats(r: number, g: number, b: number): boolean;
  5257. /**
  5258. * Multiplies in place each rgb value by scale
  5259. * @param scale defines the scaling factor
  5260. * @returns the updated Color3
  5261. */
  5262. scale(scale: number): Color3;
  5263. /**
  5264. * Multiplies the rgb values by scale and stores the result into "result"
  5265. * @param scale defines the scaling factor
  5266. * @param result defines the Color3 object where to store the result
  5267. * @returns the unmodified current Color3
  5268. */
  5269. scaleToRef(scale: number, result: Color3): Color3;
  5270. /**
  5271. * Scale the current Color3 values by a factor and add the result to a given Color3
  5272. * @param scale defines the scale factor
  5273. * @param result defines color to store the result into
  5274. * @returns the unmodified current Color3
  5275. */
  5276. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5277. /**
  5278. * Clamps the rgb values by the min and max values and stores the result into "result"
  5279. * @param min defines minimum clamping value (default is 0)
  5280. * @param max defines maximum clamping value (default is 1)
  5281. * @param result defines color to store the result into
  5282. * @returns the original Color3
  5283. */
  5284. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5285. /**
  5286. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5287. * @param otherColor defines the second operand
  5288. * @returns the new Color3
  5289. */
  5290. add(otherColor: DeepImmutable<Color3>): Color3;
  5291. /**
  5292. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5293. * @param otherColor defines the second operand
  5294. * @param result defines Color3 object to store the result into
  5295. * @returns the unmodified current Color3
  5296. */
  5297. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5298. /**
  5299. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5300. * @param otherColor defines the second operand
  5301. * @returns the new Color3
  5302. */
  5303. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5304. /**
  5305. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5306. * @param otherColor defines the second operand
  5307. * @param result defines Color3 object to store the result into
  5308. * @returns the unmodified current Color3
  5309. */
  5310. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5311. /**
  5312. * Copy the current object
  5313. * @returns a new Color3 copied the current one
  5314. */
  5315. clone(): Color3;
  5316. /**
  5317. * Copies the rgb values from the source in the current Color3
  5318. * @param source defines the source Color3 object
  5319. * @returns the updated Color3 object
  5320. */
  5321. copyFrom(source: DeepImmutable<Color3>): Color3;
  5322. /**
  5323. * Updates the Color3 rgb values from the given floats
  5324. * @param r defines the red component to read from
  5325. * @param g defines the green component to read from
  5326. * @param b defines the blue component to read from
  5327. * @returns the current Color3 object
  5328. */
  5329. copyFromFloats(r: number, g: number, b: number): Color3;
  5330. /**
  5331. * Updates the Color3 rgb values from the given floats
  5332. * @param r defines the red component to read from
  5333. * @param g defines the green component to read from
  5334. * @param b defines the blue component to read from
  5335. * @returns the current Color3 object
  5336. */
  5337. set(r: number, g: number, b: number): Color3;
  5338. /**
  5339. * Compute the Color3 hexadecimal code as a string
  5340. * @returns a string containing the hexadecimal representation of the Color3 object
  5341. */
  5342. toHexString(): string;
  5343. /**
  5344. * Computes a new Color3 converted from the current one to linear space
  5345. * @returns a new Color3 object
  5346. */
  5347. toLinearSpace(): Color3;
  5348. /**
  5349. * Converts current color in rgb space to HSV values
  5350. * @returns a new color3 representing the HSV values
  5351. */
  5352. toHSV(): Color3;
  5353. /**
  5354. * Converts current color in rgb space to HSV values
  5355. * @param result defines the Color3 where to store the HSV values
  5356. */
  5357. toHSVToRef(result: Color3): void;
  5358. /**
  5359. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5360. * @param convertedColor defines the Color3 object where to store the linear space version
  5361. * @returns the unmodified Color3
  5362. */
  5363. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5364. /**
  5365. * Computes a new Color3 converted from the current one to gamma space
  5366. * @returns a new Color3 object
  5367. */
  5368. toGammaSpace(): Color3;
  5369. /**
  5370. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5371. * @param convertedColor defines the Color3 object where to store the gamma space version
  5372. * @returns the unmodified Color3
  5373. */
  5374. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5375. private static _BlackReadOnly;
  5376. /**
  5377. * Convert Hue, saturation and value to a Color3 (RGB)
  5378. * @param hue defines the hue
  5379. * @param saturation defines the saturation
  5380. * @param value defines the value
  5381. * @param result defines the Color3 where to store the RGB values
  5382. */
  5383. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5384. /**
  5385. * Creates a new Color3 from the string containing valid hexadecimal values
  5386. * @param hex defines a string containing valid hexadecimal values
  5387. * @returns a new Color3 object
  5388. */
  5389. static FromHexString(hex: string): Color3;
  5390. /**
  5391. * Creates a new Color3 from the starting index of the given array
  5392. * @param array defines the source array
  5393. * @param offset defines an offset in the source array
  5394. * @returns a new Color3 object
  5395. */
  5396. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5397. /**
  5398. * Creates a new Color3 from integer values (< 256)
  5399. * @param r defines the red component to read from (value between 0 and 255)
  5400. * @param g defines the green component to read from (value between 0 and 255)
  5401. * @param b defines the blue component to read from (value between 0 and 255)
  5402. * @returns a new Color3 object
  5403. */
  5404. static FromInts(r: number, g: number, b: number): Color3;
  5405. /**
  5406. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5407. * @param start defines the start Color3 value
  5408. * @param end defines the end Color3 value
  5409. * @param amount defines the gradient value between start and end
  5410. * @returns a new Color3 object
  5411. */
  5412. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5413. /**
  5414. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5415. * @param left defines the start value
  5416. * @param right defines the end value
  5417. * @param amount defines the gradient factor
  5418. * @param result defines the Color3 object where to store the result
  5419. */
  5420. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5421. /**
  5422. * Returns a Color3 value containing a red color
  5423. * @returns a new Color3 object
  5424. */
  5425. static Red(): Color3;
  5426. /**
  5427. * Returns a Color3 value containing a green color
  5428. * @returns a new Color3 object
  5429. */
  5430. static Green(): Color3;
  5431. /**
  5432. * Returns a Color3 value containing a blue color
  5433. * @returns a new Color3 object
  5434. */
  5435. static Blue(): Color3;
  5436. /**
  5437. * Returns a Color3 value containing a black color
  5438. * @returns a new Color3 object
  5439. */
  5440. static Black(): Color3;
  5441. /**
  5442. * Gets a Color3 value containing a black color that must not be updated
  5443. */
  5444. static readonly BlackReadOnly: DeepImmutable<Color3>;
  5445. /**
  5446. * Returns a Color3 value containing a white color
  5447. * @returns a new Color3 object
  5448. */
  5449. static White(): Color3;
  5450. /**
  5451. * Returns a Color3 value containing a purple color
  5452. * @returns a new Color3 object
  5453. */
  5454. static Purple(): Color3;
  5455. /**
  5456. * Returns a Color3 value containing a magenta color
  5457. * @returns a new Color3 object
  5458. */
  5459. static Magenta(): Color3;
  5460. /**
  5461. * Returns a Color3 value containing a yellow color
  5462. * @returns a new Color3 object
  5463. */
  5464. static Yellow(): Color3;
  5465. /**
  5466. * Returns a Color3 value containing a gray color
  5467. * @returns a new Color3 object
  5468. */
  5469. static Gray(): Color3;
  5470. /**
  5471. * Returns a Color3 value containing a teal color
  5472. * @returns a new Color3 object
  5473. */
  5474. static Teal(): Color3;
  5475. /**
  5476. * Returns a Color3 value containing a random color
  5477. * @returns a new Color3 object
  5478. */
  5479. static Random(): Color3;
  5480. }
  5481. /**
  5482. * Class used to hold a RBGA color
  5483. */
  5484. export class Color4 {
  5485. /**
  5486. * Defines the red component (between 0 and 1, default is 0)
  5487. */
  5488. r: number;
  5489. /**
  5490. * Defines the green component (between 0 and 1, default is 0)
  5491. */
  5492. g: number;
  5493. /**
  5494. * Defines the blue component (between 0 and 1, default is 0)
  5495. */
  5496. b: number;
  5497. /**
  5498. * Defines the alpha component (between 0 and 1, default is 1)
  5499. */
  5500. a: number;
  5501. /**
  5502. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5503. * @param r defines the red component (between 0 and 1, default is 0)
  5504. * @param g defines the green component (between 0 and 1, default is 0)
  5505. * @param b defines the blue component (between 0 and 1, default is 0)
  5506. * @param a defines the alpha component (between 0 and 1, default is 1)
  5507. */
  5508. constructor(
  5509. /**
  5510. * Defines the red component (between 0 and 1, default is 0)
  5511. */
  5512. r?: number,
  5513. /**
  5514. * Defines the green component (between 0 and 1, default is 0)
  5515. */
  5516. g?: number,
  5517. /**
  5518. * Defines the blue component (between 0 and 1, default is 0)
  5519. */
  5520. b?: number,
  5521. /**
  5522. * Defines the alpha component (between 0 and 1, default is 1)
  5523. */
  5524. a?: number);
  5525. /**
  5526. * Adds in place the given Color4 values to the current Color4 object
  5527. * @param right defines the second operand
  5528. * @returns the current updated Color4 object
  5529. */
  5530. addInPlace(right: DeepImmutable<Color4>): Color4;
  5531. /**
  5532. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5533. * @returns the new array
  5534. */
  5535. asArray(): number[];
  5536. /**
  5537. * Stores from the starting index in the given array the Color4 successive values
  5538. * @param array defines the array where to store the r,g,b components
  5539. * @param index defines an optional index in the target array to define where to start storing values
  5540. * @returns the current Color4 object
  5541. */
  5542. toArray(array: number[], index?: number): Color4;
  5543. /**
  5544. * Determines equality between Color4 objects
  5545. * @param otherColor defines the second operand
  5546. * @returns true if the rgba values are equal to the given ones
  5547. */
  5548. equals(otherColor: DeepImmutable<Color4>): boolean;
  5549. /**
  5550. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5551. * @param right defines the second operand
  5552. * @returns a new Color4 object
  5553. */
  5554. add(right: DeepImmutable<Color4>): Color4;
  5555. /**
  5556. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5557. * @param right defines the second operand
  5558. * @returns a new Color4 object
  5559. */
  5560. subtract(right: DeepImmutable<Color4>): Color4;
  5561. /**
  5562. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5563. * @param right defines the second operand
  5564. * @param result defines the Color4 object where to store the result
  5565. * @returns the current Color4 object
  5566. */
  5567. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5568. /**
  5569. * Creates a new Color4 with the current Color4 values multiplied by scale
  5570. * @param scale defines the scaling factor to apply
  5571. * @returns a new Color4 object
  5572. */
  5573. scale(scale: number): Color4;
  5574. /**
  5575. * Multiplies the current Color4 values by scale and stores the result in "result"
  5576. * @param scale defines the scaling factor to apply
  5577. * @param result defines the Color4 object where to store the result
  5578. * @returns the current unmodified Color4
  5579. */
  5580. scaleToRef(scale: number, result: Color4): Color4;
  5581. /**
  5582. * Scale the current Color4 values by a factor and add the result to a given Color4
  5583. * @param scale defines the scale factor
  5584. * @param result defines the Color4 object where to store the result
  5585. * @returns the unmodified current Color4
  5586. */
  5587. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5588. /**
  5589. * Clamps the rgb values by the min and max values and stores the result into "result"
  5590. * @param min defines minimum clamping value (default is 0)
  5591. * @param max defines maximum clamping value (default is 1)
  5592. * @param result defines color to store the result into.
  5593. * @returns the cuurent Color4
  5594. */
  5595. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5596. /**
  5597. * Multipy an Color4 value by another and return a new Color4 object
  5598. * @param color defines the Color4 value to multiply by
  5599. * @returns a new Color4 object
  5600. */
  5601. multiply(color: Color4): Color4;
  5602. /**
  5603. * Multipy a Color4 value by another and push the result in a reference value
  5604. * @param color defines the Color4 value to multiply by
  5605. * @param result defines the Color4 to fill the result in
  5606. * @returns the result Color4
  5607. */
  5608. multiplyToRef(color: Color4, result: Color4): Color4;
  5609. /**
  5610. * Creates a string with the Color4 current values
  5611. * @returns the string representation of the Color4 object
  5612. */
  5613. toString(): string;
  5614. /**
  5615. * Returns the string "Color4"
  5616. * @returns "Color4"
  5617. */
  5618. getClassName(): string;
  5619. /**
  5620. * Compute the Color4 hash code
  5621. * @returns an unique number that can be used to hash Color4 objects
  5622. */
  5623. getHashCode(): number;
  5624. /**
  5625. * Creates a new Color4 copied from the current one
  5626. * @returns a new Color4 object
  5627. */
  5628. clone(): Color4;
  5629. /**
  5630. * Copies the given Color4 values into the current one
  5631. * @param source defines the source Color4 object
  5632. * @returns the current updated Color4 object
  5633. */
  5634. copyFrom(source: Color4): Color4;
  5635. /**
  5636. * Copies the given float values into the current one
  5637. * @param r defines the red component to read from
  5638. * @param g defines the green component to read from
  5639. * @param b defines the blue component to read from
  5640. * @param a defines the alpha component to read from
  5641. * @returns the current updated Color4 object
  5642. */
  5643. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  5644. /**
  5645. * Copies the given float values into the current one
  5646. * @param r defines the red component to read from
  5647. * @param g defines the green component to read from
  5648. * @param b defines the blue component to read from
  5649. * @param a defines the alpha component to read from
  5650. * @returns the current updated Color4 object
  5651. */
  5652. set(r: number, g: number, b: number, a: number): Color4;
  5653. /**
  5654. * Compute the Color4 hexadecimal code as a string
  5655. * @returns a string containing the hexadecimal representation of the Color4 object
  5656. */
  5657. toHexString(): string;
  5658. /**
  5659. * Computes a new Color4 converted from the current one to linear space
  5660. * @returns a new Color4 object
  5661. */
  5662. toLinearSpace(): Color4;
  5663. /**
  5664. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  5665. * @param convertedColor defines the Color4 object where to store the linear space version
  5666. * @returns the unmodified Color4
  5667. */
  5668. toLinearSpaceToRef(convertedColor: Color4): Color4;
  5669. /**
  5670. * Computes a new Color4 converted from the current one to gamma space
  5671. * @returns a new Color4 object
  5672. */
  5673. toGammaSpace(): Color4;
  5674. /**
  5675. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  5676. * @param convertedColor defines the Color4 object where to store the gamma space version
  5677. * @returns the unmodified Color4
  5678. */
  5679. toGammaSpaceToRef(convertedColor: Color4): Color4;
  5680. /**
  5681. * Creates a new Color4 from the string containing valid hexadecimal values
  5682. * @param hex defines a string containing valid hexadecimal values
  5683. * @returns a new Color4 object
  5684. */
  5685. static FromHexString(hex: string): Color4;
  5686. /**
  5687. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5688. * @param left defines the start value
  5689. * @param right defines the end value
  5690. * @param amount defines the gradient factor
  5691. * @returns a new Color4 object
  5692. */
  5693. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  5694. /**
  5695. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5696. * @param left defines the start value
  5697. * @param right defines the end value
  5698. * @param amount defines the gradient factor
  5699. * @param result defines the Color4 object where to store data
  5700. */
  5701. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  5702. /**
  5703. * Creates a new Color4 from a Color3 and an alpha value
  5704. * @param color3 defines the source Color3 to read from
  5705. * @param alpha defines the alpha component (1.0 by default)
  5706. * @returns a new Color4 object
  5707. */
  5708. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  5709. /**
  5710. * Creates a new Color4 from the starting index element of the given array
  5711. * @param array defines the source array to read from
  5712. * @param offset defines the offset in the source array
  5713. * @returns a new Color4 object
  5714. */
  5715. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5716. /**
  5717. * Creates a new Color3 from integer values (< 256)
  5718. * @param r defines the red component to read from (value between 0 and 255)
  5719. * @param g defines the green component to read from (value between 0 and 255)
  5720. * @param b defines the blue component to read from (value between 0 and 255)
  5721. * @param a defines the alpha component to read from (value between 0 and 255)
  5722. * @returns a new Color3 object
  5723. */
  5724. static FromInts(r: number, g: number, b: number, a: number): Color4;
  5725. /**
  5726. * Check the content of a given array and convert it to an array containing RGBA data
  5727. * If the original array was already containing count * 4 values then it is returned directly
  5728. * @param colors defines the array to check
  5729. * @param count defines the number of RGBA data to expect
  5730. * @returns an array containing count * 4 values (RGBA)
  5731. */
  5732. static CheckColors4(colors: number[], count: number): number[];
  5733. }
  5734. /**
  5735. * @hidden
  5736. */
  5737. export class TmpColors {
  5738. static Color3: Color3[];
  5739. static Color4: Color4[];
  5740. }
  5741. }
  5742. declare module "babylonjs/Animations/animationKey" {
  5743. /**
  5744. * Defines an interface which represents an animation key frame
  5745. */
  5746. export interface IAnimationKey {
  5747. /**
  5748. * Frame of the key frame
  5749. */
  5750. frame: number;
  5751. /**
  5752. * Value at the specifies key frame
  5753. */
  5754. value: any;
  5755. /**
  5756. * The input tangent for the cubic hermite spline
  5757. */
  5758. inTangent?: any;
  5759. /**
  5760. * The output tangent for the cubic hermite spline
  5761. */
  5762. outTangent?: any;
  5763. /**
  5764. * The animation interpolation type
  5765. */
  5766. interpolation?: AnimationKeyInterpolation;
  5767. }
  5768. /**
  5769. * Enum for the animation key frame interpolation type
  5770. */
  5771. export enum AnimationKeyInterpolation {
  5772. /**
  5773. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  5774. */
  5775. STEP = 1
  5776. }
  5777. }
  5778. declare module "babylonjs/Animations/animationRange" {
  5779. /**
  5780. * Represents the range of an animation
  5781. */
  5782. export class AnimationRange {
  5783. /**The name of the animation range**/
  5784. name: string;
  5785. /**The starting frame of the animation */
  5786. from: number;
  5787. /**The ending frame of the animation*/
  5788. to: number;
  5789. /**
  5790. * Initializes the range of an animation
  5791. * @param name The name of the animation range
  5792. * @param from The starting frame of the animation
  5793. * @param to The ending frame of the animation
  5794. */
  5795. constructor(
  5796. /**The name of the animation range**/
  5797. name: string,
  5798. /**The starting frame of the animation */
  5799. from: number,
  5800. /**The ending frame of the animation*/
  5801. to: number);
  5802. /**
  5803. * Makes a copy of the animation range
  5804. * @returns A copy of the animation range
  5805. */
  5806. clone(): AnimationRange;
  5807. }
  5808. }
  5809. declare module "babylonjs/Animations/animationEvent" {
  5810. /**
  5811. * Composed of a frame, and an action function
  5812. */
  5813. export class AnimationEvent {
  5814. /** The frame for which the event is triggered **/
  5815. frame: number;
  5816. /** The event to perform when triggered **/
  5817. action: (currentFrame: number) => void;
  5818. /** Specifies if the event should be triggered only once**/
  5819. onlyOnce?: boolean | undefined;
  5820. /**
  5821. * Specifies if the animation event is done
  5822. */
  5823. isDone: boolean;
  5824. /**
  5825. * Initializes the animation event
  5826. * @param frame The frame for which the event is triggered
  5827. * @param action The event to perform when triggered
  5828. * @param onlyOnce Specifies if the event should be triggered only once
  5829. */
  5830. constructor(
  5831. /** The frame for which the event is triggered **/
  5832. frame: number,
  5833. /** The event to perform when triggered **/
  5834. action: (currentFrame: number) => void,
  5835. /** Specifies if the event should be triggered only once**/
  5836. onlyOnce?: boolean | undefined);
  5837. /** @hidden */
  5838. _clone(): AnimationEvent;
  5839. }
  5840. }
  5841. declare module "babylonjs/Behaviors/behavior" {
  5842. import { Nullable } from "babylonjs/types";
  5843. /**
  5844. * Interface used to define a behavior
  5845. */
  5846. export interface Behavior<T> {
  5847. /** gets or sets behavior's name */
  5848. name: string;
  5849. /**
  5850. * Function called when the behavior needs to be initialized (after attaching it to a target)
  5851. */
  5852. init(): void;
  5853. /**
  5854. * Called when the behavior is attached to a target
  5855. * @param target defines the target where the behavior is attached to
  5856. */
  5857. attach(target: T): void;
  5858. /**
  5859. * Called when the behavior is detached from its target
  5860. */
  5861. detach(): void;
  5862. }
  5863. /**
  5864. * Interface implemented by classes supporting behaviors
  5865. */
  5866. export interface IBehaviorAware<T> {
  5867. /**
  5868. * Attach a behavior
  5869. * @param behavior defines the behavior to attach
  5870. * @returns the current host
  5871. */
  5872. addBehavior(behavior: Behavior<T>): T;
  5873. /**
  5874. * Remove a behavior from the current object
  5875. * @param behavior defines the behavior to detach
  5876. * @returns the current host
  5877. */
  5878. removeBehavior(behavior: Behavior<T>): T;
  5879. /**
  5880. * Gets a behavior using its name to search
  5881. * @param name defines the name to search
  5882. * @returns the behavior or null if not found
  5883. */
  5884. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  5885. }
  5886. }
  5887. declare module "babylonjs/Misc/smartArray" {
  5888. /**
  5889. * Defines an array and its length.
  5890. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  5891. */
  5892. export interface ISmartArrayLike<T> {
  5893. /**
  5894. * The data of the array.
  5895. */
  5896. data: Array<T>;
  5897. /**
  5898. * The active length of the array.
  5899. */
  5900. length: number;
  5901. }
  5902. /**
  5903. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  5904. */
  5905. export class SmartArray<T> implements ISmartArrayLike<T> {
  5906. /**
  5907. * The full set of data from the array.
  5908. */
  5909. data: Array<T>;
  5910. /**
  5911. * The active length of the array.
  5912. */
  5913. length: number;
  5914. protected _id: number;
  5915. /**
  5916. * Instantiates a Smart Array.
  5917. * @param capacity defines the default capacity of the array.
  5918. */
  5919. constructor(capacity: number);
  5920. /**
  5921. * Pushes a value at the end of the active data.
  5922. * @param value defines the object to push in the array.
  5923. */
  5924. push(value: T): void;
  5925. /**
  5926. * Iterates over the active data and apply the lambda to them.
  5927. * @param func defines the action to apply on each value.
  5928. */
  5929. forEach(func: (content: T) => void): void;
  5930. /**
  5931. * Sorts the full sets of data.
  5932. * @param compareFn defines the comparison function to apply.
  5933. */
  5934. sort(compareFn: (a: T, b: T) => number): void;
  5935. /**
  5936. * Resets the active data to an empty array.
  5937. */
  5938. reset(): void;
  5939. /**
  5940. * Releases all the data from the array as well as the array.
  5941. */
  5942. dispose(): void;
  5943. /**
  5944. * Concats the active data with a given array.
  5945. * @param array defines the data to concatenate with.
  5946. */
  5947. concat(array: any): void;
  5948. /**
  5949. * Returns the position of a value in the active data.
  5950. * @param value defines the value to find the index for
  5951. * @returns the index if found in the active data otherwise -1
  5952. */
  5953. indexOf(value: T): number;
  5954. /**
  5955. * Returns whether an element is part of the active data.
  5956. * @param value defines the value to look for
  5957. * @returns true if found in the active data otherwise false
  5958. */
  5959. contains(value: T): boolean;
  5960. private static _GlobalId;
  5961. }
  5962. /**
  5963. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  5964. * The data in this array can only be present once
  5965. */
  5966. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  5967. private _duplicateId;
  5968. /**
  5969. * Pushes a value at the end of the active data.
  5970. * THIS DOES NOT PREVENT DUPPLICATE DATA
  5971. * @param value defines the object to push in the array.
  5972. */
  5973. push(value: T): void;
  5974. /**
  5975. * Pushes a value at the end of the active data.
  5976. * If the data is already present, it won t be added again
  5977. * @param value defines the object to push in the array.
  5978. * @returns true if added false if it was already present
  5979. */
  5980. pushNoDuplicate(value: T): boolean;
  5981. /**
  5982. * Resets the active data to an empty array.
  5983. */
  5984. reset(): void;
  5985. /**
  5986. * Concats the active data with a given array.
  5987. * This ensures no dupplicate will be present in the result.
  5988. * @param array defines the data to concatenate with.
  5989. */
  5990. concatWithNoDuplicate(array: any): void;
  5991. }
  5992. }
  5993. declare module "babylonjs/Cameras/cameraInputsManager" {
  5994. import { Nullable } from "babylonjs/types";
  5995. import { Camera } from "babylonjs/Cameras/camera";
  5996. /**
  5997. * @ignore
  5998. * This is a list of all the different input types that are available in the application.
  5999. * Fo instance: ArcRotateCameraGamepadInput...
  6000. */
  6001. export var CameraInputTypes: {};
  6002. /**
  6003. * This is the contract to implement in order to create a new input class.
  6004. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6005. */
  6006. export interface ICameraInput<TCamera extends Camera> {
  6007. /**
  6008. * Defines the camera the input is attached to.
  6009. */
  6010. camera: Nullable<TCamera>;
  6011. /**
  6012. * Gets the class name of the current intput.
  6013. * @returns the class name
  6014. */
  6015. getClassName(): string;
  6016. /**
  6017. * Get the friendly name associated with the input class.
  6018. * @returns the input friendly name
  6019. */
  6020. getSimpleName(): string;
  6021. /**
  6022. * Attach the input controls to a specific dom element to get the input from.
  6023. * @param element Defines the element the controls should be listened from
  6024. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6025. */
  6026. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6027. /**
  6028. * Detach the current controls from the specified dom element.
  6029. * @param element Defines the element to stop listening the inputs from
  6030. */
  6031. detachControl(element: Nullable<HTMLElement>): void;
  6032. /**
  6033. * Update the current camera state depending on the inputs that have been used this frame.
  6034. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6035. */
  6036. checkInputs?: () => void;
  6037. }
  6038. /**
  6039. * Represents a map of input types to input instance or input index to input instance.
  6040. */
  6041. export interface CameraInputsMap<TCamera extends Camera> {
  6042. /**
  6043. * Accessor to the input by input type.
  6044. */
  6045. [name: string]: ICameraInput<TCamera>;
  6046. /**
  6047. * Accessor to the input by input index.
  6048. */
  6049. [idx: number]: ICameraInput<TCamera>;
  6050. }
  6051. /**
  6052. * This represents the input manager used within a camera.
  6053. * It helps dealing with all the different kind of input attached to a camera.
  6054. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6055. */
  6056. export class CameraInputsManager<TCamera extends Camera> {
  6057. /**
  6058. * Defines the list of inputs attahed to the camera.
  6059. */
  6060. attached: CameraInputsMap<TCamera>;
  6061. /**
  6062. * Defines the dom element the camera is collecting inputs from.
  6063. * This is null if the controls have not been attached.
  6064. */
  6065. attachedElement: Nullable<HTMLElement>;
  6066. /**
  6067. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6068. */
  6069. noPreventDefault: boolean;
  6070. /**
  6071. * Defined the camera the input manager belongs to.
  6072. */
  6073. camera: TCamera;
  6074. /**
  6075. * Update the current camera state depending on the inputs that have been used this frame.
  6076. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6077. */
  6078. checkInputs: () => void;
  6079. /**
  6080. * Instantiate a new Camera Input Manager.
  6081. * @param camera Defines the camera the input manager blongs to
  6082. */
  6083. constructor(camera: TCamera);
  6084. /**
  6085. * Add an input method to a camera
  6086. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6087. * @param input camera input method
  6088. */
  6089. add(input: ICameraInput<TCamera>): void;
  6090. /**
  6091. * Remove a specific input method from a camera
  6092. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6093. * @param inputToRemove camera input method
  6094. */
  6095. remove(inputToRemove: ICameraInput<TCamera>): void;
  6096. /**
  6097. * Remove a specific input type from a camera
  6098. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6099. * @param inputType the type of the input to remove
  6100. */
  6101. removeByType(inputType: string): void;
  6102. private _addCheckInputs;
  6103. /**
  6104. * Attach the input controls to the currently attached dom element to listen the events from.
  6105. * @param input Defines the input to attach
  6106. */
  6107. attachInput(input: ICameraInput<TCamera>): void;
  6108. /**
  6109. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6110. * @param element Defines the dom element to collect the events from
  6111. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6112. */
  6113. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6114. /**
  6115. * Detach the current manager inputs controls from a specific dom element.
  6116. * @param element Defines the dom element to collect the events from
  6117. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6118. */
  6119. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6120. /**
  6121. * Rebuild the dynamic inputCheck function from the current list of
  6122. * defined inputs in the manager.
  6123. */
  6124. rebuildInputCheck(): void;
  6125. /**
  6126. * Remove all attached input methods from a camera
  6127. */
  6128. clear(): void;
  6129. /**
  6130. * Serialize the current input manager attached to a camera.
  6131. * This ensures than once parsed,
  6132. * the input associated to the camera will be identical to the current ones
  6133. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6134. */
  6135. serialize(serializedCamera: any): void;
  6136. /**
  6137. * Parses an input manager serialized JSON to restore the previous list of inputs
  6138. * and states associated to a camera.
  6139. * @param parsedCamera Defines the JSON to parse
  6140. */
  6141. parse(parsedCamera: any): void;
  6142. }
  6143. }
  6144. declare module "babylonjs/Meshes/buffer" {
  6145. import { Nullable, DataArray } from "babylonjs/types";
  6146. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6147. /**
  6148. * Class used to store data that will be store in GPU memory
  6149. */
  6150. export class Buffer {
  6151. private _engine;
  6152. private _buffer;
  6153. /** @hidden */
  6154. _data: Nullable<DataArray>;
  6155. private _updatable;
  6156. private _instanced;
  6157. private _divisor;
  6158. /**
  6159. * Gets the byte stride.
  6160. */
  6161. readonly byteStride: number;
  6162. /**
  6163. * Constructor
  6164. * @param engine the engine
  6165. * @param data the data to use for this buffer
  6166. * @param updatable whether the data is updatable
  6167. * @param stride the stride (optional)
  6168. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6169. * @param instanced whether the buffer is instanced (optional)
  6170. * @param useBytes set to true if the stride in in bytes (optional)
  6171. * @param divisor sets an optional divisor for instances (1 by default)
  6172. */
  6173. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6174. /**
  6175. * Create a new VertexBuffer based on the current buffer
  6176. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6177. * @param offset defines offset in the buffer (0 by default)
  6178. * @param size defines the size in floats of attributes (position is 3 for instance)
  6179. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6180. * @param instanced defines if the vertex buffer contains indexed data
  6181. * @param useBytes defines if the offset and stride are in bytes *
  6182. * @param divisor sets an optional divisor for instances (1 by default)
  6183. * @returns the new vertex buffer
  6184. */
  6185. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6186. /**
  6187. * Gets a boolean indicating if the Buffer is updatable?
  6188. * @returns true if the buffer is updatable
  6189. */
  6190. isUpdatable(): boolean;
  6191. /**
  6192. * Gets current buffer's data
  6193. * @returns a DataArray or null
  6194. */
  6195. getData(): Nullable<DataArray>;
  6196. /**
  6197. * Gets underlying native buffer
  6198. * @returns underlying native buffer
  6199. */
  6200. getBuffer(): Nullable<DataBuffer>;
  6201. /**
  6202. * Gets the stride in float32 units (i.e. byte stride / 4).
  6203. * May not be an integer if the byte stride is not divisible by 4.
  6204. * DEPRECATED. Use byteStride instead.
  6205. * @returns the stride in float32 units
  6206. */
  6207. getStrideSize(): number;
  6208. /**
  6209. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6210. * @param data defines the data to store
  6211. */
  6212. create(data?: Nullable<DataArray>): void;
  6213. /** @hidden */
  6214. _rebuild(): void;
  6215. /**
  6216. * Update current buffer data
  6217. * @param data defines the data to store
  6218. */
  6219. update(data: DataArray): void;
  6220. /**
  6221. * Updates the data directly.
  6222. * @param data the new data
  6223. * @param offset the new offset
  6224. * @param vertexCount the vertex count (optional)
  6225. * @param useBytes set to true if the offset is in bytes
  6226. */
  6227. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6228. /**
  6229. * Release all resources
  6230. */
  6231. dispose(): void;
  6232. }
  6233. /**
  6234. * Specialized buffer used to store vertex data
  6235. */
  6236. export class VertexBuffer {
  6237. /** @hidden */
  6238. _buffer: Buffer;
  6239. private _kind;
  6240. private _size;
  6241. private _ownsBuffer;
  6242. private _instanced;
  6243. private _instanceDivisor;
  6244. /**
  6245. * The byte type.
  6246. */
  6247. static readonly BYTE: number;
  6248. /**
  6249. * The unsigned byte type.
  6250. */
  6251. static readonly UNSIGNED_BYTE: number;
  6252. /**
  6253. * The short type.
  6254. */
  6255. static readonly SHORT: number;
  6256. /**
  6257. * The unsigned short type.
  6258. */
  6259. static readonly UNSIGNED_SHORT: number;
  6260. /**
  6261. * The integer type.
  6262. */
  6263. static readonly INT: number;
  6264. /**
  6265. * The unsigned integer type.
  6266. */
  6267. static readonly UNSIGNED_INT: number;
  6268. /**
  6269. * The float type.
  6270. */
  6271. static readonly FLOAT: number;
  6272. /**
  6273. * Gets or sets the instance divisor when in instanced mode
  6274. */
  6275. instanceDivisor: number;
  6276. /**
  6277. * Gets the byte stride.
  6278. */
  6279. readonly byteStride: number;
  6280. /**
  6281. * Gets the byte offset.
  6282. */
  6283. readonly byteOffset: number;
  6284. /**
  6285. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6286. */
  6287. readonly normalized: boolean;
  6288. /**
  6289. * Gets the data type of each component in the array.
  6290. */
  6291. readonly type: number;
  6292. /**
  6293. * Constructor
  6294. * @param engine the engine
  6295. * @param data the data to use for this vertex buffer
  6296. * @param kind the vertex buffer kind
  6297. * @param updatable whether the data is updatable
  6298. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6299. * @param stride the stride (optional)
  6300. * @param instanced whether the buffer is instanced (optional)
  6301. * @param offset the offset of the data (optional)
  6302. * @param size the number of components (optional)
  6303. * @param type the type of the component (optional)
  6304. * @param normalized whether the data contains normalized data (optional)
  6305. * @param useBytes set to true if stride and offset are in bytes (optional)
  6306. * @param divisor defines the instance divisor to use (1 by default)
  6307. */
  6308. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  6309. /** @hidden */
  6310. _rebuild(): void;
  6311. /**
  6312. * Returns the kind of the VertexBuffer (string)
  6313. * @returns a string
  6314. */
  6315. getKind(): string;
  6316. /**
  6317. * Gets a boolean indicating if the VertexBuffer is updatable?
  6318. * @returns true if the buffer is updatable
  6319. */
  6320. isUpdatable(): boolean;
  6321. /**
  6322. * Gets current buffer's data
  6323. * @returns a DataArray or null
  6324. */
  6325. getData(): Nullable<DataArray>;
  6326. /**
  6327. * Gets underlying native buffer
  6328. * @returns underlying native buffer
  6329. */
  6330. getBuffer(): Nullable<DataBuffer>;
  6331. /**
  6332. * Gets the stride in float32 units (i.e. byte stride / 4).
  6333. * May not be an integer if the byte stride is not divisible by 4.
  6334. * DEPRECATED. Use byteStride instead.
  6335. * @returns the stride in float32 units
  6336. */
  6337. getStrideSize(): number;
  6338. /**
  6339. * Returns the offset as a multiple of the type byte length.
  6340. * DEPRECATED. Use byteOffset instead.
  6341. * @returns the offset in bytes
  6342. */
  6343. getOffset(): number;
  6344. /**
  6345. * Returns the number of components per vertex attribute (integer)
  6346. * @returns the size in float
  6347. */
  6348. getSize(): number;
  6349. /**
  6350. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6351. * @returns true if this buffer is instanced
  6352. */
  6353. getIsInstanced(): boolean;
  6354. /**
  6355. * Returns the instancing divisor, zero for non-instanced (integer).
  6356. * @returns a number
  6357. */
  6358. getInstanceDivisor(): number;
  6359. /**
  6360. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6361. * @param data defines the data to store
  6362. */
  6363. create(data?: DataArray): void;
  6364. /**
  6365. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6366. * This function will create a new buffer if the current one is not updatable
  6367. * @param data defines the data to store
  6368. */
  6369. update(data: DataArray): void;
  6370. /**
  6371. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6372. * Returns the directly updated WebGLBuffer.
  6373. * @param data the new data
  6374. * @param offset the new offset
  6375. * @param useBytes set to true if the offset is in bytes
  6376. */
  6377. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6378. /**
  6379. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6380. */
  6381. dispose(): void;
  6382. /**
  6383. * Enumerates each value of this vertex buffer as numbers.
  6384. * @param count the number of values to enumerate
  6385. * @param callback the callback function called for each value
  6386. */
  6387. forEach(count: number, callback: (value: number, index: number) => void): void;
  6388. /**
  6389. * Positions
  6390. */
  6391. static readonly PositionKind: string;
  6392. /**
  6393. * Normals
  6394. */
  6395. static readonly NormalKind: string;
  6396. /**
  6397. * Tangents
  6398. */
  6399. static readonly TangentKind: string;
  6400. /**
  6401. * Texture coordinates
  6402. */
  6403. static readonly UVKind: string;
  6404. /**
  6405. * Texture coordinates 2
  6406. */
  6407. static readonly UV2Kind: string;
  6408. /**
  6409. * Texture coordinates 3
  6410. */
  6411. static readonly UV3Kind: string;
  6412. /**
  6413. * Texture coordinates 4
  6414. */
  6415. static readonly UV4Kind: string;
  6416. /**
  6417. * Texture coordinates 5
  6418. */
  6419. static readonly UV5Kind: string;
  6420. /**
  6421. * Texture coordinates 6
  6422. */
  6423. static readonly UV6Kind: string;
  6424. /**
  6425. * Colors
  6426. */
  6427. static readonly ColorKind: string;
  6428. /**
  6429. * Matrix indices (for bones)
  6430. */
  6431. static readonly MatricesIndicesKind: string;
  6432. /**
  6433. * Matrix weights (for bones)
  6434. */
  6435. static readonly MatricesWeightsKind: string;
  6436. /**
  6437. * Additional matrix indices (for bones)
  6438. */
  6439. static readonly MatricesIndicesExtraKind: string;
  6440. /**
  6441. * Additional matrix weights (for bones)
  6442. */
  6443. static readonly MatricesWeightsExtraKind: string;
  6444. /**
  6445. * Deduces the stride given a kind.
  6446. * @param kind The kind string to deduce
  6447. * @returns The deduced stride
  6448. */
  6449. static DeduceStride(kind: string): number;
  6450. /**
  6451. * Gets the byte length of the given type.
  6452. * @param type the type
  6453. * @returns the number of bytes
  6454. */
  6455. static GetTypeByteLength(type: number): number;
  6456. /**
  6457. * Enumerates each value of the given parameters as numbers.
  6458. * @param data the data to enumerate
  6459. * @param byteOffset the byte offset of the data
  6460. * @param byteStride the byte stride of the data
  6461. * @param componentCount the number of components per element
  6462. * @param componentType the type of the component
  6463. * @param count the number of values to enumerate
  6464. * @param normalized whether the data is normalized
  6465. * @param callback the callback function called for each value
  6466. */
  6467. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6468. private static _GetFloatValue;
  6469. }
  6470. }
  6471. declare module "babylonjs/Collisions/intersectionInfo" {
  6472. import { Nullable } from "babylonjs/types";
  6473. /**
  6474. * @hidden
  6475. */
  6476. export class IntersectionInfo {
  6477. bu: Nullable<number>;
  6478. bv: Nullable<number>;
  6479. distance: number;
  6480. faceId: number;
  6481. subMeshId: number;
  6482. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6483. }
  6484. }
  6485. declare module "babylonjs/Maths/math.plane" {
  6486. import { DeepImmutable } from "babylonjs/types";
  6487. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  6488. /**
  6489. * Represens a plane by the equation ax + by + cz + d = 0
  6490. */
  6491. export class Plane {
  6492. private static _TmpMatrix;
  6493. /**
  6494. * Normal of the plane (a,b,c)
  6495. */
  6496. normal: Vector3;
  6497. /**
  6498. * d component of the plane
  6499. */
  6500. d: number;
  6501. /**
  6502. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  6503. * @param a a component of the plane
  6504. * @param b b component of the plane
  6505. * @param c c component of the plane
  6506. * @param d d component of the plane
  6507. */
  6508. constructor(a: number, b: number, c: number, d: number);
  6509. /**
  6510. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  6511. */
  6512. asArray(): number[];
  6513. /**
  6514. * @returns a new plane copied from the current Plane.
  6515. */
  6516. clone(): Plane;
  6517. /**
  6518. * @returns the string "Plane".
  6519. */
  6520. getClassName(): string;
  6521. /**
  6522. * @returns the Plane hash code.
  6523. */
  6524. getHashCode(): number;
  6525. /**
  6526. * Normalize the current Plane in place.
  6527. * @returns the updated Plane.
  6528. */
  6529. normalize(): Plane;
  6530. /**
  6531. * Applies a transformation the plane and returns the result
  6532. * @param transformation the transformation matrix to be applied to the plane
  6533. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  6534. */
  6535. transform(transformation: DeepImmutable<Matrix>): Plane;
  6536. /**
  6537. * Calcualtte the dot product between the point and the plane normal
  6538. * @param point point to calculate the dot product with
  6539. * @returns the dot product (float) of the point coordinates and the plane normal.
  6540. */
  6541. dotCoordinate(point: DeepImmutable<Vector3>): number;
  6542. /**
  6543. * Updates the current Plane from the plane defined by the three given points.
  6544. * @param point1 one of the points used to contruct the plane
  6545. * @param point2 one of the points used to contruct the plane
  6546. * @param point3 one of the points used to contruct the plane
  6547. * @returns the updated Plane.
  6548. */
  6549. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6550. /**
  6551. * Checks if the plane is facing a given direction
  6552. * @param direction the direction to check if the plane is facing
  6553. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  6554. * @returns True is the vector "direction" is the same side than the plane normal.
  6555. */
  6556. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  6557. /**
  6558. * Calculates the distance to a point
  6559. * @param point point to calculate distance to
  6560. * @returns the signed distance (float) from the given point to the Plane.
  6561. */
  6562. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  6563. /**
  6564. * Creates a plane from an array
  6565. * @param array the array to create a plane from
  6566. * @returns a new Plane from the given array.
  6567. */
  6568. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  6569. /**
  6570. * Creates a plane from three points
  6571. * @param point1 point used to create the plane
  6572. * @param point2 point used to create the plane
  6573. * @param point3 point used to create the plane
  6574. * @returns a new Plane defined by the three given points.
  6575. */
  6576. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6577. /**
  6578. * Creates a plane from an origin point and a normal
  6579. * @param origin origin of the plane to be constructed
  6580. * @param normal normal of the plane to be constructed
  6581. * @returns a new Plane the normal vector to this plane at the given origin point.
  6582. * Note : the vector "normal" is updated because normalized.
  6583. */
  6584. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  6585. /**
  6586. * Calculates the distance from a plane and a point
  6587. * @param origin origin of the plane to be constructed
  6588. * @param normal normal of the plane to be constructed
  6589. * @param point point to calculate distance to
  6590. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  6591. */
  6592. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  6593. }
  6594. }
  6595. declare module "babylonjs/Culling/boundingSphere" {
  6596. import { DeepImmutable } from "babylonjs/types";
  6597. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6598. import { Plane } from "babylonjs/Maths/math.plane";
  6599. /**
  6600. * Class used to store bounding sphere information
  6601. */
  6602. export class BoundingSphere {
  6603. /**
  6604. * Gets the center of the bounding sphere in local space
  6605. */
  6606. readonly center: Vector3;
  6607. /**
  6608. * Radius of the bounding sphere in local space
  6609. */
  6610. radius: number;
  6611. /**
  6612. * Gets the center of the bounding sphere in world space
  6613. */
  6614. readonly centerWorld: Vector3;
  6615. /**
  6616. * Radius of the bounding sphere in world space
  6617. */
  6618. radiusWorld: number;
  6619. /**
  6620. * Gets the minimum vector in local space
  6621. */
  6622. readonly minimum: Vector3;
  6623. /**
  6624. * Gets the maximum vector in local space
  6625. */
  6626. readonly maximum: Vector3;
  6627. private _worldMatrix;
  6628. private static readonly TmpVector3;
  6629. /**
  6630. * Creates a new bounding sphere
  6631. * @param min defines the minimum vector (in local space)
  6632. * @param max defines the maximum vector (in local space)
  6633. * @param worldMatrix defines the new world matrix
  6634. */
  6635. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6636. /**
  6637. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6638. * @param min defines the new minimum vector (in local space)
  6639. * @param max defines the new maximum vector (in local space)
  6640. * @param worldMatrix defines the new world matrix
  6641. */
  6642. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6643. /**
  6644. * Scale the current bounding sphere by applying a scale factor
  6645. * @param factor defines the scale factor to apply
  6646. * @returns the current bounding box
  6647. */
  6648. scale(factor: number): BoundingSphere;
  6649. /**
  6650. * Gets the world matrix of the bounding box
  6651. * @returns a matrix
  6652. */
  6653. getWorldMatrix(): DeepImmutable<Matrix>;
  6654. /** @hidden */
  6655. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6656. /**
  6657. * Tests if the bounding sphere is intersecting the frustum planes
  6658. * @param frustumPlanes defines the frustum planes to test
  6659. * @returns true if there is an intersection
  6660. */
  6661. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6662. /**
  6663. * Tests if the bounding sphere center is in between the frustum planes.
  6664. * Used for optimistic fast inclusion.
  6665. * @param frustumPlanes defines the frustum planes to test
  6666. * @returns true if the sphere center is in between the frustum planes
  6667. */
  6668. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6669. /**
  6670. * Tests if a point is inside the bounding sphere
  6671. * @param point defines the point to test
  6672. * @returns true if the point is inside the bounding sphere
  6673. */
  6674. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6675. /**
  6676. * Checks if two sphere intersct
  6677. * @param sphere0 sphere 0
  6678. * @param sphere1 sphere 1
  6679. * @returns true if the speres intersect
  6680. */
  6681. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6682. }
  6683. }
  6684. declare module "babylonjs/Culling/boundingBox" {
  6685. import { DeepImmutable } from "babylonjs/types";
  6686. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6687. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6688. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6689. import { Plane } from "babylonjs/Maths/math.plane";
  6690. /**
  6691. * Class used to store bounding box information
  6692. */
  6693. export class BoundingBox implements ICullable {
  6694. /**
  6695. * Gets the 8 vectors representing the bounding box in local space
  6696. */
  6697. readonly vectors: Vector3[];
  6698. /**
  6699. * Gets the center of the bounding box in local space
  6700. */
  6701. readonly center: Vector3;
  6702. /**
  6703. * Gets the center of the bounding box in world space
  6704. */
  6705. readonly centerWorld: Vector3;
  6706. /**
  6707. * Gets the extend size in local space
  6708. */
  6709. readonly extendSize: Vector3;
  6710. /**
  6711. * Gets the extend size in world space
  6712. */
  6713. readonly extendSizeWorld: Vector3;
  6714. /**
  6715. * Gets the OBB (object bounding box) directions
  6716. */
  6717. readonly directions: Vector3[];
  6718. /**
  6719. * Gets the 8 vectors representing the bounding box in world space
  6720. */
  6721. readonly vectorsWorld: Vector3[];
  6722. /**
  6723. * Gets the minimum vector in world space
  6724. */
  6725. readonly minimumWorld: Vector3;
  6726. /**
  6727. * Gets the maximum vector in world space
  6728. */
  6729. readonly maximumWorld: Vector3;
  6730. /**
  6731. * Gets the minimum vector in local space
  6732. */
  6733. readonly minimum: Vector3;
  6734. /**
  6735. * Gets the maximum vector in local space
  6736. */
  6737. readonly maximum: Vector3;
  6738. private _worldMatrix;
  6739. private static readonly TmpVector3;
  6740. /**
  6741. * @hidden
  6742. */
  6743. _tag: number;
  6744. /**
  6745. * Creates a new bounding box
  6746. * @param min defines the minimum vector (in local space)
  6747. * @param max defines the maximum vector (in local space)
  6748. * @param worldMatrix defines the new world matrix
  6749. */
  6750. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6751. /**
  6752. * Recreates the entire bounding box from scratch as if we call the constructor in place
  6753. * @param min defines the new minimum vector (in local space)
  6754. * @param max defines the new maximum vector (in local space)
  6755. * @param worldMatrix defines the new world matrix
  6756. */
  6757. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6758. /**
  6759. * Scale the current bounding box by applying a scale factor
  6760. * @param factor defines the scale factor to apply
  6761. * @returns the current bounding box
  6762. */
  6763. scale(factor: number): BoundingBox;
  6764. /**
  6765. * Gets the world matrix of the bounding box
  6766. * @returns a matrix
  6767. */
  6768. getWorldMatrix(): DeepImmutable<Matrix>;
  6769. /** @hidden */
  6770. _update(world: DeepImmutable<Matrix>): void;
  6771. /**
  6772. * Tests if the bounding box is intersecting the frustum planes
  6773. * @param frustumPlanes defines the frustum planes to test
  6774. * @returns true if there is an intersection
  6775. */
  6776. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6777. /**
  6778. * Tests if the bounding box is entirely inside the frustum planes
  6779. * @param frustumPlanes defines the frustum planes to test
  6780. * @returns true if there is an inclusion
  6781. */
  6782. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6783. /**
  6784. * Tests if a point is inside the bounding box
  6785. * @param point defines the point to test
  6786. * @returns true if the point is inside the bounding box
  6787. */
  6788. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6789. /**
  6790. * Tests if the bounding box intersects with a bounding sphere
  6791. * @param sphere defines the sphere to test
  6792. * @returns true if there is an intersection
  6793. */
  6794. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  6795. /**
  6796. * Tests if the bounding box intersects with a box defined by a min and max vectors
  6797. * @param min defines the min vector to use
  6798. * @param max defines the max vector to use
  6799. * @returns true if there is an intersection
  6800. */
  6801. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  6802. /**
  6803. * Tests if two bounding boxes are intersections
  6804. * @param box0 defines the first box to test
  6805. * @param box1 defines the second box to test
  6806. * @returns true if there is an intersection
  6807. */
  6808. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  6809. /**
  6810. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  6811. * @param minPoint defines the minimum vector of the bounding box
  6812. * @param maxPoint defines the maximum vector of the bounding box
  6813. * @param sphereCenter defines the sphere center
  6814. * @param sphereRadius defines the sphere radius
  6815. * @returns true if there is an intersection
  6816. */
  6817. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  6818. /**
  6819. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  6820. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  6821. * @param frustumPlanes defines the frustum planes to test
  6822. * @return true if there is an inclusion
  6823. */
  6824. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6825. /**
  6826. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  6827. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  6828. * @param frustumPlanes defines the frustum planes to test
  6829. * @return true if there is an intersection
  6830. */
  6831. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6832. }
  6833. }
  6834. declare module "babylonjs/Collisions/collider" {
  6835. import { Nullable, IndicesArray } from "babylonjs/types";
  6836. import { Vector3 } from "babylonjs/Maths/math.vector";
  6837. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  6838. import { Plane } from "babylonjs/Maths/math.plane";
  6839. /** @hidden */
  6840. export class Collider {
  6841. /** Define if a collision was found */
  6842. collisionFound: boolean;
  6843. /**
  6844. * Define last intersection point in local space
  6845. */
  6846. intersectionPoint: Vector3;
  6847. /**
  6848. * Define last collided mesh
  6849. */
  6850. collidedMesh: Nullable<AbstractMesh>;
  6851. private _collisionPoint;
  6852. private _planeIntersectionPoint;
  6853. private _tempVector;
  6854. private _tempVector2;
  6855. private _tempVector3;
  6856. private _tempVector4;
  6857. private _edge;
  6858. private _baseToVertex;
  6859. private _destinationPoint;
  6860. private _slidePlaneNormal;
  6861. private _displacementVector;
  6862. /** @hidden */
  6863. _radius: Vector3;
  6864. /** @hidden */
  6865. _retry: number;
  6866. private _velocity;
  6867. private _basePoint;
  6868. private _epsilon;
  6869. /** @hidden */
  6870. _velocityWorldLength: number;
  6871. /** @hidden */
  6872. _basePointWorld: Vector3;
  6873. private _velocityWorld;
  6874. private _normalizedVelocity;
  6875. /** @hidden */
  6876. _initialVelocity: Vector3;
  6877. /** @hidden */
  6878. _initialPosition: Vector3;
  6879. private _nearestDistance;
  6880. private _collisionMask;
  6881. collisionMask: number;
  6882. /**
  6883. * Gets the plane normal used to compute the sliding response (in local space)
  6884. */
  6885. readonly slidePlaneNormal: Vector3;
  6886. /** @hidden */
  6887. _initialize(source: Vector3, dir: Vector3, e: number): void;
  6888. /** @hidden */
  6889. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  6890. /** @hidden */
  6891. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  6892. /** @hidden */
  6893. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  6894. /** @hidden */
  6895. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  6896. /** @hidden */
  6897. _getResponse(pos: Vector3, vel: Vector3): void;
  6898. }
  6899. }
  6900. declare module "babylonjs/Culling/boundingInfo" {
  6901. import { DeepImmutable } from "babylonjs/types";
  6902. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6903. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  6904. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6905. import { Plane } from "babylonjs/Maths/math.plane";
  6906. import { Collider } from "babylonjs/Collisions/collider";
  6907. /**
  6908. * Interface for cullable objects
  6909. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  6910. */
  6911. export interface ICullable {
  6912. /**
  6913. * Checks if the object or part of the object is in the frustum
  6914. * @param frustumPlanes Camera near/planes
  6915. * @returns true if the object is in frustum otherwise false
  6916. */
  6917. isInFrustum(frustumPlanes: Plane[]): boolean;
  6918. /**
  6919. * Checks if a cullable object (mesh...) is in the camera frustum
  6920. * Unlike isInFrustum this cheks the full bounding box
  6921. * @param frustumPlanes Camera near/planes
  6922. * @returns true if the object is in frustum otherwise false
  6923. */
  6924. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  6925. }
  6926. /**
  6927. * Info for a bounding data of a mesh
  6928. */
  6929. export class BoundingInfo implements ICullable {
  6930. /**
  6931. * Bounding box for the mesh
  6932. */
  6933. readonly boundingBox: BoundingBox;
  6934. /**
  6935. * Bounding sphere for the mesh
  6936. */
  6937. readonly boundingSphere: BoundingSphere;
  6938. private _isLocked;
  6939. private static readonly TmpVector3;
  6940. /**
  6941. * Constructs bounding info
  6942. * @param minimum min vector of the bounding box/sphere
  6943. * @param maximum max vector of the bounding box/sphere
  6944. * @param worldMatrix defines the new world matrix
  6945. */
  6946. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6947. /**
  6948. * Recreates the entire bounding info from scratch as if we call the constructor in place
  6949. * @param min defines the new minimum vector (in local space)
  6950. * @param max defines the new maximum vector (in local space)
  6951. * @param worldMatrix defines the new world matrix
  6952. */
  6953. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6954. /**
  6955. * min vector of the bounding box/sphere
  6956. */
  6957. readonly minimum: Vector3;
  6958. /**
  6959. * max vector of the bounding box/sphere
  6960. */
  6961. readonly maximum: Vector3;
  6962. /**
  6963. * If the info is locked and won't be updated to avoid perf overhead
  6964. */
  6965. isLocked: boolean;
  6966. /**
  6967. * Updates the bounding sphere and box
  6968. * @param world world matrix to be used to update
  6969. */
  6970. update(world: DeepImmutable<Matrix>): void;
  6971. /**
  6972. * Recreate the bounding info to be centered around a specific point given a specific extend.
  6973. * @param center New center of the bounding info
  6974. * @param extend New extend of the bounding info
  6975. * @returns the current bounding info
  6976. */
  6977. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  6978. /**
  6979. * Scale the current bounding info by applying a scale factor
  6980. * @param factor defines the scale factor to apply
  6981. * @returns the current bounding info
  6982. */
  6983. scale(factor: number): BoundingInfo;
  6984. /**
  6985. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  6986. * @param frustumPlanes defines the frustum to test
  6987. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  6988. * @returns true if the bounding info is in the frustum planes
  6989. */
  6990. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  6991. /**
  6992. * Gets the world distance between the min and max points of the bounding box
  6993. */
  6994. readonly diagonalLength: number;
  6995. /**
  6996. * Checks if a cullable object (mesh...) is in the camera frustum
  6997. * Unlike isInFrustum this cheks the full bounding box
  6998. * @param frustumPlanes Camera near/planes
  6999. * @returns true if the object is in frustum otherwise false
  7000. */
  7001. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7002. /** @hidden */
  7003. _checkCollision(collider: Collider): boolean;
  7004. /**
  7005. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7006. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7007. * @param point the point to check intersection with
  7008. * @returns if the point intersects
  7009. */
  7010. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7011. /**
  7012. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7013. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7014. * @param boundingInfo the bounding info to check intersection with
  7015. * @param precise if the intersection should be done using OBB
  7016. * @returns if the bounding info intersects
  7017. */
  7018. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7019. }
  7020. }
  7021. declare module "babylonjs/Maths/math.functions" {
  7022. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7023. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7024. /**
  7025. * Extracts minimum and maximum values from a list of indexed positions
  7026. * @param positions defines the positions to use
  7027. * @param indices defines the indices to the positions
  7028. * @param indexStart defines the start index
  7029. * @param indexCount defines the end index
  7030. * @param bias defines bias value to add to the result
  7031. * @return minimum and maximum values
  7032. */
  7033. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7034. minimum: Vector3;
  7035. maximum: Vector3;
  7036. };
  7037. /**
  7038. * Extracts minimum and maximum values from a list of positions
  7039. * @param positions defines the positions to use
  7040. * @param start defines the start index in the positions array
  7041. * @param count defines the number of positions to handle
  7042. * @param bias defines bias value to add to the result
  7043. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7044. * @return minimum and maximum values
  7045. */
  7046. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7047. minimum: Vector3;
  7048. maximum: Vector3;
  7049. };
  7050. }
  7051. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7052. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7053. /** @hidden */
  7054. export class WebGLDataBuffer extends DataBuffer {
  7055. private _buffer;
  7056. constructor(resource: WebGLBuffer);
  7057. readonly underlyingResource: any;
  7058. }
  7059. }
  7060. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7061. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7062. import { Nullable } from "babylonjs/types";
  7063. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7064. /** @hidden */
  7065. export class WebGLPipelineContext implements IPipelineContext {
  7066. engine: ThinEngine;
  7067. program: Nullable<WebGLProgram>;
  7068. context?: WebGLRenderingContext;
  7069. vertexShader?: WebGLShader;
  7070. fragmentShader?: WebGLShader;
  7071. isParallelCompiled: boolean;
  7072. onCompiled?: () => void;
  7073. transformFeedback?: WebGLTransformFeedback | null;
  7074. readonly isAsync: boolean;
  7075. readonly isReady: boolean;
  7076. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7077. }
  7078. }
  7079. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7080. import { FloatArray, Nullable } from "babylonjs/types";
  7081. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7082. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7083. module "babylonjs/Engines/thinEngine" {
  7084. interface ThinEngine {
  7085. /**
  7086. * Create an uniform buffer
  7087. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7088. * @param elements defines the content of the uniform buffer
  7089. * @returns the webGL uniform buffer
  7090. */
  7091. createUniformBuffer(elements: FloatArray): DataBuffer;
  7092. /**
  7093. * Create a dynamic uniform buffer
  7094. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7095. * @param elements defines the content of the uniform buffer
  7096. * @returns the webGL uniform buffer
  7097. */
  7098. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7099. /**
  7100. * Update an existing uniform buffer
  7101. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7102. * @param uniformBuffer defines the target uniform buffer
  7103. * @param elements defines the content to update
  7104. * @param offset defines the offset in the uniform buffer where update should start
  7105. * @param count defines the size of the data to update
  7106. */
  7107. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7108. /**
  7109. * Bind an uniform buffer to the current webGL context
  7110. * @param buffer defines the buffer to bind
  7111. */
  7112. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7113. /**
  7114. * Bind a buffer to the current webGL context at a given location
  7115. * @param buffer defines the buffer to bind
  7116. * @param location defines the index where to bind the buffer
  7117. */
  7118. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7119. /**
  7120. * Bind a specific block at a given index in a specific shader program
  7121. * @param pipelineContext defines the pipeline context to use
  7122. * @param blockName defines the block name
  7123. * @param index defines the index where to bind the block
  7124. */
  7125. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7126. }
  7127. }
  7128. }
  7129. declare module "babylonjs/Materials/uniformBuffer" {
  7130. import { Nullable, FloatArray } from "babylonjs/types";
  7131. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7132. import { Engine } from "babylonjs/Engines/engine";
  7133. import { Effect } from "babylonjs/Materials/effect";
  7134. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7135. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7136. import { Color3 } from "babylonjs/Maths/math.color";
  7137. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7138. /**
  7139. * Uniform buffer objects.
  7140. *
  7141. * Handles blocks of uniform on the GPU.
  7142. *
  7143. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7144. *
  7145. * For more information, please refer to :
  7146. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7147. */
  7148. export class UniformBuffer {
  7149. private _engine;
  7150. private _buffer;
  7151. private _data;
  7152. private _bufferData;
  7153. private _dynamic?;
  7154. private _uniformLocations;
  7155. private _uniformSizes;
  7156. private _uniformLocationPointer;
  7157. private _needSync;
  7158. private _noUBO;
  7159. private _currentEffect;
  7160. /** @hidden */
  7161. _alreadyBound: boolean;
  7162. private static _MAX_UNIFORM_SIZE;
  7163. private static _tempBuffer;
  7164. /**
  7165. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7166. * This is dynamic to allow compat with webgl 1 and 2.
  7167. * You will need to pass the name of the uniform as well as the value.
  7168. */
  7169. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7170. /**
  7171. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7172. * This is dynamic to allow compat with webgl 1 and 2.
  7173. * You will need to pass the name of the uniform as well as the value.
  7174. */
  7175. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7176. /**
  7177. * Lambda to Update a single float in a uniform buffer.
  7178. * This is dynamic to allow compat with webgl 1 and 2.
  7179. * You will need to pass the name of the uniform as well as the value.
  7180. */
  7181. updateFloat: (name: string, x: number) => void;
  7182. /**
  7183. * Lambda to Update a vec2 of float in a uniform buffer.
  7184. * This is dynamic to allow compat with webgl 1 and 2.
  7185. * You will need to pass the name of the uniform as well as the value.
  7186. */
  7187. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7188. /**
  7189. * Lambda to Update a vec3 of float in a uniform buffer.
  7190. * This is dynamic to allow compat with webgl 1 and 2.
  7191. * You will need to pass the name of the uniform as well as the value.
  7192. */
  7193. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7194. /**
  7195. * Lambda to Update a vec4 of float in a uniform buffer.
  7196. * This is dynamic to allow compat with webgl 1 and 2.
  7197. * You will need to pass the name of the uniform as well as the value.
  7198. */
  7199. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7200. /**
  7201. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7202. * This is dynamic to allow compat with webgl 1 and 2.
  7203. * You will need to pass the name of the uniform as well as the value.
  7204. */
  7205. updateMatrix: (name: string, mat: Matrix) => void;
  7206. /**
  7207. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7208. * This is dynamic to allow compat with webgl 1 and 2.
  7209. * You will need to pass the name of the uniform as well as the value.
  7210. */
  7211. updateVector3: (name: string, vector: Vector3) => void;
  7212. /**
  7213. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7214. * This is dynamic to allow compat with webgl 1 and 2.
  7215. * You will need to pass the name of the uniform as well as the value.
  7216. */
  7217. updateVector4: (name: string, vector: Vector4) => void;
  7218. /**
  7219. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7220. * This is dynamic to allow compat with webgl 1 and 2.
  7221. * You will need to pass the name of the uniform as well as the value.
  7222. */
  7223. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7224. /**
  7225. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7226. * This is dynamic to allow compat with webgl 1 and 2.
  7227. * You will need to pass the name of the uniform as well as the value.
  7228. */
  7229. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7230. /**
  7231. * Instantiates a new Uniform buffer objects.
  7232. *
  7233. * Handles blocks of uniform on the GPU.
  7234. *
  7235. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7236. *
  7237. * For more information, please refer to :
  7238. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7239. * @param engine Define the engine the buffer is associated with
  7240. * @param data Define the data contained in the buffer
  7241. * @param dynamic Define if the buffer is updatable
  7242. */
  7243. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7244. /**
  7245. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7246. * or just falling back on setUniformXXX calls.
  7247. */
  7248. readonly useUbo: boolean;
  7249. /**
  7250. * Indicates if the WebGL underlying uniform buffer is in sync
  7251. * with the javascript cache data.
  7252. */
  7253. readonly isSync: boolean;
  7254. /**
  7255. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7256. * Also, a dynamic UniformBuffer will disable cache verification and always
  7257. * update the underlying WebGL uniform buffer to the GPU.
  7258. * @returns if Dynamic, otherwise false
  7259. */
  7260. isDynamic(): boolean;
  7261. /**
  7262. * The data cache on JS side.
  7263. * @returns the underlying data as a float array
  7264. */
  7265. getData(): Float32Array;
  7266. /**
  7267. * The underlying WebGL Uniform buffer.
  7268. * @returns the webgl buffer
  7269. */
  7270. getBuffer(): Nullable<DataBuffer>;
  7271. /**
  7272. * std140 layout specifies how to align data within an UBO structure.
  7273. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7274. * for specs.
  7275. */
  7276. private _fillAlignment;
  7277. /**
  7278. * Adds an uniform in the buffer.
  7279. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7280. * for the layout to be correct !
  7281. * @param name Name of the uniform, as used in the uniform block in the shader.
  7282. * @param size Data size, or data directly.
  7283. */
  7284. addUniform(name: string, size: number | number[]): void;
  7285. /**
  7286. * Adds a Matrix 4x4 to the uniform buffer.
  7287. * @param name Name of the uniform, as used in the uniform block in the shader.
  7288. * @param mat A 4x4 matrix.
  7289. */
  7290. addMatrix(name: string, mat: Matrix): void;
  7291. /**
  7292. * Adds a vec2 to the uniform buffer.
  7293. * @param name Name of the uniform, as used in the uniform block in the shader.
  7294. * @param x Define the x component value of the vec2
  7295. * @param y Define the y component value of the vec2
  7296. */
  7297. addFloat2(name: string, x: number, y: number): void;
  7298. /**
  7299. * Adds a vec3 to the uniform buffer.
  7300. * @param name Name of the uniform, as used in the uniform block in the shader.
  7301. * @param x Define the x component value of the vec3
  7302. * @param y Define the y component value of the vec3
  7303. * @param z Define the z component value of the vec3
  7304. */
  7305. addFloat3(name: string, x: number, y: number, z: number): void;
  7306. /**
  7307. * Adds a vec3 to the uniform buffer.
  7308. * @param name Name of the uniform, as used in the uniform block in the shader.
  7309. * @param color Define the vec3 from a Color
  7310. */
  7311. addColor3(name: string, color: Color3): void;
  7312. /**
  7313. * Adds a vec4 to the uniform buffer.
  7314. * @param name Name of the uniform, as used in the uniform block in the shader.
  7315. * @param color Define the rgb components from a Color
  7316. * @param alpha Define the a component of the vec4
  7317. */
  7318. addColor4(name: string, color: Color3, alpha: number): void;
  7319. /**
  7320. * Adds a vec3 to the uniform buffer.
  7321. * @param name Name of the uniform, as used in the uniform block in the shader.
  7322. * @param vector Define the vec3 components from a Vector
  7323. */
  7324. addVector3(name: string, vector: Vector3): void;
  7325. /**
  7326. * Adds a Matrix 3x3 to the uniform buffer.
  7327. * @param name Name of the uniform, as used in the uniform block in the shader.
  7328. */
  7329. addMatrix3x3(name: string): void;
  7330. /**
  7331. * Adds a Matrix 2x2 to the uniform buffer.
  7332. * @param name Name of the uniform, as used in the uniform block in the shader.
  7333. */
  7334. addMatrix2x2(name: string): void;
  7335. /**
  7336. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7337. */
  7338. create(): void;
  7339. /** @hidden */
  7340. _rebuild(): void;
  7341. /**
  7342. * Updates the WebGL Uniform Buffer on the GPU.
  7343. * If the `dynamic` flag is set to true, no cache comparison is done.
  7344. * Otherwise, the buffer will be updated only if the cache differs.
  7345. */
  7346. update(): void;
  7347. /**
  7348. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7349. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7350. * @param data Define the flattened data
  7351. * @param size Define the size of the data.
  7352. */
  7353. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7354. private _valueCache;
  7355. private _cacheMatrix;
  7356. private _updateMatrix3x3ForUniform;
  7357. private _updateMatrix3x3ForEffect;
  7358. private _updateMatrix2x2ForEffect;
  7359. private _updateMatrix2x2ForUniform;
  7360. private _updateFloatForEffect;
  7361. private _updateFloatForUniform;
  7362. private _updateFloat2ForEffect;
  7363. private _updateFloat2ForUniform;
  7364. private _updateFloat3ForEffect;
  7365. private _updateFloat3ForUniform;
  7366. private _updateFloat4ForEffect;
  7367. private _updateFloat4ForUniform;
  7368. private _updateMatrixForEffect;
  7369. private _updateMatrixForUniform;
  7370. private _updateVector3ForEffect;
  7371. private _updateVector3ForUniform;
  7372. private _updateVector4ForEffect;
  7373. private _updateVector4ForUniform;
  7374. private _updateColor3ForEffect;
  7375. private _updateColor3ForUniform;
  7376. private _updateColor4ForEffect;
  7377. private _updateColor4ForUniform;
  7378. /**
  7379. * Sets a sampler uniform on the effect.
  7380. * @param name Define the name of the sampler.
  7381. * @param texture Define the texture to set in the sampler
  7382. */
  7383. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7384. /**
  7385. * Directly updates the value of the uniform in the cache AND on the GPU.
  7386. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7387. * @param data Define the flattened data
  7388. */
  7389. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7390. /**
  7391. * Binds this uniform buffer to an effect.
  7392. * @param effect Define the effect to bind the buffer to
  7393. * @param name Name of the uniform block in the shader.
  7394. */
  7395. bindToEffect(effect: Effect, name: string): void;
  7396. /**
  7397. * Disposes the uniform buffer.
  7398. */
  7399. dispose(): void;
  7400. }
  7401. }
  7402. declare module "babylonjs/Misc/iInspectable" {
  7403. /**
  7404. * Enum that determines the text-wrapping mode to use.
  7405. */
  7406. export enum InspectableType {
  7407. /**
  7408. * Checkbox for booleans
  7409. */
  7410. Checkbox = 0,
  7411. /**
  7412. * Sliders for numbers
  7413. */
  7414. Slider = 1,
  7415. /**
  7416. * Vector3
  7417. */
  7418. Vector3 = 2,
  7419. /**
  7420. * Quaternions
  7421. */
  7422. Quaternion = 3,
  7423. /**
  7424. * Color3
  7425. */
  7426. Color3 = 4,
  7427. /**
  7428. * String
  7429. */
  7430. String = 5
  7431. }
  7432. /**
  7433. * Interface used to define custom inspectable properties.
  7434. * This interface is used by the inspector to display custom property grids
  7435. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7436. */
  7437. export interface IInspectable {
  7438. /**
  7439. * Gets the label to display
  7440. */
  7441. label: string;
  7442. /**
  7443. * Gets the name of the property to edit
  7444. */
  7445. propertyName: string;
  7446. /**
  7447. * Gets the type of the editor to use
  7448. */
  7449. type: InspectableType;
  7450. /**
  7451. * Gets the minimum value of the property when using in "slider" mode
  7452. */
  7453. min?: number;
  7454. /**
  7455. * Gets the maximum value of the property when using in "slider" mode
  7456. */
  7457. max?: number;
  7458. /**
  7459. * Gets the setp to use when using in "slider" mode
  7460. */
  7461. step?: number;
  7462. }
  7463. }
  7464. declare module "babylonjs/Misc/timingTools" {
  7465. /**
  7466. * Class used to provide helper for timing
  7467. */
  7468. export class TimingTools {
  7469. /**
  7470. * Polyfill for setImmediate
  7471. * @param action defines the action to execute after the current execution block
  7472. */
  7473. static SetImmediate(action: () => void): void;
  7474. }
  7475. }
  7476. declare module "babylonjs/Misc/instantiationTools" {
  7477. /**
  7478. * Class used to enable instatition of objects by class name
  7479. */
  7480. export class InstantiationTools {
  7481. /**
  7482. * Use this object to register external classes like custom textures or material
  7483. * to allow the laoders to instantiate them
  7484. */
  7485. static RegisteredExternalClasses: {
  7486. [key: string]: Object;
  7487. };
  7488. /**
  7489. * Tries to instantiate a new object from a given class name
  7490. * @param className defines the class name to instantiate
  7491. * @returns the new object or null if the system was not able to do the instantiation
  7492. */
  7493. static Instantiate(className: string): any;
  7494. }
  7495. }
  7496. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7497. /**
  7498. * Define options used to create a depth texture
  7499. */
  7500. export class DepthTextureCreationOptions {
  7501. /** Specifies whether or not a stencil should be allocated in the texture */
  7502. generateStencil?: boolean;
  7503. /** Specifies whether or not bilinear filtering is enable on the texture */
  7504. bilinearFiltering?: boolean;
  7505. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7506. comparisonFunction?: number;
  7507. /** Specifies if the created texture is a cube texture */
  7508. isCube?: boolean;
  7509. }
  7510. }
  7511. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7512. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7513. import { Nullable } from "babylonjs/types";
  7514. import { Scene } from "babylonjs/scene";
  7515. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  7516. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7517. module "babylonjs/Engines/thinEngine" {
  7518. interface ThinEngine {
  7519. /**
  7520. * Creates a depth stencil cube texture.
  7521. * This is only available in WebGL 2.
  7522. * @param size The size of face edge in the cube texture.
  7523. * @param options The options defining the cube texture.
  7524. * @returns The cube texture
  7525. */
  7526. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7527. /**
  7528. * Creates a cube texture
  7529. * @param rootUrl defines the url where the files to load is located
  7530. * @param scene defines the current scene
  7531. * @param files defines the list of files to load (1 per face)
  7532. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7533. * @param onLoad defines an optional callback raised when the texture is loaded
  7534. * @param onError defines an optional callback raised if there is an issue to load the texture
  7535. * @param format defines the format of the data
  7536. * @param forcedExtension defines the extension to use to pick the right loader
  7537. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7538. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7539. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7540. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7541. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  7542. * @returns the cube texture as an InternalTexture
  7543. */
  7544. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>, excludeLoaders: Array<IInternalTextureLoader>): InternalTexture;
  7545. /**
  7546. * Creates a cube texture
  7547. * @param rootUrl defines the url where the files to load is located
  7548. * @param scene defines the current scene
  7549. * @param files defines the list of files to load (1 per face)
  7550. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7551. * @param onLoad defines an optional callback raised when the texture is loaded
  7552. * @param onError defines an optional callback raised if there is an issue to load the texture
  7553. * @param format defines the format of the data
  7554. * @param forcedExtension defines the extension to use to pick the right loader
  7555. * @returns the cube texture as an InternalTexture
  7556. */
  7557. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any): InternalTexture;
  7558. /**
  7559. * Creates a cube texture
  7560. * @param rootUrl defines the url where the files to load is located
  7561. * @param scene defines the current scene
  7562. * @param files defines the list of files to load (1 per face)
  7563. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7564. * @param onLoad defines an optional callback raised when the texture is loaded
  7565. * @param onError defines an optional callback raised if there is an issue to load the texture
  7566. * @param format defines the format of the data
  7567. * @param forcedExtension defines the extension to use to pick the right loader
  7568. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7569. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7570. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7571. * @returns the cube texture as an InternalTexture
  7572. */
  7573. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number): InternalTexture;
  7574. /** @hidden */
  7575. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7576. /** @hidden */
  7577. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7578. /** @hidden */
  7579. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7580. /** @hidden */
  7581. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7582. /**
  7583. * @hidden
  7584. */
  7585. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7586. }
  7587. }
  7588. }
  7589. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7590. import { Nullable } from "babylonjs/types";
  7591. import { Scene } from "babylonjs/scene";
  7592. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7593. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7594. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7595. /**
  7596. * Class for creating a cube texture
  7597. */
  7598. export class CubeTexture extends BaseTexture {
  7599. private _delayedOnLoad;
  7600. /**
  7601. * The url of the texture
  7602. */
  7603. url: string;
  7604. /**
  7605. * Gets or sets the center of the bounding box associated with the cube texture.
  7606. * It must define where the camera used to render the texture was set
  7607. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7608. */
  7609. boundingBoxPosition: Vector3;
  7610. private _boundingBoxSize;
  7611. /**
  7612. * Gets or sets the size of the bounding box associated with the cube texture
  7613. * When defined, the cubemap will switch to local mode
  7614. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7615. * @example https://www.babylonjs-playground.com/#RNASML
  7616. */
  7617. /**
  7618. * Returns the bounding box size
  7619. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7620. */
  7621. boundingBoxSize: Vector3;
  7622. protected _rotationY: number;
  7623. /**
  7624. * Sets texture matrix rotation angle around Y axis in radians.
  7625. */
  7626. /**
  7627. * Gets texture matrix rotation angle around Y axis radians.
  7628. */
  7629. rotationY: number;
  7630. /**
  7631. * Are mip maps generated for this texture or not.
  7632. */
  7633. readonly noMipmap: boolean;
  7634. private _noMipmap;
  7635. private _files;
  7636. protected _forcedExtension: Nullable<string>;
  7637. private _extensions;
  7638. private _textureMatrix;
  7639. private _format;
  7640. private _createPolynomials;
  7641. /** @hidden */
  7642. _prefiltered: boolean;
  7643. /**
  7644. * Creates a cube texture from an array of image urls
  7645. * @param files defines an array of image urls
  7646. * @param scene defines the hosting scene
  7647. * @param noMipmap specifies if mip maps are not used
  7648. * @returns a cube texture
  7649. */
  7650. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7651. /**
  7652. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7653. * @param url defines the url of the prefiltered texture
  7654. * @param scene defines the scene the texture is attached to
  7655. * @param forcedExtension defines the extension of the file if different from the url
  7656. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7657. * @return the prefiltered texture
  7658. */
  7659. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7660. /**
  7661. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7662. * as prefiltered data.
  7663. * @param rootUrl defines the url of the texture or the root name of the six images
  7664. * @param scene defines the scene the texture is attached to
  7665. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7666. * @param noMipmap defines if mipmaps should be created or not
  7667. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7668. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7669. * @param onError defines a callback triggered in case of error during load
  7670. * @param format defines the internal format to use for the texture once loaded
  7671. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7672. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7673. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7674. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7675. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7676. * @return the cube texture
  7677. */
  7678. constructor(rootUrl: string, scene: Scene, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  7679. /**
  7680. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  7681. */
  7682. readonly isPrefiltered: boolean;
  7683. /**
  7684. * Get the current class name of the texture useful for serialization or dynamic coding.
  7685. * @returns "CubeTexture"
  7686. */
  7687. getClassName(): string;
  7688. /**
  7689. * Update the url (and optional buffer) of this texture if url was null during construction.
  7690. * @param url the url of the texture
  7691. * @param forcedExtension defines the extension to use
  7692. * @param onLoad callback called when the texture is loaded (defaults to null)
  7693. */
  7694. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  7695. /**
  7696. * Delays loading of the cube texture
  7697. * @param forcedExtension defines the extension to use
  7698. */
  7699. delayLoad(forcedExtension?: string): void;
  7700. /**
  7701. * Returns the reflection texture matrix
  7702. * @returns the reflection texture matrix
  7703. */
  7704. getReflectionTextureMatrix(): Matrix;
  7705. /**
  7706. * Sets the reflection texture matrix
  7707. * @param value Reflection texture matrix
  7708. */
  7709. setReflectionTextureMatrix(value: Matrix): void;
  7710. /**
  7711. * Parses text to create a cube texture
  7712. * @param parsedTexture define the serialized text to read from
  7713. * @param scene defines the hosting scene
  7714. * @param rootUrl defines the root url of the cube texture
  7715. * @returns a cube texture
  7716. */
  7717. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  7718. /**
  7719. * Makes a clone, or deep copy, of the cube texture
  7720. * @returns a new cube texture
  7721. */
  7722. clone(): CubeTexture;
  7723. }
  7724. }
  7725. declare module "babylonjs/Materials/materialDefines" {
  7726. /**
  7727. * Manages the defines for the Material
  7728. */
  7729. export class MaterialDefines {
  7730. /** @hidden */
  7731. protected _keys: string[];
  7732. private _isDirty;
  7733. /** @hidden */
  7734. _renderId: number;
  7735. /** @hidden */
  7736. _areLightsDirty: boolean;
  7737. /** @hidden */
  7738. _areLightsDisposed: boolean;
  7739. /** @hidden */
  7740. _areAttributesDirty: boolean;
  7741. /** @hidden */
  7742. _areTexturesDirty: boolean;
  7743. /** @hidden */
  7744. _areFresnelDirty: boolean;
  7745. /** @hidden */
  7746. _areMiscDirty: boolean;
  7747. /** @hidden */
  7748. _areImageProcessingDirty: boolean;
  7749. /** @hidden */
  7750. _normals: boolean;
  7751. /** @hidden */
  7752. _uvs: boolean;
  7753. /** @hidden */
  7754. _needNormals: boolean;
  7755. /** @hidden */
  7756. _needUVs: boolean;
  7757. [id: string]: any;
  7758. /**
  7759. * Specifies if the material needs to be re-calculated
  7760. */
  7761. readonly isDirty: boolean;
  7762. /**
  7763. * Marks the material to indicate that it has been re-calculated
  7764. */
  7765. markAsProcessed(): void;
  7766. /**
  7767. * Marks the material to indicate that it needs to be re-calculated
  7768. */
  7769. markAsUnprocessed(): void;
  7770. /**
  7771. * Marks the material to indicate all of its defines need to be re-calculated
  7772. */
  7773. markAllAsDirty(): void;
  7774. /**
  7775. * Marks the material to indicate that image processing needs to be re-calculated
  7776. */
  7777. markAsImageProcessingDirty(): void;
  7778. /**
  7779. * Marks the material to indicate the lights need to be re-calculated
  7780. * @param disposed Defines whether the light is dirty due to dispose or not
  7781. */
  7782. markAsLightDirty(disposed?: boolean): void;
  7783. /**
  7784. * Marks the attribute state as changed
  7785. */
  7786. markAsAttributesDirty(): void;
  7787. /**
  7788. * Marks the texture state as changed
  7789. */
  7790. markAsTexturesDirty(): void;
  7791. /**
  7792. * Marks the fresnel state as changed
  7793. */
  7794. markAsFresnelDirty(): void;
  7795. /**
  7796. * Marks the misc state as changed
  7797. */
  7798. markAsMiscDirty(): void;
  7799. /**
  7800. * Rebuilds the material defines
  7801. */
  7802. rebuild(): void;
  7803. /**
  7804. * Specifies if two material defines are equal
  7805. * @param other - A material define instance to compare to
  7806. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  7807. */
  7808. isEqual(other: MaterialDefines): boolean;
  7809. /**
  7810. * Clones this instance's defines to another instance
  7811. * @param other - material defines to clone values to
  7812. */
  7813. cloneTo(other: MaterialDefines): void;
  7814. /**
  7815. * Resets the material define values
  7816. */
  7817. reset(): void;
  7818. /**
  7819. * Converts the material define values to a string
  7820. * @returns - String of material define information
  7821. */
  7822. toString(): string;
  7823. }
  7824. }
  7825. declare module "babylonjs/Materials/colorCurves" {
  7826. import { Effect } from "babylonjs/Materials/effect";
  7827. /**
  7828. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  7829. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  7830. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  7831. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  7832. */
  7833. export class ColorCurves {
  7834. private _dirty;
  7835. private _tempColor;
  7836. private _globalCurve;
  7837. private _highlightsCurve;
  7838. private _midtonesCurve;
  7839. private _shadowsCurve;
  7840. private _positiveCurve;
  7841. private _negativeCurve;
  7842. private _globalHue;
  7843. private _globalDensity;
  7844. private _globalSaturation;
  7845. private _globalExposure;
  7846. /**
  7847. * Gets the global Hue value.
  7848. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7849. */
  7850. /**
  7851. * Sets the global Hue value.
  7852. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7853. */
  7854. globalHue: number;
  7855. /**
  7856. * Gets the global Density value.
  7857. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7858. * Values less than zero provide a filter of opposite hue.
  7859. */
  7860. /**
  7861. * Sets the global Density value.
  7862. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7863. * Values less than zero provide a filter of opposite hue.
  7864. */
  7865. globalDensity: number;
  7866. /**
  7867. * Gets the global Saturation value.
  7868. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7869. */
  7870. /**
  7871. * Sets the global Saturation value.
  7872. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7873. */
  7874. globalSaturation: number;
  7875. /**
  7876. * Gets the global Exposure value.
  7877. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7878. */
  7879. /**
  7880. * Sets the global Exposure value.
  7881. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7882. */
  7883. globalExposure: number;
  7884. private _highlightsHue;
  7885. private _highlightsDensity;
  7886. private _highlightsSaturation;
  7887. private _highlightsExposure;
  7888. /**
  7889. * Gets the highlights Hue value.
  7890. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7891. */
  7892. /**
  7893. * Sets the highlights Hue value.
  7894. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7895. */
  7896. highlightsHue: number;
  7897. /**
  7898. * Gets the highlights Density value.
  7899. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7900. * Values less than zero provide a filter of opposite hue.
  7901. */
  7902. /**
  7903. * Sets the highlights Density value.
  7904. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7905. * Values less than zero provide a filter of opposite hue.
  7906. */
  7907. highlightsDensity: number;
  7908. /**
  7909. * Gets the highlights Saturation value.
  7910. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7911. */
  7912. /**
  7913. * Sets the highlights Saturation value.
  7914. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7915. */
  7916. highlightsSaturation: number;
  7917. /**
  7918. * Gets the highlights Exposure value.
  7919. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7920. */
  7921. /**
  7922. * Sets the highlights Exposure value.
  7923. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7924. */
  7925. highlightsExposure: number;
  7926. private _midtonesHue;
  7927. private _midtonesDensity;
  7928. private _midtonesSaturation;
  7929. private _midtonesExposure;
  7930. /**
  7931. * Gets the midtones Hue value.
  7932. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7933. */
  7934. /**
  7935. * Sets the midtones Hue value.
  7936. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7937. */
  7938. midtonesHue: number;
  7939. /**
  7940. * Gets the midtones Density value.
  7941. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7942. * Values less than zero provide a filter of opposite hue.
  7943. */
  7944. /**
  7945. * Sets the midtones Density value.
  7946. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7947. * Values less than zero provide a filter of opposite hue.
  7948. */
  7949. midtonesDensity: number;
  7950. /**
  7951. * Gets the midtones Saturation value.
  7952. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7953. */
  7954. /**
  7955. * Sets the midtones Saturation value.
  7956. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7957. */
  7958. midtonesSaturation: number;
  7959. /**
  7960. * Gets the midtones Exposure value.
  7961. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7962. */
  7963. /**
  7964. * Sets the midtones Exposure value.
  7965. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  7966. */
  7967. midtonesExposure: number;
  7968. private _shadowsHue;
  7969. private _shadowsDensity;
  7970. private _shadowsSaturation;
  7971. private _shadowsExposure;
  7972. /**
  7973. * Gets the shadows Hue value.
  7974. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7975. */
  7976. /**
  7977. * Sets the shadows Hue value.
  7978. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  7979. */
  7980. shadowsHue: number;
  7981. /**
  7982. * Gets the shadows Density value.
  7983. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7984. * Values less than zero provide a filter of opposite hue.
  7985. */
  7986. /**
  7987. * Sets the shadows Density value.
  7988. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  7989. * Values less than zero provide a filter of opposite hue.
  7990. */
  7991. shadowsDensity: number;
  7992. /**
  7993. * Gets the shadows Saturation value.
  7994. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7995. */
  7996. /**
  7997. * Sets the shadows Saturation value.
  7998. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7999. */
  8000. shadowsSaturation: number;
  8001. /**
  8002. * Gets the shadows Exposure value.
  8003. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8004. */
  8005. /**
  8006. * Sets the shadows Exposure value.
  8007. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8008. */
  8009. shadowsExposure: number;
  8010. /**
  8011. * Returns the class name
  8012. * @returns The class name
  8013. */
  8014. getClassName(): string;
  8015. /**
  8016. * Binds the color curves to the shader.
  8017. * @param colorCurves The color curve to bind
  8018. * @param effect The effect to bind to
  8019. * @param positiveUniform The positive uniform shader parameter
  8020. * @param neutralUniform The neutral uniform shader parameter
  8021. * @param negativeUniform The negative uniform shader parameter
  8022. */
  8023. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8024. /**
  8025. * Prepare the list of uniforms associated with the ColorCurves effects.
  8026. * @param uniformsList The list of uniforms used in the effect
  8027. */
  8028. static PrepareUniforms(uniformsList: string[]): void;
  8029. /**
  8030. * Returns color grading data based on a hue, density, saturation and exposure value.
  8031. * @param filterHue The hue of the color filter.
  8032. * @param filterDensity The density of the color filter.
  8033. * @param saturation The saturation.
  8034. * @param exposure The exposure.
  8035. * @param result The result data container.
  8036. */
  8037. private getColorGradingDataToRef;
  8038. /**
  8039. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8040. * @param value The input slider value in range [-100,100].
  8041. * @returns Adjusted value.
  8042. */
  8043. private static applyColorGradingSliderNonlinear;
  8044. /**
  8045. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8046. * @param hue The hue (H) input.
  8047. * @param saturation The saturation (S) input.
  8048. * @param brightness The brightness (B) input.
  8049. * @result An RGBA color represented as Vector4.
  8050. */
  8051. private static fromHSBToRef;
  8052. /**
  8053. * Returns a value clamped between min and max
  8054. * @param value The value to clamp
  8055. * @param min The minimum of value
  8056. * @param max The maximum of value
  8057. * @returns The clamped value.
  8058. */
  8059. private static clamp;
  8060. /**
  8061. * Clones the current color curve instance.
  8062. * @return The cloned curves
  8063. */
  8064. clone(): ColorCurves;
  8065. /**
  8066. * Serializes the current color curve instance to a json representation.
  8067. * @return a JSON representation
  8068. */
  8069. serialize(): any;
  8070. /**
  8071. * Parses the color curve from a json representation.
  8072. * @param source the JSON source to parse
  8073. * @return The parsed curves
  8074. */
  8075. static Parse(source: any): ColorCurves;
  8076. }
  8077. }
  8078. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8079. import { Observable } from "babylonjs/Misc/observable";
  8080. import { Nullable } from "babylonjs/types";
  8081. import { Color4 } from "babylonjs/Maths/math.color";
  8082. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8083. import { Effect } from "babylonjs/Materials/effect";
  8084. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8085. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8086. /**
  8087. * Interface to follow in your material defines to integrate easily the
  8088. * Image proccessing functions.
  8089. * @hidden
  8090. */
  8091. export interface IImageProcessingConfigurationDefines {
  8092. IMAGEPROCESSING: boolean;
  8093. VIGNETTE: boolean;
  8094. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8095. VIGNETTEBLENDMODEOPAQUE: boolean;
  8096. TONEMAPPING: boolean;
  8097. TONEMAPPING_ACES: boolean;
  8098. CONTRAST: boolean;
  8099. EXPOSURE: boolean;
  8100. COLORCURVES: boolean;
  8101. COLORGRADING: boolean;
  8102. COLORGRADING3D: boolean;
  8103. SAMPLER3DGREENDEPTH: boolean;
  8104. SAMPLER3DBGRMAP: boolean;
  8105. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8106. }
  8107. /**
  8108. * @hidden
  8109. */
  8110. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8111. IMAGEPROCESSING: boolean;
  8112. VIGNETTE: boolean;
  8113. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8114. VIGNETTEBLENDMODEOPAQUE: boolean;
  8115. TONEMAPPING: boolean;
  8116. TONEMAPPING_ACES: boolean;
  8117. CONTRAST: boolean;
  8118. COLORCURVES: boolean;
  8119. COLORGRADING: boolean;
  8120. COLORGRADING3D: boolean;
  8121. SAMPLER3DGREENDEPTH: boolean;
  8122. SAMPLER3DBGRMAP: boolean;
  8123. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8124. EXPOSURE: boolean;
  8125. constructor();
  8126. }
  8127. /**
  8128. * This groups together the common properties used for image processing either in direct forward pass
  8129. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8130. * or not.
  8131. */
  8132. export class ImageProcessingConfiguration {
  8133. /**
  8134. * Default tone mapping applied in BabylonJS.
  8135. */
  8136. static readonly TONEMAPPING_STANDARD: number;
  8137. /**
  8138. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8139. * to other engines rendering to increase portability.
  8140. */
  8141. static readonly TONEMAPPING_ACES: number;
  8142. /**
  8143. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8144. */
  8145. colorCurves: Nullable<ColorCurves>;
  8146. private _colorCurvesEnabled;
  8147. /**
  8148. * Gets wether the color curves effect is enabled.
  8149. */
  8150. /**
  8151. * Sets wether the color curves effect is enabled.
  8152. */
  8153. colorCurvesEnabled: boolean;
  8154. private _colorGradingTexture;
  8155. /**
  8156. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8157. */
  8158. /**
  8159. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8160. */
  8161. colorGradingTexture: Nullable<BaseTexture>;
  8162. private _colorGradingEnabled;
  8163. /**
  8164. * Gets wether the color grading effect is enabled.
  8165. */
  8166. /**
  8167. * Sets wether the color grading effect is enabled.
  8168. */
  8169. colorGradingEnabled: boolean;
  8170. private _colorGradingWithGreenDepth;
  8171. /**
  8172. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8173. */
  8174. /**
  8175. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8176. */
  8177. colorGradingWithGreenDepth: boolean;
  8178. private _colorGradingBGR;
  8179. /**
  8180. * Gets wether the color grading texture contains BGR values.
  8181. */
  8182. /**
  8183. * Sets wether the color grading texture contains BGR values.
  8184. */
  8185. colorGradingBGR: boolean;
  8186. /** @hidden */
  8187. _exposure: number;
  8188. /**
  8189. * Gets the Exposure used in the effect.
  8190. */
  8191. /**
  8192. * Sets the Exposure used in the effect.
  8193. */
  8194. exposure: number;
  8195. private _toneMappingEnabled;
  8196. /**
  8197. * Gets wether the tone mapping effect is enabled.
  8198. */
  8199. /**
  8200. * Sets wether the tone mapping effect is enabled.
  8201. */
  8202. toneMappingEnabled: boolean;
  8203. private _toneMappingType;
  8204. /**
  8205. * Gets the type of tone mapping effect.
  8206. */
  8207. /**
  8208. * Sets the type of tone mapping effect used in BabylonJS.
  8209. */
  8210. toneMappingType: number;
  8211. protected _contrast: number;
  8212. /**
  8213. * Gets the contrast used in the effect.
  8214. */
  8215. /**
  8216. * Sets the contrast used in the effect.
  8217. */
  8218. contrast: number;
  8219. /**
  8220. * Vignette stretch size.
  8221. */
  8222. vignetteStretch: number;
  8223. /**
  8224. * Vignette centre X Offset.
  8225. */
  8226. vignetteCentreX: number;
  8227. /**
  8228. * Vignette centre Y Offset.
  8229. */
  8230. vignetteCentreY: number;
  8231. /**
  8232. * Vignette weight or intensity of the vignette effect.
  8233. */
  8234. vignetteWeight: number;
  8235. /**
  8236. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8237. * if vignetteEnabled is set to true.
  8238. */
  8239. vignetteColor: Color4;
  8240. /**
  8241. * Camera field of view used by the Vignette effect.
  8242. */
  8243. vignetteCameraFov: number;
  8244. private _vignetteBlendMode;
  8245. /**
  8246. * Gets the vignette blend mode allowing different kind of effect.
  8247. */
  8248. /**
  8249. * Sets the vignette blend mode allowing different kind of effect.
  8250. */
  8251. vignetteBlendMode: number;
  8252. private _vignetteEnabled;
  8253. /**
  8254. * Gets wether the vignette effect is enabled.
  8255. */
  8256. /**
  8257. * Sets wether the vignette effect is enabled.
  8258. */
  8259. vignetteEnabled: boolean;
  8260. private _applyByPostProcess;
  8261. /**
  8262. * Gets wether the image processing is applied through a post process or not.
  8263. */
  8264. /**
  8265. * Sets wether the image processing is applied through a post process or not.
  8266. */
  8267. applyByPostProcess: boolean;
  8268. private _isEnabled;
  8269. /**
  8270. * Gets wether the image processing is enabled or not.
  8271. */
  8272. /**
  8273. * Sets wether the image processing is enabled or not.
  8274. */
  8275. isEnabled: boolean;
  8276. /**
  8277. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8278. */
  8279. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8280. /**
  8281. * Method called each time the image processing information changes requires to recompile the effect.
  8282. */
  8283. protected _updateParameters(): void;
  8284. /**
  8285. * Gets the current class name.
  8286. * @return "ImageProcessingConfiguration"
  8287. */
  8288. getClassName(): string;
  8289. /**
  8290. * Prepare the list of uniforms associated with the Image Processing effects.
  8291. * @param uniforms The list of uniforms used in the effect
  8292. * @param defines the list of defines currently in use
  8293. */
  8294. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8295. /**
  8296. * Prepare the list of samplers associated with the Image Processing effects.
  8297. * @param samplersList The list of uniforms used in the effect
  8298. * @param defines the list of defines currently in use
  8299. */
  8300. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8301. /**
  8302. * Prepare the list of defines associated to the shader.
  8303. * @param defines the list of defines to complete
  8304. * @param forPostProcess Define if we are currently in post process mode or not
  8305. */
  8306. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8307. /**
  8308. * Returns true if all the image processing information are ready.
  8309. * @returns True if ready, otherwise, false
  8310. */
  8311. isReady(): boolean;
  8312. /**
  8313. * Binds the image processing to the shader.
  8314. * @param effect The effect to bind to
  8315. * @param overrideAspectRatio Override the aspect ratio of the effect
  8316. */
  8317. bind(effect: Effect, overrideAspectRatio?: number): void;
  8318. /**
  8319. * Clones the current image processing instance.
  8320. * @return The cloned image processing
  8321. */
  8322. clone(): ImageProcessingConfiguration;
  8323. /**
  8324. * Serializes the current image processing instance to a json representation.
  8325. * @return a JSON representation
  8326. */
  8327. serialize(): any;
  8328. /**
  8329. * Parses the image processing from a json representation.
  8330. * @param source the JSON source to parse
  8331. * @return The parsed image processing
  8332. */
  8333. static Parse(source: any): ImageProcessingConfiguration;
  8334. private static _VIGNETTEMODE_MULTIPLY;
  8335. private static _VIGNETTEMODE_OPAQUE;
  8336. /**
  8337. * Used to apply the vignette as a mix with the pixel color.
  8338. */
  8339. static readonly VIGNETTEMODE_MULTIPLY: number;
  8340. /**
  8341. * Used to apply the vignette as a replacement of the pixel color.
  8342. */
  8343. static readonly VIGNETTEMODE_OPAQUE: number;
  8344. }
  8345. }
  8346. declare module "babylonjs/Shaders/postprocess.vertex" {
  8347. /** @hidden */
  8348. export var postprocessVertexShader: {
  8349. name: string;
  8350. shader: string;
  8351. };
  8352. }
  8353. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8354. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8355. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8356. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8357. module "babylonjs/Engines/thinEngine" {
  8358. interface ThinEngine {
  8359. /**
  8360. * Creates a new render target texture
  8361. * @param size defines the size of the texture
  8362. * @param options defines the options used to create the texture
  8363. * @returns a new render target texture stored in an InternalTexture
  8364. */
  8365. createRenderTargetTexture(size: number | {
  8366. width: number;
  8367. height: number;
  8368. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8369. /**
  8370. * Creates a depth stencil texture.
  8371. * This is only available in WebGL 2 or with the depth texture extension available.
  8372. * @param size The size of face edge in the texture.
  8373. * @param options The options defining the texture.
  8374. * @returns The texture
  8375. */
  8376. createDepthStencilTexture(size: number | {
  8377. width: number;
  8378. height: number;
  8379. }, options: DepthTextureCreationOptions): InternalTexture;
  8380. /** @hidden */
  8381. _createDepthStencilTexture(size: number | {
  8382. width: number;
  8383. height: number;
  8384. }, options: DepthTextureCreationOptions): InternalTexture;
  8385. }
  8386. }
  8387. }
  8388. declare module "babylonjs/Maths/math.axis" {
  8389. import { Vector3 } from "babylonjs/Maths/math.vector";
  8390. /** Defines supported spaces */
  8391. export enum Space {
  8392. /** Local (object) space */
  8393. LOCAL = 0,
  8394. /** World space */
  8395. WORLD = 1,
  8396. /** Bone space */
  8397. BONE = 2
  8398. }
  8399. /** Defines the 3 main axes */
  8400. export class Axis {
  8401. /** X axis */
  8402. static X: Vector3;
  8403. /** Y axis */
  8404. static Y: Vector3;
  8405. /** Z axis */
  8406. static Z: Vector3;
  8407. }
  8408. }
  8409. declare module "babylonjs/Cameras/targetCamera" {
  8410. import { Nullable } from "babylonjs/types";
  8411. import { Camera } from "babylonjs/Cameras/camera";
  8412. import { Scene } from "babylonjs/scene";
  8413. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8414. /**
  8415. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  8416. * This is the base of the follow, arc rotate cameras and Free camera
  8417. * @see http://doc.babylonjs.com/features/cameras
  8418. */
  8419. export class TargetCamera extends Camera {
  8420. private static _RigCamTransformMatrix;
  8421. private static _TargetTransformMatrix;
  8422. private static _TargetFocalPoint;
  8423. /**
  8424. * Define the current direction the camera is moving to
  8425. */
  8426. cameraDirection: Vector3;
  8427. /**
  8428. * Define the current rotation the camera is rotating to
  8429. */
  8430. cameraRotation: Vector2;
  8431. /**
  8432. * When set, the up vector of the camera will be updated by the rotation of the camera
  8433. */
  8434. updateUpVectorFromRotation: boolean;
  8435. private _tmpQuaternion;
  8436. /**
  8437. * Define the current rotation of the camera
  8438. */
  8439. rotation: Vector3;
  8440. /**
  8441. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  8442. */
  8443. rotationQuaternion: Quaternion;
  8444. /**
  8445. * Define the current speed of the camera
  8446. */
  8447. speed: number;
  8448. /**
  8449. * Add cconstraint to the camera to prevent it to move freely in all directions and
  8450. * around all axis.
  8451. */
  8452. noRotationConstraint: boolean;
  8453. /**
  8454. * Define the current target of the camera as an object or a position.
  8455. */
  8456. lockedTarget: any;
  8457. /** @hidden */
  8458. _currentTarget: Vector3;
  8459. /** @hidden */
  8460. _initialFocalDistance: number;
  8461. /** @hidden */
  8462. _viewMatrix: Matrix;
  8463. /** @hidden */
  8464. _camMatrix: Matrix;
  8465. /** @hidden */
  8466. _cameraTransformMatrix: Matrix;
  8467. /** @hidden */
  8468. _cameraRotationMatrix: Matrix;
  8469. /** @hidden */
  8470. _referencePoint: Vector3;
  8471. /** @hidden */
  8472. _transformedReferencePoint: Vector3;
  8473. protected _globalCurrentTarget: Vector3;
  8474. protected _globalCurrentUpVector: Vector3;
  8475. /** @hidden */
  8476. _reset: () => void;
  8477. private _defaultUp;
  8478. /**
  8479. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  8480. * This is the base of the follow, arc rotate cameras and Free camera
  8481. * @see http://doc.babylonjs.com/features/cameras
  8482. * @param name Defines the name of the camera in the scene
  8483. * @param position Defines the start position of the camera in the scene
  8484. * @param scene Defines the scene the camera belongs to
  8485. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  8486. */
  8487. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  8488. /**
  8489. * Gets the position in front of the camera at a given distance.
  8490. * @param distance The distance from the camera we want the position to be
  8491. * @returns the position
  8492. */
  8493. getFrontPosition(distance: number): Vector3;
  8494. /** @hidden */
  8495. _getLockedTargetPosition(): Nullable<Vector3>;
  8496. private _storedPosition;
  8497. private _storedRotation;
  8498. private _storedRotationQuaternion;
  8499. /**
  8500. * Store current camera state of the camera (fov, position, rotation, etc..)
  8501. * @returns the camera
  8502. */
  8503. storeState(): Camera;
  8504. /**
  8505. * Restored camera state. You must call storeState() first
  8506. * @returns whether it was successful or not
  8507. * @hidden
  8508. */
  8509. _restoreStateValues(): boolean;
  8510. /** @hidden */
  8511. _initCache(): void;
  8512. /** @hidden */
  8513. _updateCache(ignoreParentClass?: boolean): void;
  8514. /** @hidden */
  8515. _isSynchronizedViewMatrix(): boolean;
  8516. /** @hidden */
  8517. _computeLocalCameraSpeed(): number;
  8518. /**
  8519. * Defines the target the camera should look at.
  8520. * @param target Defines the new target as a Vector or a mesh
  8521. */
  8522. setTarget(target: Vector3): void;
  8523. /**
  8524. * Return the current target position of the camera. This value is expressed in local space.
  8525. * @returns the target position
  8526. */
  8527. getTarget(): Vector3;
  8528. /** @hidden */
  8529. _decideIfNeedsToMove(): boolean;
  8530. /** @hidden */
  8531. _updatePosition(): void;
  8532. /** @hidden */
  8533. _checkInputs(): void;
  8534. protected _updateCameraRotationMatrix(): void;
  8535. /**
  8536. * Update the up vector to apply the rotation of the camera (So if you changed the camera rotation.z this will let you update the up vector as well)
  8537. * @returns the current camera
  8538. */
  8539. private _rotateUpVectorWithCameraRotationMatrix;
  8540. private _cachedRotationZ;
  8541. private _cachedQuaternionRotationZ;
  8542. /** @hidden */
  8543. _getViewMatrix(): Matrix;
  8544. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  8545. /**
  8546. * @hidden
  8547. */
  8548. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  8549. /**
  8550. * @hidden
  8551. */
  8552. _updateRigCameras(): void;
  8553. private _getRigCamPositionAndTarget;
  8554. /**
  8555. * Gets the current object class name.
  8556. * @return the class name
  8557. */
  8558. getClassName(): string;
  8559. }
  8560. }
  8561. declare module "babylonjs/Events/keyboardEvents" {
  8562. /**
  8563. * Gather the list of keyboard event types as constants.
  8564. */
  8565. export class KeyboardEventTypes {
  8566. /**
  8567. * The keydown event is fired when a key becomes active (pressed).
  8568. */
  8569. static readonly KEYDOWN: number;
  8570. /**
  8571. * The keyup event is fired when a key has been released.
  8572. */
  8573. static readonly KEYUP: number;
  8574. }
  8575. /**
  8576. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8577. */
  8578. export class KeyboardInfo {
  8579. /**
  8580. * Defines the type of event (KeyboardEventTypes)
  8581. */
  8582. type: number;
  8583. /**
  8584. * Defines the related dom event
  8585. */
  8586. event: KeyboardEvent;
  8587. /**
  8588. * Instantiates a new keyboard info.
  8589. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8590. * @param type Defines the type of event (KeyboardEventTypes)
  8591. * @param event Defines the related dom event
  8592. */
  8593. constructor(
  8594. /**
  8595. * Defines the type of event (KeyboardEventTypes)
  8596. */
  8597. type: number,
  8598. /**
  8599. * Defines the related dom event
  8600. */
  8601. event: KeyboardEvent);
  8602. }
  8603. /**
  8604. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8605. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  8606. */
  8607. export class KeyboardInfoPre extends KeyboardInfo {
  8608. /**
  8609. * Defines the type of event (KeyboardEventTypes)
  8610. */
  8611. type: number;
  8612. /**
  8613. * Defines the related dom event
  8614. */
  8615. event: KeyboardEvent;
  8616. /**
  8617. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  8618. */
  8619. skipOnPointerObservable: boolean;
  8620. /**
  8621. * Instantiates a new keyboard pre info.
  8622. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8623. * @param type Defines the type of event (KeyboardEventTypes)
  8624. * @param event Defines the related dom event
  8625. */
  8626. constructor(
  8627. /**
  8628. * Defines the type of event (KeyboardEventTypes)
  8629. */
  8630. type: number,
  8631. /**
  8632. * Defines the related dom event
  8633. */
  8634. event: KeyboardEvent);
  8635. }
  8636. }
  8637. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  8638. import { Nullable } from "babylonjs/types";
  8639. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  8640. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  8641. /**
  8642. * Manage the keyboard inputs to control the movement of a free camera.
  8643. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  8644. */
  8645. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  8646. /**
  8647. * Defines the camera the input is attached to.
  8648. */
  8649. camera: FreeCamera;
  8650. /**
  8651. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  8652. */
  8653. keysUp: number[];
  8654. /**
  8655. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  8656. */
  8657. keysDown: number[];
  8658. /**
  8659. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  8660. */
  8661. keysLeft: number[];
  8662. /**
  8663. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  8664. */
  8665. keysRight: number[];
  8666. private _keys;
  8667. private _onCanvasBlurObserver;
  8668. private _onKeyboardObserver;
  8669. private _engine;
  8670. private _scene;
  8671. /**
  8672. * Attach the input controls to a specific dom element to get the input from.
  8673. * @param element Defines the element the controls should be listened from
  8674. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  8675. */
  8676. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  8677. /**
  8678. * Detach the current controls from the specified dom element.
  8679. * @param element Defines the element to stop listening the inputs from
  8680. */
  8681. detachControl(element: Nullable<HTMLElement>): void;
  8682. /**
  8683. * Update the current camera state depending on the inputs that have been used this frame.
  8684. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  8685. */
  8686. checkInputs(): void;
  8687. /**
  8688. * Gets the class name of the current intput.
  8689. * @returns the class name
  8690. */
  8691. getClassName(): string;
  8692. /** @hidden */
  8693. _onLostFocus(): void;
  8694. /**
  8695. * Get the friendly name associated with the input class.
  8696. * @returns the input friendly name
  8697. */
  8698. getSimpleName(): string;
  8699. }
  8700. }
  8701. declare module "babylonjs/Lights/shadowLight" {
  8702. import { Camera } from "babylonjs/Cameras/camera";
  8703. import { Scene } from "babylonjs/scene";
  8704. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  8705. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8706. import { Light } from "babylonjs/Lights/light";
  8707. /**
  8708. * Interface describing all the common properties and methods a shadow light needs to implement.
  8709. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  8710. * as well as binding the different shadow properties to the effects.
  8711. */
  8712. export interface IShadowLight extends Light {
  8713. /**
  8714. * The light id in the scene (used in scene.findLighById for instance)
  8715. */
  8716. id: string;
  8717. /**
  8718. * The position the shdow will be casted from.
  8719. */
  8720. position: Vector3;
  8721. /**
  8722. * In 2d mode (needCube being false), the direction used to cast the shadow.
  8723. */
  8724. direction: Vector3;
  8725. /**
  8726. * The transformed position. Position of the light in world space taking parenting in account.
  8727. */
  8728. transformedPosition: Vector3;
  8729. /**
  8730. * The transformed direction. Direction of the light in world space taking parenting in account.
  8731. */
  8732. transformedDirection: Vector3;
  8733. /**
  8734. * The friendly name of the light in the scene.
  8735. */
  8736. name: string;
  8737. /**
  8738. * Defines the shadow projection clipping minimum z value.
  8739. */
  8740. shadowMinZ: number;
  8741. /**
  8742. * Defines the shadow projection clipping maximum z value.
  8743. */
  8744. shadowMaxZ: number;
  8745. /**
  8746. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8747. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8748. */
  8749. computeTransformedInformation(): boolean;
  8750. /**
  8751. * Gets the scene the light belongs to.
  8752. * @returns The scene
  8753. */
  8754. getScene(): Scene;
  8755. /**
  8756. * Callback defining a custom Projection Matrix Builder.
  8757. * This can be used to override the default projection matrix computation.
  8758. */
  8759. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8760. /**
  8761. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8762. * @param matrix The materix to updated with the projection information
  8763. * @param viewMatrix The transform matrix of the light
  8764. * @param renderList The list of mesh to render in the map
  8765. * @returns The current light
  8766. */
  8767. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8768. /**
  8769. * Gets the current depth scale used in ESM.
  8770. * @returns The scale
  8771. */
  8772. getDepthScale(): number;
  8773. /**
  8774. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8775. * @returns true if a cube texture needs to be use
  8776. */
  8777. needCube(): boolean;
  8778. /**
  8779. * Detects if the projection matrix requires to be recomputed this frame.
  8780. * @returns true if it requires to be recomputed otherwise, false.
  8781. */
  8782. needProjectionMatrixCompute(): boolean;
  8783. /**
  8784. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8785. */
  8786. forceProjectionMatrixCompute(): void;
  8787. /**
  8788. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8789. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8790. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8791. */
  8792. getShadowDirection(faceIndex?: number): Vector3;
  8793. /**
  8794. * Gets the minZ used for shadow according to both the scene and the light.
  8795. * @param activeCamera The camera we are returning the min for
  8796. * @returns the depth min z
  8797. */
  8798. getDepthMinZ(activeCamera: Camera): number;
  8799. /**
  8800. * Gets the maxZ used for shadow according to both the scene and the light.
  8801. * @param activeCamera The camera we are returning the max for
  8802. * @returns the depth max z
  8803. */
  8804. getDepthMaxZ(activeCamera: Camera): number;
  8805. }
  8806. /**
  8807. * Base implementation IShadowLight
  8808. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  8809. */
  8810. export abstract class ShadowLight extends Light implements IShadowLight {
  8811. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  8812. protected _position: Vector3;
  8813. protected _setPosition(value: Vector3): void;
  8814. /**
  8815. * Sets the position the shadow will be casted from. Also use as the light position for both
  8816. * point and spot lights.
  8817. */
  8818. /**
  8819. * Sets the position the shadow will be casted from. Also use as the light position for both
  8820. * point and spot lights.
  8821. */
  8822. position: Vector3;
  8823. protected _direction: Vector3;
  8824. protected _setDirection(value: Vector3): void;
  8825. /**
  8826. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  8827. * Also use as the light direction on spot and directional lights.
  8828. */
  8829. /**
  8830. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  8831. * Also use as the light direction on spot and directional lights.
  8832. */
  8833. direction: Vector3;
  8834. private _shadowMinZ;
  8835. /**
  8836. * Gets the shadow projection clipping minimum z value.
  8837. */
  8838. /**
  8839. * Sets the shadow projection clipping minimum z value.
  8840. */
  8841. shadowMinZ: number;
  8842. private _shadowMaxZ;
  8843. /**
  8844. * Sets the shadow projection clipping maximum z value.
  8845. */
  8846. /**
  8847. * Gets the shadow projection clipping maximum z value.
  8848. */
  8849. shadowMaxZ: number;
  8850. /**
  8851. * Callback defining a custom Projection Matrix Builder.
  8852. * This can be used to override the default projection matrix computation.
  8853. */
  8854. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8855. /**
  8856. * The transformed position. Position of the light in world space taking parenting in account.
  8857. */
  8858. transformedPosition: Vector3;
  8859. /**
  8860. * The transformed direction. Direction of the light in world space taking parenting in account.
  8861. */
  8862. transformedDirection: Vector3;
  8863. private _needProjectionMatrixCompute;
  8864. /**
  8865. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8866. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8867. */
  8868. computeTransformedInformation(): boolean;
  8869. /**
  8870. * Return the depth scale used for the shadow map.
  8871. * @returns the depth scale.
  8872. */
  8873. getDepthScale(): number;
  8874. /**
  8875. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8876. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8877. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8878. */
  8879. getShadowDirection(faceIndex?: number): Vector3;
  8880. /**
  8881. * Returns the ShadowLight absolute position in the World.
  8882. * @returns the position vector in world space
  8883. */
  8884. getAbsolutePosition(): Vector3;
  8885. /**
  8886. * Sets the ShadowLight direction toward the passed target.
  8887. * @param target The point to target in local space
  8888. * @returns the updated ShadowLight direction
  8889. */
  8890. setDirectionToTarget(target: Vector3): Vector3;
  8891. /**
  8892. * Returns the light rotation in euler definition.
  8893. * @returns the x y z rotation in local space.
  8894. */
  8895. getRotation(): Vector3;
  8896. /**
  8897. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8898. * @returns true if a cube texture needs to be use
  8899. */
  8900. needCube(): boolean;
  8901. /**
  8902. * Detects if the projection matrix requires to be recomputed this frame.
  8903. * @returns true if it requires to be recomputed otherwise, false.
  8904. */
  8905. needProjectionMatrixCompute(): boolean;
  8906. /**
  8907. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8908. */
  8909. forceProjectionMatrixCompute(): void;
  8910. /** @hidden */
  8911. _initCache(): void;
  8912. /** @hidden */
  8913. _isSynchronized(): boolean;
  8914. /**
  8915. * Computes the world matrix of the node
  8916. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  8917. * @returns the world matrix
  8918. */
  8919. computeWorldMatrix(force?: boolean): Matrix;
  8920. /**
  8921. * Gets the minZ used for shadow according to both the scene and the light.
  8922. * @param activeCamera The camera we are returning the min for
  8923. * @returns the depth min z
  8924. */
  8925. getDepthMinZ(activeCamera: Camera): number;
  8926. /**
  8927. * Gets the maxZ used for shadow according to both the scene and the light.
  8928. * @param activeCamera The camera we are returning the max for
  8929. * @returns the depth max z
  8930. */
  8931. getDepthMaxZ(activeCamera: Camera): number;
  8932. /**
  8933. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8934. * @param matrix The materix to updated with the projection information
  8935. * @param viewMatrix The transform matrix of the light
  8936. * @param renderList The list of mesh to render in the map
  8937. * @returns The current light
  8938. */
  8939. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8940. }
  8941. }
  8942. declare module "babylonjs/Materials/effectFallbacks" {
  8943. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  8944. import { Effect } from "babylonjs/Materials/effect";
  8945. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8946. /**
  8947. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  8948. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  8949. */
  8950. export class EffectFallbacks implements IEffectFallbacks {
  8951. private _defines;
  8952. private _currentRank;
  8953. private _maxRank;
  8954. private _mesh;
  8955. /**
  8956. * Removes the fallback from the bound mesh.
  8957. */
  8958. unBindMesh(): void;
  8959. /**
  8960. * Adds a fallback on the specified property.
  8961. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  8962. * @param define The name of the define in the shader
  8963. */
  8964. addFallback(rank: number, define: string): void;
  8965. /**
  8966. * Sets the mesh to use CPU skinning when needing to fallback.
  8967. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  8968. * @param mesh The mesh to use the fallbacks.
  8969. */
  8970. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  8971. /**
  8972. * Checks to see if more fallbacks are still availible.
  8973. */
  8974. readonly hasMoreFallbacks: boolean;
  8975. /**
  8976. * Removes the defines that should be removed when falling back.
  8977. * @param currentDefines defines the current define statements for the shader.
  8978. * @param effect defines the current effect we try to compile
  8979. * @returns The resulting defines with defines of the current rank removed.
  8980. */
  8981. reduce(currentDefines: string, effect: Effect): string;
  8982. }
  8983. }
  8984. declare module "babylonjs/Materials/materialHelper" {
  8985. import { Nullable } from "babylonjs/types";
  8986. import { Scene } from "babylonjs/scene";
  8987. import { Engine } from "babylonjs/Engines/engine";
  8988. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8989. import { Light } from "babylonjs/Lights/light";
  8990. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  8991. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  8992. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8993. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8994. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  8995. /**
  8996. * "Static Class" containing the most commonly used helper while dealing with material for
  8997. * rendering purpose.
  8998. *
  8999. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  9000. *
  9001. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  9002. */
  9003. export class MaterialHelper {
  9004. /**
  9005. * Bind the current view position to an effect.
  9006. * @param effect The effect to be bound
  9007. * @param scene The scene the eyes position is used from
  9008. */
  9009. static BindEyePosition(effect: Effect, scene: Scene): void;
  9010. /**
  9011. * Helps preparing the defines values about the UVs in used in the effect.
  9012. * UVs are shared as much as we can accross channels in the shaders.
  9013. * @param texture The texture we are preparing the UVs for
  9014. * @param defines The defines to update
  9015. * @param key The channel key "diffuse", "specular"... used in the shader
  9016. */
  9017. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  9018. /**
  9019. * Binds a texture matrix value to its corrsponding uniform
  9020. * @param texture The texture to bind the matrix for
  9021. * @param uniformBuffer The uniform buffer receivin the data
  9022. * @param key The channel key "diffuse", "specular"... used in the shader
  9023. */
  9024. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  9025. /**
  9026. * Gets the current status of the fog (should it be enabled?)
  9027. * @param mesh defines the mesh to evaluate for fog support
  9028. * @param scene defines the hosting scene
  9029. * @returns true if fog must be enabled
  9030. */
  9031. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  9032. /**
  9033. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  9034. * @param mesh defines the current mesh
  9035. * @param scene defines the current scene
  9036. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  9037. * @param pointsCloud defines if point cloud rendering has to be turned on
  9038. * @param fogEnabled defines if fog has to be turned on
  9039. * @param alphaTest defines if alpha testing has to be turned on
  9040. * @param defines defines the current list of defines
  9041. */
  9042. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  9043. /**
  9044. * Helper used to prepare the list of defines associated with frame values for shader compilation
  9045. * @param scene defines the current scene
  9046. * @param engine defines the current engine
  9047. * @param defines specifies the list of active defines
  9048. * @param useInstances defines if instances have to be turned on
  9049. * @param useClipPlane defines if clip plane have to be turned on
  9050. */
  9051. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  9052. /**
  9053. * Prepares the defines for bones
  9054. * @param mesh The mesh containing the geometry data we will draw
  9055. * @param defines The defines to update
  9056. */
  9057. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  9058. /**
  9059. * Prepares the defines for morph targets
  9060. * @param mesh The mesh containing the geometry data we will draw
  9061. * @param defines The defines to update
  9062. */
  9063. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  9064. /**
  9065. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  9066. * @param mesh The mesh containing the geometry data we will draw
  9067. * @param defines The defines to update
  9068. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  9069. * @param useBones Precise whether bones should be used or not (override mesh info)
  9070. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  9071. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  9072. * @returns false if defines are considered not dirty and have not been checked
  9073. */
  9074. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  9075. /**
  9076. * Prepares the defines related to multiview
  9077. * @param scene The scene we are intending to draw
  9078. * @param defines The defines to update
  9079. */
  9080. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  9081. /**
  9082. * Prepares the defines related to the light information passed in parameter
  9083. * @param scene The scene we are intending to draw
  9084. * @param mesh The mesh the effect is compiling for
  9085. * @param light The light the effect is compiling for
  9086. * @param lightIndex The index of the light
  9087. * @param defines The defines to update
  9088. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  9089. * @param state Defines the current state regarding what is needed (normals, etc...)
  9090. */
  9091. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  9092. needNormals: boolean;
  9093. needRebuild: boolean;
  9094. shadowEnabled: boolean;
  9095. specularEnabled: boolean;
  9096. lightmapMode: boolean;
  9097. }): void;
  9098. /**
  9099. * Prepares the defines related to the light information passed in parameter
  9100. * @param scene The scene we are intending to draw
  9101. * @param mesh The mesh the effect is compiling for
  9102. * @param defines The defines to update
  9103. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  9104. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  9105. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  9106. * @returns true if normals will be required for the rest of the effect
  9107. */
  9108. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  9109. /**
  9110. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  9111. * @param lightIndex defines the light index
  9112. * @param uniformsList The uniform list
  9113. * @param samplersList The sampler list
  9114. * @param projectedLightTexture defines if projected texture must be used
  9115. * @param uniformBuffersList defines an optional list of uniform buffers
  9116. */
  9117. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  9118. /**
  9119. * Prepares the uniforms and samplers list to be used in the effect
  9120. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  9121. * @param samplersList The sampler list
  9122. * @param defines The defines helping in the list generation
  9123. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  9124. */
  9125. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  9126. /**
  9127. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  9128. * @param defines The defines to update while falling back
  9129. * @param fallbacks The authorized effect fallbacks
  9130. * @param maxSimultaneousLights The maximum number of lights allowed
  9131. * @param rank the current rank of the Effect
  9132. * @returns The newly affected rank
  9133. */
  9134. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  9135. private static _TmpMorphInfluencers;
  9136. /**
  9137. * Prepares the list of attributes required for morph targets according to the effect defines.
  9138. * @param attribs The current list of supported attribs
  9139. * @param mesh The mesh to prepare the morph targets attributes for
  9140. * @param influencers The number of influencers
  9141. */
  9142. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  9143. /**
  9144. * Prepares the list of attributes required for morph targets according to the effect defines.
  9145. * @param attribs The current list of supported attribs
  9146. * @param mesh The mesh to prepare the morph targets attributes for
  9147. * @param defines The current Defines of the effect
  9148. */
  9149. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  9150. /**
  9151. * Prepares the list of attributes required for bones according to the effect defines.
  9152. * @param attribs The current list of supported attribs
  9153. * @param mesh The mesh to prepare the bones attributes for
  9154. * @param defines The current Defines of the effect
  9155. * @param fallbacks The current efffect fallback strategy
  9156. */
  9157. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  9158. /**
  9159. * Check and prepare the list of attributes required for instances according to the effect defines.
  9160. * @param attribs The current list of supported attribs
  9161. * @param defines The current MaterialDefines of the effect
  9162. */
  9163. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  9164. /**
  9165. * Add the list of attributes required for instances to the attribs array.
  9166. * @param attribs The current list of supported attribs
  9167. */
  9168. static PushAttributesForInstances(attribs: string[]): void;
  9169. /**
  9170. * Binds the light information to the effect.
  9171. * @param light The light containing the generator
  9172. * @param effect The effect we are binding the data to
  9173. * @param lightIndex The light index in the effect used to render
  9174. */
  9175. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  9176. /**
  9177. * Binds the lights information from the scene to the effect for the given mesh.
  9178. * @param light Light to bind
  9179. * @param lightIndex Light index
  9180. * @param scene The scene where the light belongs to
  9181. * @param effect The effect we are binding the data to
  9182. * @param useSpecular Defines if specular is supported
  9183. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9184. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9185. */
  9186. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9187. /**
  9188. * Binds the lights information from the scene to the effect for the given mesh.
  9189. * @param scene The scene the lights belongs to
  9190. * @param mesh The mesh we are binding the information to render
  9191. * @param effect The effect we are binding the data to
  9192. * @param defines The generated defines for the effect
  9193. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  9194. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9195. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9196. */
  9197. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9198. private static _tempFogColor;
  9199. /**
  9200. * Binds the fog information from the scene to the effect for the given mesh.
  9201. * @param scene The scene the lights belongs to
  9202. * @param mesh The mesh we are binding the information to render
  9203. * @param effect The effect we are binding the data to
  9204. * @param linearSpace Defines if the fog effect is applied in linear space
  9205. */
  9206. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  9207. /**
  9208. * Binds the bones information from the mesh to the effect.
  9209. * @param mesh The mesh we are binding the information to render
  9210. * @param effect The effect we are binding the data to
  9211. */
  9212. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  9213. /**
  9214. * Binds the morph targets information from the mesh to the effect.
  9215. * @param abstractMesh The mesh we are binding the information to render
  9216. * @param effect The effect we are binding the data to
  9217. */
  9218. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  9219. /**
  9220. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  9221. * @param defines The generated defines used in the effect
  9222. * @param effect The effect we are binding the data to
  9223. * @param scene The scene we are willing to render with logarithmic scale for
  9224. */
  9225. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  9226. /**
  9227. * Binds the clip plane information from the scene to the effect.
  9228. * @param scene The scene the clip plane information are extracted from
  9229. * @param effect The effect we are binding the data to
  9230. */
  9231. static BindClipPlane(effect: Effect, scene: Scene): void;
  9232. }
  9233. }
  9234. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9235. /** @hidden */
  9236. export var packingFunctions: {
  9237. name: string;
  9238. shader: string;
  9239. };
  9240. }
  9241. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9242. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9243. /** @hidden */
  9244. export var shadowMapPixelShader: {
  9245. name: string;
  9246. shader: string;
  9247. };
  9248. }
  9249. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9250. /** @hidden */
  9251. export var bonesDeclaration: {
  9252. name: string;
  9253. shader: string;
  9254. };
  9255. }
  9256. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9257. /** @hidden */
  9258. export var morphTargetsVertexGlobalDeclaration: {
  9259. name: string;
  9260. shader: string;
  9261. };
  9262. }
  9263. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9264. /** @hidden */
  9265. export var morphTargetsVertexDeclaration: {
  9266. name: string;
  9267. shader: string;
  9268. };
  9269. }
  9270. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9271. /** @hidden */
  9272. export var instancesDeclaration: {
  9273. name: string;
  9274. shader: string;
  9275. };
  9276. }
  9277. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9278. /** @hidden */
  9279. export var helperFunctions: {
  9280. name: string;
  9281. shader: string;
  9282. };
  9283. }
  9284. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9285. /** @hidden */
  9286. export var morphTargetsVertex: {
  9287. name: string;
  9288. shader: string;
  9289. };
  9290. }
  9291. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9292. /** @hidden */
  9293. export var instancesVertex: {
  9294. name: string;
  9295. shader: string;
  9296. };
  9297. }
  9298. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9299. /** @hidden */
  9300. export var bonesVertex: {
  9301. name: string;
  9302. shader: string;
  9303. };
  9304. }
  9305. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9306. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9307. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9308. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9309. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9310. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9311. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9312. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9313. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9314. /** @hidden */
  9315. export var shadowMapVertexShader: {
  9316. name: string;
  9317. shader: string;
  9318. };
  9319. }
  9320. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9321. /** @hidden */
  9322. export var depthBoxBlurPixelShader: {
  9323. name: string;
  9324. shader: string;
  9325. };
  9326. }
  9327. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  9328. import { Nullable } from "babylonjs/types";
  9329. import { Scene } from "babylonjs/scene";
  9330. import { Matrix } from "babylonjs/Maths/math.vector";
  9331. import { SubMesh } from "babylonjs/Meshes/subMesh";
  9332. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9333. import { Mesh } from "babylonjs/Meshes/mesh";
  9334. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  9335. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  9336. import { Effect } from "babylonjs/Materials/effect";
  9337. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  9338. import "babylonjs/Shaders/shadowMap.fragment";
  9339. import "babylonjs/Shaders/shadowMap.vertex";
  9340. import "babylonjs/Shaders/depthBoxBlur.fragment";
  9341. import { Observable } from "babylonjs/Misc/observable";
  9342. /**
  9343. * Defines the options associated with the creation of a custom shader for a shadow generator.
  9344. */
  9345. export interface ICustomShaderOptions {
  9346. /**
  9347. * Gets or sets the custom shader name to use
  9348. */
  9349. shaderName: string;
  9350. /**
  9351. * The list of attribute names used in the shader
  9352. */
  9353. attributes?: string[];
  9354. /**
  9355. * The list of unifrom names used in the shader
  9356. */
  9357. uniforms?: string[];
  9358. /**
  9359. * The list of sampler names used in the shader
  9360. */
  9361. samplers?: string[];
  9362. /**
  9363. * The list of defines used in the shader
  9364. */
  9365. defines?: string[];
  9366. }
  9367. /**
  9368. * Interface to implement to create a shadow generator compatible with BJS.
  9369. */
  9370. export interface IShadowGenerator {
  9371. /**
  9372. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9373. * @returns The render target texture if present otherwise, null
  9374. */
  9375. getShadowMap(): Nullable<RenderTargetTexture>;
  9376. /**
  9377. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9378. * @returns The render target texture if the shadow map is present otherwise, null
  9379. */
  9380. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9381. /**
  9382. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9383. * @param subMesh The submesh we want to render in the shadow map
  9384. * @param useInstances Defines wether will draw in the map using instances
  9385. * @returns true if ready otherwise, false
  9386. */
  9387. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9388. /**
  9389. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9390. * @param defines Defines of the material we want to update
  9391. * @param lightIndex Index of the light in the enabled light list of the material
  9392. */
  9393. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  9394. /**
  9395. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9396. * defined in the generator but impacting the effect).
  9397. * It implies the unifroms available on the materials are the standard BJS ones.
  9398. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9399. * @param effect The effect we are binfing the information for
  9400. */
  9401. bindShadowLight(lightIndex: string, effect: Effect): void;
  9402. /**
  9403. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9404. * (eq to shadow prjection matrix * light transform matrix)
  9405. * @returns The transform matrix used to create the shadow map
  9406. */
  9407. getTransformMatrix(): Matrix;
  9408. /**
  9409. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9410. * Cube and 2D textures for instance.
  9411. */
  9412. recreateShadowMap(): void;
  9413. /**
  9414. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9415. * @param onCompiled Callback triggered at the and of the effects compilation
  9416. * @param options Sets of optional options forcing the compilation with different modes
  9417. */
  9418. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9419. useInstances: boolean;
  9420. }>): void;
  9421. /**
  9422. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9423. * @param options Sets of optional options forcing the compilation with different modes
  9424. * @returns A promise that resolves when the compilation completes
  9425. */
  9426. forceCompilationAsync(options?: Partial<{
  9427. useInstances: boolean;
  9428. }>): Promise<void>;
  9429. /**
  9430. * Serializes the shadow generator setup to a json object.
  9431. * @returns The serialized JSON object
  9432. */
  9433. serialize(): any;
  9434. /**
  9435. * Disposes the Shadow map and related Textures and effects.
  9436. */
  9437. dispose(): void;
  9438. }
  9439. /**
  9440. * Default implementation IShadowGenerator.
  9441. * This is the main object responsible of generating shadows in the framework.
  9442. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  9443. */
  9444. export class ShadowGenerator implements IShadowGenerator {
  9445. /**
  9446. * Shadow generator mode None: no filtering applied.
  9447. */
  9448. static readonly FILTER_NONE: number;
  9449. /**
  9450. * Shadow generator mode ESM: Exponential Shadow Mapping.
  9451. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9452. */
  9453. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  9454. /**
  9455. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  9456. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  9457. */
  9458. static readonly FILTER_POISSONSAMPLING: number;
  9459. /**
  9460. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  9461. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9462. */
  9463. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  9464. /**
  9465. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  9466. * edge artifacts on steep falloff.
  9467. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9468. */
  9469. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  9470. /**
  9471. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  9472. * edge artifacts on steep falloff.
  9473. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9474. */
  9475. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  9476. /**
  9477. * Shadow generator mode PCF: Percentage Closer Filtering
  9478. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9479. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  9480. */
  9481. static readonly FILTER_PCF: number;
  9482. /**
  9483. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  9484. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9485. * Contact Hardening
  9486. */
  9487. static readonly FILTER_PCSS: number;
  9488. /**
  9489. * Reserved for PCF and PCSS
  9490. * Highest Quality.
  9491. *
  9492. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  9493. *
  9494. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  9495. */
  9496. static readonly QUALITY_HIGH: number;
  9497. /**
  9498. * Reserved for PCF and PCSS
  9499. * Good tradeoff for quality/perf cross devices
  9500. *
  9501. * Execute PCF on a 3*3 kernel.
  9502. *
  9503. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  9504. */
  9505. static readonly QUALITY_MEDIUM: number;
  9506. /**
  9507. * Reserved for PCF and PCSS
  9508. * The lowest quality but the fastest.
  9509. *
  9510. * Execute PCF on a 1*1 kernel.
  9511. *
  9512. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  9513. */
  9514. static readonly QUALITY_LOW: number;
  9515. /** Gets or sets the custom shader name to use */
  9516. customShaderOptions: ICustomShaderOptions;
  9517. /**
  9518. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  9519. */
  9520. onBeforeShadowMapRenderObservable: Observable<Effect>;
  9521. /**
  9522. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  9523. */
  9524. onAfterShadowMapRenderObservable: Observable<Effect>;
  9525. /**
  9526. * Observable triggered before a mesh is rendered in the shadow map.
  9527. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  9528. */
  9529. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  9530. /**
  9531. * Observable triggered after a mesh is rendered in the shadow map.
  9532. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  9533. */
  9534. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  9535. private _bias;
  9536. /**
  9537. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  9538. */
  9539. /**
  9540. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  9541. */
  9542. bias: number;
  9543. private _normalBias;
  9544. /**
  9545. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9546. */
  9547. /**
  9548. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9549. */
  9550. normalBias: number;
  9551. private _blurBoxOffset;
  9552. /**
  9553. * Gets the blur box offset: offset applied during the blur pass.
  9554. * Only useful if useKernelBlur = false
  9555. */
  9556. /**
  9557. * Sets the blur box offset: offset applied during the blur pass.
  9558. * Only useful if useKernelBlur = false
  9559. */
  9560. blurBoxOffset: number;
  9561. private _blurScale;
  9562. /**
  9563. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  9564. * 2 means half of the size.
  9565. */
  9566. /**
  9567. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  9568. * 2 means half of the size.
  9569. */
  9570. blurScale: number;
  9571. private _blurKernel;
  9572. /**
  9573. * Gets the blur kernel: kernel size of the blur pass.
  9574. * Only useful if useKernelBlur = true
  9575. */
  9576. /**
  9577. * Sets the blur kernel: kernel size of the blur pass.
  9578. * Only useful if useKernelBlur = true
  9579. */
  9580. blurKernel: number;
  9581. private _useKernelBlur;
  9582. /**
  9583. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  9584. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9585. */
  9586. /**
  9587. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  9588. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9589. */
  9590. useKernelBlur: boolean;
  9591. private _depthScale;
  9592. /**
  9593. * Gets the depth scale used in ESM mode.
  9594. */
  9595. /**
  9596. * Sets the depth scale used in ESM mode.
  9597. * This can override the scale stored on the light.
  9598. */
  9599. depthScale: number;
  9600. private _filter;
  9601. /**
  9602. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  9603. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9604. */
  9605. /**
  9606. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  9607. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9608. */
  9609. filter: number;
  9610. /**
  9611. * Gets if the current filter is set to Poisson Sampling.
  9612. */
  9613. /**
  9614. * Sets the current filter to Poisson Sampling.
  9615. */
  9616. usePoissonSampling: boolean;
  9617. /**
  9618. * Gets if the current filter is set to ESM.
  9619. */
  9620. /**
  9621. * Sets the current filter is to ESM.
  9622. */
  9623. useExponentialShadowMap: boolean;
  9624. /**
  9625. * Gets if the current filter is set to filtered ESM.
  9626. */
  9627. /**
  9628. * Gets if the current filter is set to filtered ESM.
  9629. */
  9630. useBlurExponentialShadowMap: boolean;
  9631. /**
  9632. * Gets if the current filter is set to "close ESM" (using the inverse of the
  9633. * exponential to prevent steep falloff artifacts).
  9634. */
  9635. /**
  9636. * Sets the current filter to "close ESM" (using the inverse of the
  9637. * exponential to prevent steep falloff artifacts).
  9638. */
  9639. useCloseExponentialShadowMap: boolean;
  9640. /**
  9641. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  9642. * exponential to prevent steep falloff artifacts).
  9643. */
  9644. /**
  9645. * Sets the current filter to filtered "close ESM" (using the inverse of the
  9646. * exponential to prevent steep falloff artifacts).
  9647. */
  9648. useBlurCloseExponentialShadowMap: boolean;
  9649. /**
  9650. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  9651. */
  9652. /**
  9653. * Sets the current filter to "PCF" (percentage closer filtering).
  9654. */
  9655. usePercentageCloserFiltering: boolean;
  9656. private _filteringQuality;
  9657. /**
  9658. * Gets the PCF or PCSS Quality.
  9659. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9660. */
  9661. /**
  9662. * Sets the PCF or PCSS Quality.
  9663. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9664. */
  9665. filteringQuality: number;
  9666. /**
  9667. * Gets if the current filter is set to "PCSS" (contact hardening).
  9668. */
  9669. /**
  9670. * Sets the current filter to "PCSS" (contact hardening).
  9671. */
  9672. useContactHardeningShadow: boolean;
  9673. private _contactHardeningLightSizeUVRatio;
  9674. /**
  9675. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9676. * Using a ratio helps keeping shape stability independently of the map size.
  9677. *
  9678. * It does not account for the light projection as it was having too much
  9679. * instability during the light setup or during light position changes.
  9680. *
  9681. * Only valid if useContactHardeningShadow is true.
  9682. */
  9683. /**
  9684. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9685. * Using a ratio helps keeping shape stability independently of the map size.
  9686. *
  9687. * It does not account for the light projection as it was having too much
  9688. * instability during the light setup or during light position changes.
  9689. *
  9690. * Only valid if useContactHardeningShadow is true.
  9691. */
  9692. contactHardeningLightSizeUVRatio: number;
  9693. private _darkness;
  9694. /** Gets or sets the actual darkness of a shadow */
  9695. darkness: number;
  9696. /**
  9697. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  9698. * 0 means strongest and 1 would means no shadow.
  9699. * @returns the darkness.
  9700. */
  9701. getDarkness(): number;
  9702. /**
  9703. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  9704. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  9705. * @returns the shadow generator allowing fluent coding.
  9706. */
  9707. setDarkness(darkness: number): ShadowGenerator;
  9708. private _transparencyShadow;
  9709. /** Gets or sets the ability to have transparent shadow */
  9710. transparencyShadow: boolean;
  9711. /**
  9712. * Sets the ability to have transparent shadow (boolean).
  9713. * @param transparent True if transparent else False
  9714. * @returns the shadow generator allowing fluent coding
  9715. */
  9716. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  9717. private _shadowMap;
  9718. private _shadowMap2;
  9719. /**
  9720. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9721. * @returns The render target texture if present otherwise, null
  9722. */
  9723. getShadowMap(): Nullable<RenderTargetTexture>;
  9724. /**
  9725. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9726. * @returns The render target texture if the shadow map is present otherwise, null
  9727. */
  9728. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9729. /**
  9730. * Gets the class name of that object
  9731. * @returns "ShadowGenerator"
  9732. */
  9733. getClassName(): string;
  9734. /**
  9735. * Helper function to add a mesh and its descendants to the list of shadow casters.
  9736. * @param mesh Mesh to add
  9737. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  9738. * @returns the Shadow Generator itself
  9739. */
  9740. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9741. /**
  9742. * Helper function to remove a mesh and its descendants from the list of shadow casters
  9743. * @param mesh Mesh to remove
  9744. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  9745. * @returns the Shadow Generator itself
  9746. */
  9747. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9748. /**
  9749. * Controls the extent to which the shadows fade out at the edge of the frustum
  9750. * Used only by directionals and spots
  9751. */
  9752. frustumEdgeFalloff: number;
  9753. private _light;
  9754. /**
  9755. * Returns the associated light object.
  9756. * @returns the light generating the shadow
  9757. */
  9758. getLight(): IShadowLight;
  9759. /**
  9760. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  9761. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  9762. * It might on the other hand introduce peter panning.
  9763. */
  9764. forceBackFacesOnly: boolean;
  9765. private _scene;
  9766. private _lightDirection;
  9767. private _effect;
  9768. private _viewMatrix;
  9769. private _projectionMatrix;
  9770. private _transformMatrix;
  9771. private _cachedPosition;
  9772. private _cachedDirection;
  9773. private _cachedDefines;
  9774. private _currentRenderID;
  9775. private _boxBlurPostprocess;
  9776. private _kernelBlurXPostprocess;
  9777. private _kernelBlurYPostprocess;
  9778. private _blurPostProcesses;
  9779. private _mapSize;
  9780. private _currentFaceIndex;
  9781. private _currentFaceIndexCache;
  9782. private _textureType;
  9783. private _defaultTextureMatrix;
  9784. private _storedUniqueId;
  9785. /** @hidden */
  9786. static _SceneComponentInitialization: (scene: Scene) => void;
  9787. /**
  9788. * Creates a ShadowGenerator object.
  9789. * A ShadowGenerator is the required tool to use the shadows.
  9790. * Each light casting shadows needs to use its own ShadowGenerator.
  9791. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  9792. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  9793. * @param light The light object generating the shadows.
  9794. * @param usefulFloatFirst By default the generator will try to use half float textures but if you need precision (for self shadowing for instance), you can use this option to enforce full float texture.
  9795. */
  9796. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  9797. private _initializeGenerator;
  9798. private _initializeShadowMap;
  9799. private _initializeBlurRTTAndPostProcesses;
  9800. private _renderForShadowMap;
  9801. private _renderSubMeshForShadowMap;
  9802. private _applyFilterValues;
  9803. /**
  9804. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9805. * @param onCompiled Callback triggered at the and of the effects compilation
  9806. * @param options Sets of optional options forcing the compilation with different modes
  9807. */
  9808. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9809. useInstances: boolean;
  9810. }>): void;
  9811. /**
  9812. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9813. * @param options Sets of optional options forcing the compilation with different modes
  9814. * @returns A promise that resolves when the compilation completes
  9815. */
  9816. forceCompilationAsync(options?: Partial<{
  9817. useInstances: boolean;
  9818. }>): Promise<void>;
  9819. /**
  9820. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9821. * @param subMesh The submesh we want to render in the shadow map
  9822. * @param useInstances Defines wether will draw in the map using instances
  9823. * @returns true if ready otherwise, false
  9824. */
  9825. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9826. /**
  9827. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9828. * @param defines Defines of the material we want to update
  9829. * @param lightIndex Index of the light in the enabled light list of the material
  9830. */
  9831. prepareDefines(defines: any, lightIndex: number): void;
  9832. /**
  9833. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9834. * defined in the generator but impacting the effect).
  9835. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9836. * @param effect The effect we are binfing the information for
  9837. */
  9838. bindShadowLight(lightIndex: string, effect: Effect): void;
  9839. /**
  9840. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9841. * (eq to shadow prjection matrix * light transform matrix)
  9842. * @returns The transform matrix used to create the shadow map
  9843. */
  9844. getTransformMatrix(): Matrix;
  9845. /**
  9846. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9847. * Cube and 2D textures for instance.
  9848. */
  9849. recreateShadowMap(): void;
  9850. private _disposeBlurPostProcesses;
  9851. private _disposeRTTandPostProcesses;
  9852. /**
  9853. * Disposes the ShadowGenerator.
  9854. * Returns nothing.
  9855. */
  9856. dispose(): void;
  9857. /**
  9858. * Serializes the shadow generator setup to a json object.
  9859. * @returns The serialized JSON object
  9860. */
  9861. serialize(): any;
  9862. /**
  9863. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  9864. * @param parsedShadowGenerator The JSON object to parse
  9865. * @param scene The scene to create the shadow map for
  9866. * @returns The parsed shadow generator
  9867. */
  9868. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  9869. }
  9870. }
  9871. declare module "babylonjs/Lights/light" {
  9872. import { Nullable } from "babylonjs/types";
  9873. import { Scene } from "babylonjs/scene";
  9874. import { Vector3 } from "babylonjs/Maths/math.vector";
  9875. import { Color3 } from "babylonjs/Maths/math.color";
  9876. import { Node } from "babylonjs/node";
  9877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9878. import { Effect } from "babylonjs/Materials/effect";
  9879. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  9880. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  9881. /**
  9882. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  9883. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  9884. * All meshes allow light to pass through them unless shadow generation is activated. The default number of lights allowed is four but this can be increased.
  9885. */
  9886. export abstract class Light extends Node {
  9887. /**
  9888. * Falloff Default: light is falling off following the material specification:
  9889. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  9890. */
  9891. static readonly FALLOFF_DEFAULT: number;
  9892. /**
  9893. * Falloff Physical: light is falling off following the inverse squared distance law.
  9894. */
  9895. static readonly FALLOFF_PHYSICAL: number;
  9896. /**
  9897. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  9898. * to enhance interoperability with other engines.
  9899. */
  9900. static readonly FALLOFF_GLTF: number;
  9901. /**
  9902. * Falloff Standard: light is falling off like in the standard material
  9903. * to enhance interoperability with other materials.
  9904. */
  9905. static readonly FALLOFF_STANDARD: number;
  9906. /**
  9907. * If every light affecting the material is in this lightmapMode,
  9908. * material.lightmapTexture adds or multiplies
  9909. * (depends on material.useLightmapAsShadowmap)
  9910. * after every other light calculations.
  9911. */
  9912. static readonly LIGHTMAP_DEFAULT: number;
  9913. /**
  9914. * material.lightmapTexture as only diffuse lighting from this light
  9915. * adds only specular lighting from this light
  9916. * adds dynamic shadows
  9917. */
  9918. static readonly LIGHTMAP_SPECULAR: number;
  9919. /**
  9920. * material.lightmapTexture as only lighting
  9921. * no light calculation from this light
  9922. * only adds dynamic shadows from this light
  9923. */
  9924. static readonly LIGHTMAP_SHADOWSONLY: number;
  9925. /**
  9926. * Each light type uses the default quantity according to its type:
  9927. * point/spot lights use luminous intensity
  9928. * directional lights use illuminance
  9929. */
  9930. static readonly INTENSITYMODE_AUTOMATIC: number;
  9931. /**
  9932. * lumen (lm)
  9933. */
  9934. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  9935. /**
  9936. * candela (lm/sr)
  9937. */
  9938. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  9939. /**
  9940. * lux (lm/m^2)
  9941. */
  9942. static readonly INTENSITYMODE_ILLUMINANCE: number;
  9943. /**
  9944. * nit (cd/m^2)
  9945. */
  9946. static readonly INTENSITYMODE_LUMINANCE: number;
  9947. /**
  9948. * Light type const id of the point light.
  9949. */
  9950. static readonly LIGHTTYPEID_POINTLIGHT: number;
  9951. /**
  9952. * Light type const id of the directional light.
  9953. */
  9954. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  9955. /**
  9956. * Light type const id of the spot light.
  9957. */
  9958. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  9959. /**
  9960. * Light type const id of the hemispheric light.
  9961. */
  9962. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  9963. /**
  9964. * Diffuse gives the basic color to an object.
  9965. */
  9966. diffuse: Color3;
  9967. /**
  9968. * Specular produces a highlight color on an object.
  9969. * Note: This is note affecting PBR materials.
  9970. */
  9971. specular: Color3;
  9972. /**
  9973. * Defines the falloff type for this light. This lets overrriding how punctual light are
  9974. * falling off base on range or angle.
  9975. * This can be set to any values in Light.FALLOFF_x.
  9976. *
  9977. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  9978. * other types of materials.
  9979. */
  9980. falloffType: number;
  9981. /**
  9982. * Strength of the light.
  9983. * Note: By default it is define in the framework own unit.
  9984. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  9985. */
  9986. intensity: number;
  9987. private _range;
  9988. protected _inverseSquaredRange: number;
  9989. /**
  9990. * Defines how far from the source the light is impacting in scene units.
  9991. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  9992. */
  9993. /**
  9994. * Defines how far from the source the light is impacting in scene units.
  9995. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  9996. */
  9997. range: number;
  9998. /**
  9999. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  10000. * of light.
  10001. */
  10002. private _photometricScale;
  10003. private _intensityMode;
  10004. /**
  10005. * Gets the photometric scale used to interpret the intensity.
  10006. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  10007. */
  10008. /**
  10009. * Sets the photometric scale used to interpret the intensity.
  10010. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  10011. */
  10012. intensityMode: number;
  10013. private _radius;
  10014. /**
  10015. * Gets the light radius used by PBR Materials to simulate soft area lights.
  10016. */
  10017. /**
  10018. * sets the light radius used by PBR Materials to simulate soft area lights.
  10019. */
  10020. radius: number;
  10021. private _renderPriority;
  10022. /**
  10023. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  10024. * exceeding the number allowed of the materials.
  10025. */
  10026. renderPriority: number;
  10027. private _shadowEnabled;
  10028. /**
  10029. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  10030. * the current shadow generator.
  10031. */
  10032. /**
  10033. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  10034. * the current shadow generator.
  10035. */
  10036. shadowEnabled: boolean;
  10037. private _includedOnlyMeshes;
  10038. /**
  10039. * Gets the only meshes impacted by this light.
  10040. */
  10041. /**
  10042. * Sets the only meshes impacted by this light.
  10043. */
  10044. includedOnlyMeshes: AbstractMesh[];
  10045. private _excludedMeshes;
  10046. /**
  10047. * Gets the meshes not impacted by this light.
  10048. */
  10049. /**
  10050. * Sets the meshes not impacted by this light.
  10051. */
  10052. excludedMeshes: AbstractMesh[];
  10053. private _excludeWithLayerMask;
  10054. /**
  10055. * Gets the layer id use to find what meshes are not impacted by the light.
  10056. * Inactive if 0
  10057. */
  10058. /**
  10059. * Sets the layer id use to find what meshes are not impacted by the light.
  10060. * Inactive if 0
  10061. */
  10062. excludeWithLayerMask: number;
  10063. private _includeOnlyWithLayerMask;
  10064. /**
  10065. * Gets the layer id use to find what meshes are impacted by the light.
  10066. * Inactive if 0
  10067. */
  10068. /**
  10069. * Sets the layer id use to find what meshes are impacted by the light.
  10070. * Inactive if 0
  10071. */
  10072. includeOnlyWithLayerMask: number;
  10073. private _lightmapMode;
  10074. /**
  10075. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  10076. */
  10077. /**
  10078. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  10079. */
  10080. lightmapMode: number;
  10081. /**
  10082. * Shadow generator associted to the light.
  10083. * @hidden Internal use only.
  10084. */
  10085. _shadowGenerator: Nullable<IShadowGenerator>;
  10086. /**
  10087. * @hidden Internal use only.
  10088. */
  10089. _excludedMeshesIds: string[];
  10090. /**
  10091. * @hidden Internal use only.
  10092. */
  10093. _includedOnlyMeshesIds: string[];
  10094. /**
  10095. * The current light unifom buffer.
  10096. * @hidden Internal use only.
  10097. */
  10098. _uniformBuffer: UniformBuffer;
  10099. /** @hidden */
  10100. _renderId: number;
  10101. /**
  10102. * Creates a Light object in the scene.
  10103. * Documentation : https://doc.babylonjs.com/babylon101/lights
  10104. * @param name The firendly name of the light
  10105. * @param scene The scene the light belongs too
  10106. */
  10107. constructor(name: string, scene: Scene);
  10108. protected abstract _buildUniformLayout(): void;
  10109. /**
  10110. * Sets the passed Effect "effect" with the Light information.
  10111. * @param effect The effect to update
  10112. * @param lightIndex The index of the light in the effect to update
  10113. * @returns The light
  10114. */
  10115. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  10116. /**
  10117. * Sets the passed Effect "effect" with the Light information.
  10118. * @param effect The effect to update
  10119. * @param lightDataUniformName The uniform used to store light data (position or direction)
  10120. * @returns The light
  10121. */
  10122. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  10123. /**
  10124. * Returns the string "Light".
  10125. * @returns the class name
  10126. */
  10127. getClassName(): string;
  10128. /** @hidden */
  10129. readonly _isLight: boolean;
  10130. /**
  10131. * Converts the light information to a readable string for debug purpose.
  10132. * @param fullDetails Supports for multiple levels of logging within scene loading
  10133. * @returns the human readable light info
  10134. */
  10135. toString(fullDetails?: boolean): string;
  10136. /** @hidden */
  10137. protected _syncParentEnabledState(): void;
  10138. /**
  10139. * Set the enabled state of this node.
  10140. * @param value - the new enabled state
  10141. */
  10142. setEnabled(value: boolean): void;
  10143. /**
  10144. * Returns the Light associated shadow generator if any.
  10145. * @return the associated shadow generator.
  10146. */
  10147. getShadowGenerator(): Nullable<IShadowGenerator>;
  10148. /**
  10149. * Returns a Vector3, the absolute light position in the World.
  10150. * @returns the world space position of the light
  10151. */
  10152. getAbsolutePosition(): Vector3;
  10153. /**
  10154. * Specifies if the light will affect the passed mesh.
  10155. * @param mesh The mesh to test against the light
  10156. * @return true the mesh is affected otherwise, false.
  10157. */
  10158. canAffectMesh(mesh: AbstractMesh): boolean;
  10159. /**
  10160. * Sort function to order lights for rendering.
  10161. * @param a First Light object to compare to second.
  10162. * @param b Second Light object to compare first.
  10163. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  10164. */
  10165. static CompareLightsPriority(a: Light, b: Light): number;
  10166. /**
  10167. * Releases resources associated with this node.
  10168. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  10169. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  10170. */
  10171. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  10172. /**
  10173. * Returns the light type ID (integer).
  10174. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  10175. */
  10176. getTypeID(): number;
  10177. /**
  10178. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  10179. * @returns the scaled intensity in intensity mode unit
  10180. */
  10181. getScaledIntensity(): number;
  10182. /**
  10183. * Returns a new Light object, named "name", from the current one.
  10184. * @param name The name of the cloned light
  10185. * @returns the new created light
  10186. */
  10187. clone(name: string): Nullable<Light>;
  10188. /**
  10189. * Serializes the current light into a Serialization object.
  10190. * @returns the serialized object.
  10191. */
  10192. serialize(): any;
  10193. /**
  10194. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  10195. * This new light is named "name" and added to the passed scene.
  10196. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  10197. * @param name The friendly name of the light
  10198. * @param scene The scene the new light will belong to
  10199. * @returns the constructor function
  10200. */
  10201. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  10202. /**
  10203. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  10204. * @param parsedLight The JSON representation of the light
  10205. * @param scene The scene to create the parsed light in
  10206. * @returns the created light after parsing
  10207. */
  10208. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  10209. private _hookArrayForExcluded;
  10210. private _hookArrayForIncludedOnly;
  10211. private _resyncMeshes;
  10212. /**
  10213. * Forces the meshes to update their light related information in their rendering used effects
  10214. * @hidden Internal Use Only
  10215. */
  10216. _markMeshesAsLightDirty(): void;
  10217. /**
  10218. * Recomputes the cached photometric scale if needed.
  10219. */
  10220. private _computePhotometricScale;
  10221. /**
  10222. * Returns the Photometric Scale according to the light type and intensity mode.
  10223. */
  10224. private _getPhotometricScale;
  10225. /**
  10226. * Reorder the light in the scene according to their defined priority.
  10227. * @hidden Internal Use Only
  10228. */
  10229. _reorderLightsInScene(): void;
  10230. /**
  10231. * Prepares the list of defines specific to the light type.
  10232. * @param defines the list of defines
  10233. * @param lightIndex defines the index of the light for the effect
  10234. */
  10235. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  10236. }
  10237. }
  10238. declare module "babylonjs/Actions/action" {
  10239. import { Observable } from "babylonjs/Misc/observable";
  10240. import { Condition } from "babylonjs/Actions/condition";
  10241. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10242. import { ActionManager } from "babylonjs/Actions/actionManager";
  10243. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10244. /**
  10245. * Interface used to define Action
  10246. */
  10247. export interface IAction {
  10248. /**
  10249. * Trigger for the action
  10250. */
  10251. trigger: number;
  10252. /** Options of the trigger */
  10253. triggerOptions: any;
  10254. /**
  10255. * Gets the trigger parameters
  10256. * @returns the trigger parameters
  10257. */
  10258. getTriggerParameter(): any;
  10259. /**
  10260. * Internal only - executes current action event
  10261. * @hidden
  10262. */
  10263. _executeCurrent(evt?: ActionEvent): void;
  10264. /**
  10265. * Serialize placeholder for child classes
  10266. * @param parent of child
  10267. * @returns the serialized object
  10268. */
  10269. serialize(parent: any): any;
  10270. /**
  10271. * Internal only
  10272. * @hidden
  10273. */
  10274. _prepare(): void;
  10275. /**
  10276. * Internal only - manager for action
  10277. * @hidden
  10278. */
  10279. _actionManager: AbstractActionManager;
  10280. /**
  10281. * Adds action to chain of actions, may be a DoNothingAction
  10282. * @param action defines the next action to execute
  10283. * @returns The action passed in
  10284. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10285. */
  10286. then(action: IAction): IAction;
  10287. }
  10288. /**
  10289. * The action to be carried out following a trigger
  10290. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  10291. */
  10292. export class Action implements IAction {
  10293. /** the trigger, with or without parameters, for the action */
  10294. triggerOptions: any;
  10295. /**
  10296. * Trigger for the action
  10297. */
  10298. trigger: number;
  10299. /**
  10300. * Internal only - manager for action
  10301. * @hidden
  10302. */
  10303. _actionManager: ActionManager;
  10304. private _nextActiveAction;
  10305. private _child;
  10306. private _condition?;
  10307. private _triggerParameter;
  10308. /**
  10309. * An event triggered prior to action being executed.
  10310. */
  10311. onBeforeExecuteObservable: Observable<Action>;
  10312. /**
  10313. * Creates a new Action
  10314. * @param triggerOptions the trigger, with or without parameters, for the action
  10315. * @param condition an optional determinant of action
  10316. */
  10317. constructor(
  10318. /** the trigger, with or without parameters, for the action */
  10319. triggerOptions: any, condition?: Condition);
  10320. /**
  10321. * Internal only
  10322. * @hidden
  10323. */
  10324. _prepare(): void;
  10325. /**
  10326. * Gets the trigger parameters
  10327. * @returns the trigger parameters
  10328. */
  10329. getTriggerParameter(): any;
  10330. /**
  10331. * Internal only - executes current action event
  10332. * @hidden
  10333. */
  10334. _executeCurrent(evt?: ActionEvent): void;
  10335. /**
  10336. * Execute placeholder for child classes
  10337. * @param evt optional action event
  10338. */
  10339. execute(evt?: ActionEvent): void;
  10340. /**
  10341. * Skips to next active action
  10342. */
  10343. skipToNextActiveAction(): void;
  10344. /**
  10345. * Adds action to chain of actions, may be a DoNothingAction
  10346. * @param action defines the next action to execute
  10347. * @returns The action passed in
  10348. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10349. */
  10350. then(action: Action): Action;
  10351. /**
  10352. * Internal only
  10353. * @hidden
  10354. */
  10355. _getProperty(propertyPath: string): string;
  10356. /**
  10357. * Internal only
  10358. * @hidden
  10359. */
  10360. _getEffectiveTarget(target: any, propertyPath: string): any;
  10361. /**
  10362. * Serialize placeholder for child classes
  10363. * @param parent of child
  10364. * @returns the serialized object
  10365. */
  10366. serialize(parent: any): any;
  10367. /**
  10368. * Internal only called by serialize
  10369. * @hidden
  10370. */
  10371. protected _serialize(serializedAction: any, parent?: any): any;
  10372. /**
  10373. * Internal only
  10374. * @hidden
  10375. */
  10376. static _SerializeValueAsString: (value: any) => string;
  10377. /**
  10378. * Internal only
  10379. * @hidden
  10380. */
  10381. static _GetTargetProperty: (target: import("babylonjs/node").Node | import("babylonjs/scene").Scene) => {
  10382. name: string;
  10383. targetType: string;
  10384. value: string;
  10385. };
  10386. }
  10387. }
  10388. declare module "babylonjs/Actions/condition" {
  10389. import { ActionManager } from "babylonjs/Actions/actionManager";
  10390. /**
  10391. * A Condition applied to an Action
  10392. */
  10393. export class Condition {
  10394. /**
  10395. * Internal only - manager for action
  10396. * @hidden
  10397. */
  10398. _actionManager: ActionManager;
  10399. /**
  10400. * Internal only
  10401. * @hidden
  10402. */
  10403. _evaluationId: number;
  10404. /**
  10405. * Internal only
  10406. * @hidden
  10407. */
  10408. _currentResult: boolean;
  10409. /**
  10410. * Creates a new Condition
  10411. * @param actionManager the manager of the action the condition is applied to
  10412. */
  10413. constructor(actionManager: ActionManager);
  10414. /**
  10415. * Check if the current condition is valid
  10416. * @returns a boolean
  10417. */
  10418. isValid(): boolean;
  10419. /**
  10420. * Internal only
  10421. * @hidden
  10422. */
  10423. _getProperty(propertyPath: string): string;
  10424. /**
  10425. * Internal only
  10426. * @hidden
  10427. */
  10428. _getEffectiveTarget(target: any, propertyPath: string): any;
  10429. /**
  10430. * Serialize placeholder for child classes
  10431. * @returns the serialized object
  10432. */
  10433. serialize(): any;
  10434. /**
  10435. * Internal only
  10436. * @hidden
  10437. */
  10438. protected _serialize(serializedCondition: any): any;
  10439. }
  10440. /**
  10441. * Defines specific conditional operators as extensions of Condition
  10442. */
  10443. export class ValueCondition extends Condition {
  10444. /** path to specify the property of the target the conditional operator uses */
  10445. propertyPath: string;
  10446. /** the value compared by the conditional operator against the current value of the property */
  10447. value: any;
  10448. /** the conditional operator, default ValueCondition.IsEqual */
  10449. operator: number;
  10450. /**
  10451. * Internal only
  10452. * @hidden
  10453. */
  10454. private static _IsEqual;
  10455. /**
  10456. * Internal only
  10457. * @hidden
  10458. */
  10459. private static _IsDifferent;
  10460. /**
  10461. * Internal only
  10462. * @hidden
  10463. */
  10464. private static _IsGreater;
  10465. /**
  10466. * Internal only
  10467. * @hidden
  10468. */
  10469. private static _IsLesser;
  10470. /**
  10471. * returns the number for IsEqual
  10472. */
  10473. static readonly IsEqual: number;
  10474. /**
  10475. * Returns the number for IsDifferent
  10476. */
  10477. static readonly IsDifferent: number;
  10478. /**
  10479. * Returns the number for IsGreater
  10480. */
  10481. static readonly IsGreater: number;
  10482. /**
  10483. * Returns the number for IsLesser
  10484. */
  10485. static readonly IsLesser: number;
  10486. /**
  10487. * Internal only The action manager for the condition
  10488. * @hidden
  10489. */
  10490. _actionManager: ActionManager;
  10491. /**
  10492. * Internal only
  10493. * @hidden
  10494. */
  10495. private _target;
  10496. /**
  10497. * Internal only
  10498. * @hidden
  10499. */
  10500. private _effectiveTarget;
  10501. /**
  10502. * Internal only
  10503. * @hidden
  10504. */
  10505. private _property;
  10506. /**
  10507. * Creates a new ValueCondition
  10508. * @param actionManager manager for the action the condition applies to
  10509. * @param target for the action
  10510. * @param propertyPath path to specify the property of the target the conditional operator uses
  10511. * @param value the value compared by the conditional operator against the current value of the property
  10512. * @param operator the conditional operator, default ValueCondition.IsEqual
  10513. */
  10514. constructor(actionManager: ActionManager, target: any,
  10515. /** path to specify the property of the target the conditional operator uses */
  10516. propertyPath: string,
  10517. /** the value compared by the conditional operator against the current value of the property */
  10518. value: any,
  10519. /** the conditional operator, default ValueCondition.IsEqual */
  10520. operator?: number);
  10521. /**
  10522. * Compares the given value with the property value for the specified conditional operator
  10523. * @returns the result of the comparison
  10524. */
  10525. isValid(): boolean;
  10526. /**
  10527. * Serialize the ValueCondition into a JSON compatible object
  10528. * @returns serialization object
  10529. */
  10530. serialize(): any;
  10531. /**
  10532. * Gets the name of the conditional operator for the ValueCondition
  10533. * @param operator the conditional operator
  10534. * @returns the name
  10535. */
  10536. static GetOperatorName(operator: number): string;
  10537. }
  10538. /**
  10539. * Defines a predicate condition as an extension of Condition
  10540. */
  10541. export class PredicateCondition extends Condition {
  10542. /** defines the predicate function used to validate the condition */
  10543. predicate: () => boolean;
  10544. /**
  10545. * Internal only - manager for action
  10546. * @hidden
  10547. */
  10548. _actionManager: ActionManager;
  10549. /**
  10550. * Creates a new PredicateCondition
  10551. * @param actionManager manager for the action the condition applies to
  10552. * @param predicate defines the predicate function used to validate the condition
  10553. */
  10554. constructor(actionManager: ActionManager,
  10555. /** defines the predicate function used to validate the condition */
  10556. predicate: () => boolean);
  10557. /**
  10558. * @returns the validity of the predicate condition
  10559. */
  10560. isValid(): boolean;
  10561. }
  10562. /**
  10563. * Defines a state condition as an extension of Condition
  10564. */
  10565. export class StateCondition extends Condition {
  10566. /** Value to compare with target state */
  10567. value: string;
  10568. /**
  10569. * Internal only - manager for action
  10570. * @hidden
  10571. */
  10572. _actionManager: ActionManager;
  10573. /**
  10574. * Internal only
  10575. * @hidden
  10576. */
  10577. private _target;
  10578. /**
  10579. * Creates a new StateCondition
  10580. * @param actionManager manager for the action the condition applies to
  10581. * @param target of the condition
  10582. * @param value to compare with target state
  10583. */
  10584. constructor(actionManager: ActionManager, target: any,
  10585. /** Value to compare with target state */
  10586. value: string);
  10587. /**
  10588. * Gets a boolean indicating if the current condition is met
  10589. * @returns the validity of the state
  10590. */
  10591. isValid(): boolean;
  10592. /**
  10593. * Serialize the StateCondition into a JSON compatible object
  10594. * @returns serialization object
  10595. */
  10596. serialize(): any;
  10597. }
  10598. }
  10599. declare module "babylonjs/Actions/directActions" {
  10600. import { Action } from "babylonjs/Actions/action";
  10601. import { Condition } from "babylonjs/Actions/condition";
  10602. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10603. /**
  10604. * This defines an action responsible to toggle a boolean once triggered.
  10605. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10606. */
  10607. export class SwitchBooleanAction extends Action {
  10608. /**
  10609. * The path to the boolean property in the target object
  10610. */
  10611. propertyPath: string;
  10612. private _target;
  10613. private _effectiveTarget;
  10614. private _property;
  10615. /**
  10616. * Instantiate the action
  10617. * @param triggerOptions defines the trigger options
  10618. * @param target defines the object containing the boolean
  10619. * @param propertyPath defines the path to the boolean property in the target object
  10620. * @param condition defines the trigger related conditions
  10621. */
  10622. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  10623. /** @hidden */
  10624. _prepare(): void;
  10625. /**
  10626. * Execute the action toggle the boolean value.
  10627. */
  10628. execute(): void;
  10629. /**
  10630. * Serializes the actions and its related information.
  10631. * @param parent defines the object to serialize in
  10632. * @returns the serialized object
  10633. */
  10634. serialize(parent: any): any;
  10635. }
  10636. /**
  10637. * This defines an action responsible to set a the state field of the target
  10638. * to a desired value once triggered.
  10639. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10640. */
  10641. export class SetStateAction extends Action {
  10642. /**
  10643. * The value to store in the state field.
  10644. */
  10645. value: string;
  10646. private _target;
  10647. /**
  10648. * Instantiate the action
  10649. * @param triggerOptions defines the trigger options
  10650. * @param target defines the object containing the state property
  10651. * @param value defines the value to store in the state field
  10652. * @param condition defines the trigger related conditions
  10653. */
  10654. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  10655. /**
  10656. * Execute the action and store the value on the target state property.
  10657. */
  10658. execute(): void;
  10659. /**
  10660. * Serializes the actions and its related information.
  10661. * @param parent defines the object to serialize in
  10662. * @returns the serialized object
  10663. */
  10664. serialize(parent: any): any;
  10665. }
  10666. /**
  10667. * This defines an action responsible to set a property of the target
  10668. * to a desired value once triggered.
  10669. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10670. */
  10671. export class SetValueAction extends Action {
  10672. /**
  10673. * The path of the property to set in the target.
  10674. */
  10675. propertyPath: string;
  10676. /**
  10677. * The value to set in the property
  10678. */
  10679. value: any;
  10680. private _target;
  10681. private _effectiveTarget;
  10682. private _property;
  10683. /**
  10684. * Instantiate the action
  10685. * @param triggerOptions defines the trigger options
  10686. * @param target defines the object containing the property
  10687. * @param propertyPath defines the path of the property to set in the target
  10688. * @param value defines the value to set in the property
  10689. * @param condition defines the trigger related conditions
  10690. */
  10691. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10692. /** @hidden */
  10693. _prepare(): void;
  10694. /**
  10695. * Execute the action and set the targetted property to the desired value.
  10696. */
  10697. execute(): void;
  10698. /**
  10699. * Serializes the actions and its related information.
  10700. * @param parent defines the object to serialize in
  10701. * @returns the serialized object
  10702. */
  10703. serialize(parent: any): any;
  10704. }
  10705. /**
  10706. * This defines an action responsible to increment the target value
  10707. * to a desired value once triggered.
  10708. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10709. */
  10710. export class IncrementValueAction extends Action {
  10711. /**
  10712. * The path of the property to increment in the target.
  10713. */
  10714. propertyPath: string;
  10715. /**
  10716. * The value we should increment the property by.
  10717. */
  10718. value: any;
  10719. private _target;
  10720. private _effectiveTarget;
  10721. private _property;
  10722. /**
  10723. * Instantiate the action
  10724. * @param triggerOptions defines the trigger options
  10725. * @param target defines the object containing the property
  10726. * @param propertyPath defines the path of the property to increment in the target
  10727. * @param value defines the value value we should increment the property by
  10728. * @param condition defines the trigger related conditions
  10729. */
  10730. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10731. /** @hidden */
  10732. _prepare(): void;
  10733. /**
  10734. * Execute the action and increment the target of the value amount.
  10735. */
  10736. execute(): void;
  10737. /**
  10738. * Serializes the actions and its related information.
  10739. * @param parent defines the object to serialize in
  10740. * @returns the serialized object
  10741. */
  10742. serialize(parent: any): any;
  10743. }
  10744. /**
  10745. * This defines an action responsible to start an animation once triggered.
  10746. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10747. */
  10748. export class PlayAnimationAction extends Action {
  10749. /**
  10750. * Where the animation should start (animation frame)
  10751. */
  10752. from: number;
  10753. /**
  10754. * Where the animation should stop (animation frame)
  10755. */
  10756. to: number;
  10757. /**
  10758. * Define if the animation should loop or stop after the first play.
  10759. */
  10760. loop?: boolean;
  10761. private _target;
  10762. /**
  10763. * Instantiate the action
  10764. * @param triggerOptions defines the trigger options
  10765. * @param target defines the target animation or animation name
  10766. * @param from defines from where the animation should start (animation frame)
  10767. * @param end defines where the animation should stop (animation frame)
  10768. * @param loop defines if the animation should loop or stop after the first play
  10769. * @param condition defines the trigger related conditions
  10770. */
  10771. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10772. /** @hidden */
  10773. _prepare(): void;
  10774. /**
  10775. * Execute the action and play the animation.
  10776. */
  10777. execute(): void;
  10778. /**
  10779. * Serializes the actions and its related information.
  10780. * @param parent defines the object to serialize in
  10781. * @returns the serialized object
  10782. */
  10783. serialize(parent: any): any;
  10784. }
  10785. /**
  10786. * This defines an action responsible to stop an animation once triggered.
  10787. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10788. */
  10789. export class StopAnimationAction extends Action {
  10790. private _target;
  10791. /**
  10792. * Instantiate the action
  10793. * @param triggerOptions defines the trigger options
  10794. * @param target defines the target animation or animation name
  10795. * @param condition defines the trigger related conditions
  10796. */
  10797. constructor(triggerOptions: any, target: any, condition?: Condition);
  10798. /** @hidden */
  10799. _prepare(): void;
  10800. /**
  10801. * Execute the action and stop the animation.
  10802. */
  10803. execute(): void;
  10804. /**
  10805. * Serializes the actions and its related information.
  10806. * @param parent defines the object to serialize in
  10807. * @returns the serialized object
  10808. */
  10809. serialize(parent: any): any;
  10810. }
  10811. /**
  10812. * This defines an action responsible that does nothing once triggered.
  10813. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10814. */
  10815. export class DoNothingAction extends Action {
  10816. /**
  10817. * Instantiate the action
  10818. * @param triggerOptions defines the trigger options
  10819. * @param condition defines the trigger related conditions
  10820. */
  10821. constructor(triggerOptions?: any, condition?: Condition);
  10822. /**
  10823. * Execute the action and do nothing.
  10824. */
  10825. execute(): void;
  10826. /**
  10827. * Serializes the actions and its related information.
  10828. * @param parent defines the object to serialize in
  10829. * @returns the serialized object
  10830. */
  10831. serialize(parent: any): any;
  10832. }
  10833. /**
  10834. * This defines an action responsible to trigger several actions once triggered.
  10835. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10836. */
  10837. export class CombineAction extends Action {
  10838. /**
  10839. * The list of aggregated animations to run.
  10840. */
  10841. children: Action[];
  10842. /**
  10843. * Instantiate the action
  10844. * @param triggerOptions defines the trigger options
  10845. * @param children defines the list of aggregated animations to run
  10846. * @param condition defines the trigger related conditions
  10847. */
  10848. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10849. /** @hidden */
  10850. _prepare(): void;
  10851. /**
  10852. * Execute the action and executes all the aggregated actions.
  10853. */
  10854. execute(evt: ActionEvent): void;
  10855. /**
  10856. * Serializes the actions and its related information.
  10857. * @param parent defines the object to serialize in
  10858. * @returns the serialized object
  10859. */
  10860. serialize(parent: any): any;
  10861. }
  10862. /**
  10863. * This defines an action responsible to run code (external event) once triggered.
  10864. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10865. */
  10866. export class ExecuteCodeAction extends Action {
  10867. /**
  10868. * The callback function to run.
  10869. */
  10870. func: (evt: ActionEvent) => void;
  10871. /**
  10872. * Instantiate the action
  10873. * @param triggerOptions defines the trigger options
  10874. * @param func defines the callback function to run
  10875. * @param condition defines the trigger related conditions
  10876. */
  10877. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10878. /**
  10879. * Execute the action and run the attached code.
  10880. */
  10881. execute(evt: ActionEvent): void;
  10882. }
  10883. /**
  10884. * This defines an action responsible to set the parent property of the target once triggered.
  10885. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10886. */
  10887. export class SetParentAction extends Action {
  10888. private _parent;
  10889. private _target;
  10890. /**
  10891. * Instantiate the action
  10892. * @param triggerOptions defines the trigger options
  10893. * @param target defines the target containing the parent property
  10894. * @param parent defines from where the animation should start (animation frame)
  10895. * @param condition defines the trigger related conditions
  10896. */
  10897. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10898. /** @hidden */
  10899. _prepare(): void;
  10900. /**
  10901. * Execute the action and set the parent property.
  10902. */
  10903. execute(): void;
  10904. /**
  10905. * Serializes the actions and its related information.
  10906. * @param parent defines the object to serialize in
  10907. * @returns the serialized object
  10908. */
  10909. serialize(parent: any): any;
  10910. }
  10911. }
  10912. declare module "babylonjs/Actions/actionManager" {
  10913. import { Nullable } from "babylonjs/types";
  10914. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10915. import { Scene } from "babylonjs/scene";
  10916. import { IAction } from "babylonjs/Actions/action";
  10917. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10918. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10919. /**
  10920. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10921. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10922. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10923. */
  10924. export class ActionManager extends AbstractActionManager {
  10925. /**
  10926. * Nothing
  10927. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10928. */
  10929. static readonly NothingTrigger: number;
  10930. /**
  10931. * On pick
  10932. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10933. */
  10934. static readonly OnPickTrigger: number;
  10935. /**
  10936. * On left pick
  10937. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10938. */
  10939. static readonly OnLeftPickTrigger: number;
  10940. /**
  10941. * On right pick
  10942. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10943. */
  10944. static readonly OnRightPickTrigger: number;
  10945. /**
  10946. * On center pick
  10947. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10948. */
  10949. static readonly OnCenterPickTrigger: number;
  10950. /**
  10951. * On pick down
  10952. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10953. */
  10954. static readonly OnPickDownTrigger: number;
  10955. /**
  10956. * On double pick
  10957. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10958. */
  10959. static readonly OnDoublePickTrigger: number;
  10960. /**
  10961. * On pick up
  10962. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10963. */
  10964. static readonly OnPickUpTrigger: number;
  10965. /**
  10966. * On pick out.
  10967. * This trigger will only be raised if you also declared a OnPickDown
  10968. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10969. */
  10970. static readonly OnPickOutTrigger: number;
  10971. /**
  10972. * On long press
  10973. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10974. */
  10975. static readonly OnLongPressTrigger: number;
  10976. /**
  10977. * On pointer over
  10978. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10979. */
  10980. static readonly OnPointerOverTrigger: number;
  10981. /**
  10982. * On pointer out
  10983. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10984. */
  10985. static readonly OnPointerOutTrigger: number;
  10986. /**
  10987. * On every frame
  10988. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10989. */
  10990. static readonly OnEveryFrameTrigger: number;
  10991. /**
  10992. * On intersection enter
  10993. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10994. */
  10995. static readonly OnIntersectionEnterTrigger: number;
  10996. /**
  10997. * On intersection exit
  10998. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10999. */
  11000. static readonly OnIntersectionExitTrigger: number;
  11001. /**
  11002. * On key down
  11003. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11004. */
  11005. static readonly OnKeyDownTrigger: number;
  11006. /**
  11007. * On key up
  11008. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11009. */
  11010. static readonly OnKeyUpTrigger: number;
  11011. private _scene;
  11012. /**
  11013. * Creates a new action manager
  11014. * @param scene defines the hosting scene
  11015. */
  11016. constructor(scene: Scene);
  11017. /**
  11018. * Releases all associated resources
  11019. */
  11020. dispose(): void;
  11021. /**
  11022. * Gets hosting scene
  11023. * @returns the hosting scene
  11024. */
  11025. getScene(): Scene;
  11026. /**
  11027. * Does this action manager handles actions of any of the given triggers
  11028. * @param triggers defines the triggers to be tested
  11029. * @return a boolean indicating whether one (or more) of the triggers is handled
  11030. */
  11031. hasSpecificTriggers(triggers: number[]): boolean;
  11032. /**
  11033. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  11034. * speed.
  11035. * @param triggerA defines the trigger to be tested
  11036. * @param triggerB defines the trigger to be tested
  11037. * @return a boolean indicating whether one (or more) of the triggers is handled
  11038. */
  11039. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  11040. /**
  11041. * Does this action manager handles actions of a given trigger
  11042. * @param trigger defines the trigger to be tested
  11043. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  11044. * @return whether the trigger is handled
  11045. */
  11046. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  11047. /**
  11048. * Does this action manager has pointer triggers
  11049. */
  11050. readonly hasPointerTriggers: boolean;
  11051. /**
  11052. * Does this action manager has pick triggers
  11053. */
  11054. readonly hasPickTriggers: boolean;
  11055. /**
  11056. * Registers an action to this action manager
  11057. * @param action defines the action to be registered
  11058. * @return the action amended (prepared) after registration
  11059. */
  11060. registerAction(action: IAction): Nullable<IAction>;
  11061. /**
  11062. * Unregisters an action to this action manager
  11063. * @param action defines the action to be unregistered
  11064. * @return a boolean indicating whether the action has been unregistered
  11065. */
  11066. unregisterAction(action: IAction): Boolean;
  11067. /**
  11068. * Process a specific trigger
  11069. * @param trigger defines the trigger to process
  11070. * @param evt defines the event details to be processed
  11071. */
  11072. processTrigger(trigger: number, evt?: IActionEvent): void;
  11073. /** @hidden */
  11074. _getEffectiveTarget(target: any, propertyPath: string): any;
  11075. /** @hidden */
  11076. _getProperty(propertyPath: string): string;
  11077. /**
  11078. * Serialize this manager to a JSON object
  11079. * @param name defines the property name to store this manager
  11080. * @returns a JSON representation of this manager
  11081. */
  11082. serialize(name: string): any;
  11083. /**
  11084. * Creates a new ActionManager from a JSON data
  11085. * @param parsedActions defines the JSON data to read from
  11086. * @param object defines the hosting mesh
  11087. * @param scene defines the hosting scene
  11088. */
  11089. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  11090. /**
  11091. * Get a trigger name by index
  11092. * @param trigger defines the trigger index
  11093. * @returns a trigger name
  11094. */
  11095. static GetTriggerName(trigger: number): string;
  11096. }
  11097. }
  11098. declare module "babylonjs/Culling/ray" {
  11099. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  11100. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  11101. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11102. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11103. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  11104. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  11105. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  11106. import { Plane } from "babylonjs/Maths/math.plane";
  11107. /**
  11108. * Class representing a ray with position and direction
  11109. */
  11110. export class Ray {
  11111. /** origin point */
  11112. origin: Vector3;
  11113. /** direction */
  11114. direction: Vector3;
  11115. /** length of the ray */
  11116. length: number;
  11117. private static readonly TmpVector3;
  11118. private _tmpRay;
  11119. /**
  11120. * Creates a new ray
  11121. * @param origin origin point
  11122. * @param direction direction
  11123. * @param length length of the ray
  11124. */
  11125. constructor(
  11126. /** origin point */
  11127. origin: Vector3,
  11128. /** direction */
  11129. direction: Vector3,
  11130. /** length of the ray */
  11131. length?: number);
  11132. /**
  11133. * Checks if the ray intersects a box
  11134. * @param minimum bound of the box
  11135. * @param maximum bound of the box
  11136. * @param intersectionTreshold extra extend to be added to the box in all direction
  11137. * @returns if the box was hit
  11138. */
  11139. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  11140. /**
  11141. * Checks if the ray intersects a box
  11142. * @param box the bounding box to check
  11143. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  11144. * @returns if the box was hit
  11145. */
  11146. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  11147. /**
  11148. * If the ray hits a sphere
  11149. * @param sphere the bounding sphere to check
  11150. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  11151. * @returns true if it hits the sphere
  11152. */
  11153. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  11154. /**
  11155. * If the ray hits a triange
  11156. * @param vertex0 triangle vertex
  11157. * @param vertex1 triangle vertex
  11158. * @param vertex2 triangle vertex
  11159. * @returns intersection information if hit
  11160. */
  11161. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  11162. /**
  11163. * Checks if ray intersects a plane
  11164. * @param plane the plane to check
  11165. * @returns the distance away it was hit
  11166. */
  11167. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  11168. /**
  11169. * Calculate the intercept of a ray on a given axis
  11170. * @param axis to check 'x' | 'y' | 'z'
  11171. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  11172. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  11173. */
  11174. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  11175. /**
  11176. * Checks if ray intersects a mesh
  11177. * @param mesh the mesh to check
  11178. * @param fastCheck if only the bounding box should checked
  11179. * @returns picking info of the intersecton
  11180. */
  11181. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  11182. /**
  11183. * Checks if ray intersects a mesh
  11184. * @param meshes the meshes to check
  11185. * @param fastCheck if only the bounding box should checked
  11186. * @param results array to store result in
  11187. * @returns Array of picking infos
  11188. */
  11189. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  11190. private _comparePickingInfo;
  11191. private static smallnum;
  11192. private static rayl;
  11193. /**
  11194. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  11195. * @param sega the first point of the segment to test the intersection against
  11196. * @param segb the second point of the segment to test the intersection against
  11197. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  11198. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  11199. */
  11200. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  11201. /**
  11202. * Update the ray from viewport position
  11203. * @param x position
  11204. * @param y y position
  11205. * @param viewportWidth viewport width
  11206. * @param viewportHeight viewport height
  11207. * @param world world matrix
  11208. * @param view view matrix
  11209. * @param projection projection matrix
  11210. * @returns this ray updated
  11211. */
  11212. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11213. /**
  11214. * Creates a ray with origin and direction of 0,0,0
  11215. * @returns the new ray
  11216. */
  11217. static Zero(): Ray;
  11218. /**
  11219. * Creates a new ray from screen space and viewport
  11220. * @param x position
  11221. * @param y y position
  11222. * @param viewportWidth viewport width
  11223. * @param viewportHeight viewport height
  11224. * @param world world matrix
  11225. * @param view view matrix
  11226. * @param projection projection matrix
  11227. * @returns new ray
  11228. */
  11229. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11230. /**
  11231. * Function will create a new transformed ray starting from origin and ending at the end point. Ray's length will be set, and ray will be
  11232. * transformed to the given world matrix.
  11233. * @param origin The origin point
  11234. * @param end The end point
  11235. * @param world a matrix to transform the ray to. Default is the identity matrix.
  11236. * @returns the new ray
  11237. */
  11238. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  11239. /**
  11240. * Transforms a ray by a matrix
  11241. * @param ray ray to transform
  11242. * @param matrix matrix to apply
  11243. * @returns the resulting new ray
  11244. */
  11245. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  11246. /**
  11247. * Transforms a ray by a matrix
  11248. * @param ray ray to transform
  11249. * @param matrix matrix to apply
  11250. * @param result ray to store result in
  11251. */
  11252. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  11253. /**
  11254. * Unproject a ray from screen space to object space
  11255. * @param sourceX defines the screen space x coordinate to use
  11256. * @param sourceY defines the screen space y coordinate to use
  11257. * @param viewportWidth defines the current width of the viewport
  11258. * @param viewportHeight defines the current height of the viewport
  11259. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  11260. * @param view defines the view matrix to use
  11261. * @param projection defines the projection matrix to use
  11262. */
  11263. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  11264. }
  11265. /**
  11266. * Type used to define predicate used to select faces when a mesh intersection is detected
  11267. */
  11268. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  11269. module "babylonjs/scene" {
  11270. interface Scene {
  11271. /** @hidden */
  11272. _tempPickingRay: Nullable<Ray>;
  11273. /** @hidden */
  11274. _cachedRayForTransform: Ray;
  11275. /** @hidden */
  11276. _pickWithRayInverseMatrix: Matrix;
  11277. /** @hidden */
  11278. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  11279. /** @hidden */
  11280. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  11281. }
  11282. }
  11283. }
  11284. declare module "babylonjs/sceneComponent" {
  11285. import { Scene } from "babylonjs/scene";
  11286. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11287. import { SubMesh } from "babylonjs/Meshes/subMesh";
  11288. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  11289. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  11290. import { Nullable } from "babylonjs/types";
  11291. import { Camera } from "babylonjs/Cameras/camera";
  11292. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  11293. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11294. import { AbstractScene } from "babylonjs/abstractScene";
  11295. import { Mesh } from "babylonjs/Meshes/mesh";
  11296. /**
  11297. * Groups all the scene component constants in one place to ease maintenance.
  11298. * @hidden
  11299. */
  11300. export class SceneComponentConstants {
  11301. static readonly NAME_EFFECTLAYER: string;
  11302. static readonly NAME_LAYER: string;
  11303. static readonly NAME_LENSFLARESYSTEM: string;
  11304. static readonly NAME_BOUNDINGBOXRENDERER: string;
  11305. static readonly NAME_PARTICLESYSTEM: string;
  11306. static readonly NAME_GAMEPAD: string;
  11307. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  11308. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  11309. static readonly NAME_DEPTHRENDERER: string;
  11310. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  11311. static readonly NAME_SPRITE: string;
  11312. static readonly NAME_OUTLINERENDERER: string;
  11313. static readonly NAME_PROCEDURALTEXTURE: string;
  11314. static readonly NAME_SHADOWGENERATOR: string;
  11315. static readonly NAME_OCTREE: string;
  11316. static readonly NAME_PHYSICSENGINE: string;
  11317. static readonly NAME_AUDIO: string;
  11318. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  11319. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11320. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  11321. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11322. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  11323. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  11324. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  11325. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  11326. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  11327. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  11328. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  11329. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  11330. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  11331. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  11332. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  11333. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  11334. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  11335. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  11336. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  11337. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  11338. static readonly STEP_AFTERRENDER_AUDIO: number;
  11339. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  11340. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  11341. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  11342. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  11343. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  11344. static readonly STEP_POINTERMOVE_SPRITE: number;
  11345. static readonly STEP_POINTERDOWN_SPRITE: number;
  11346. static readonly STEP_POINTERUP_SPRITE: number;
  11347. }
  11348. /**
  11349. * This represents a scene component.
  11350. *
  11351. * This is used to decouple the dependency the scene is having on the different workloads like
  11352. * layers, post processes...
  11353. */
  11354. export interface ISceneComponent {
  11355. /**
  11356. * The name of the component. Each component must have a unique name.
  11357. */
  11358. name: string;
  11359. /**
  11360. * The scene the component belongs to.
  11361. */
  11362. scene: Scene;
  11363. /**
  11364. * Register the component to one instance of a scene.
  11365. */
  11366. register(): void;
  11367. /**
  11368. * Rebuilds the elements related to this component in case of
  11369. * context lost for instance.
  11370. */
  11371. rebuild(): void;
  11372. /**
  11373. * Disposes the component and the associated ressources.
  11374. */
  11375. dispose(): void;
  11376. }
  11377. /**
  11378. * This represents a SERIALIZABLE scene component.
  11379. *
  11380. * This extends Scene Component to add Serialization methods on top.
  11381. */
  11382. export interface ISceneSerializableComponent extends ISceneComponent {
  11383. /**
  11384. * Adds all the elements from the container to the scene
  11385. * @param container the container holding the elements
  11386. */
  11387. addFromContainer(container: AbstractScene): void;
  11388. /**
  11389. * Removes all the elements in the container from the scene
  11390. * @param container contains the elements to remove
  11391. * @param dispose if the removed element should be disposed (default: false)
  11392. */
  11393. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  11394. /**
  11395. * Serializes the component data to the specified json object
  11396. * @param serializationObject The object to serialize to
  11397. */
  11398. serialize(serializationObject: any): void;
  11399. }
  11400. /**
  11401. * Strong typing of a Mesh related stage step action
  11402. */
  11403. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  11404. /**
  11405. * Strong typing of a Evaluate Sub Mesh related stage step action
  11406. */
  11407. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  11408. /**
  11409. * Strong typing of a Active Mesh related stage step action
  11410. */
  11411. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  11412. /**
  11413. * Strong typing of a Camera related stage step action
  11414. */
  11415. export type CameraStageAction = (camera: Camera) => void;
  11416. /**
  11417. * Strong typing of a Camera Frame buffer related stage step action
  11418. */
  11419. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  11420. /**
  11421. * Strong typing of a Render Target related stage step action
  11422. */
  11423. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  11424. /**
  11425. * Strong typing of a RenderingGroup related stage step action
  11426. */
  11427. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  11428. /**
  11429. * Strong typing of a Mesh Render related stage step action
  11430. */
  11431. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  11432. /**
  11433. * Strong typing of a simple stage step action
  11434. */
  11435. export type SimpleStageAction = () => void;
  11436. /**
  11437. * Strong typing of a render target action.
  11438. */
  11439. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  11440. /**
  11441. * Strong typing of a pointer move action.
  11442. */
  11443. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  11444. /**
  11445. * Strong typing of a pointer up/down action.
  11446. */
  11447. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  11448. /**
  11449. * Representation of a stage in the scene (Basically a list of ordered steps)
  11450. * @hidden
  11451. */
  11452. export class Stage<T extends Function> extends Array<{
  11453. index: number;
  11454. component: ISceneComponent;
  11455. action: T;
  11456. }> {
  11457. /**
  11458. * Hide ctor from the rest of the world.
  11459. * @param items The items to add.
  11460. */
  11461. private constructor();
  11462. /**
  11463. * Creates a new Stage.
  11464. * @returns A new instance of a Stage
  11465. */
  11466. static Create<T extends Function>(): Stage<T>;
  11467. /**
  11468. * Registers a step in an ordered way in the targeted stage.
  11469. * @param index Defines the position to register the step in
  11470. * @param component Defines the component attached to the step
  11471. * @param action Defines the action to launch during the step
  11472. */
  11473. registerStep(index: number, component: ISceneComponent, action: T): void;
  11474. /**
  11475. * Clears all the steps from the stage.
  11476. */
  11477. clear(): void;
  11478. }
  11479. }
  11480. declare module "babylonjs/Sprites/spriteSceneComponent" {
  11481. import { Nullable } from "babylonjs/types";
  11482. import { Observable } from "babylonjs/Misc/observable";
  11483. import { Scene } from "babylonjs/scene";
  11484. import { Sprite } from "babylonjs/Sprites/sprite";
  11485. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11486. import { Ray } from "babylonjs/Culling/ray";
  11487. import { Camera } from "babylonjs/Cameras/camera";
  11488. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11489. import { ISceneComponent } from "babylonjs/sceneComponent";
  11490. module "babylonjs/scene" {
  11491. interface Scene {
  11492. /** @hidden */
  11493. _pointerOverSprite: Nullable<Sprite>;
  11494. /** @hidden */
  11495. _pickedDownSprite: Nullable<Sprite>;
  11496. /** @hidden */
  11497. _tempSpritePickingRay: Nullable<Ray>;
  11498. /**
  11499. * All of the sprite managers added to this scene
  11500. * @see http://doc.babylonjs.com/babylon101/sprites
  11501. */
  11502. spriteManagers: Array<ISpriteManager>;
  11503. /**
  11504. * An event triggered when sprites rendering is about to start
  11505. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11506. */
  11507. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11508. /**
  11509. * An event triggered when sprites rendering is done
  11510. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11511. */
  11512. onAfterSpritesRenderingObservable: Observable<Scene>;
  11513. /** @hidden */
  11514. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11515. /** Launch a ray to try to pick a sprite in the scene
  11516. * @param x position on screen
  11517. * @param y position on screen
  11518. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11519. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11520. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11521. * @returns a PickingInfo
  11522. */
  11523. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11524. /** Use the given ray to pick a sprite in the scene
  11525. * @param ray The ray (in world space) to use to pick meshes
  11526. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11527. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11528. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11529. * @returns a PickingInfo
  11530. */
  11531. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11532. /** @hidden */
  11533. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11534. /** Launch a ray to try to pick sprites in the scene
  11535. * @param x position on screen
  11536. * @param y position on screen
  11537. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11538. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11539. * @returns a PickingInfo array
  11540. */
  11541. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11542. /** Use the given ray to pick sprites in the scene
  11543. * @param ray The ray (in world space) to use to pick meshes
  11544. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11545. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11546. * @returns a PickingInfo array
  11547. */
  11548. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11549. /**
  11550. * Force the sprite under the pointer
  11551. * @param sprite defines the sprite to use
  11552. */
  11553. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11554. /**
  11555. * Gets the sprite under the pointer
  11556. * @returns a Sprite or null if no sprite is under the pointer
  11557. */
  11558. getPointerOverSprite(): Nullable<Sprite>;
  11559. }
  11560. }
  11561. /**
  11562. * Defines the sprite scene component responsible to manage sprites
  11563. * in a given scene.
  11564. */
  11565. export class SpriteSceneComponent implements ISceneComponent {
  11566. /**
  11567. * The component name helpfull to identify the component in the list of scene components.
  11568. */
  11569. readonly name: string;
  11570. /**
  11571. * The scene the component belongs to.
  11572. */
  11573. scene: Scene;
  11574. /** @hidden */
  11575. private _spritePredicate;
  11576. /**
  11577. * Creates a new instance of the component for the given scene
  11578. * @param scene Defines the scene to register the component in
  11579. */
  11580. constructor(scene: Scene);
  11581. /**
  11582. * Registers the component in a given scene
  11583. */
  11584. register(): void;
  11585. /**
  11586. * Rebuilds the elements related to this component in case of
  11587. * context lost for instance.
  11588. */
  11589. rebuild(): void;
  11590. /**
  11591. * Disposes the component and the associated ressources.
  11592. */
  11593. dispose(): void;
  11594. private _pickSpriteButKeepRay;
  11595. private _pointerMove;
  11596. private _pointerDown;
  11597. private _pointerUp;
  11598. }
  11599. }
  11600. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11601. /** @hidden */
  11602. export var fogFragmentDeclaration: {
  11603. name: string;
  11604. shader: string;
  11605. };
  11606. }
  11607. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11608. /** @hidden */
  11609. export var fogFragment: {
  11610. name: string;
  11611. shader: string;
  11612. };
  11613. }
  11614. declare module "babylonjs/Shaders/sprites.fragment" {
  11615. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11616. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11617. /** @hidden */
  11618. export var spritesPixelShader: {
  11619. name: string;
  11620. shader: string;
  11621. };
  11622. }
  11623. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11624. /** @hidden */
  11625. export var fogVertexDeclaration: {
  11626. name: string;
  11627. shader: string;
  11628. };
  11629. }
  11630. declare module "babylonjs/Shaders/sprites.vertex" {
  11631. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11632. /** @hidden */
  11633. export var spritesVertexShader: {
  11634. name: string;
  11635. shader: string;
  11636. };
  11637. }
  11638. declare module "babylonjs/Sprites/spriteManager" {
  11639. import { IDisposable, Scene } from "babylonjs/scene";
  11640. import { Nullable } from "babylonjs/types";
  11641. import { Observable } from "babylonjs/Misc/observable";
  11642. import { Sprite } from "babylonjs/Sprites/sprite";
  11643. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11644. import { Camera } from "babylonjs/Cameras/camera";
  11645. import { Texture } from "babylonjs/Materials/Textures/texture";
  11646. import "babylonjs/Shaders/sprites.fragment";
  11647. import "babylonjs/Shaders/sprites.vertex";
  11648. import { Ray } from "babylonjs/Culling/ray";
  11649. /**
  11650. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11651. */
  11652. export interface ISpriteManager extends IDisposable {
  11653. /**
  11654. * Restricts the camera to viewing objects with the same layerMask.
  11655. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11656. */
  11657. layerMask: number;
  11658. /**
  11659. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11660. */
  11661. isPickable: boolean;
  11662. /**
  11663. * Specifies the rendering group id for this mesh (0 by default)
  11664. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11665. */
  11666. renderingGroupId: number;
  11667. /**
  11668. * Defines the list of sprites managed by the manager.
  11669. */
  11670. sprites: Array<Sprite>;
  11671. /**
  11672. * Tests the intersection of a sprite with a specific ray.
  11673. * @param ray The ray we are sending to test the collision
  11674. * @param camera The camera space we are sending rays in
  11675. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11676. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  11677. * @returns picking info or null.
  11678. */
  11679. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11680. /**
  11681. * Intersects the sprites with a ray
  11682. * @param ray defines the ray to intersect with
  11683. * @param camera defines the current active camera
  11684. * @param predicate defines a predicate used to select candidate sprites
  11685. * @returns null if no hit or a PickingInfo array
  11686. */
  11687. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11688. /**
  11689. * Renders the list of sprites on screen.
  11690. */
  11691. render(): void;
  11692. }
  11693. /**
  11694. * Class used to manage multiple sprites on the same spritesheet
  11695. * @see http://doc.babylonjs.com/babylon101/sprites
  11696. */
  11697. export class SpriteManager implements ISpriteManager {
  11698. /** defines the manager's name */
  11699. name: string;
  11700. /** Gets the list of sprites */
  11701. sprites: Sprite[];
  11702. /** Gets or sets the rendering group id (0 by default) */
  11703. renderingGroupId: number;
  11704. /** Gets or sets camera layer mask */
  11705. layerMask: number;
  11706. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11707. fogEnabled: boolean;
  11708. /** Gets or sets a boolean indicating if the sprites are pickable */
  11709. isPickable: boolean;
  11710. /** Defines the default width of a cell in the spritesheet */
  11711. cellWidth: number;
  11712. /** Defines the default height of a cell in the spritesheet */
  11713. cellHeight: number;
  11714. /** Associative array from JSON sprite data file */
  11715. private _cellData;
  11716. /** Array of sprite names from JSON sprite data file */
  11717. private _spriteMap;
  11718. /** True when packed cell data from JSON file is ready*/
  11719. private _packedAndReady;
  11720. /**
  11721. * An event triggered when the manager is disposed.
  11722. */
  11723. onDisposeObservable: Observable<SpriteManager>;
  11724. private _onDisposeObserver;
  11725. /**
  11726. * Callback called when the manager is disposed
  11727. */
  11728. onDispose: () => void;
  11729. private _capacity;
  11730. private _fromPacked;
  11731. private _spriteTexture;
  11732. private _epsilon;
  11733. private _scene;
  11734. private _vertexData;
  11735. private _buffer;
  11736. private _vertexBuffers;
  11737. private _indexBuffer;
  11738. private _effectBase;
  11739. private _effectFog;
  11740. /**
  11741. * Gets or sets the spritesheet texture
  11742. */
  11743. texture: Texture;
  11744. /**
  11745. * Creates a new sprite manager
  11746. * @param name defines the manager's name
  11747. * @param imgUrl defines the sprite sheet url
  11748. * @param capacity defines the maximum allowed number of sprites
  11749. * @param cellSize defines the size of a sprite cell
  11750. * @param scene defines the hosting scene
  11751. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11752. * @param samplingMode defines the smapling mode to use with spritesheet
  11753. * @param fromPacked set to false; do not alter
  11754. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11755. */
  11756. constructor(
  11757. /** defines the manager's name */
  11758. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  11759. private _makePacked;
  11760. private _appendSpriteVertex;
  11761. /**
  11762. * Intersects the sprites with a ray
  11763. * @param ray defines the ray to intersect with
  11764. * @param camera defines the current active camera
  11765. * @param predicate defines a predicate used to select candidate sprites
  11766. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11767. * @returns null if no hit or a PickingInfo
  11768. */
  11769. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11770. /**
  11771. * Intersects the sprites with a ray
  11772. * @param ray defines the ray to intersect with
  11773. * @param camera defines the current active camera
  11774. * @param predicate defines a predicate used to select candidate sprites
  11775. * @returns null if no hit or a PickingInfo array
  11776. */
  11777. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11778. /**
  11779. * Render all child sprites
  11780. */
  11781. render(): void;
  11782. /**
  11783. * Release associated resources
  11784. */
  11785. dispose(): void;
  11786. }
  11787. }
  11788. declare module "babylonjs/Sprites/sprite" {
  11789. import { Vector3 } from "babylonjs/Maths/math.vector";
  11790. import { Nullable } from "babylonjs/types";
  11791. import { ActionManager } from "babylonjs/Actions/actionManager";
  11792. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11793. import { Color4 } from "babylonjs/Maths/math.color";
  11794. /**
  11795. * Class used to represent a sprite
  11796. * @see http://doc.babylonjs.com/babylon101/sprites
  11797. */
  11798. export class Sprite {
  11799. /** defines the name */
  11800. name: string;
  11801. /** Gets or sets the current world position */
  11802. position: Vector3;
  11803. /** Gets or sets the main color */
  11804. color: Color4;
  11805. /** Gets or sets the width */
  11806. width: number;
  11807. /** Gets or sets the height */
  11808. height: number;
  11809. /** Gets or sets rotation angle */
  11810. angle: number;
  11811. /** Gets or sets the cell index in the sprite sheet */
  11812. cellIndex: number;
  11813. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  11814. cellRef: string;
  11815. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  11816. invertU: number;
  11817. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  11818. invertV: number;
  11819. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  11820. disposeWhenFinishedAnimating: boolean;
  11821. /** Gets the list of attached animations */
  11822. animations: Animation[];
  11823. /** Gets or sets a boolean indicating if the sprite can be picked */
  11824. isPickable: boolean;
  11825. /**
  11826. * Gets or sets the associated action manager
  11827. */
  11828. actionManager: Nullable<ActionManager>;
  11829. private _animationStarted;
  11830. private _loopAnimation;
  11831. private _fromIndex;
  11832. private _toIndex;
  11833. private _delay;
  11834. private _direction;
  11835. private _manager;
  11836. private _time;
  11837. private _onAnimationEnd;
  11838. /**
  11839. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  11840. */
  11841. isVisible: boolean;
  11842. /**
  11843. * Gets or sets the sprite size
  11844. */
  11845. size: number;
  11846. /**
  11847. * Creates a new Sprite
  11848. * @param name defines the name
  11849. * @param manager defines the manager
  11850. */
  11851. constructor(
  11852. /** defines the name */
  11853. name: string, manager: ISpriteManager);
  11854. /**
  11855. * Starts an animation
  11856. * @param from defines the initial key
  11857. * @param to defines the end key
  11858. * @param loop defines if the animation must loop
  11859. * @param delay defines the start delay (in ms)
  11860. * @param onAnimationEnd defines a callback to call when animation ends
  11861. */
  11862. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  11863. /** Stops current animation (if any) */
  11864. stopAnimation(): void;
  11865. /** @hidden */
  11866. _animate(deltaTime: number): void;
  11867. /** Release associated resources */
  11868. dispose(): void;
  11869. }
  11870. }
  11871. declare module "babylonjs/Collisions/pickingInfo" {
  11872. import { Nullable } from "babylonjs/types";
  11873. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11874. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11875. import { Sprite } from "babylonjs/Sprites/sprite";
  11876. import { Ray } from "babylonjs/Culling/ray";
  11877. /**
  11878. * Information about the result of picking within a scene
  11879. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  11880. */
  11881. export class PickingInfo {
  11882. /** @hidden */
  11883. _pickingUnavailable: boolean;
  11884. /**
  11885. * If the pick collided with an object
  11886. */
  11887. hit: boolean;
  11888. /**
  11889. * Distance away where the pick collided
  11890. */
  11891. distance: number;
  11892. /**
  11893. * The location of pick collision
  11894. */
  11895. pickedPoint: Nullable<Vector3>;
  11896. /**
  11897. * The mesh corresponding the the pick collision
  11898. */
  11899. pickedMesh: Nullable<AbstractMesh>;
  11900. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  11901. bu: number;
  11902. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  11903. bv: number;
  11904. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  11905. faceId: number;
  11906. /** Id of the the submesh that was picked */
  11907. subMeshId: number;
  11908. /** If a sprite was picked, this will be the sprite the pick collided with */
  11909. pickedSprite: Nullable<Sprite>;
  11910. /**
  11911. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  11912. */
  11913. originMesh: Nullable<AbstractMesh>;
  11914. /**
  11915. * The ray that was used to perform the picking.
  11916. */
  11917. ray: Nullable<Ray>;
  11918. /**
  11919. * Gets the normal correspodning to the face the pick collided with
  11920. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  11921. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  11922. * @returns The normal correspodning to the face the pick collided with
  11923. */
  11924. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  11925. /**
  11926. * Gets the texture coordinates of where the pick occured
  11927. * @returns the vector containing the coordnates of the texture
  11928. */
  11929. getTextureCoordinates(): Nullable<Vector2>;
  11930. }
  11931. }
  11932. declare module "babylonjs/Events/pointerEvents" {
  11933. import { Nullable } from "babylonjs/types";
  11934. import { Vector2 } from "babylonjs/Maths/math.vector";
  11935. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11936. import { Ray } from "babylonjs/Culling/ray";
  11937. /**
  11938. * Gather the list of pointer event types as constants.
  11939. */
  11940. export class PointerEventTypes {
  11941. /**
  11942. * The pointerdown event is fired when a pointer becomes active. For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed. For touch, it is fired when physical contact is made with the digitizer. For pen, it is fired when the stylus makes physical contact with the digitizer.
  11943. */
  11944. static readonly POINTERDOWN: number;
  11945. /**
  11946. * The pointerup event is fired when a pointer is no longer active.
  11947. */
  11948. static readonly POINTERUP: number;
  11949. /**
  11950. * The pointermove event is fired when a pointer changes coordinates.
  11951. */
  11952. static readonly POINTERMOVE: number;
  11953. /**
  11954. * The pointerwheel event is fired when a mouse wheel has been rotated.
  11955. */
  11956. static readonly POINTERWHEEL: number;
  11957. /**
  11958. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  11959. */
  11960. static readonly POINTERPICK: number;
  11961. /**
  11962. * The pointertap event is fired when a the object has been touched and released without drag.
  11963. */
  11964. static readonly POINTERTAP: number;
  11965. /**
  11966. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  11967. */
  11968. static readonly POINTERDOUBLETAP: number;
  11969. }
  11970. /**
  11971. * Base class of pointer info types.
  11972. */
  11973. export class PointerInfoBase {
  11974. /**
  11975. * Defines the type of event (PointerEventTypes)
  11976. */
  11977. type: number;
  11978. /**
  11979. * Defines the related dom event
  11980. */
  11981. event: PointerEvent | MouseWheelEvent;
  11982. /**
  11983. * Instantiates the base class of pointers info.
  11984. * @param type Defines the type of event (PointerEventTypes)
  11985. * @param event Defines the related dom event
  11986. */
  11987. constructor(
  11988. /**
  11989. * Defines the type of event (PointerEventTypes)
  11990. */
  11991. type: number,
  11992. /**
  11993. * Defines the related dom event
  11994. */
  11995. event: PointerEvent | MouseWheelEvent);
  11996. }
  11997. /**
  11998. * This class is used to store pointer related info for the onPrePointerObservable event.
  11999. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  12000. */
  12001. export class PointerInfoPre extends PointerInfoBase {
  12002. /**
  12003. * Ray from a pointer if availible (eg. 6dof controller)
  12004. */
  12005. ray: Nullable<Ray>;
  12006. /**
  12007. * Defines the local position of the pointer on the canvas.
  12008. */
  12009. localPosition: Vector2;
  12010. /**
  12011. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  12012. */
  12013. skipOnPointerObservable: boolean;
  12014. /**
  12015. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  12016. * @param type Defines the type of event (PointerEventTypes)
  12017. * @param event Defines the related dom event
  12018. * @param localX Defines the local x coordinates of the pointer when the event occured
  12019. * @param localY Defines the local y coordinates of the pointer when the event occured
  12020. */
  12021. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  12022. }
  12023. /**
  12024. * This type contains all the data related to a pointer event in Babylon.js.
  12025. * The event member is an instance of PointerEvent for all types except PointerWheel and is of type MouseWheelEvent when type equals PointerWheel. The different event types can be found in the PointerEventTypes class.
  12026. */
  12027. export class PointerInfo extends PointerInfoBase {
  12028. /**
  12029. * Defines the picking info associated to the info (if any)\
  12030. */
  12031. pickInfo: Nullable<PickingInfo>;
  12032. /**
  12033. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  12034. * @param type Defines the type of event (PointerEventTypes)
  12035. * @param event Defines the related dom event
  12036. * @param pickInfo Defines the picking info associated to the info (if any)\
  12037. */
  12038. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  12039. /**
  12040. * Defines the picking info associated to the info (if any)\
  12041. */
  12042. pickInfo: Nullable<PickingInfo>);
  12043. }
  12044. /**
  12045. * Data relating to a touch event on the screen.
  12046. */
  12047. export interface PointerTouch {
  12048. /**
  12049. * X coordinate of touch.
  12050. */
  12051. x: number;
  12052. /**
  12053. * Y coordinate of touch.
  12054. */
  12055. y: number;
  12056. /**
  12057. * Id of touch. Unique for each finger.
  12058. */
  12059. pointerId: number;
  12060. /**
  12061. * Event type passed from DOM.
  12062. */
  12063. type: any;
  12064. }
  12065. }
  12066. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  12067. import { Observable } from "babylonjs/Misc/observable";
  12068. import { Nullable } from "babylonjs/types";
  12069. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12070. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12071. /**
  12072. * Manage the mouse inputs to control the movement of a free camera.
  12073. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12074. */
  12075. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  12076. /**
  12077. * Define if touch is enabled in the mouse input
  12078. */
  12079. touchEnabled: boolean;
  12080. /**
  12081. * Defines the camera the input is attached to.
  12082. */
  12083. camera: FreeCamera;
  12084. /**
  12085. * Defines the buttons associated with the input to handle camera move.
  12086. */
  12087. buttons: number[];
  12088. /**
  12089. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  12090. */
  12091. angularSensibility: number;
  12092. private _pointerInput;
  12093. private _onMouseMove;
  12094. private _observer;
  12095. private previousPosition;
  12096. /**
  12097. * Observable for when a pointer move event occurs containing the move offset
  12098. */
  12099. onPointerMovedObservable: Observable<{
  12100. offsetX: number;
  12101. offsetY: number;
  12102. }>;
  12103. /**
  12104. * @hidden
  12105. * If the camera should be rotated automatically based on pointer movement
  12106. */
  12107. _allowCameraRotation: boolean;
  12108. /**
  12109. * Manage the mouse inputs to control the movement of a free camera.
  12110. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12111. * @param touchEnabled Defines if touch is enabled or not
  12112. */
  12113. constructor(
  12114. /**
  12115. * Define if touch is enabled in the mouse input
  12116. */
  12117. touchEnabled?: boolean);
  12118. /**
  12119. * Attach the input controls to a specific dom element to get the input from.
  12120. * @param element Defines the element the controls should be listened from
  12121. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12122. */
  12123. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12124. /**
  12125. * Called on JS contextmenu event.
  12126. * Override this method to provide functionality.
  12127. */
  12128. protected onContextMenu(evt: PointerEvent): void;
  12129. /**
  12130. * Detach the current controls from the specified dom element.
  12131. * @param element Defines the element to stop listening the inputs from
  12132. */
  12133. detachControl(element: Nullable<HTMLElement>): void;
  12134. /**
  12135. * Gets the class name of the current intput.
  12136. * @returns the class name
  12137. */
  12138. getClassName(): string;
  12139. /**
  12140. * Get the friendly name associated with the input class.
  12141. * @returns the input friendly name
  12142. */
  12143. getSimpleName(): string;
  12144. }
  12145. }
  12146. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  12147. import { Nullable } from "babylonjs/types";
  12148. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12149. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12150. /**
  12151. * Manage the touch inputs to control the movement of a free camera.
  12152. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12153. */
  12154. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  12155. /**
  12156. * Defines the camera the input is attached to.
  12157. */
  12158. camera: FreeCamera;
  12159. /**
  12160. * Defines the touch sensibility for rotation.
  12161. * The higher the faster.
  12162. */
  12163. touchAngularSensibility: number;
  12164. /**
  12165. * Defines the touch sensibility for move.
  12166. * The higher the faster.
  12167. */
  12168. touchMoveSensibility: number;
  12169. private _offsetX;
  12170. private _offsetY;
  12171. private _pointerPressed;
  12172. private _pointerInput;
  12173. private _observer;
  12174. private _onLostFocus;
  12175. /**
  12176. * Attach the input controls to a specific dom element to get the input from.
  12177. * @param element Defines the element the controls should be listened from
  12178. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12179. */
  12180. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12181. /**
  12182. * Detach the current controls from the specified dom element.
  12183. * @param element Defines the element to stop listening the inputs from
  12184. */
  12185. detachControl(element: Nullable<HTMLElement>): void;
  12186. /**
  12187. * Update the current camera state depending on the inputs that have been used this frame.
  12188. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  12189. */
  12190. checkInputs(): void;
  12191. /**
  12192. * Gets the class name of the current intput.
  12193. * @returns the class name
  12194. */
  12195. getClassName(): string;
  12196. /**
  12197. * Get the friendly name associated with the input class.
  12198. * @returns the input friendly name
  12199. */
  12200. getSimpleName(): string;
  12201. }
  12202. }
  12203. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  12204. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12205. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  12206. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  12207. import { Nullable } from "babylonjs/types";
  12208. /**
  12209. * Default Inputs manager for the FreeCamera.
  12210. * It groups all the default supported inputs for ease of use.
  12211. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12212. */
  12213. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  12214. /**
  12215. * @hidden
  12216. */
  12217. _mouseInput: Nullable<FreeCameraMouseInput>;
  12218. /**
  12219. * Instantiates a new FreeCameraInputsManager.
  12220. * @param camera Defines the camera the inputs belong to
  12221. */
  12222. constructor(camera: FreeCamera);
  12223. /**
  12224. * Add keyboard input support to the input manager.
  12225. * @returns the current input manager
  12226. */
  12227. addKeyboard(): FreeCameraInputsManager;
  12228. /**
  12229. * Add mouse input support to the input manager.
  12230. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  12231. * @returns the current input manager
  12232. */
  12233. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  12234. /**
  12235. * Removes the mouse input support from the manager
  12236. * @returns the current input manager
  12237. */
  12238. removeMouse(): FreeCameraInputsManager;
  12239. /**
  12240. * Add touch input support to the input manager.
  12241. * @returns the current input manager
  12242. */
  12243. addTouch(): FreeCameraInputsManager;
  12244. /**
  12245. * Remove all attached input methods from a camera
  12246. */
  12247. clear(): void;
  12248. }
  12249. }
  12250. declare module "babylonjs/Cameras/freeCamera" {
  12251. import { Vector3 } from "babylonjs/Maths/math.vector";
  12252. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12253. import { Scene } from "babylonjs/scene";
  12254. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  12255. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  12256. /**
  12257. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12258. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  12259. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12260. */
  12261. export class FreeCamera extends TargetCamera {
  12262. /**
  12263. * Define the collision ellipsoid of the camera.
  12264. * This is helpful to simulate a camera body like the player body around the camera
  12265. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  12266. */
  12267. ellipsoid: Vector3;
  12268. /**
  12269. * Define an offset for the position of the ellipsoid around the camera.
  12270. * This can be helpful to determine the center of the body near the gravity center of the body
  12271. * instead of its head.
  12272. */
  12273. ellipsoidOffset: Vector3;
  12274. /**
  12275. * Enable or disable collisions of the camera with the rest of the scene objects.
  12276. */
  12277. checkCollisions: boolean;
  12278. /**
  12279. * Enable or disable gravity on the camera.
  12280. */
  12281. applyGravity: boolean;
  12282. /**
  12283. * Define the input manager associated to the camera.
  12284. */
  12285. inputs: FreeCameraInputsManager;
  12286. /**
  12287. * Gets the input sensibility for a mouse input. (default is 2000.0)
  12288. * Higher values reduce sensitivity.
  12289. */
  12290. /**
  12291. * Sets the input sensibility for a mouse input. (default is 2000.0)
  12292. * Higher values reduce sensitivity.
  12293. */
  12294. angularSensibility: number;
  12295. /**
  12296. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  12297. */
  12298. keysUp: number[];
  12299. /**
  12300. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  12301. */
  12302. keysDown: number[];
  12303. /**
  12304. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  12305. */
  12306. keysLeft: number[];
  12307. /**
  12308. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  12309. */
  12310. keysRight: number[];
  12311. /**
  12312. * Event raised when the camera collide with a mesh in the scene.
  12313. */
  12314. onCollide: (collidedMesh: AbstractMesh) => void;
  12315. private _collider;
  12316. private _needMoveForGravity;
  12317. private _oldPosition;
  12318. private _diffPosition;
  12319. private _newPosition;
  12320. /** @hidden */
  12321. _localDirection: Vector3;
  12322. /** @hidden */
  12323. _transformedDirection: Vector3;
  12324. /**
  12325. * Instantiates a Free Camera.
  12326. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12327. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  12328. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12329. * @param name Define the name of the camera in the scene
  12330. * @param position Define the start position of the camera in the scene
  12331. * @param scene Define the scene the camera belongs to
  12332. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  12333. */
  12334. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  12335. /**
  12336. * Attached controls to the current camera.
  12337. * @param element Defines the element the controls should be listened from
  12338. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12339. */
  12340. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12341. /**
  12342. * Detach the current controls from the camera.
  12343. * The camera will stop reacting to inputs.
  12344. * @param element Defines the element to stop listening the inputs from
  12345. */
  12346. detachControl(element: HTMLElement): void;
  12347. private _collisionMask;
  12348. /**
  12349. * Define a collision mask to limit the list of object the camera can collide with
  12350. */
  12351. collisionMask: number;
  12352. /** @hidden */
  12353. _collideWithWorld(displacement: Vector3): void;
  12354. private _onCollisionPositionChange;
  12355. /** @hidden */
  12356. _checkInputs(): void;
  12357. /** @hidden */
  12358. _decideIfNeedsToMove(): boolean;
  12359. /** @hidden */
  12360. _updatePosition(): void;
  12361. /**
  12362. * Destroy the camera and release the current resources hold by it.
  12363. */
  12364. dispose(): void;
  12365. /**
  12366. * Gets the current object class name.
  12367. * @return the class name
  12368. */
  12369. getClassName(): string;
  12370. }
  12371. }
  12372. declare module "babylonjs/Gamepads/gamepad" {
  12373. import { Observable } from "babylonjs/Misc/observable";
  12374. /**
  12375. * Represents a gamepad control stick position
  12376. */
  12377. export class StickValues {
  12378. /**
  12379. * The x component of the control stick
  12380. */
  12381. x: number;
  12382. /**
  12383. * The y component of the control stick
  12384. */
  12385. y: number;
  12386. /**
  12387. * Initializes the gamepad x and y control stick values
  12388. * @param x The x component of the gamepad control stick value
  12389. * @param y The y component of the gamepad control stick value
  12390. */
  12391. constructor(
  12392. /**
  12393. * The x component of the control stick
  12394. */
  12395. x: number,
  12396. /**
  12397. * The y component of the control stick
  12398. */
  12399. y: number);
  12400. }
  12401. /**
  12402. * An interface which manages callbacks for gamepad button changes
  12403. */
  12404. export interface GamepadButtonChanges {
  12405. /**
  12406. * Called when a gamepad has been changed
  12407. */
  12408. changed: boolean;
  12409. /**
  12410. * Called when a gamepad press event has been triggered
  12411. */
  12412. pressChanged: boolean;
  12413. /**
  12414. * Called when a touch event has been triggered
  12415. */
  12416. touchChanged: boolean;
  12417. /**
  12418. * Called when a value has changed
  12419. */
  12420. valueChanged: boolean;
  12421. }
  12422. /**
  12423. * Represents a gamepad
  12424. */
  12425. export class Gamepad {
  12426. /**
  12427. * The id of the gamepad
  12428. */
  12429. id: string;
  12430. /**
  12431. * The index of the gamepad
  12432. */
  12433. index: number;
  12434. /**
  12435. * The browser gamepad
  12436. */
  12437. browserGamepad: any;
  12438. /**
  12439. * Specifies what type of gamepad this represents
  12440. */
  12441. type: number;
  12442. private _leftStick;
  12443. private _rightStick;
  12444. /** @hidden */
  12445. _isConnected: boolean;
  12446. private _leftStickAxisX;
  12447. private _leftStickAxisY;
  12448. private _rightStickAxisX;
  12449. private _rightStickAxisY;
  12450. /**
  12451. * Triggered when the left control stick has been changed
  12452. */
  12453. private _onleftstickchanged;
  12454. /**
  12455. * Triggered when the right control stick has been changed
  12456. */
  12457. private _onrightstickchanged;
  12458. /**
  12459. * Represents a gamepad controller
  12460. */
  12461. static GAMEPAD: number;
  12462. /**
  12463. * Represents a generic controller
  12464. */
  12465. static GENERIC: number;
  12466. /**
  12467. * Represents an XBox controller
  12468. */
  12469. static XBOX: number;
  12470. /**
  12471. * Represents a pose-enabled controller
  12472. */
  12473. static POSE_ENABLED: number;
  12474. /**
  12475. * Represents an Dual Shock controller
  12476. */
  12477. static DUALSHOCK: number;
  12478. /**
  12479. * Specifies whether the left control stick should be Y-inverted
  12480. */
  12481. protected _invertLeftStickY: boolean;
  12482. /**
  12483. * Specifies if the gamepad has been connected
  12484. */
  12485. readonly isConnected: boolean;
  12486. /**
  12487. * Initializes the gamepad
  12488. * @param id The id of the gamepad
  12489. * @param index The index of the gamepad
  12490. * @param browserGamepad The browser gamepad
  12491. * @param leftStickX The x component of the left joystick
  12492. * @param leftStickY The y component of the left joystick
  12493. * @param rightStickX The x component of the right joystick
  12494. * @param rightStickY The y component of the right joystick
  12495. */
  12496. constructor(
  12497. /**
  12498. * The id of the gamepad
  12499. */
  12500. id: string,
  12501. /**
  12502. * The index of the gamepad
  12503. */
  12504. index: number,
  12505. /**
  12506. * The browser gamepad
  12507. */
  12508. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  12509. /**
  12510. * Callback triggered when the left joystick has changed
  12511. * @param callback
  12512. */
  12513. onleftstickchanged(callback: (values: StickValues) => void): void;
  12514. /**
  12515. * Callback triggered when the right joystick has changed
  12516. * @param callback
  12517. */
  12518. onrightstickchanged(callback: (values: StickValues) => void): void;
  12519. /**
  12520. * Gets the left joystick
  12521. */
  12522. /**
  12523. * Sets the left joystick values
  12524. */
  12525. leftStick: StickValues;
  12526. /**
  12527. * Gets the right joystick
  12528. */
  12529. /**
  12530. * Sets the right joystick value
  12531. */
  12532. rightStick: StickValues;
  12533. /**
  12534. * Updates the gamepad joystick positions
  12535. */
  12536. update(): void;
  12537. /**
  12538. * Disposes the gamepad
  12539. */
  12540. dispose(): void;
  12541. }
  12542. /**
  12543. * Represents a generic gamepad
  12544. */
  12545. export class GenericPad extends Gamepad {
  12546. private _buttons;
  12547. private _onbuttondown;
  12548. private _onbuttonup;
  12549. /**
  12550. * Observable triggered when a button has been pressed
  12551. */
  12552. onButtonDownObservable: Observable<number>;
  12553. /**
  12554. * Observable triggered when a button has been released
  12555. */
  12556. onButtonUpObservable: Observable<number>;
  12557. /**
  12558. * Callback triggered when a button has been pressed
  12559. * @param callback Called when a button has been pressed
  12560. */
  12561. onbuttondown(callback: (buttonPressed: number) => void): void;
  12562. /**
  12563. * Callback triggered when a button has been released
  12564. * @param callback Called when a button has been released
  12565. */
  12566. onbuttonup(callback: (buttonReleased: number) => void): void;
  12567. /**
  12568. * Initializes the generic gamepad
  12569. * @param id The id of the generic gamepad
  12570. * @param index The index of the generic gamepad
  12571. * @param browserGamepad The browser gamepad
  12572. */
  12573. constructor(id: string, index: number, browserGamepad: any);
  12574. private _setButtonValue;
  12575. /**
  12576. * Updates the generic gamepad
  12577. */
  12578. update(): void;
  12579. /**
  12580. * Disposes the generic gamepad
  12581. */
  12582. dispose(): void;
  12583. }
  12584. }
  12585. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  12586. import { Nullable } from "babylonjs/types";
  12587. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  12588. import { Scene } from "babylonjs/scene";
  12589. module "babylonjs/Engines/engine" {
  12590. interface Engine {
  12591. /**
  12592. * Creates a raw texture
  12593. * @param data defines the data to store in the texture
  12594. * @param width defines the width of the texture
  12595. * @param height defines the height of the texture
  12596. * @param format defines the format of the data
  12597. * @param generateMipMaps defines if the engine should generate the mip levels
  12598. * @param invertY defines if data must be stored with Y axis inverted
  12599. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  12600. * @param compression defines the compression used (null by default)
  12601. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12602. * @returns the raw texture inside an InternalTexture
  12603. */
  12604. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  12605. /**
  12606. * Update a raw texture
  12607. * @param texture defines the texture to update
  12608. * @param data defines the data to store in the texture
  12609. * @param format defines the format of the data
  12610. * @param invertY defines if data must be stored with Y axis inverted
  12611. */
  12612. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12613. /**
  12614. * Update a raw texture
  12615. * @param texture defines the texture to update
  12616. * @param data defines the data to store in the texture
  12617. * @param format defines the format of the data
  12618. * @param invertY defines if data must be stored with Y axis inverted
  12619. * @param compression defines the compression used (null by default)
  12620. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12621. */
  12622. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  12623. /**
  12624. * Creates a new raw cube texture
  12625. * @param data defines the array of data to use to create each face
  12626. * @param size defines the size of the textures
  12627. * @param format defines the format of the data
  12628. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12629. * @param generateMipMaps defines if the engine should generate the mip levels
  12630. * @param invertY defines if data must be stored with Y axis inverted
  12631. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12632. * @param compression defines the compression used (null by default)
  12633. * @returns the cube texture as an InternalTexture
  12634. */
  12635. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  12636. /**
  12637. * Update a raw cube texture
  12638. * @param texture defines the texture to udpdate
  12639. * @param data defines the data to store
  12640. * @param format defines the data format
  12641. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12642. * @param invertY defines if data must be stored with Y axis inverted
  12643. */
  12644. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  12645. /**
  12646. * Update a raw cube texture
  12647. * @param texture defines the texture to udpdate
  12648. * @param data defines the data to store
  12649. * @param format defines the data format
  12650. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12651. * @param invertY defines if data must be stored with Y axis inverted
  12652. * @param compression defines the compression used (null by default)
  12653. */
  12654. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  12655. /**
  12656. * Update a raw cube texture
  12657. * @param texture defines the texture to udpdate
  12658. * @param data defines the data to store
  12659. * @param format defines the data format
  12660. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12661. * @param invertY defines if data must be stored with Y axis inverted
  12662. * @param compression defines the compression used (null by default)
  12663. * @param level defines which level of the texture to update
  12664. */
  12665. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  12666. /**
  12667. * Creates a new raw cube texture from a specified url
  12668. * @param url defines the url where the data is located
  12669. * @param scene defines the current scene
  12670. * @param size defines the size of the textures
  12671. * @param format defines the format of the data
  12672. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12673. * @param noMipmap defines if the engine should avoid generating the mip levels
  12674. * @param callback defines a callback used to extract texture data from loaded data
  12675. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12676. * @param onLoad defines a callback called when texture is loaded
  12677. * @param onError defines a callback called if there is an error
  12678. * @returns the cube texture as an InternalTexture
  12679. */
  12680. createRawCubeTextureFromUrl(url: string, scene: Scene, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  12681. /**
  12682. * Creates a new raw cube texture from a specified url
  12683. * @param url defines the url where the data is located
  12684. * @param scene defines the current scene
  12685. * @param size defines the size of the textures
  12686. * @param format defines the format of the data
  12687. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12688. * @param noMipmap defines if the engine should avoid generating the mip levels
  12689. * @param callback defines a callback used to extract texture data from loaded data
  12690. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12691. * @param onLoad defines a callback called when texture is loaded
  12692. * @param onError defines a callback called if there is an error
  12693. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12694. * @param invertY defines if data must be stored with Y axis inverted
  12695. * @returns the cube texture as an InternalTexture
  12696. */
  12697. createRawCubeTextureFromUrl(url: string, scene: Scene, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  12698. /**
  12699. * Creates a new raw 3D texture
  12700. * @param data defines the data used to create the texture
  12701. * @param width defines the width of the texture
  12702. * @param height defines the height of the texture
  12703. * @param depth defines the depth of the texture
  12704. * @param format defines the format of the texture
  12705. * @param generateMipMaps defines if the engine must generate mip levels
  12706. * @param invertY defines if data must be stored with Y axis inverted
  12707. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12708. * @param compression defines the compressed used (can be null)
  12709. * @param textureType defines the compressed used (can be null)
  12710. * @returns a new raw 3D texture (stored in an InternalTexture)
  12711. */
  12712. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  12713. /**
  12714. * Update a raw 3D texture
  12715. * @param texture defines the texture to update
  12716. * @param data defines the data to store
  12717. * @param format defines the data format
  12718. * @param invertY defines if data must be stored with Y axis inverted
  12719. */
  12720. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12721. /**
  12722. * Update a raw 3D texture
  12723. * @param texture defines the texture to update
  12724. * @param data defines the data to store
  12725. * @param format defines the data format
  12726. * @param invertY defines if data must be stored with Y axis inverted
  12727. * @param compression defines the used compression (can be null)
  12728. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  12729. */
  12730. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  12731. /**
  12732. * Creates a new raw 2D array texture
  12733. * @param data defines the data used to create the texture
  12734. * @param width defines the width of the texture
  12735. * @param height defines the height of the texture
  12736. * @param depth defines the number of layers of the texture
  12737. * @param format defines the format of the texture
  12738. * @param generateMipMaps defines if the engine must generate mip levels
  12739. * @param invertY defines if data must be stored with Y axis inverted
  12740. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12741. * @param compression defines the compressed used (can be null)
  12742. * @param textureType defines the compressed used (can be null)
  12743. * @returns a new raw 2D array texture (stored in an InternalTexture)
  12744. */
  12745. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  12746. /**
  12747. * Update a raw 2D array texture
  12748. * @param texture defines the texture to update
  12749. * @param data defines the data to store
  12750. * @param format defines the data format
  12751. * @param invertY defines if data must be stored with Y axis inverted
  12752. */
  12753. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12754. /**
  12755. * Update a raw 2D array texture
  12756. * @param texture defines the texture to update
  12757. * @param data defines the data to store
  12758. * @param format defines the data format
  12759. * @param invertY defines if data must be stored with Y axis inverted
  12760. * @param compression defines the used compression (can be null)
  12761. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  12762. */
  12763. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  12764. }
  12765. }
  12766. }
  12767. declare module "babylonjs/Materials/Textures/rawTexture" {
  12768. import { Scene } from "babylonjs/scene";
  12769. import { Texture } from "babylonjs/Materials/Textures/texture";
  12770. import "babylonjs/Engines/Extensions/engine.rawTexture";
  12771. /**
  12772. * Raw texture can help creating a texture directly from an array of data.
  12773. * This can be super useful if you either get the data from an uncompressed source or
  12774. * if you wish to create your texture pixel by pixel.
  12775. */
  12776. export class RawTexture extends Texture {
  12777. /**
  12778. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12779. */
  12780. format: number;
  12781. private _engine;
  12782. /**
  12783. * Instantiates a new RawTexture.
  12784. * Raw texture can help creating a texture directly from an array of data.
  12785. * This can be super useful if you either get the data from an uncompressed source or
  12786. * if you wish to create your texture pixel by pixel.
  12787. * @param data define the array of data to use to create the texture
  12788. * @param width define the width of the texture
  12789. * @param height define the height of the texture
  12790. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12791. * @param scene define the scene the texture belongs to
  12792. * @param generateMipMaps define whether mip maps should be generated or not
  12793. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12794. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12795. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12796. */
  12797. constructor(data: ArrayBufferView, width: number, height: number,
  12798. /**
  12799. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12800. */
  12801. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  12802. /**
  12803. * Updates the texture underlying data.
  12804. * @param data Define the new data of the texture
  12805. */
  12806. update(data: ArrayBufferView): void;
  12807. /**
  12808. * Creates a luminance texture from some data.
  12809. * @param data Define the texture data
  12810. * @param width Define the width of the texture
  12811. * @param height Define the height of the texture
  12812. * @param scene Define the scene the texture belongs to
  12813. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12814. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12815. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12816. * @returns the luminance texture
  12817. */
  12818. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12819. /**
  12820. * Creates a luminance alpha texture from some data.
  12821. * @param data Define the texture data
  12822. * @param width Define the width of the texture
  12823. * @param height Define the height of the texture
  12824. * @param scene Define the scene the texture belongs to
  12825. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12826. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12827. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12828. * @returns the luminance alpha texture
  12829. */
  12830. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12831. /**
  12832. * Creates an alpha texture from some data.
  12833. * @param data Define the texture data
  12834. * @param width Define the width of the texture
  12835. * @param height Define the height of the texture
  12836. * @param scene Define the scene the texture belongs to
  12837. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12838. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12839. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12840. * @returns the alpha texture
  12841. */
  12842. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12843. /**
  12844. * Creates a RGB texture from some data.
  12845. * @param data Define the texture data
  12846. * @param width Define the width of the texture
  12847. * @param height Define the height of the texture
  12848. * @param scene Define the scene the texture belongs to
  12849. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12850. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12851. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12852. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12853. * @returns the RGB alpha texture
  12854. */
  12855. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12856. /**
  12857. * Creates a RGBA texture from some data.
  12858. * @param data Define the texture data
  12859. * @param width Define the width of the texture
  12860. * @param height Define the height of the texture
  12861. * @param scene Define the scene the texture belongs to
  12862. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12863. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12864. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12865. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12866. * @returns the RGBA texture
  12867. */
  12868. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12869. /**
  12870. * Creates a R texture from some data.
  12871. * @param data Define the texture data
  12872. * @param width Define the width of the texture
  12873. * @param height Define the height of the texture
  12874. * @param scene Define the scene the texture belongs to
  12875. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12876. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12877. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12878. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12879. * @returns the R texture
  12880. */
  12881. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12882. }
  12883. }
  12884. declare module "babylonjs/Maths/math.size" {
  12885. /**
  12886. * Interface for the size containing width and height
  12887. */
  12888. export interface ISize {
  12889. /**
  12890. * Width
  12891. */
  12892. width: number;
  12893. /**
  12894. * Heighht
  12895. */
  12896. height: number;
  12897. }
  12898. /**
  12899. * Size containing widht and height
  12900. */
  12901. export class Size implements ISize {
  12902. /**
  12903. * Width
  12904. */
  12905. width: number;
  12906. /**
  12907. * Height
  12908. */
  12909. height: number;
  12910. /**
  12911. * Creates a Size object from the given width and height (floats).
  12912. * @param width width of the new size
  12913. * @param height height of the new size
  12914. */
  12915. constructor(width: number, height: number);
  12916. /**
  12917. * Returns a string with the Size width and height
  12918. * @returns a string with the Size width and height
  12919. */
  12920. toString(): string;
  12921. /**
  12922. * "Size"
  12923. * @returns the string "Size"
  12924. */
  12925. getClassName(): string;
  12926. /**
  12927. * Returns the Size hash code.
  12928. * @returns a hash code for a unique width and height
  12929. */
  12930. getHashCode(): number;
  12931. /**
  12932. * Updates the current size from the given one.
  12933. * @param src the given size
  12934. */
  12935. copyFrom(src: Size): void;
  12936. /**
  12937. * Updates in place the current Size from the given floats.
  12938. * @param width width of the new size
  12939. * @param height height of the new size
  12940. * @returns the updated Size.
  12941. */
  12942. copyFromFloats(width: number, height: number): Size;
  12943. /**
  12944. * Updates in place the current Size from the given floats.
  12945. * @param width width to set
  12946. * @param height height to set
  12947. * @returns the updated Size.
  12948. */
  12949. set(width: number, height: number): Size;
  12950. /**
  12951. * Multiplies the width and height by numbers
  12952. * @param w factor to multiple the width by
  12953. * @param h factor to multiple the height by
  12954. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  12955. */
  12956. multiplyByFloats(w: number, h: number): Size;
  12957. /**
  12958. * Clones the size
  12959. * @returns a new Size copied from the given one.
  12960. */
  12961. clone(): Size;
  12962. /**
  12963. * True if the current Size and the given one width and height are strictly equal.
  12964. * @param other the other size to compare against
  12965. * @returns True if the current Size and the given one width and height are strictly equal.
  12966. */
  12967. equals(other: Size): boolean;
  12968. /**
  12969. * The surface of the Size : width * height (float).
  12970. */
  12971. readonly surface: number;
  12972. /**
  12973. * Create a new size of zero
  12974. * @returns a new Size set to (0.0, 0.0)
  12975. */
  12976. static Zero(): Size;
  12977. /**
  12978. * Sums the width and height of two sizes
  12979. * @param otherSize size to add to this size
  12980. * @returns a new Size set as the addition result of the current Size and the given one.
  12981. */
  12982. add(otherSize: Size): Size;
  12983. /**
  12984. * Subtracts the width and height of two
  12985. * @param otherSize size to subtract to this size
  12986. * @returns a new Size set as the subtraction result of the given one from the current Size.
  12987. */
  12988. subtract(otherSize: Size): Size;
  12989. /**
  12990. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  12991. * @param start starting size to lerp between
  12992. * @param end end size to lerp between
  12993. * @param amount amount to lerp between the start and end values
  12994. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  12995. */
  12996. static Lerp(start: Size, end: Size, amount: number): Size;
  12997. }
  12998. }
  12999. declare module "babylonjs/Animations/runtimeAnimation" {
  13000. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  13001. import { Animatable } from "babylonjs/Animations/animatable";
  13002. import { Scene } from "babylonjs/scene";
  13003. /**
  13004. * Defines a runtime animation
  13005. */
  13006. export class RuntimeAnimation {
  13007. private _events;
  13008. /**
  13009. * The current frame of the runtime animation
  13010. */
  13011. private _currentFrame;
  13012. /**
  13013. * The animation used by the runtime animation
  13014. */
  13015. private _animation;
  13016. /**
  13017. * The target of the runtime animation
  13018. */
  13019. private _target;
  13020. /**
  13021. * The initiating animatable
  13022. */
  13023. private _host;
  13024. /**
  13025. * The original value of the runtime animation
  13026. */
  13027. private _originalValue;
  13028. /**
  13029. * The original blend value of the runtime animation
  13030. */
  13031. private _originalBlendValue;
  13032. /**
  13033. * The offsets cache of the runtime animation
  13034. */
  13035. private _offsetsCache;
  13036. /**
  13037. * The high limits cache of the runtime animation
  13038. */
  13039. private _highLimitsCache;
  13040. /**
  13041. * Specifies if the runtime animation has been stopped
  13042. */
  13043. private _stopped;
  13044. /**
  13045. * The blending factor of the runtime animation
  13046. */
  13047. private _blendingFactor;
  13048. /**
  13049. * The BabylonJS scene
  13050. */
  13051. private _scene;
  13052. /**
  13053. * The current value of the runtime animation
  13054. */
  13055. private _currentValue;
  13056. /** @hidden */
  13057. _animationState: _IAnimationState;
  13058. /**
  13059. * The active target of the runtime animation
  13060. */
  13061. private _activeTargets;
  13062. private _currentActiveTarget;
  13063. private _directTarget;
  13064. /**
  13065. * The target path of the runtime animation
  13066. */
  13067. private _targetPath;
  13068. /**
  13069. * The weight of the runtime animation
  13070. */
  13071. private _weight;
  13072. /**
  13073. * The ratio offset of the runtime animation
  13074. */
  13075. private _ratioOffset;
  13076. /**
  13077. * The previous delay of the runtime animation
  13078. */
  13079. private _previousDelay;
  13080. /**
  13081. * The previous ratio of the runtime animation
  13082. */
  13083. private _previousRatio;
  13084. private _enableBlending;
  13085. private _keys;
  13086. private _minFrame;
  13087. private _maxFrame;
  13088. private _minValue;
  13089. private _maxValue;
  13090. private _targetIsArray;
  13091. /**
  13092. * Gets the current frame of the runtime animation
  13093. */
  13094. readonly currentFrame: number;
  13095. /**
  13096. * Gets the weight of the runtime animation
  13097. */
  13098. readonly weight: number;
  13099. /**
  13100. * Gets the current value of the runtime animation
  13101. */
  13102. readonly currentValue: any;
  13103. /**
  13104. * Gets the target path of the runtime animation
  13105. */
  13106. readonly targetPath: string;
  13107. /**
  13108. * Gets the actual target of the runtime animation
  13109. */
  13110. readonly target: any;
  13111. /** @hidden */
  13112. _onLoop: () => void;
  13113. /**
  13114. * Create a new RuntimeAnimation object
  13115. * @param target defines the target of the animation
  13116. * @param animation defines the source animation object
  13117. * @param scene defines the hosting scene
  13118. * @param host defines the initiating Animatable
  13119. */
  13120. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  13121. private _preparePath;
  13122. /**
  13123. * Gets the animation from the runtime animation
  13124. */
  13125. readonly animation: Animation;
  13126. /**
  13127. * Resets the runtime animation to the beginning
  13128. * @param restoreOriginal defines whether to restore the target property to the original value
  13129. */
  13130. reset(restoreOriginal?: boolean): void;
  13131. /**
  13132. * Specifies if the runtime animation is stopped
  13133. * @returns Boolean specifying if the runtime animation is stopped
  13134. */
  13135. isStopped(): boolean;
  13136. /**
  13137. * Disposes of the runtime animation
  13138. */
  13139. dispose(): void;
  13140. /**
  13141. * Apply the interpolated value to the target
  13142. * @param currentValue defines the value computed by the animation
  13143. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  13144. */
  13145. setValue(currentValue: any, weight: number): void;
  13146. private _getOriginalValues;
  13147. private _setValue;
  13148. /**
  13149. * Gets the loop pmode of the runtime animation
  13150. * @returns Loop Mode
  13151. */
  13152. private _getCorrectLoopMode;
  13153. /**
  13154. * Move the current animation to a given frame
  13155. * @param frame defines the frame to move to
  13156. */
  13157. goToFrame(frame: number): void;
  13158. /**
  13159. * @hidden Internal use only
  13160. */
  13161. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  13162. /**
  13163. * Execute the current animation
  13164. * @param delay defines the delay to add to the current frame
  13165. * @param from defines the lower bound of the animation range
  13166. * @param to defines the upper bound of the animation range
  13167. * @param loop defines if the current animation must loop
  13168. * @param speedRatio defines the current speed ratio
  13169. * @param weight defines the weight of the animation (default is -1 so no weight)
  13170. * @param onLoop optional callback called when animation loops
  13171. * @returns a boolean indicating if the animation is running
  13172. */
  13173. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  13174. }
  13175. }
  13176. declare module "babylonjs/Animations/animatable" {
  13177. import { Animation } from "babylonjs/Animations/animation";
  13178. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  13179. import { Nullable } from "babylonjs/types";
  13180. import { Observable } from "babylonjs/Misc/observable";
  13181. import { Scene } from "babylonjs/scene";
  13182. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  13183. import { Node } from "babylonjs/node";
  13184. /**
  13185. * Class used to store an actual running animation
  13186. */
  13187. export class Animatable {
  13188. /** defines the target object */
  13189. target: any;
  13190. /** defines the starting frame number (default is 0) */
  13191. fromFrame: number;
  13192. /** defines the ending frame number (default is 100) */
  13193. toFrame: number;
  13194. /** defines if the animation must loop (default is false) */
  13195. loopAnimation: boolean;
  13196. /** defines a callback to call when animation ends if it is not looping */
  13197. onAnimationEnd?: (() => void) | null | undefined;
  13198. /** defines a callback to call when animation loops */
  13199. onAnimationLoop?: (() => void) | null | undefined;
  13200. private _localDelayOffset;
  13201. private _pausedDelay;
  13202. private _runtimeAnimations;
  13203. private _paused;
  13204. private _scene;
  13205. private _speedRatio;
  13206. private _weight;
  13207. private _syncRoot;
  13208. /**
  13209. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  13210. * This will only apply for non looping animation (default is true)
  13211. */
  13212. disposeOnEnd: boolean;
  13213. /**
  13214. * Gets a boolean indicating if the animation has started
  13215. */
  13216. animationStarted: boolean;
  13217. /**
  13218. * Observer raised when the animation ends
  13219. */
  13220. onAnimationEndObservable: Observable<Animatable>;
  13221. /**
  13222. * Observer raised when the animation loops
  13223. */
  13224. onAnimationLoopObservable: Observable<Animatable>;
  13225. /**
  13226. * Gets the root Animatable used to synchronize and normalize animations
  13227. */
  13228. readonly syncRoot: Nullable<Animatable>;
  13229. /**
  13230. * Gets the current frame of the first RuntimeAnimation
  13231. * Used to synchronize Animatables
  13232. */
  13233. readonly masterFrame: number;
  13234. /**
  13235. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  13236. */
  13237. weight: number;
  13238. /**
  13239. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  13240. */
  13241. speedRatio: number;
  13242. /**
  13243. * Creates a new Animatable
  13244. * @param scene defines the hosting scene
  13245. * @param target defines the target object
  13246. * @param fromFrame defines the starting frame number (default is 0)
  13247. * @param toFrame defines the ending frame number (default is 100)
  13248. * @param loopAnimation defines if the animation must loop (default is false)
  13249. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  13250. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  13251. * @param animations defines a group of animation to add to the new Animatable
  13252. * @param onAnimationLoop defines a callback to call when animation loops
  13253. */
  13254. constructor(scene: Scene,
  13255. /** defines the target object */
  13256. target: any,
  13257. /** defines the starting frame number (default is 0) */
  13258. fromFrame?: number,
  13259. /** defines the ending frame number (default is 100) */
  13260. toFrame?: number,
  13261. /** defines if the animation must loop (default is false) */
  13262. loopAnimation?: boolean, speedRatio?: number,
  13263. /** defines a callback to call when animation ends if it is not looping */
  13264. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  13265. /** defines a callback to call when animation loops */
  13266. onAnimationLoop?: (() => void) | null | undefined);
  13267. /**
  13268. * Synchronize and normalize current Animatable with a source Animatable
  13269. * This is useful when using animation weights and when animations are not of the same length
  13270. * @param root defines the root Animatable to synchronize with
  13271. * @returns the current Animatable
  13272. */
  13273. syncWith(root: Animatable): Animatable;
  13274. /**
  13275. * Gets the list of runtime animations
  13276. * @returns an array of RuntimeAnimation
  13277. */
  13278. getAnimations(): RuntimeAnimation[];
  13279. /**
  13280. * Adds more animations to the current animatable
  13281. * @param target defines the target of the animations
  13282. * @param animations defines the new animations to add
  13283. */
  13284. appendAnimations(target: any, animations: Animation[]): void;
  13285. /**
  13286. * Gets the source animation for a specific property
  13287. * @param property defines the propertyu to look for
  13288. * @returns null or the source animation for the given property
  13289. */
  13290. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  13291. /**
  13292. * Gets the runtime animation for a specific property
  13293. * @param property defines the propertyu to look for
  13294. * @returns null or the runtime animation for the given property
  13295. */
  13296. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  13297. /**
  13298. * Resets the animatable to its original state
  13299. */
  13300. reset(): void;
  13301. /**
  13302. * Allows the animatable to blend with current running animations
  13303. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13304. * @param blendingSpeed defines the blending speed to use
  13305. */
  13306. enableBlending(blendingSpeed: number): void;
  13307. /**
  13308. * Disable animation blending
  13309. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13310. */
  13311. disableBlending(): void;
  13312. /**
  13313. * Jump directly to a given frame
  13314. * @param frame defines the frame to jump to
  13315. */
  13316. goToFrame(frame: number): void;
  13317. /**
  13318. * Pause the animation
  13319. */
  13320. pause(): void;
  13321. /**
  13322. * Restart the animation
  13323. */
  13324. restart(): void;
  13325. private _raiseOnAnimationEnd;
  13326. /**
  13327. * Stop and delete the current animation
  13328. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  13329. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  13330. */
  13331. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  13332. /**
  13333. * Wait asynchronously for the animation to end
  13334. * @returns a promise which will be fullfilled when the animation ends
  13335. */
  13336. waitAsync(): Promise<Animatable>;
  13337. /** @hidden */
  13338. _animate(delay: number): boolean;
  13339. }
  13340. module "babylonjs/scene" {
  13341. interface Scene {
  13342. /** @hidden */
  13343. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  13344. /** @hidden */
  13345. _processLateAnimationBindingsForMatrices(holder: {
  13346. totalWeight: number;
  13347. animations: RuntimeAnimation[];
  13348. originalValue: Matrix;
  13349. }): any;
  13350. /** @hidden */
  13351. _processLateAnimationBindingsForQuaternions(holder: {
  13352. totalWeight: number;
  13353. animations: RuntimeAnimation[];
  13354. originalValue: Quaternion;
  13355. }, refQuaternion: Quaternion): Quaternion;
  13356. /** @hidden */
  13357. _processLateAnimationBindings(): void;
  13358. /**
  13359. * Will start the animation sequence of a given target
  13360. * @param target defines the target
  13361. * @param from defines from which frame should animation start
  13362. * @param to defines until which frame should animation run.
  13363. * @param weight defines the weight to apply to the animation (1.0 by default)
  13364. * @param loop defines if the animation loops
  13365. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13366. * @param onAnimationEnd defines the function to be executed when the animation ends
  13367. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13368. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13369. * @param onAnimationLoop defines the callback to call when an animation loops
  13370. * @returns the animatable object created for this animation
  13371. */
  13372. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13373. /**
  13374. * Will start the animation sequence of a given target
  13375. * @param target defines the target
  13376. * @param from defines from which frame should animation start
  13377. * @param to defines until which frame should animation run.
  13378. * @param loop defines if the animation loops
  13379. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13380. * @param onAnimationEnd defines the function to be executed when the animation ends
  13381. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13382. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13383. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  13384. * @param onAnimationLoop defines the callback to call when an animation loops
  13385. * @returns the animatable object created for this animation
  13386. */
  13387. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13388. /**
  13389. * Will start the animation sequence of a given target and its hierarchy
  13390. * @param target defines the target
  13391. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  13392. * @param from defines from which frame should animation start
  13393. * @param to defines until which frame should animation run.
  13394. * @param loop defines if the animation loops
  13395. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13396. * @param onAnimationEnd defines the function to be executed when the animation ends
  13397. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13398. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13399. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13400. * @param onAnimationLoop defines the callback to call when an animation loops
  13401. * @returns the list of created animatables
  13402. */
  13403. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable[];
  13404. /**
  13405. * Begin a new animation on a given node
  13406. * @param target defines the target where the animation will take place
  13407. * @param animations defines the list of animations to start
  13408. * @param from defines the initial value
  13409. * @param to defines the final value
  13410. * @param loop defines if you want animation to loop (off by default)
  13411. * @param speedRatio defines the speed ratio to apply to all animations
  13412. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13413. * @param onAnimationLoop defines the callback to call when an animation loops
  13414. * @returns the list of created animatables
  13415. */
  13416. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  13417. /**
  13418. * Begin a new animation on a given node and its hierarchy
  13419. * @param target defines the root node where the animation will take place
  13420. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  13421. * @param animations defines the list of animations to start
  13422. * @param from defines the initial value
  13423. * @param to defines the final value
  13424. * @param loop defines if you want animation to loop (off by default)
  13425. * @param speedRatio defines the speed ratio to apply to all animations
  13426. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13427. * @param onAnimationLoop defines the callback to call when an animation loops
  13428. * @returns the list of animatables created for all nodes
  13429. */
  13430. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  13431. /**
  13432. * Gets the animatable associated with a specific target
  13433. * @param target defines the target of the animatable
  13434. * @returns the required animatable if found
  13435. */
  13436. getAnimatableByTarget(target: any): Nullable<Animatable>;
  13437. /**
  13438. * Gets all animatables associated with a given target
  13439. * @param target defines the target to look animatables for
  13440. * @returns an array of Animatables
  13441. */
  13442. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  13443. /**
  13444. * Stops and removes all animations that have been applied to the scene
  13445. */
  13446. stopAllAnimations(): void;
  13447. /**
  13448. * Gets the current delta time used by animation engine
  13449. */
  13450. deltaTime: number;
  13451. }
  13452. }
  13453. module "babylonjs/Bones/bone" {
  13454. interface Bone {
  13455. /**
  13456. * Copy an animation range from another bone
  13457. * @param source defines the source bone
  13458. * @param rangeName defines the range name to copy
  13459. * @param frameOffset defines the frame offset
  13460. * @param rescaleAsRequired defines if rescaling must be applied if required
  13461. * @param skelDimensionsRatio defines the scaling ratio
  13462. * @returns true if operation was successful
  13463. */
  13464. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  13465. }
  13466. }
  13467. }
  13468. declare module "babylonjs/Animations/animationPropertiesOverride" {
  13469. /**
  13470. * Class used to override all child animations of a given target
  13471. */
  13472. export class AnimationPropertiesOverride {
  13473. /**
  13474. * Gets or sets a value indicating if animation blending must be used
  13475. */
  13476. enableBlending: boolean;
  13477. /**
  13478. * Gets or sets the blending speed to use when enableBlending is true
  13479. */
  13480. blendingSpeed: number;
  13481. /**
  13482. * Gets or sets the default loop mode to use
  13483. */
  13484. loopMode: number;
  13485. }
  13486. }
  13487. declare module "babylonjs/Bones/skeleton" {
  13488. import { Bone } from "babylonjs/Bones/bone";
  13489. import { Observable } from "babylonjs/Misc/observable";
  13490. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13491. import { Scene } from "babylonjs/scene";
  13492. import { Nullable } from "babylonjs/types";
  13493. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13494. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  13495. import { Animatable } from "babylonjs/Animations/animatable";
  13496. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13497. import { Animation } from "babylonjs/Animations/animation";
  13498. import { AnimationRange } from "babylonjs/Animations/animationRange";
  13499. import { IInspectable } from "babylonjs/Misc/iInspectable";
  13500. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  13501. /**
  13502. * Class used to handle skinning animations
  13503. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13504. */
  13505. export class Skeleton implements IAnimatable {
  13506. /** defines the skeleton name */
  13507. name: string;
  13508. /** defines the skeleton Id */
  13509. id: string;
  13510. /**
  13511. * Defines the list of child bones
  13512. */
  13513. bones: Bone[];
  13514. /**
  13515. * Defines an estimate of the dimension of the skeleton at rest
  13516. */
  13517. dimensionsAtRest: Vector3;
  13518. /**
  13519. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  13520. */
  13521. needInitialSkinMatrix: boolean;
  13522. /**
  13523. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  13524. */
  13525. overrideMesh: Nullable<AbstractMesh>;
  13526. /**
  13527. * Gets the list of animations attached to this skeleton
  13528. */
  13529. animations: Array<Animation>;
  13530. private _scene;
  13531. private _isDirty;
  13532. private _transformMatrices;
  13533. private _transformMatrixTexture;
  13534. private _meshesWithPoseMatrix;
  13535. private _animatables;
  13536. private _identity;
  13537. private _synchronizedWithMesh;
  13538. private _ranges;
  13539. private _lastAbsoluteTransformsUpdateId;
  13540. private _canUseTextureForBones;
  13541. private _uniqueId;
  13542. /** @hidden */
  13543. _numBonesWithLinkedTransformNode: number;
  13544. /** @hidden */
  13545. _hasWaitingData: Nullable<boolean>;
  13546. /**
  13547. * Specifies if the skeleton should be serialized
  13548. */
  13549. doNotSerialize: boolean;
  13550. private _useTextureToStoreBoneMatrices;
  13551. /**
  13552. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  13553. * Please note that this option is not available if the hardware does not support it
  13554. */
  13555. useTextureToStoreBoneMatrices: boolean;
  13556. private _animationPropertiesOverride;
  13557. /**
  13558. * Gets or sets the animation properties override
  13559. */
  13560. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13561. /**
  13562. * List of inspectable custom properties (used by the Inspector)
  13563. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  13564. */
  13565. inspectableCustomProperties: IInspectable[];
  13566. /**
  13567. * An observable triggered before computing the skeleton's matrices
  13568. */
  13569. onBeforeComputeObservable: Observable<Skeleton>;
  13570. /**
  13571. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  13572. */
  13573. readonly isUsingTextureForMatrices: boolean;
  13574. /**
  13575. * Gets the unique ID of this skeleton
  13576. */
  13577. readonly uniqueId: number;
  13578. /**
  13579. * Creates a new skeleton
  13580. * @param name defines the skeleton name
  13581. * @param id defines the skeleton Id
  13582. * @param scene defines the hosting scene
  13583. */
  13584. constructor(
  13585. /** defines the skeleton name */
  13586. name: string,
  13587. /** defines the skeleton Id */
  13588. id: string, scene: Scene);
  13589. /**
  13590. * Gets the current object class name.
  13591. * @return the class name
  13592. */
  13593. getClassName(): string;
  13594. /**
  13595. * Returns an array containing the root bones
  13596. * @returns an array containing the root bones
  13597. */
  13598. getChildren(): Array<Bone>;
  13599. /**
  13600. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  13601. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13602. * @returns a Float32Array containing matrices data
  13603. */
  13604. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  13605. /**
  13606. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  13607. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13608. * @returns a raw texture containing the data
  13609. */
  13610. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  13611. /**
  13612. * Gets the current hosting scene
  13613. * @returns a scene object
  13614. */
  13615. getScene(): Scene;
  13616. /**
  13617. * Gets a string representing the current skeleton data
  13618. * @param fullDetails defines a boolean indicating if we want a verbose version
  13619. * @returns a string representing the current skeleton data
  13620. */
  13621. toString(fullDetails?: boolean): string;
  13622. /**
  13623. * Get bone's index searching by name
  13624. * @param name defines bone's name to search for
  13625. * @return the indice of the bone. Returns -1 if not found
  13626. */
  13627. getBoneIndexByName(name: string): number;
  13628. /**
  13629. * Creater a new animation range
  13630. * @param name defines the name of the range
  13631. * @param from defines the start key
  13632. * @param to defines the end key
  13633. */
  13634. createAnimationRange(name: string, from: number, to: number): void;
  13635. /**
  13636. * Delete a specific animation range
  13637. * @param name defines the name of the range
  13638. * @param deleteFrames defines if frames must be removed as well
  13639. */
  13640. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  13641. /**
  13642. * Gets a specific animation range
  13643. * @param name defines the name of the range to look for
  13644. * @returns the requested animation range or null if not found
  13645. */
  13646. getAnimationRange(name: string): Nullable<AnimationRange>;
  13647. /**
  13648. * Gets the list of all animation ranges defined on this skeleton
  13649. * @returns an array
  13650. */
  13651. getAnimationRanges(): Nullable<AnimationRange>[];
  13652. /**
  13653. * Copy animation range from a source skeleton.
  13654. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  13655. * @param source defines the source skeleton
  13656. * @param name defines the name of the range to copy
  13657. * @param rescaleAsRequired defines if rescaling must be applied if required
  13658. * @returns true if operation was successful
  13659. */
  13660. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  13661. /**
  13662. * Forces the skeleton to go to rest pose
  13663. */
  13664. returnToRest(): void;
  13665. private _getHighestAnimationFrame;
  13666. /**
  13667. * Begin a specific animation range
  13668. * @param name defines the name of the range to start
  13669. * @param loop defines if looping must be turned on (false by default)
  13670. * @param speedRatio defines the speed ratio to apply (1 by default)
  13671. * @param onAnimationEnd defines a callback which will be called when animation will end
  13672. * @returns a new animatable
  13673. */
  13674. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  13675. /** @hidden */
  13676. _markAsDirty(): void;
  13677. /** @hidden */
  13678. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13679. /** @hidden */
  13680. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13681. private _computeTransformMatrices;
  13682. /**
  13683. * Build all resources required to render a skeleton
  13684. */
  13685. prepare(): void;
  13686. /**
  13687. * Gets the list of animatables currently running for this skeleton
  13688. * @returns an array of animatables
  13689. */
  13690. getAnimatables(): IAnimatable[];
  13691. /**
  13692. * Clone the current skeleton
  13693. * @param name defines the name of the new skeleton
  13694. * @param id defines the id of the new skeleton
  13695. * @returns the new skeleton
  13696. */
  13697. clone(name: string, id?: string): Skeleton;
  13698. /**
  13699. * Enable animation blending for this skeleton
  13700. * @param blendingSpeed defines the blending speed to apply
  13701. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13702. */
  13703. enableBlending(blendingSpeed?: number): void;
  13704. /**
  13705. * Releases all resources associated with the current skeleton
  13706. */
  13707. dispose(): void;
  13708. /**
  13709. * Serialize the skeleton in a JSON object
  13710. * @returns a JSON object
  13711. */
  13712. serialize(): any;
  13713. /**
  13714. * Creates a new skeleton from serialized data
  13715. * @param parsedSkeleton defines the serialized data
  13716. * @param scene defines the hosting scene
  13717. * @returns a new skeleton
  13718. */
  13719. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  13720. /**
  13721. * Compute all node absolute transforms
  13722. * @param forceUpdate defines if computation must be done even if cache is up to date
  13723. */
  13724. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  13725. /**
  13726. * Gets the root pose matrix
  13727. * @returns a matrix
  13728. */
  13729. getPoseMatrix(): Nullable<Matrix>;
  13730. /**
  13731. * Sorts bones per internal index
  13732. */
  13733. sortBones(): void;
  13734. private _sortBones;
  13735. }
  13736. }
  13737. declare module "babylonjs/Bones/bone" {
  13738. import { Skeleton } from "babylonjs/Bones/skeleton";
  13739. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  13740. import { Nullable } from "babylonjs/types";
  13741. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13742. import { TransformNode } from "babylonjs/Meshes/transformNode";
  13743. import { Node } from "babylonjs/node";
  13744. import { Space } from "babylonjs/Maths/math.axis";
  13745. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13746. /**
  13747. * Class used to store bone information
  13748. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13749. */
  13750. export class Bone extends Node {
  13751. /**
  13752. * defines the bone name
  13753. */
  13754. name: string;
  13755. private static _tmpVecs;
  13756. private static _tmpQuat;
  13757. private static _tmpMats;
  13758. /**
  13759. * Gets the list of child bones
  13760. */
  13761. children: Bone[];
  13762. /** Gets the animations associated with this bone */
  13763. animations: import("babylonjs/Animations/animation").Animation[];
  13764. /**
  13765. * Gets or sets bone length
  13766. */
  13767. length: number;
  13768. /**
  13769. * @hidden Internal only
  13770. * Set this value to map this bone to a different index in the transform matrices
  13771. * Set this value to -1 to exclude the bone from the transform matrices
  13772. */
  13773. _index: Nullable<number>;
  13774. private _skeleton;
  13775. private _localMatrix;
  13776. private _restPose;
  13777. private _baseMatrix;
  13778. private _absoluteTransform;
  13779. private _invertedAbsoluteTransform;
  13780. private _parent;
  13781. private _scalingDeterminant;
  13782. private _worldTransform;
  13783. private _localScaling;
  13784. private _localRotation;
  13785. private _localPosition;
  13786. private _needToDecompose;
  13787. private _needToCompose;
  13788. /** @hidden */
  13789. _linkedTransformNode: Nullable<TransformNode>;
  13790. /** @hidden */
  13791. _waitingTransformNodeId: Nullable<string>;
  13792. /** @hidden */
  13793. /** @hidden */
  13794. _matrix: Matrix;
  13795. /**
  13796. * Create a new bone
  13797. * @param name defines the bone name
  13798. * @param skeleton defines the parent skeleton
  13799. * @param parentBone defines the parent (can be null if the bone is the root)
  13800. * @param localMatrix defines the local matrix
  13801. * @param restPose defines the rest pose matrix
  13802. * @param baseMatrix defines the base matrix
  13803. * @param index defines index of the bone in the hiearchy
  13804. */
  13805. constructor(
  13806. /**
  13807. * defines the bone name
  13808. */
  13809. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  13810. /**
  13811. * Gets the current object class name.
  13812. * @return the class name
  13813. */
  13814. getClassName(): string;
  13815. /**
  13816. * Gets the parent skeleton
  13817. * @returns a skeleton
  13818. */
  13819. getSkeleton(): Skeleton;
  13820. /**
  13821. * Gets parent bone
  13822. * @returns a bone or null if the bone is the root of the bone hierarchy
  13823. */
  13824. getParent(): Nullable<Bone>;
  13825. /**
  13826. * Returns an array containing the root bones
  13827. * @returns an array containing the root bones
  13828. */
  13829. getChildren(): Array<Bone>;
  13830. /**
  13831. * Gets the node index in matrix array generated for rendering
  13832. * @returns the node index
  13833. */
  13834. getIndex(): number;
  13835. /**
  13836. * Sets the parent bone
  13837. * @param parent defines the parent (can be null if the bone is the root)
  13838. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13839. */
  13840. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  13841. /**
  13842. * Gets the local matrix
  13843. * @returns a matrix
  13844. */
  13845. getLocalMatrix(): Matrix;
  13846. /**
  13847. * Gets the base matrix (initial matrix which remains unchanged)
  13848. * @returns a matrix
  13849. */
  13850. getBaseMatrix(): Matrix;
  13851. /**
  13852. * Gets the rest pose matrix
  13853. * @returns a matrix
  13854. */
  13855. getRestPose(): Matrix;
  13856. /**
  13857. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  13858. */
  13859. getWorldMatrix(): Matrix;
  13860. /**
  13861. * Sets the local matrix to rest pose matrix
  13862. */
  13863. returnToRest(): void;
  13864. /**
  13865. * Gets the inverse of the absolute transform matrix.
  13866. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  13867. * @returns a matrix
  13868. */
  13869. getInvertedAbsoluteTransform(): Matrix;
  13870. /**
  13871. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  13872. * @returns a matrix
  13873. */
  13874. getAbsoluteTransform(): Matrix;
  13875. /**
  13876. * Links with the given transform node.
  13877. * The local matrix of this bone is copied from the transform node every frame.
  13878. * @param transformNode defines the transform node to link to
  13879. */
  13880. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  13881. /**
  13882. * Gets the node used to drive the bone's transformation
  13883. * @returns a transform node or null
  13884. */
  13885. getTransformNode(): Nullable<TransformNode>;
  13886. /** Gets or sets current position (in local space) */
  13887. position: Vector3;
  13888. /** Gets or sets current rotation (in local space) */
  13889. rotation: Vector3;
  13890. /** Gets or sets current rotation quaternion (in local space) */
  13891. rotationQuaternion: Quaternion;
  13892. /** Gets or sets current scaling (in local space) */
  13893. scaling: Vector3;
  13894. /**
  13895. * Gets the animation properties override
  13896. */
  13897. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13898. private _decompose;
  13899. private _compose;
  13900. /**
  13901. * Update the base and local matrices
  13902. * @param matrix defines the new base or local matrix
  13903. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13904. * @param updateLocalMatrix defines if the local matrix should be updated
  13905. */
  13906. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  13907. /** @hidden */
  13908. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  13909. /**
  13910. * Flag the bone as dirty (Forcing it to update everything)
  13911. */
  13912. markAsDirty(): void;
  13913. /** @hidden */
  13914. _markAsDirtyAndCompose(): void;
  13915. private _markAsDirtyAndDecompose;
  13916. /**
  13917. * Translate the bone in local or world space
  13918. * @param vec The amount to translate the bone
  13919. * @param space The space that the translation is in
  13920. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13921. */
  13922. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13923. /**
  13924. * Set the postion of the bone in local or world space
  13925. * @param position The position to set the bone
  13926. * @param space The space that the position is in
  13927. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13928. */
  13929. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13930. /**
  13931. * Set the absolute position of the bone (world space)
  13932. * @param position The position to set the bone
  13933. * @param mesh The mesh that this bone is attached to
  13934. */
  13935. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  13936. /**
  13937. * Scale the bone on the x, y and z axes (in local space)
  13938. * @param x The amount to scale the bone on the x axis
  13939. * @param y The amount to scale the bone on the y axis
  13940. * @param z The amount to scale the bone on the z axis
  13941. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  13942. */
  13943. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  13944. /**
  13945. * Set the bone scaling in local space
  13946. * @param scale defines the scaling vector
  13947. */
  13948. setScale(scale: Vector3): void;
  13949. /**
  13950. * Gets the current scaling in local space
  13951. * @returns the current scaling vector
  13952. */
  13953. getScale(): Vector3;
  13954. /**
  13955. * Gets the current scaling in local space and stores it in a target vector
  13956. * @param result defines the target vector
  13957. */
  13958. getScaleToRef(result: Vector3): void;
  13959. /**
  13960. * Set the yaw, pitch, and roll of the bone in local or world space
  13961. * @param yaw The rotation of the bone on the y axis
  13962. * @param pitch The rotation of the bone on the x axis
  13963. * @param roll The rotation of the bone on the z axis
  13964. * @param space The space that the axes of rotation are in
  13965. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13966. */
  13967. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  13968. /**
  13969. * Add a rotation to the bone on an axis in local or world space
  13970. * @param axis The axis to rotate the bone on
  13971. * @param amount The amount to rotate the bone
  13972. * @param space The space that the axis is in
  13973. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13974. */
  13975. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  13976. /**
  13977. * Set the rotation of the bone to a particular axis angle in local or world space
  13978. * @param axis The axis to rotate the bone on
  13979. * @param angle The angle that the bone should be rotated to
  13980. * @param space The space that the axis is in
  13981. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13982. */
  13983. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  13984. /**
  13985. * Set the euler rotation of the bone in local of world space
  13986. * @param rotation The euler rotation that the bone should be set to
  13987. * @param space The space that the rotation is in
  13988. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13989. */
  13990. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  13991. /**
  13992. * Set the quaternion rotation of the bone in local of world space
  13993. * @param quat The quaternion rotation that the bone should be set to
  13994. * @param space The space that the rotation is in
  13995. * @param mesh The mesh that this bone is attached to. This is only used in world space
  13996. */
  13997. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  13998. /**
  13999. * Set the rotation matrix of the bone in local of world space
  14000. * @param rotMat The rotation matrix that the bone should be set to
  14001. * @param space The space that the rotation is in
  14002. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14003. */
  14004. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  14005. private _rotateWithMatrix;
  14006. private _getNegativeRotationToRef;
  14007. /**
  14008. * Get the position of the bone in local or world space
  14009. * @param space The space that the returned position is in
  14010. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14011. * @returns The position of the bone
  14012. */
  14013. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  14014. /**
  14015. * Copy the position of the bone to a vector3 in local or world space
  14016. * @param space The space that the returned position is in
  14017. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14018. * @param result The vector3 to copy the position to
  14019. */
  14020. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  14021. /**
  14022. * Get the absolute position of the bone (world space)
  14023. * @param mesh The mesh that this bone is attached to
  14024. * @returns The absolute position of the bone
  14025. */
  14026. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  14027. /**
  14028. * Copy the absolute position of the bone (world space) to the result param
  14029. * @param mesh The mesh that this bone is attached to
  14030. * @param result The vector3 to copy the absolute position to
  14031. */
  14032. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  14033. /**
  14034. * Compute the absolute transforms of this bone and its children
  14035. */
  14036. computeAbsoluteTransforms(): void;
  14037. /**
  14038. * Get the world direction from an axis that is in the local space of the bone
  14039. * @param localAxis The local direction that is used to compute the world direction
  14040. * @param mesh The mesh that this bone is attached to
  14041. * @returns The world direction
  14042. */
  14043. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14044. /**
  14045. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  14046. * @param localAxis The local direction that is used to compute the world direction
  14047. * @param mesh The mesh that this bone is attached to
  14048. * @param result The vector3 that the world direction will be copied to
  14049. */
  14050. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14051. /**
  14052. * Get the euler rotation of the bone in local or world space
  14053. * @param space The space that the rotation should be in
  14054. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14055. * @returns The euler rotation
  14056. */
  14057. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  14058. /**
  14059. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  14060. * @param space The space that the rotation should be in
  14061. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14062. * @param result The vector3 that the rotation should be copied to
  14063. */
  14064. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14065. /**
  14066. * Get the quaternion rotation of the bone in either local or world space
  14067. * @param space The space that the rotation should be in
  14068. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14069. * @returns The quaternion rotation
  14070. */
  14071. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  14072. /**
  14073. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  14074. * @param space The space that the rotation should be in
  14075. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14076. * @param result The quaternion that the rotation should be copied to
  14077. */
  14078. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  14079. /**
  14080. * Get the rotation matrix of the bone in local or world space
  14081. * @param space The space that the rotation should be in
  14082. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14083. * @returns The rotation matrix
  14084. */
  14085. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  14086. /**
  14087. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  14088. * @param space The space that the rotation should be in
  14089. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14090. * @param result The quaternion that the rotation should be copied to
  14091. */
  14092. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  14093. /**
  14094. * Get the world position of a point that is in the local space of the bone
  14095. * @param position The local position
  14096. * @param mesh The mesh that this bone is attached to
  14097. * @returns The world position
  14098. */
  14099. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14100. /**
  14101. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  14102. * @param position The local position
  14103. * @param mesh The mesh that this bone is attached to
  14104. * @param result The vector3 that the world position should be copied to
  14105. */
  14106. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14107. /**
  14108. * Get the local position of a point that is in world space
  14109. * @param position The world position
  14110. * @param mesh The mesh that this bone is attached to
  14111. * @returns The local position
  14112. */
  14113. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14114. /**
  14115. * Get the local position of a point that is in world space and copy it to the result param
  14116. * @param position The world position
  14117. * @param mesh The mesh that this bone is attached to
  14118. * @param result The vector3 that the local position should be copied to
  14119. */
  14120. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14121. }
  14122. }
  14123. declare module "babylonjs/Meshes/transformNode" {
  14124. import { DeepImmutable } from "babylonjs/types";
  14125. import { Observable } from "babylonjs/Misc/observable";
  14126. import { Nullable } from "babylonjs/types";
  14127. import { Camera } from "babylonjs/Cameras/camera";
  14128. import { Scene } from "babylonjs/scene";
  14129. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14130. import { Node } from "babylonjs/node";
  14131. import { Bone } from "babylonjs/Bones/bone";
  14132. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14133. import { Space } from "babylonjs/Maths/math.axis";
  14134. /**
  14135. * A TransformNode is an object that is not rendered but can be used as a center of transformation. This can decrease memory usage and increase rendering speed compared to using an empty mesh as a parent and is less complicated than using a pivot matrix.
  14136. * @see https://doc.babylonjs.com/how_to/transformnode
  14137. */
  14138. export class TransformNode extends Node {
  14139. /**
  14140. * Object will not rotate to face the camera
  14141. */
  14142. static BILLBOARDMODE_NONE: number;
  14143. /**
  14144. * Object will rotate to face the camera but only on the x axis
  14145. */
  14146. static BILLBOARDMODE_X: number;
  14147. /**
  14148. * Object will rotate to face the camera but only on the y axis
  14149. */
  14150. static BILLBOARDMODE_Y: number;
  14151. /**
  14152. * Object will rotate to face the camera but only on the z axis
  14153. */
  14154. static BILLBOARDMODE_Z: number;
  14155. /**
  14156. * Object will rotate to face the camera
  14157. */
  14158. static BILLBOARDMODE_ALL: number;
  14159. /**
  14160. * Object will rotate to face the camera's position instead of orientation
  14161. */
  14162. static BILLBOARDMODE_USE_POSITION: number;
  14163. private _forward;
  14164. private _forwardInverted;
  14165. private _up;
  14166. private _right;
  14167. private _rightInverted;
  14168. private _position;
  14169. private _rotation;
  14170. private _rotationQuaternion;
  14171. protected _scaling: Vector3;
  14172. protected _isDirty: boolean;
  14173. private _transformToBoneReferal;
  14174. private _isAbsoluteSynced;
  14175. private _billboardMode;
  14176. /**
  14177. * Gets or sets the billboard mode. Default is 0.
  14178. *
  14179. * | Value | Type | Description |
  14180. * | --- | --- | --- |
  14181. * | 0 | BILLBOARDMODE_NONE | |
  14182. * | 1 | BILLBOARDMODE_X | |
  14183. * | 2 | BILLBOARDMODE_Y | |
  14184. * | 4 | BILLBOARDMODE_Z | |
  14185. * | 7 | BILLBOARDMODE_ALL | |
  14186. *
  14187. */
  14188. billboardMode: number;
  14189. private _preserveParentRotationForBillboard;
  14190. /**
  14191. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  14192. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  14193. */
  14194. preserveParentRotationForBillboard: boolean;
  14195. /**
  14196. * Multiplication factor on scale x/y/z when computing the world matrix. Eg. for a 1x1x1 cube setting this to 2 will make it a 2x2x2 cube
  14197. */
  14198. scalingDeterminant: number;
  14199. private _infiniteDistance;
  14200. /**
  14201. * Gets or sets the distance of the object to max, often used by skybox
  14202. */
  14203. infiniteDistance: boolean;
  14204. /**
  14205. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  14206. * By default the system will update normals to compensate
  14207. */
  14208. ignoreNonUniformScaling: boolean;
  14209. /**
  14210. * Gets or sets a boolean indicating that even if rotationQuaternion is defined, you can keep updating rotation property and Babylon.js will just mix both
  14211. */
  14212. reIntegrateRotationIntoRotationQuaternion: boolean;
  14213. /** @hidden */
  14214. _poseMatrix: Nullable<Matrix>;
  14215. /** @hidden */
  14216. _localMatrix: Matrix;
  14217. private _usePivotMatrix;
  14218. private _absolutePosition;
  14219. private _absoluteScaling;
  14220. private _absoluteRotationQuaternion;
  14221. private _pivotMatrix;
  14222. private _pivotMatrixInverse;
  14223. protected _postMultiplyPivotMatrix: boolean;
  14224. protected _isWorldMatrixFrozen: boolean;
  14225. /** @hidden */
  14226. _indexInSceneTransformNodesArray: number;
  14227. /**
  14228. * An event triggered after the world matrix is updated
  14229. */
  14230. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  14231. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  14232. /**
  14233. * Gets a string identifying the name of the class
  14234. * @returns "TransformNode" string
  14235. */
  14236. getClassName(): string;
  14237. /**
  14238. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  14239. */
  14240. position: Vector3;
  14241. /**
  14242. * Gets or sets the rotation property : a Vector3 defining the rotation value in radians around each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  14243. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  14244. */
  14245. rotation: Vector3;
  14246. /**
  14247. * Gets or sets the scaling property : a Vector3 defining the node scaling along each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  14248. */
  14249. scaling: Vector3;
  14250. /**
  14251. * Gets or sets the rotation Quaternion property : this a Quaternion object defining the node rotation by using a unit quaternion (undefined by default, but can be null).
  14252. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  14253. */
  14254. rotationQuaternion: Nullable<Quaternion>;
  14255. /**
  14256. * The forward direction of that transform in world space.
  14257. */
  14258. readonly forward: Vector3;
  14259. /**
  14260. * The up direction of that transform in world space.
  14261. */
  14262. readonly up: Vector3;
  14263. /**
  14264. * The right direction of that transform in world space.
  14265. */
  14266. readonly right: Vector3;
  14267. /**
  14268. * Copies the parameter passed Matrix into the mesh Pose matrix.
  14269. * @param matrix the matrix to copy the pose from
  14270. * @returns this TransformNode.
  14271. */
  14272. updatePoseMatrix(matrix: Matrix): TransformNode;
  14273. /**
  14274. * Returns the mesh Pose matrix.
  14275. * @returns the pose matrix
  14276. */
  14277. getPoseMatrix(): Matrix;
  14278. /** @hidden */
  14279. _isSynchronized(): boolean;
  14280. /** @hidden */
  14281. _initCache(): void;
  14282. /**
  14283. * Flag the transform node as dirty (Forcing it to update everything)
  14284. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  14285. * @returns this transform node
  14286. */
  14287. markAsDirty(property: string): TransformNode;
  14288. /**
  14289. * Returns the current mesh absolute position.
  14290. * Returns a Vector3.
  14291. */
  14292. readonly absolutePosition: Vector3;
  14293. /**
  14294. * Returns the current mesh absolute scaling.
  14295. * Returns a Vector3.
  14296. */
  14297. readonly absoluteScaling: Vector3;
  14298. /**
  14299. * Returns the current mesh absolute rotation.
  14300. * Returns a Quaternion.
  14301. */
  14302. readonly absoluteRotationQuaternion: Quaternion;
  14303. /**
  14304. * Sets a new matrix to apply before all other transformation
  14305. * @param matrix defines the transform matrix
  14306. * @returns the current TransformNode
  14307. */
  14308. setPreTransformMatrix(matrix: Matrix): TransformNode;
  14309. /**
  14310. * Sets a new pivot matrix to the current node
  14311. * @param matrix defines the new pivot matrix to use
  14312. * @param postMultiplyPivotMatrix defines if the pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect
  14313. * @returns the current TransformNode
  14314. */
  14315. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  14316. /**
  14317. * Returns the mesh pivot matrix.
  14318. * Default : Identity.
  14319. * @returns the matrix
  14320. */
  14321. getPivotMatrix(): Matrix;
  14322. /**
  14323. * Instantiate (when possible) or clone that node with its hierarchy
  14324. * @param newParent defines the new parent to use for the instance (or clone)
  14325. * @param options defines options to configure how copy is done
  14326. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  14327. * @returns an instance (or a clone) of the current node with its hiearchy
  14328. */
  14329. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  14330. doNotInstantiate: boolean;
  14331. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  14332. /**
  14333. * Prevents the World matrix to be computed any longer
  14334. * @param newWorldMatrix defines an optional matrix to use as world matrix
  14335. * @returns the TransformNode.
  14336. */
  14337. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  14338. /**
  14339. * Allows back the World matrix computation.
  14340. * @returns the TransformNode.
  14341. */
  14342. unfreezeWorldMatrix(): this;
  14343. /**
  14344. * True if the World matrix has been frozen.
  14345. */
  14346. readonly isWorldMatrixFrozen: boolean;
  14347. /**
  14348. * Retuns the mesh absolute position in the World.
  14349. * @returns a Vector3.
  14350. */
  14351. getAbsolutePosition(): Vector3;
  14352. /**
  14353. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  14354. * @param absolutePosition the absolute position to set
  14355. * @returns the TransformNode.
  14356. */
  14357. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  14358. /**
  14359. * Sets the mesh position in its local space.
  14360. * @param vector3 the position to set in localspace
  14361. * @returns the TransformNode.
  14362. */
  14363. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  14364. /**
  14365. * Returns the mesh position in the local space from the current World matrix values.
  14366. * @returns a new Vector3.
  14367. */
  14368. getPositionExpressedInLocalSpace(): Vector3;
  14369. /**
  14370. * Translates the mesh along the passed Vector3 in its local space.
  14371. * @param vector3 the distance to translate in localspace
  14372. * @returns the TransformNode.
  14373. */
  14374. locallyTranslate(vector3: Vector3): TransformNode;
  14375. private static _lookAtVectorCache;
  14376. /**
  14377. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  14378. * @param targetPoint the position (must be in same space as current mesh) to look at
  14379. * @param yawCor optional yaw (y-axis) correction in radians
  14380. * @param pitchCor optional pitch (x-axis) correction in radians
  14381. * @param rollCor optional roll (z-axis) correction in radians
  14382. * @param space the choosen space of the target
  14383. * @returns the TransformNode.
  14384. */
  14385. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  14386. /**
  14387. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14388. * This Vector3 is expressed in the World space.
  14389. * @param localAxis axis to rotate
  14390. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14391. */
  14392. getDirection(localAxis: Vector3): Vector3;
  14393. /**
  14394. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  14395. * localAxis is expressed in the mesh local space.
  14396. * result is computed in the Wordl space from the mesh World matrix.
  14397. * @param localAxis axis to rotate
  14398. * @param result the resulting transformnode
  14399. * @returns this TransformNode.
  14400. */
  14401. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  14402. /**
  14403. * Sets this transform node rotation to the given local axis.
  14404. * @param localAxis the axis in local space
  14405. * @param yawCor optional yaw (y-axis) correction in radians
  14406. * @param pitchCor optional pitch (x-axis) correction in radians
  14407. * @param rollCor optional roll (z-axis) correction in radians
  14408. * @returns this TransformNode
  14409. */
  14410. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  14411. /**
  14412. * Sets a new pivot point to the current node
  14413. * @param point defines the new pivot point to use
  14414. * @param space defines if the point is in world or local space (local by default)
  14415. * @returns the current TransformNode
  14416. */
  14417. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  14418. /**
  14419. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  14420. * @returns the pivot point
  14421. */
  14422. getPivotPoint(): Vector3;
  14423. /**
  14424. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  14425. * @param result the vector3 to store the result
  14426. * @returns this TransformNode.
  14427. */
  14428. getPivotPointToRef(result: Vector3): TransformNode;
  14429. /**
  14430. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  14431. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  14432. */
  14433. getAbsolutePivotPoint(): Vector3;
  14434. /**
  14435. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  14436. * @param result vector3 to store the result
  14437. * @returns this TransformNode.
  14438. */
  14439. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  14440. /**
  14441. * Defines the passed node as the parent of the current node.
  14442. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  14443. * @see https://doc.babylonjs.com/how_to/parenting
  14444. * @param node the node ot set as the parent
  14445. * @returns this TransformNode.
  14446. */
  14447. setParent(node: Nullable<Node>): TransformNode;
  14448. private _nonUniformScaling;
  14449. /**
  14450. * True if the scaling property of this object is non uniform eg. (1,2,1)
  14451. */
  14452. readonly nonUniformScaling: boolean;
  14453. /** @hidden */
  14454. _updateNonUniformScalingState(value: boolean): boolean;
  14455. /**
  14456. * Attach the current TransformNode to another TransformNode associated with a bone
  14457. * @param bone Bone affecting the TransformNode
  14458. * @param affectedTransformNode TransformNode associated with the bone
  14459. * @returns this object
  14460. */
  14461. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  14462. /**
  14463. * Detach the transform node if its associated with a bone
  14464. * @returns this object
  14465. */
  14466. detachFromBone(): TransformNode;
  14467. private static _rotationAxisCache;
  14468. /**
  14469. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  14470. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14471. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14472. * The passed axis is also normalized.
  14473. * @param axis the axis to rotate around
  14474. * @param amount the amount to rotate in radians
  14475. * @param space Space to rotate in (Default: local)
  14476. * @returns the TransformNode.
  14477. */
  14478. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  14479. /**
  14480. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  14481. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14482. * The passed axis is also normalized. .
  14483. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  14484. * @param point the point to rotate around
  14485. * @param axis the axis to rotate around
  14486. * @param amount the amount to rotate in radians
  14487. * @returns the TransformNode
  14488. */
  14489. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  14490. /**
  14491. * Translates the mesh along the axis vector for the passed distance in the given space.
  14492. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14493. * @param axis the axis to translate in
  14494. * @param distance the distance to translate
  14495. * @param space Space to rotate in (Default: local)
  14496. * @returns the TransformNode.
  14497. */
  14498. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  14499. /**
  14500. * Adds a rotation step to the mesh current rotation.
  14501. * x, y, z are Euler angles expressed in radians.
  14502. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  14503. * This means this rotation is made in the mesh local space only.
  14504. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  14505. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  14506. * ```javascript
  14507. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  14508. * ```
  14509. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  14510. * Under the hood, only quaternions are used. So it's a little faster is you use .rotationQuaternion because it doesn't need to translate them back to Euler angles.
  14511. * @param x Rotation to add
  14512. * @param y Rotation to add
  14513. * @param z Rotation to add
  14514. * @returns the TransformNode.
  14515. */
  14516. addRotation(x: number, y: number, z: number): TransformNode;
  14517. /**
  14518. * @hidden
  14519. */
  14520. protected _getEffectiveParent(): Nullable<Node>;
  14521. /**
  14522. * Computes the world matrix of the node
  14523. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14524. * @returns the world matrix
  14525. */
  14526. computeWorldMatrix(force?: boolean): Matrix;
  14527. protected _afterComputeWorldMatrix(): void;
  14528. /**
  14529. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  14530. * @param func callback function to add
  14531. *
  14532. * @returns the TransformNode.
  14533. */
  14534. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14535. /**
  14536. * Removes a registered callback function.
  14537. * @param func callback function to remove
  14538. * @returns the TransformNode.
  14539. */
  14540. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14541. /**
  14542. * Gets the position of the current mesh in camera space
  14543. * @param camera defines the camera to use
  14544. * @returns a position
  14545. */
  14546. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  14547. /**
  14548. * Returns the distance from the mesh to the active camera
  14549. * @param camera defines the camera to use
  14550. * @returns the distance
  14551. */
  14552. getDistanceToCamera(camera?: Nullable<Camera>): number;
  14553. /**
  14554. * Clone the current transform node
  14555. * @param name Name of the new clone
  14556. * @param newParent New parent for the clone
  14557. * @param doNotCloneChildren Do not clone children hierarchy
  14558. * @returns the new transform node
  14559. */
  14560. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  14561. /**
  14562. * Serializes the objects information.
  14563. * @param currentSerializationObject defines the object to serialize in
  14564. * @returns the serialized object
  14565. */
  14566. serialize(currentSerializationObject?: any): any;
  14567. /**
  14568. * Returns a new TransformNode object parsed from the source provided.
  14569. * @param parsedTransformNode is the source.
  14570. * @param scene the scne the object belongs to
  14571. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  14572. * @returns a new TransformNode object parsed from the source provided.
  14573. */
  14574. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  14575. /**
  14576. * Get all child-transformNodes of this node
  14577. * @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
  14578. * @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
  14579. * @returns an array of TransformNode
  14580. */
  14581. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  14582. /**
  14583. * Releases resources associated with this transform node.
  14584. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  14585. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  14586. */
  14587. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  14588. /**
  14589. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  14590. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  14591. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  14592. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  14593. * @returns the current mesh
  14594. */
  14595. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  14596. private _syncAbsoluteScalingAndRotation;
  14597. }
  14598. }
  14599. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  14600. import { Observable } from "babylonjs/Misc/observable";
  14601. import { Nullable } from "babylonjs/types";
  14602. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14603. import { TransformNode } from "babylonjs/Meshes/transformNode";
  14604. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14605. import { Ray } from "babylonjs/Culling/ray";
  14606. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  14607. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  14608. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  14609. /**
  14610. * Defines the types of pose enabled controllers that are supported
  14611. */
  14612. export enum PoseEnabledControllerType {
  14613. /**
  14614. * HTC Vive
  14615. */
  14616. VIVE = 0,
  14617. /**
  14618. * Oculus Rift
  14619. */
  14620. OCULUS = 1,
  14621. /**
  14622. * Windows mixed reality
  14623. */
  14624. WINDOWS = 2,
  14625. /**
  14626. * Samsung gear VR
  14627. */
  14628. GEAR_VR = 3,
  14629. /**
  14630. * Google Daydream
  14631. */
  14632. DAYDREAM = 4,
  14633. /**
  14634. * Generic
  14635. */
  14636. GENERIC = 5
  14637. }
  14638. /**
  14639. * Defines the MutableGamepadButton interface for the state of a gamepad button
  14640. */
  14641. export interface MutableGamepadButton {
  14642. /**
  14643. * Value of the button/trigger
  14644. */
  14645. value: number;
  14646. /**
  14647. * If the button/trigger is currently touched
  14648. */
  14649. touched: boolean;
  14650. /**
  14651. * If the button/trigger is currently pressed
  14652. */
  14653. pressed: boolean;
  14654. }
  14655. /**
  14656. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  14657. * @hidden
  14658. */
  14659. export interface ExtendedGamepadButton extends GamepadButton {
  14660. /**
  14661. * If the button/trigger is currently pressed
  14662. */
  14663. readonly pressed: boolean;
  14664. /**
  14665. * If the button/trigger is currently touched
  14666. */
  14667. readonly touched: boolean;
  14668. /**
  14669. * Value of the button/trigger
  14670. */
  14671. readonly value: number;
  14672. }
  14673. /** @hidden */
  14674. export interface _GamePadFactory {
  14675. /**
  14676. * Returns wether or not the current gamepad can be created for this type of controller.
  14677. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14678. * @returns true if it can be created, otherwise false
  14679. */
  14680. canCreate(gamepadInfo: any): boolean;
  14681. /**
  14682. * Creates a new instance of the Gamepad.
  14683. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14684. * @returns the new gamepad instance
  14685. */
  14686. create(gamepadInfo: any): Gamepad;
  14687. }
  14688. /**
  14689. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14690. */
  14691. export class PoseEnabledControllerHelper {
  14692. /** @hidden */
  14693. static _ControllerFactories: _GamePadFactory[];
  14694. /** @hidden */
  14695. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  14696. /**
  14697. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14698. * @param vrGamepad the gamepad to initialized
  14699. * @returns a vr controller of the type the gamepad identified as
  14700. */
  14701. static InitiateController(vrGamepad: any): Gamepad;
  14702. }
  14703. /**
  14704. * Defines the PoseEnabledController object that contains state of a vr capable controller
  14705. */
  14706. export class PoseEnabledController extends Gamepad implements PoseControlled {
  14707. /**
  14708. * If the controller is used in a webXR session
  14709. */
  14710. isXR: boolean;
  14711. private _deviceRoomPosition;
  14712. private _deviceRoomRotationQuaternion;
  14713. /**
  14714. * The device position in babylon space
  14715. */
  14716. devicePosition: Vector3;
  14717. /**
  14718. * The device rotation in babylon space
  14719. */
  14720. deviceRotationQuaternion: Quaternion;
  14721. /**
  14722. * The scale factor of the device in babylon space
  14723. */
  14724. deviceScaleFactor: number;
  14725. /**
  14726. * (Likely devicePosition should be used instead) The device position in its room space
  14727. */
  14728. position: Vector3;
  14729. /**
  14730. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  14731. */
  14732. rotationQuaternion: Quaternion;
  14733. /**
  14734. * The type of controller (Eg. Windows mixed reality)
  14735. */
  14736. controllerType: PoseEnabledControllerType;
  14737. protected _calculatedPosition: Vector3;
  14738. private _calculatedRotation;
  14739. /**
  14740. * The raw pose from the device
  14741. */
  14742. rawPose: DevicePose;
  14743. private _trackPosition;
  14744. private _maxRotationDistFromHeadset;
  14745. private _draggedRoomRotation;
  14746. /**
  14747. * @hidden
  14748. */
  14749. _disableTrackPosition(fixedPosition: Vector3): void;
  14750. /**
  14751. * Internal, the mesh attached to the controller
  14752. * @hidden
  14753. */
  14754. _mesh: Nullable<AbstractMesh>;
  14755. private _poseControlledCamera;
  14756. private _leftHandSystemQuaternion;
  14757. /**
  14758. * Internal, matrix used to convert room space to babylon space
  14759. * @hidden
  14760. */
  14761. _deviceToWorld: Matrix;
  14762. /**
  14763. * Node to be used when casting a ray from the controller
  14764. * @hidden
  14765. */
  14766. _pointingPoseNode: Nullable<TransformNode>;
  14767. /**
  14768. * Name of the child mesh that can be used to cast a ray from the controller
  14769. */
  14770. static readonly POINTING_POSE: string;
  14771. /**
  14772. * Creates a new PoseEnabledController from a gamepad
  14773. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  14774. */
  14775. constructor(browserGamepad: any);
  14776. private _workingMatrix;
  14777. /**
  14778. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  14779. */
  14780. update(): void;
  14781. /**
  14782. * Updates only the pose device and mesh without doing any button event checking
  14783. */
  14784. protected _updatePoseAndMesh(): void;
  14785. /**
  14786. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  14787. * @param poseData raw pose fromthe device
  14788. */
  14789. updateFromDevice(poseData: DevicePose): void;
  14790. /**
  14791. * @hidden
  14792. */
  14793. _meshAttachedObservable: Observable<AbstractMesh>;
  14794. /**
  14795. * Attaches a mesh to the controller
  14796. * @param mesh the mesh to be attached
  14797. */
  14798. attachToMesh(mesh: AbstractMesh): void;
  14799. /**
  14800. * Attaches the controllers mesh to a camera
  14801. * @param camera the camera the mesh should be attached to
  14802. */
  14803. attachToPoseControlledCamera(camera: TargetCamera): void;
  14804. /**
  14805. * Disposes of the controller
  14806. */
  14807. dispose(): void;
  14808. /**
  14809. * The mesh that is attached to the controller
  14810. */
  14811. readonly mesh: Nullable<AbstractMesh>;
  14812. /**
  14813. * Gets the ray of the controller in the direction the controller is pointing
  14814. * @param length the length the resulting ray should be
  14815. * @returns a ray in the direction the controller is pointing
  14816. */
  14817. getForwardRay(length?: number): Ray;
  14818. }
  14819. }
  14820. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  14821. import { Observable } from "babylonjs/Misc/observable";
  14822. import { Scene } from "babylonjs/scene";
  14823. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14824. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  14825. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  14826. import { Nullable } from "babylonjs/types";
  14827. /**
  14828. * Defines the WebVRController object that represents controllers tracked in 3D space
  14829. */
  14830. export abstract class WebVRController extends PoseEnabledController {
  14831. /**
  14832. * Internal, the default controller model for the controller
  14833. */
  14834. protected _defaultModel: Nullable<AbstractMesh>;
  14835. /**
  14836. * Fired when the trigger state has changed
  14837. */
  14838. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  14839. /**
  14840. * Fired when the main button state has changed
  14841. */
  14842. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14843. /**
  14844. * Fired when the secondary button state has changed
  14845. */
  14846. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14847. /**
  14848. * Fired when the pad state has changed
  14849. */
  14850. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  14851. /**
  14852. * Fired when controllers stick values have changed
  14853. */
  14854. onPadValuesChangedObservable: Observable<StickValues>;
  14855. /**
  14856. * Array of button availible on the controller
  14857. */
  14858. protected _buttons: Array<MutableGamepadButton>;
  14859. private _onButtonStateChange;
  14860. /**
  14861. * Fired when a controller button's state has changed
  14862. * @param callback the callback containing the button that was modified
  14863. */
  14864. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  14865. /**
  14866. * X and Y axis corresponding to the controllers joystick
  14867. */
  14868. pad: StickValues;
  14869. /**
  14870. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  14871. */
  14872. hand: string;
  14873. /**
  14874. * The default controller model for the controller
  14875. */
  14876. readonly defaultModel: Nullable<AbstractMesh>;
  14877. /**
  14878. * Creates a new WebVRController from a gamepad
  14879. * @param vrGamepad the gamepad that the WebVRController should be created from
  14880. */
  14881. constructor(vrGamepad: any);
  14882. /**
  14883. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  14884. */
  14885. update(): void;
  14886. /**
  14887. * Function to be called when a button is modified
  14888. */
  14889. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  14890. /**
  14891. * Loads a mesh and attaches it to the controller
  14892. * @param scene the scene the mesh should be added to
  14893. * @param meshLoaded callback for when the mesh has been loaded
  14894. */
  14895. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  14896. private _setButtonValue;
  14897. private _changes;
  14898. private _checkChanges;
  14899. /**
  14900. * Disposes of th webVRCOntroller
  14901. */
  14902. dispose(): void;
  14903. }
  14904. }
  14905. declare module "babylonjs/Lights/hemisphericLight" {
  14906. import { Nullable } from "babylonjs/types";
  14907. import { Scene } from "babylonjs/scene";
  14908. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14909. import { Color3 } from "babylonjs/Maths/math.color";
  14910. import { Effect } from "babylonjs/Materials/effect";
  14911. import { Light } from "babylonjs/Lights/light";
  14912. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  14913. /**
  14914. * The HemisphericLight simulates the ambient environment light,
  14915. * so the passed direction is the light reflection direction, not the incoming direction.
  14916. */
  14917. export class HemisphericLight extends Light {
  14918. /**
  14919. * The groundColor is the light in the opposite direction to the one specified during creation.
  14920. * You can think of the diffuse and specular light as coming from the centre of the object in the given direction and the groundColor light in the opposite direction.
  14921. */
  14922. groundColor: Color3;
  14923. /**
  14924. * The light reflection direction, not the incoming direction.
  14925. */
  14926. direction: Vector3;
  14927. /**
  14928. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  14929. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  14930. * The HemisphericLight can't cast shadows.
  14931. * Documentation : https://doc.babylonjs.com/babylon101/lights
  14932. * @param name The friendly name of the light
  14933. * @param direction The direction of the light reflection
  14934. * @param scene The scene the light belongs to
  14935. */
  14936. constructor(name: string, direction: Vector3, scene: Scene);
  14937. protected _buildUniformLayout(): void;
  14938. /**
  14939. * Returns the string "HemisphericLight".
  14940. * @return The class name
  14941. */
  14942. getClassName(): string;
  14943. /**
  14944. * Sets the HemisphericLight direction towards the passed target (Vector3).
  14945. * Returns the updated direction.
  14946. * @param target The target the direction should point to
  14947. * @return The computed direction
  14948. */
  14949. setDirectionToTarget(target: Vector3): Vector3;
  14950. /**
  14951. * Returns the shadow generator associated to the light.
  14952. * @returns Always null for hemispheric lights because it does not support shadows.
  14953. */
  14954. getShadowGenerator(): Nullable<IShadowGenerator>;
  14955. /**
  14956. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  14957. * @param effect The effect to update
  14958. * @param lightIndex The index of the light in the effect to update
  14959. * @returns The hemispheric light
  14960. */
  14961. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  14962. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  14963. /**
  14964. * Computes the world matrix of the node
  14965. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14966. * @param useWasUpdatedFlag defines a reserved property
  14967. * @returns the world matrix
  14968. */
  14969. computeWorldMatrix(): Matrix;
  14970. /**
  14971. * Returns the integer 3.
  14972. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  14973. */
  14974. getTypeID(): number;
  14975. /**
  14976. * Prepares the list of defines specific to the light type.
  14977. * @param defines the list of defines
  14978. * @param lightIndex defines the index of the light for the effect
  14979. */
  14980. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  14981. }
  14982. }
  14983. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  14984. /** @hidden */
  14985. export var vrMultiviewToSingleviewPixelShader: {
  14986. name: string;
  14987. shader: string;
  14988. };
  14989. }
  14990. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  14991. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  14992. import { Scene } from "babylonjs/scene";
  14993. /**
  14994. * Renders to multiple views with a single draw call
  14995. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  14996. */
  14997. export class MultiviewRenderTarget extends RenderTargetTexture {
  14998. /**
  14999. * Creates a multiview render target
  15000. * @param scene scene used with the render target
  15001. * @param size the size of the render target (used for each view)
  15002. */
  15003. constructor(scene: Scene, size?: number | {
  15004. width: number;
  15005. height: number;
  15006. } | {
  15007. ratio: number;
  15008. });
  15009. /**
  15010. * @hidden
  15011. * @param faceIndex the face index, if its a cube texture
  15012. */
  15013. _bindFrameBuffer(faceIndex?: number): void;
  15014. /**
  15015. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  15016. * @returns the view count
  15017. */
  15018. getViewCount(): number;
  15019. }
  15020. }
  15021. declare module "babylonjs/Maths/math.frustum" {
  15022. import { Matrix } from "babylonjs/Maths/math.vector";
  15023. import { DeepImmutable } from "babylonjs/types";
  15024. import { Plane } from "babylonjs/Maths/math.plane";
  15025. /**
  15026. * Represents a camera frustum
  15027. */
  15028. export class Frustum {
  15029. /**
  15030. * Gets the planes representing the frustum
  15031. * @param transform matrix to be applied to the returned planes
  15032. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  15033. */
  15034. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  15035. /**
  15036. * Gets the near frustum plane transformed by the transform matrix
  15037. * @param transform transformation matrix to be applied to the resulting frustum plane
  15038. * @param frustumPlane the resuling frustum plane
  15039. */
  15040. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15041. /**
  15042. * Gets the far frustum plane transformed by the transform matrix
  15043. * @param transform transformation matrix to be applied to the resulting frustum plane
  15044. * @param frustumPlane the resuling frustum plane
  15045. */
  15046. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15047. /**
  15048. * Gets the left frustum plane transformed by the transform matrix
  15049. * @param transform transformation matrix to be applied to the resulting frustum plane
  15050. * @param frustumPlane the resuling frustum plane
  15051. */
  15052. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15053. /**
  15054. * Gets the right frustum plane transformed by the transform matrix
  15055. * @param transform transformation matrix to be applied to the resulting frustum plane
  15056. * @param frustumPlane the resuling frustum plane
  15057. */
  15058. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15059. /**
  15060. * Gets the top frustum plane transformed by the transform matrix
  15061. * @param transform transformation matrix to be applied to the resulting frustum plane
  15062. * @param frustumPlane the resuling frustum plane
  15063. */
  15064. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15065. /**
  15066. * Gets the bottom frustum plane transformed by the transform matrix
  15067. * @param transform transformation matrix to be applied to the resulting frustum plane
  15068. * @param frustumPlane the resuling frustum plane
  15069. */
  15070. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15071. /**
  15072. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  15073. * @param transform transformation matrix to be applied to the resulting frustum planes
  15074. * @param frustumPlanes the resuling frustum planes
  15075. */
  15076. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  15077. }
  15078. }
  15079. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  15080. import { Camera } from "babylonjs/Cameras/camera";
  15081. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15082. import { Nullable } from "babylonjs/types";
  15083. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15084. import { Matrix } from "babylonjs/Maths/math.vector";
  15085. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  15086. module "babylonjs/Engines/engine" {
  15087. interface Engine {
  15088. /**
  15089. * Creates a new multiview render target
  15090. * @param width defines the width of the texture
  15091. * @param height defines the height of the texture
  15092. * @returns the created multiview texture
  15093. */
  15094. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  15095. /**
  15096. * Binds a multiview framebuffer to be drawn to
  15097. * @param multiviewTexture texture to bind
  15098. */
  15099. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  15100. }
  15101. }
  15102. module "babylonjs/Cameras/camera" {
  15103. interface Camera {
  15104. /**
  15105. * @hidden
  15106. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  15107. */
  15108. _useMultiviewToSingleView: boolean;
  15109. /**
  15110. * @hidden
  15111. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  15112. */
  15113. _multiviewTexture: Nullable<RenderTargetTexture>;
  15114. /**
  15115. * @hidden
  15116. * ensures the multiview texture of the camera exists and has the specified width/height
  15117. * @param width height to set on the multiview texture
  15118. * @param height width to set on the multiview texture
  15119. */
  15120. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  15121. }
  15122. }
  15123. module "babylonjs/scene" {
  15124. interface Scene {
  15125. /** @hidden */
  15126. _transformMatrixR: Matrix;
  15127. /** @hidden */
  15128. _multiviewSceneUbo: Nullable<UniformBuffer>;
  15129. /** @hidden */
  15130. _createMultiviewUbo(): void;
  15131. /** @hidden */
  15132. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  15133. /** @hidden */
  15134. _renderMultiviewToSingleView(camera: Camera): void;
  15135. }
  15136. }
  15137. }
  15138. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  15139. import { Camera } from "babylonjs/Cameras/camera";
  15140. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  15141. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  15142. import "babylonjs/Engines/Extensions/engine.multiview";
  15143. /**
  15144. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  15145. * This will not be used for webXR as it supports displaying texture arrays directly
  15146. */
  15147. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  15148. /**
  15149. * Initializes a VRMultiviewToSingleview
  15150. * @param name name of the post process
  15151. * @param camera camera to be applied to
  15152. * @param scaleFactor scaling factor to the size of the output texture
  15153. */
  15154. constructor(name: string, camera: Camera, scaleFactor: number);
  15155. }
  15156. }
  15157. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  15158. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  15159. import { Nullable } from "babylonjs/types";
  15160. import { Size } from "babylonjs/Maths/math.size";
  15161. import { Observable } from "babylonjs/Misc/observable";
  15162. /**
  15163. * Interface used to define additional presentation attributes
  15164. */
  15165. export interface IVRPresentationAttributes {
  15166. /**
  15167. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  15168. */
  15169. highRefreshRate: boolean;
  15170. /**
  15171. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  15172. */
  15173. foveationLevel: number;
  15174. }
  15175. module "babylonjs/Engines/engine" {
  15176. interface Engine {
  15177. /** @hidden */
  15178. _vrDisplay: any;
  15179. /** @hidden */
  15180. _vrSupported: boolean;
  15181. /** @hidden */
  15182. _oldSize: Size;
  15183. /** @hidden */
  15184. _oldHardwareScaleFactor: number;
  15185. /** @hidden */
  15186. _vrExclusivePointerMode: boolean;
  15187. /** @hidden */
  15188. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  15189. /** @hidden */
  15190. _onVRDisplayPointerRestricted: () => void;
  15191. /** @hidden */
  15192. _onVRDisplayPointerUnrestricted: () => void;
  15193. /** @hidden */
  15194. _onVrDisplayConnect: Nullable<(display: any) => void>;
  15195. /** @hidden */
  15196. _onVrDisplayDisconnect: Nullable<() => void>;
  15197. /** @hidden */
  15198. _onVrDisplayPresentChange: Nullable<() => void>;
  15199. /**
  15200. * Observable signaled when VR display mode changes
  15201. */
  15202. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  15203. /**
  15204. * Observable signaled when VR request present is complete
  15205. */
  15206. onVRRequestPresentComplete: Observable<boolean>;
  15207. /**
  15208. * Observable signaled when VR request present starts
  15209. */
  15210. onVRRequestPresentStart: Observable<Engine>;
  15211. /**
  15212. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  15213. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  15214. */
  15215. isInVRExclusivePointerMode: boolean;
  15216. /**
  15217. * Gets a boolean indicating if a webVR device was detected
  15218. * @returns true if a webVR device was detected
  15219. */
  15220. isVRDevicePresent(): boolean;
  15221. /**
  15222. * Gets the current webVR device
  15223. * @returns the current webVR device (or null)
  15224. */
  15225. getVRDevice(): any;
  15226. /**
  15227. * Initializes a webVR display and starts listening to display change events
  15228. * The onVRDisplayChangedObservable will be notified upon these changes
  15229. * @returns A promise containing a VRDisplay and if vr is supported
  15230. */
  15231. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  15232. /** @hidden */
  15233. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  15234. /**
  15235. * Gets or sets the presentation attributes used to configure VR rendering
  15236. */
  15237. vrPresentationAttributes?: IVRPresentationAttributes;
  15238. /**
  15239. * Call this function to switch to webVR mode
  15240. * Will do nothing if webVR is not supported or if there is no webVR device
  15241. * @see http://doc.babylonjs.com/how_to/webvr_camera
  15242. */
  15243. enableVR(): void;
  15244. /** @hidden */
  15245. _onVRFullScreenTriggered(): void;
  15246. }
  15247. }
  15248. }
  15249. declare module "babylonjs/Cameras/VR/webVRCamera" {
  15250. import { Nullable } from "babylonjs/types";
  15251. import { Observable } from "babylonjs/Misc/observable";
  15252. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  15253. import { Scene } from "babylonjs/scene";
  15254. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15255. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  15256. import { Node } from "babylonjs/node";
  15257. import { Ray } from "babylonjs/Culling/ray";
  15258. import "babylonjs/Cameras/RigModes/webVRRigMode";
  15259. import "babylonjs/Engines/Extensions/engine.webVR";
  15260. /**
  15261. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  15262. * IMPORTANT!! The data is right-hand data.
  15263. * @export
  15264. * @interface DevicePose
  15265. */
  15266. export interface DevicePose {
  15267. /**
  15268. * The position of the device, values in array are [x,y,z].
  15269. */
  15270. readonly position: Nullable<Float32Array>;
  15271. /**
  15272. * The linearVelocity of the device, values in array are [x,y,z].
  15273. */
  15274. readonly linearVelocity: Nullable<Float32Array>;
  15275. /**
  15276. * The linearAcceleration of the device, values in array are [x,y,z].
  15277. */
  15278. readonly linearAcceleration: Nullable<Float32Array>;
  15279. /**
  15280. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  15281. */
  15282. readonly orientation: Nullable<Float32Array>;
  15283. /**
  15284. * The angularVelocity of the device, values in array are [x,y,z].
  15285. */
  15286. readonly angularVelocity: Nullable<Float32Array>;
  15287. /**
  15288. * The angularAcceleration of the device, values in array are [x,y,z].
  15289. */
  15290. readonly angularAcceleration: Nullable<Float32Array>;
  15291. }
  15292. /**
  15293. * Interface representing a pose controlled object in Babylon.
  15294. * A pose controlled object has both regular pose values as well as pose values
  15295. * from an external device such as a VR head mounted display
  15296. */
  15297. export interface PoseControlled {
  15298. /**
  15299. * The position of the object in babylon space.
  15300. */
  15301. position: Vector3;
  15302. /**
  15303. * The rotation quaternion of the object in babylon space.
  15304. */
  15305. rotationQuaternion: Quaternion;
  15306. /**
  15307. * The position of the device in babylon space.
  15308. */
  15309. devicePosition?: Vector3;
  15310. /**
  15311. * The rotation quaternion of the device in babylon space.
  15312. */
  15313. deviceRotationQuaternion: Quaternion;
  15314. /**
  15315. * The raw pose coming from the device.
  15316. */
  15317. rawPose: Nullable<DevicePose>;
  15318. /**
  15319. * The scale of the device to be used when translating from device space to babylon space.
  15320. */
  15321. deviceScaleFactor: number;
  15322. /**
  15323. * Updates the poseControlled values based on the input device pose.
  15324. * @param poseData the pose data to update the object with
  15325. */
  15326. updateFromDevice(poseData: DevicePose): void;
  15327. }
  15328. /**
  15329. * Set of options to customize the webVRCamera
  15330. */
  15331. export interface WebVROptions {
  15332. /**
  15333. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  15334. */
  15335. trackPosition?: boolean;
  15336. /**
  15337. * Sets the scale of the vrDevice in babylon space. (default: 1)
  15338. */
  15339. positionScale?: number;
  15340. /**
  15341. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  15342. */
  15343. displayName?: string;
  15344. /**
  15345. * Should the native controller meshes be initialized. (default: true)
  15346. */
  15347. controllerMeshes?: boolean;
  15348. /**
  15349. * Creating a default HemiLight only on controllers. (default: true)
  15350. */
  15351. defaultLightingOnControllers?: boolean;
  15352. /**
  15353. * If you don't want to use the default VR button of the helper. (default: false)
  15354. */
  15355. useCustomVRButton?: boolean;
  15356. /**
  15357. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  15358. */
  15359. customVRButton?: HTMLButtonElement;
  15360. /**
  15361. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  15362. */
  15363. rayLength?: number;
  15364. /**
  15365. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  15366. */
  15367. defaultHeight?: number;
  15368. /**
  15369. * If multiview should be used if availible (default: false)
  15370. */
  15371. useMultiview?: boolean;
  15372. }
  15373. /**
  15374. * This represents a WebVR camera.
  15375. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  15376. * @example http://doc.babylonjs.com/how_to/webvr_camera
  15377. */
  15378. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  15379. private webVROptions;
  15380. /**
  15381. * @hidden
  15382. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  15383. */
  15384. _vrDevice: any;
  15385. /**
  15386. * The rawPose of the vrDevice.
  15387. */
  15388. rawPose: Nullable<DevicePose>;
  15389. private _onVREnabled;
  15390. private _specsVersion;
  15391. private _attached;
  15392. private _frameData;
  15393. protected _descendants: Array<Node>;
  15394. private _deviceRoomPosition;
  15395. /** @hidden */
  15396. _deviceRoomRotationQuaternion: Quaternion;
  15397. private _standingMatrix;
  15398. /**
  15399. * Represents device position in babylon space.
  15400. */
  15401. devicePosition: Vector3;
  15402. /**
  15403. * Represents device rotation in babylon space.
  15404. */
  15405. deviceRotationQuaternion: Quaternion;
  15406. /**
  15407. * The scale of the device to be used when translating from device space to babylon space.
  15408. */
  15409. deviceScaleFactor: number;
  15410. private _deviceToWorld;
  15411. private _worldToDevice;
  15412. /**
  15413. * References to the webVR controllers for the vrDevice.
  15414. */
  15415. controllers: Array<WebVRController>;
  15416. /**
  15417. * Emits an event when a controller is attached.
  15418. */
  15419. onControllersAttachedObservable: Observable<WebVRController[]>;
  15420. /**
  15421. * Emits an event when a controller's mesh has been loaded;
  15422. */
  15423. onControllerMeshLoadedObservable: Observable<WebVRController>;
  15424. /**
  15425. * Emits an event when the HMD's pose has been updated.
  15426. */
  15427. onPoseUpdatedFromDeviceObservable: Observable<any>;
  15428. private _poseSet;
  15429. /**
  15430. * If the rig cameras be used as parent instead of this camera.
  15431. */
  15432. rigParenting: boolean;
  15433. private _lightOnControllers;
  15434. private _defaultHeight?;
  15435. /**
  15436. * Instantiates a WebVRFreeCamera.
  15437. * @param name The name of the WebVRFreeCamera
  15438. * @param position The starting anchor position for the camera
  15439. * @param scene The scene the camera belongs to
  15440. * @param webVROptions a set of customizable options for the webVRCamera
  15441. */
  15442. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  15443. /**
  15444. * Gets the device distance from the ground in meters.
  15445. * @returns the distance in meters from the vrDevice to ground in device space. If standing matrix is not supported for the vrDevice 0 is returned.
  15446. */
  15447. deviceDistanceToRoomGround(): number;
  15448. /**
  15449. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15450. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  15451. */
  15452. useStandingMatrix(callback?: (bool: boolean) => void): void;
  15453. /**
  15454. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15455. * @returns A promise with a boolean set to if the standing matrix is supported.
  15456. */
  15457. useStandingMatrixAsync(): Promise<boolean>;
  15458. /**
  15459. * Disposes the camera
  15460. */
  15461. dispose(): void;
  15462. /**
  15463. * Gets a vrController by name.
  15464. * @param name The name of the controller to retreive
  15465. * @returns the controller matching the name specified or null if not found
  15466. */
  15467. getControllerByName(name: string): Nullable<WebVRController>;
  15468. private _leftController;
  15469. /**
  15470. * The controller corresponding to the users left hand.
  15471. */
  15472. readonly leftController: Nullable<WebVRController>;
  15473. private _rightController;
  15474. /**
  15475. * The controller corresponding to the users right hand.
  15476. */
  15477. readonly rightController: Nullable<WebVRController>;
  15478. /**
  15479. * Casts a ray forward from the vrCamera's gaze.
  15480. * @param length Length of the ray (default: 100)
  15481. * @returns the ray corresponding to the gaze
  15482. */
  15483. getForwardRay(length?: number): Ray;
  15484. /**
  15485. * @hidden
  15486. * Updates the camera based on device's frame data
  15487. */
  15488. _checkInputs(): void;
  15489. /**
  15490. * Updates the poseControlled values based on the input device pose.
  15491. * @param poseData Pose coming from the device
  15492. */
  15493. updateFromDevice(poseData: DevicePose): void;
  15494. private _htmlElementAttached;
  15495. private _detachIfAttached;
  15496. /**
  15497. * WebVR's attach control will start broadcasting frames to the device.
  15498. * Note that in certain browsers (chrome for example) this function must be called
  15499. * within a user-interaction callback. Example:
  15500. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  15501. *
  15502. * @param element html element to attach the vrDevice to
  15503. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  15504. */
  15505. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  15506. /**
  15507. * Detaches the camera from the html element and disables VR
  15508. *
  15509. * @param element html element to detach from
  15510. */
  15511. detachControl(element: HTMLElement): void;
  15512. /**
  15513. * @returns the name of this class
  15514. */
  15515. getClassName(): string;
  15516. /**
  15517. * Calls resetPose on the vrDisplay
  15518. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  15519. */
  15520. resetToCurrentRotation(): void;
  15521. /**
  15522. * @hidden
  15523. * Updates the rig cameras (left and right eye)
  15524. */
  15525. _updateRigCameras(): void;
  15526. private _workingVector;
  15527. private _oneVector;
  15528. private _workingMatrix;
  15529. private updateCacheCalled;
  15530. private _correctPositionIfNotTrackPosition;
  15531. /**
  15532. * @hidden
  15533. * Updates the cached values of the camera
  15534. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  15535. */
  15536. _updateCache(ignoreParentClass?: boolean): void;
  15537. /**
  15538. * @hidden
  15539. * Get current device position in babylon world
  15540. */
  15541. _computeDevicePosition(): void;
  15542. /**
  15543. * Updates the current device position and rotation in the babylon world
  15544. */
  15545. update(): void;
  15546. /**
  15547. * @hidden
  15548. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  15549. * @returns an identity matrix
  15550. */
  15551. _getViewMatrix(): Matrix;
  15552. private _tmpMatrix;
  15553. /**
  15554. * This function is called by the two RIG cameras.
  15555. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  15556. * @hidden
  15557. */
  15558. _getWebVRViewMatrix(): Matrix;
  15559. /** @hidden */
  15560. _getWebVRProjectionMatrix(): Matrix;
  15561. private _onGamepadConnectedObserver;
  15562. private _onGamepadDisconnectedObserver;
  15563. private _updateCacheWhenTrackingDisabledObserver;
  15564. /**
  15565. * Initializes the controllers and their meshes
  15566. */
  15567. initControllers(): void;
  15568. }
  15569. }
  15570. declare module "babylonjs/PostProcesses/postProcess" {
  15571. import { Nullable } from "babylonjs/types";
  15572. import { SmartArray } from "babylonjs/Misc/smartArray";
  15573. import { Observable } from "babylonjs/Misc/observable";
  15574. import { Vector2 } from "babylonjs/Maths/math.vector";
  15575. import { Camera } from "babylonjs/Cameras/camera";
  15576. import { Effect } from "babylonjs/Materials/effect";
  15577. import "babylonjs/Shaders/postprocess.vertex";
  15578. import { IInspectable } from "babylonjs/Misc/iInspectable";
  15579. import { Engine } from "babylonjs/Engines/engine";
  15580. import { Color4 } from "babylonjs/Maths/math.color";
  15581. import "babylonjs/Engines/Extensions/engine.renderTarget";
  15582. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15583. /**
  15584. * Size options for a post process
  15585. */
  15586. export type PostProcessOptions = {
  15587. width: number;
  15588. height: number;
  15589. };
  15590. /**
  15591. * PostProcess can be used to apply a shader to a texture after it has been rendered
  15592. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  15593. */
  15594. export class PostProcess {
  15595. /** Name of the PostProcess. */
  15596. name: string;
  15597. /**
  15598. * Gets or sets the unique id of the post process
  15599. */
  15600. uniqueId: number;
  15601. /**
  15602. * Width of the texture to apply the post process on
  15603. */
  15604. width: number;
  15605. /**
  15606. * Height of the texture to apply the post process on
  15607. */
  15608. height: number;
  15609. /**
  15610. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  15611. * @hidden
  15612. */
  15613. _outputTexture: Nullable<InternalTexture>;
  15614. /**
  15615. * Sampling mode used by the shader
  15616. * See https://doc.babylonjs.com/classes/3.1/texture
  15617. */
  15618. renderTargetSamplingMode: number;
  15619. /**
  15620. * Clear color to use when screen clearing
  15621. */
  15622. clearColor: Color4;
  15623. /**
  15624. * If the buffer needs to be cleared before applying the post process. (default: true)
  15625. * Should be set to false if shader will overwrite all previous pixels.
  15626. */
  15627. autoClear: boolean;
  15628. /**
  15629. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  15630. */
  15631. alphaMode: number;
  15632. /**
  15633. * Sets the setAlphaBlendConstants of the babylon engine
  15634. */
  15635. alphaConstants: Color4;
  15636. /**
  15637. * Animations to be used for the post processing
  15638. */
  15639. animations: import("babylonjs/Animations/animation").Animation[];
  15640. /**
  15641. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  15642. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  15643. */
  15644. enablePixelPerfectMode: boolean;
  15645. /**
  15646. * Force the postprocess to be applied without taking in account viewport
  15647. */
  15648. forceFullscreenViewport: boolean;
  15649. /**
  15650. * List of inspectable custom properties (used by the Inspector)
  15651. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  15652. */
  15653. inspectableCustomProperties: IInspectable[];
  15654. /**
  15655. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  15656. *
  15657. * | Value | Type | Description |
  15658. * | ----- | ----------------------------------- | ----------- |
  15659. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  15660. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  15661. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  15662. *
  15663. */
  15664. scaleMode: number;
  15665. /**
  15666. * Force textures to be a power of two (default: false)
  15667. */
  15668. alwaysForcePOT: boolean;
  15669. private _samples;
  15670. /**
  15671. * Number of sample textures (default: 1)
  15672. */
  15673. samples: number;
  15674. /**
  15675. * Modify the scale of the post process to be the same as the viewport (default: false)
  15676. */
  15677. adaptScaleToCurrentViewport: boolean;
  15678. private _camera;
  15679. private _scene;
  15680. private _engine;
  15681. private _options;
  15682. private _reusable;
  15683. private _textureType;
  15684. /**
  15685. * Smart array of input and output textures for the post process.
  15686. * @hidden
  15687. */
  15688. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  15689. /**
  15690. * The index in _textures that corresponds to the output texture.
  15691. * @hidden
  15692. */
  15693. _currentRenderTextureInd: number;
  15694. private _effect;
  15695. private _samplers;
  15696. private _fragmentUrl;
  15697. private _vertexUrl;
  15698. private _parameters;
  15699. private _scaleRatio;
  15700. protected _indexParameters: any;
  15701. private _shareOutputWithPostProcess;
  15702. private _texelSize;
  15703. private _forcedOutputTexture;
  15704. /**
  15705. * Returns the fragment url or shader name used in the post process.
  15706. * @returns the fragment url or name in the shader store.
  15707. */
  15708. getEffectName(): string;
  15709. /**
  15710. * An event triggered when the postprocess is activated.
  15711. */
  15712. onActivateObservable: Observable<Camera>;
  15713. private _onActivateObserver;
  15714. /**
  15715. * A function that is added to the onActivateObservable
  15716. */
  15717. onActivate: Nullable<(camera: Camera) => void>;
  15718. /**
  15719. * An event triggered when the postprocess changes its size.
  15720. */
  15721. onSizeChangedObservable: Observable<PostProcess>;
  15722. private _onSizeChangedObserver;
  15723. /**
  15724. * A function that is added to the onSizeChangedObservable
  15725. */
  15726. onSizeChanged: (postProcess: PostProcess) => void;
  15727. /**
  15728. * An event triggered when the postprocess applies its effect.
  15729. */
  15730. onApplyObservable: Observable<Effect>;
  15731. private _onApplyObserver;
  15732. /**
  15733. * A function that is added to the onApplyObservable
  15734. */
  15735. onApply: (effect: Effect) => void;
  15736. /**
  15737. * An event triggered before rendering the postprocess
  15738. */
  15739. onBeforeRenderObservable: Observable<Effect>;
  15740. private _onBeforeRenderObserver;
  15741. /**
  15742. * A function that is added to the onBeforeRenderObservable
  15743. */
  15744. onBeforeRender: (effect: Effect) => void;
  15745. /**
  15746. * An event triggered after rendering the postprocess
  15747. */
  15748. onAfterRenderObservable: Observable<Effect>;
  15749. private _onAfterRenderObserver;
  15750. /**
  15751. * A function that is added to the onAfterRenderObservable
  15752. */
  15753. onAfterRender: (efect: Effect) => void;
  15754. /**
  15755. * The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will
  15756. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  15757. */
  15758. inputTexture: InternalTexture;
  15759. /**
  15760. * Gets the camera which post process is applied to.
  15761. * @returns The camera the post process is applied to.
  15762. */
  15763. getCamera(): Camera;
  15764. /**
  15765. * Gets the texel size of the postprocess.
  15766. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  15767. */
  15768. readonly texelSize: Vector2;
  15769. /**
  15770. * Creates a new instance PostProcess
  15771. * @param name The name of the PostProcess.
  15772. * @param fragmentUrl The url of the fragment shader to be used.
  15773. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  15774. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  15775. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15776. * @param camera The camera to apply the render pass to.
  15777. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15778. * @param engine The engine which the post process will be applied. (default: current engine)
  15779. * @param reusable If the post process can be reused on the same frame. (default: false)
  15780. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  15781. * @param textureType Type of textures used when performing the post process. (default: 0)
  15782. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  15783. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  15784. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  15785. */
  15786. constructor(
  15787. /** Name of the PostProcess. */
  15788. name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean);
  15789. /**
  15790. * Gets a string idenfifying the name of the class
  15791. * @returns "PostProcess" string
  15792. */
  15793. getClassName(): string;
  15794. /**
  15795. * Gets the engine which this post process belongs to.
  15796. * @returns The engine the post process was enabled with.
  15797. */
  15798. getEngine(): Engine;
  15799. /**
  15800. * The effect that is created when initializing the post process.
  15801. * @returns The created effect corresponding the the postprocess.
  15802. */
  15803. getEffect(): Effect;
  15804. /**
  15805. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  15806. * @param postProcess The post process to share the output with.
  15807. * @returns This post process.
  15808. */
  15809. shareOutputWith(postProcess: PostProcess): PostProcess;
  15810. /**
  15811. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  15812. * This should be called if the post process that shares output with this post process is disabled/disposed.
  15813. */
  15814. useOwnOutput(): void;
  15815. /**
  15816. * Updates the effect with the current post process compile time values and recompiles the shader.
  15817. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15818. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15819. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15820. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  15821. * @param onCompiled Called when the shader has been compiled.
  15822. * @param onError Called if there is an error when compiling a shader.
  15823. */
  15824. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15825. /**
  15826. * The post process is reusable if it can be used multiple times within one frame.
  15827. * @returns If the post process is reusable
  15828. */
  15829. isReusable(): boolean;
  15830. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  15831. markTextureDirty(): void;
  15832. /**
  15833. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  15834. * When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.
  15835. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  15836. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  15837. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  15838. * @returns The target texture that was bound to be written to.
  15839. */
  15840. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  15841. /**
  15842. * If the post process is supported.
  15843. */
  15844. readonly isSupported: boolean;
  15845. /**
  15846. * The aspect ratio of the output texture.
  15847. */
  15848. readonly aspectRatio: number;
  15849. /**
  15850. * Get a value indicating if the post-process is ready to be used
  15851. * @returns true if the post-process is ready (shader is compiled)
  15852. */
  15853. isReady(): boolean;
  15854. /**
  15855. * Binds all textures and uniforms to the shader, this will be run on every pass.
  15856. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  15857. */
  15858. apply(): Nullable<Effect>;
  15859. private _disposeTextures;
  15860. /**
  15861. * Disposes the post process.
  15862. * @param camera The camera to dispose the post process on.
  15863. */
  15864. dispose(camera?: Camera): void;
  15865. }
  15866. }
  15867. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  15868. /** @hidden */
  15869. export var kernelBlurVaryingDeclaration: {
  15870. name: string;
  15871. shader: string;
  15872. };
  15873. }
  15874. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  15875. /** @hidden */
  15876. export var kernelBlurFragment: {
  15877. name: string;
  15878. shader: string;
  15879. };
  15880. }
  15881. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  15882. /** @hidden */
  15883. export var kernelBlurFragment2: {
  15884. name: string;
  15885. shader: string;
  15886. };
  15887. }
  15888. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  15889. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15890. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  15891. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  15892. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  15893. /** @hidden */
  15894. export var kernelBlurPixelShader: {
  15895. name: string;
  15896. shader: string;
  15897. };
  15898. }
  15899. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  15900. /** @hidden */
  15901. export var kernelBlurVertex: {
  15902. name: string;
  15903. shader: string;
  15904. };
  15905. }
  15906. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  15907. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15908. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  15909. /** @hidden */
  15910. export var kernelBlurVertexShader: {
  15911. name: string;
  15912. shader: string;
  15913. };
  15914. }
  15915. declare module "babylonjs/PostProcesses/blurPostProcess" {
  15916. import { Vector2 } from "babylonjs/Maths/math.vector";
  15917. import { Nullable } from "babylonjs/types";
  15918. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  15919. import { Camera } from "babylonjs/Cameras/camera";
  15920. import { Effect } from "babylonjs/Materials/effect";
  15921. import { Engine } from "babylonjs/Engines/engine";
  15922. import "babylonjs/Shaders/kernelBlur.fragment";
  15923. import "babylonjs/Shaders/kernelBlur.vertex";
  15924. /**
  15925. * The Blur Post Process which blurs an image based on a kernel and direction.
  15926. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  15927. */
  15928. export class BlurPostProcess extends PostProcess {
  15929. /** The direction in which to blur the image. */
  15930. direction: Vector2;
  15931. private blockCompilation;
  15932. protected _kernel: number;
  15933. protected _idealKernel: number;
  15934. protected _packedFloat: boolean;
  15935. private _staticDefines;
  15936. /**
  15937. * Sets the length in pixels of the blur sample region
  15938. */
  15939. /**
  15940. * Gets the length in pixels of the blur sample region
  15941. */
  15942. kernel: number;
  15943. /**
  15944. * Sets wether or not the blur needs to unpack/repack floats
  15945. */
  15946. /**
  15947. * Gets wether or not the blur is unpacking/repacking floats
  15948. */
  15949. packedFloat: boolean;
  15950. /**
  15951. * Creates a new instance BlurPostProcess
  15952. * @param name The name of the effect.
  15953. * @param direction The direction in which to blur the image.
  15954. * @param kernel The size of the kernel to be used when computing the blur. eg. Size of 3 will blur the center pixel by 2 pixels surrounding it.
  15955. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15956. * @param camera The camera to apply the render pass to.
  15957. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15958. * @param engine The engine which the post process will be applied. (default: current engine)
  15959. * @param reusable If the post process can be reused on the same frame. (default: false)
  15960. * @param textureType Type of textures used when performing the post process. (default: 0)
  15961. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  15962. */
  15963. constructor(name: string,
  15964. /** The direction in which to blur the image. */
  15965. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  15966. /**
  15967. * Updates the effect with the current post process compile time values and recompiles the shader.
  15968. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15969. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15970. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15971. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  15972. * @param onCompiled Called when the shader has been compiled.
  15973. * @param onError Called if there is an error when compiling a shader.
  15974. */
  15975. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15976. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15977. /**
  15978. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  15979. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  15980. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  15981. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  15982. * The gaps between physical kernels are compensated for in the weighting of the samples
  15983. * @param idealKernel Ideal blur kernel.
  15984. * @return Nearest best kernel.
  15985. */
  15986. protected _nearestBestKernel(idealKernel: number): number;
  15987. /**
  15988. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  15989. * @param x The point on the Gaussian distribution to sample.
  15990. * @return the value of the Gaussian function at x.
  15991. */
  15992. protected _gaussianWeight(x: number): number;
  15993. /**
  15994. * Generates a string that can be used as a floating point number in GLSL.
  15995. * @param x Value to print.
  15996. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  15997. * @return GLSL float string.
  15998. */
  15999. protected _glslFloat(x: number, decimalFigures?: number): string;
  16000. }
  16001. }
  16002. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  16003. import { Scene } from "babylonjs/scene";
  16004. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  16005. import { Plane } from "babylonjs/Maths/math.plane";
  16006. /**
  16007. * Mirror texture can be used to simulate the view from a mirror in a scene.
  16008. * It will dynamically be rendered every frame to adapt to the camera point of view.
  16009. * You can then easily use it as a reflectionTexture on a flat surface.
  16010. * In case the surface is not a plane, please consider relying on reflection probes.
  16011. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16012. */
  16013. export class MirrorTexture extends RenderTargetTexture {
  16014. private scene;
  16015. /**
  16016. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  16017. * It is possible to directly set the mirrorPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the mirrorPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the reflector as stated in the doc.
  16018. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16019. */
  16020. mirrorPlane: Plane;
  16021. /**
  16022. * Define the blur ratio used to blur the reflection if needed.
  16023. */
  16024. blurRatio: number;
  16025. /**
  16026. * Define the adaptive blur kernel used to blur the reflection if needed.
  16027. * This will autocompute the closest best match for the `blurKernel`
  16028. */
  16029. adaptiveBlurKernel: number;
  16030. /**
  16031. * Define the blur kernel used to blur the reflection if needed.
  16032. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16033. */
  16034. blurKernel: number;
  16035. /**
  16036. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  16037. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16038. */
  16039. blurKernelX: number;
  16040. /**
  16041. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  16042. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16043. */
  16044. blurKernelY: number;
  16045. private _autoComputeBlurKernel;
  16046. protected _onRatioRescale(): void;
  16047. private _updateGammaSpace;
  16048. private _imageProcessingConfigChangeObserver;
  16049. private _transformMatrix;
  16050. private _mirrorMatrix;
  16051. private _savedViewMatrix;
  16052. private _blurX;
  16053. private _blurY;
  16054. private _adaptiveBlurKernel;
  16055. private _blurKernelX;
  16056. private _blurKernelY;
  16057. private _blurRatio;
  16058. /**
  16059. * Instantiates a Mirror Texture.
  16060. * Mirror texture can be used to simulate the view from a mirror in a scene.
  16061. * It will dynamically be rendered every frame to adapt to the camera point of view.
  16062. * You can then easily use it as a reflectionTexture on a flat surface.
  16063. * In case the surface is not a plane, please consider relying on reflection probes.
  16064. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16065. * @param name
  16066. * @param size
  16067. * @param scene
  16068. * @param generateMipMaps
  16069. * @param type
  16070. * @param samplingMode
  16071. * @param generateDepthBuffer
  16072. */
  16073. constructor(name: string, size: number | {
  16074. width: number;
  16075. height: number;
  16076. } | {
  16077. ratio: number;
  16078. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  16079. private _preparePostProcesses;
  16080. /**
  16081. * Clone the mirror texture.
  16082. * @returns the cloned texture
  16083. */
  16084. clone(): MirrorTexture;
  16085. /**
  16086. * Serialize the texture to a JSON representation you could use in Parse later on
  16087. * @returns the serialized JSON representation
  16088. */
  16089. serialize(): any;
  16090. /**
  16091. * Dispose the texture and release its associated resources.
  16092. */
  16093. dispose(): void;
  16094. }
  16095. }
  16096. declare module "babylonjs/Materials/Textures/texture" {
  16097. import { Observable } from "babylonjs/Misc/observable";
  16098. import { Nullable } from "babylonjs/types";
  16099. import { Matrix } from "babylonjs/Maths/math.vector";
  16100. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16101. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16102. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  16103. import { Scene } from "babylonjs/scene";
  16104. /**
  16105. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16106. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16107. */
  16108. export class Texture extends BaseTexture {
  16109. /**
  16110. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  16111. */
  16112. static SerializeBuffers: boolean;
  16113. /** @hidden */
  16114. static _CubeTextureParser: (jsonTexture: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => import("babylonjs/Materials/Textures/cubeTexture").CubeTexture;
  16115. /** @hidden */
  16116. static _CreateMirror: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/mirrorTexture").MirrorTexture;
  16117. /** @hidden */
  16118. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture;
  16119. /** nearest is mag = nearest and min = nearest and mip = linear */
  16120. static readonly NEAREST_SAMPLINGMODE: number;
  16121. /** nearest is mag = nearest and min = nearest and mip = linear */
  16122. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  16123. /** Bilinear is mag = linear and min = linear and mip = nearest */
  16124. static readonly BILINEAR_SAMPLINGMODE: number;
  16125. /** Bilinear is mag = linear and min = linear and mip = nearest */
  16126. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  16127. /** Trilinear is mag = linear and min = linear and mip = linear */
  16128. static readonly TRILINEAR_SAMPLINGMODE: number;
  16129. /** Trilinear is mag = linear and min = linear and mip = linear */
  16130. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  16131. /** mag = nearest and min = nearest and mip = nearest */
  16132. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  16133. /** mag = nearest and min = linear and mip = nearest */
  16134. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  16135. /** mag = nearest and min = linear and mip = linear */
  16136. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  16137. /** mag = nearest and min = linear and mip = none */
  16138. static readonly NEAREST_LINEAR: number;
  16139. /** mag = nearest and min = nearest and mip = none */
  16140. static readonly NEAREST_NEAREST: number;
  16141. /** mag = linear and min = nearest and mip = nearest */
  16142. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  16143. /** mag = linear and min = nearest and mip = linear */
  16144. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  16145. /** mag = linear and min = linear and mip = none */
  16146. static readonly LINEAR_LINEAR: number;
  16147. /** mag = linear and min = nearest and mip = none */
  16148. static readonly LINEAR_NEAREST: number;
  16149. /** Explicit coordinates mode */
  16150. static readonly EXPLICIT_MODE: number;
  16151. /** Spherical coordinates mode */
  16152. static readonly SPHERICAL_MODE: number;
  16153. /** Planar coordinates mode */
  16154. static readonly PLANAR_MODE: number;
  16155. /** Cubic coordinates mode */
  16156. static readonly CUBIC_MODE: number;
  16157. /** Projection coordinates mode */
  16158. static readonly PROJECTION_MODE: number;
  16159. /** Inverse Cubic coordinates mode */
  16160. static readonly SKYBOX_MODE: number;
  16161. /** Inverse Cubic coordinates mode */
  16162. static readonly INVCUBIC_MODE: number;
  16163. /** Equirectangular coordinates mode */
  16164. static readonly EQUIRECTANGULAR_MODE: number;
  16165. /** Equirectangular Fixed coordinates mode */
  16166. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  16167. /** Equirectangular Fixed Mirrored coordinates mode */
  16168. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  16169. /** Texture is not repeating outside of 0..1 UVs */
  16170. static readonly CLAMP_ADDRESSMODE: number;
  16171. /** Texture is repeating outside of 0..1 UVs */
  16172. static readonly WRAP_ADDRESSMODE: number;
  16173. /** Texture is repeating and mirrored */
  16174. static readonly MIRROR_ADDRESSMODE: number;
  16175. /**
  16176. * Gets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file
  16177. */
  16178. static UseSerializedUrlIfAny: boolean;
  16179. /**
  16180. * Define the url of the texture.
  16181. */
  16182. url: Nullable<string>;
  16183. /**
  16184. * Define an offset on the texture to offset the u coordinates of the UVs
  16185. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16186. */
  16187. uOffset: number;
  16188. /**
  16189. * Define an offset on the texture to offset the v coordinates of the UVs
  16190. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16191. */
  16192. vOffset: number;
  16193. /**
  16194. * Define an offset on the texture to scale the u coordinates of the UVs
  16195. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16196. */
  16197. uScale: number;
  16198. /**
  16199. * Define an offset on the texture to scale the v coordinates of the UVs
  16200. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16201. */
  16202. vScale: number;
  16203. /**
  16204. * Define an offset on the texture to rotate around the u coordinates of the UVs
  16205. * @see http://doc.babylonjs.com/how_to/more_materials
  16206. */
  16207. uAng: number;
  16208. /**
  16209. * Define an offset on the texture to rotate around the v coordinates of the UVs
  16210. * @see http://doc.babylonjs.com/how_to/more_materials
  16211. */
  16212. vAng: number;
  16213. /**
  16214. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  16215. * @see http://doc.babylonjs.com/how_to/more_materials
  16216. */
  16217. wAng: number;
  16218. /**
  16219. * Defines the center of rotation (U)
  16220. */
  16221. uRotationCenter: number;
  16222. /**
  16223. * Defines the center of rotation (V)
  16224. */
  16225. vRotationCenter: number;
  16226. /**
  16227. * Defines the center of rotation (W)
  16228. */
  16229. wRotationCenter: number;
  16230. /**
  16231. * Are mip maps generated for this texture or not.
  16232. */
  16233. readonly noMipmap: boolean;
  16234. /**
  16235. * List of inspectable custom properties (used by the Inspector)
  16236. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16237. */
  16238. inspectableCustomProperties: Nullable<IInspectable[]>;
  16239. private _noMipmap;
  16240. /** @hidden */
  16241. _invertY: boolean;
  16242. private _rowGenerationMatrix;
  16243. private _cachedTextureMatrix;
  16244. private _projectionModeMatrix;
  16245. private _t0;
  16246. private _t1;
  16247. private _t2;
  16248. private _cachedUOffset;
  16249. private _cachedVOffset;
  16250. private _cachedUScale;
  16251. private _cachedVScale;
  16252. private _cachedUAng;
  16253. private _cachedVAng;
  16254. private _cachedWAng;
  16255. private _cachedProjectionMatrixId;
  16256. private _cachedCoordinatesMode;
  16257. /** @hidden */
  16258. protected _initialSamplingMode: number;
  16259. /** @hidden */
  16260. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  16261. private _deleteBuffer;
  16262. protected _format: Nullable<number>;
  16263. private _delayedOnLoad;
  16264. private _delayedOnError;
  16265. private _mimeType?;
  16266. /**
  16267. * Observable triggered once the texture has been loaded.
  16268. */
  16269. onLoadObservable: Observable<Texture>;
  16270. protected _isBlocking: boolean;
  16271. /**
  16272. * Is the texture preventing material to render while loading.
  16273. * If false, a default texture will be used instead of the loading one during the preparation step.
  16274. */
  16275. isBlocking: boolean;
  16276. /**
  16277. * Get the current sampling mode associated with the texture.
  16278. */
  16279. readonly samplingMode: number;
  16280. /**
  16281. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  16282. */
  16283. readonly invertY: boolean;
  16284. /**
  16285. * Instantiates a new texture.
  16286. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16287. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16288. * @param url defines the url of the picture to load as a texture
  16289. * @param scene defines the scene or engine the texture will belong to
  16290. * @param noMipmap defines if the texture will require mip maps or not
  16291. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  16292. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16293. * @param onLoad defines a callback triggered when the texture has been loaded
  16294. * @param onError defines a callback triggered when an error occurred during the loading session
  16295. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  16296. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  16297. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16298. * @param mimeType defines an optional mime type information
  16299. */
  16300. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string);
  16301. /**
  16302. * Update the url (and optional buffer) of this texture if url was null during construction.
  16303. * @param url the url of the texture
  16304. * @param buffer the buffer of the texture (defaults to null)
  16305. * @param onLoad callback called when the texture is loaded (defaults to null)
  16306. */
  16307. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  16308. /**
  16309. * Finish the loading sequence of a texture flagged as delayed load.
  16310. * @hidden
  16311. */
  16312. delayLoad(): void;
  16313. private _prepareRowForTextureGeneration;
  16314. /**
  16315. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  16316. * @returns the transform matrix of the texture.
  16317. */
  16318. getTextureMatrix(): Matrix;
  16319. /**
  16320. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  16321. * @returns The reflection texture transform
  16322. */
  16323. getReflectionTextureMatrix(): Matrix;
  16324. /**
  16325. * Clones the texture.
  16326. * @returns the cloned texture
  16327. */
  16328. clone(): Texture;
  16329. /**
  16330. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  16331. * @returns The JSON representation of the texture
  16332. */
  16333. serialize(): any;
  16334. /**
  16335. * Get the current class name of the texture useful for serialization or dynamic coding.
  16336. * @returns "Texture"
  16337. */
  16338. getClassName(): string;
  16339. /**
  16340. * Dispose the texture and release its associated resources.
  16341. */
  16342. dispose(): void;
  16343. /**
  16344. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  16345. * @param parsedTexture Define the JSON representation of the texture
  16346. * @param scene Define the scene the parsed texture should be instantiated in
  16347. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  16348. * @returns The parsed texture if successful
  16349. */
  16350. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  16351. /**
  16352. * Creates a texture from its base 64 representation.
  16353. * @param data Define the base64 payload without the data: prefix
  16354. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16355. * @param scene Define the scene the texture should belong to
  16356. * @param noMipmap Forces the texture to not create mip map information if true
  16357. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16358. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16359. * @param onLoad define a callback triggered when the texture has been loaded
  16360. * @param onError define a callback triggered when an error occurred during the loading session
  16361. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16362. * @returns the created texture
  16363. */
  16364. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  16365. /**
  16366. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  16367. * @param data Define the base64 payload without the data: prefix
  16368. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16369. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  16370. * @param scene Define the scene the texture should belong to
  16371. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  16372. * @param noMipmap Forces the texture to not create mip map information if true
  16373. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16374. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16375. * @param onLoad define a callback triggered when the texture has been loaded
  16376. * @param onError define a callback triggered when an error occurred during the loading session
  16377. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16378. * @returns the created texture
  16379. */
  16380. static LoadFromDataString(name: string, buffer: any, scene: Scene, deleteBuffer?: boolean, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number): Texture;
  16381. }
  16382. }
  16383. declare module "babylonjs/PostProcesses/postProcessManager" {
  16384. import { Nullable } from "babylonjs/types";
  16385. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16386. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  16387. import { Scene } from "babylonjs/scene";
  16388. /**
  16389. * PostProcessManager is used to manage one or more post processes or post process pipelines
  16390. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  16391. */
  16392. export class PostProcessManager {
  16393. private _scene;
  16394. private _indexBuffer;
  16395. private _vertexBuffers;
  16396. /**
  16397. * Creates a new instance PostProcess
  16398. * @param scene The scene that the post process is associated with.
  16399. */
  16400. constructor(scene: Scene);
  16401. private _prepareBuffers;
  16402. private _buildIndexBuffer;
  16403. /**
  16404. * Rebuilds the vertex buffers of the manager.
  16405. * @hidden
  16406. */
  16407. _rebuild(): void;
  16408. /**
  16409. * Prepares a frame to be run through a post process.
  16410. * @param sourceTexture The input texture to the post procesess. (default: null)
  16411. * @param postProcesses An array of post processes to be run. (default: null)
  16412. * @returns True if the post processes were able to be run.
  16413. * @hidden
  16414. */
  16415. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  16416. /**
  16417. * Manually render a set of post processes to a texture.
  16418. * @param postProcesses An array of post processes to be run.
  16419. * @param targetTexture The target texture to render to.
  16420. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  16421. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  16422. * @param lodLevel defines which lod of the texture to render to
  16423. */
  16424. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  16425. /**
  16426. * Finalize the result of the output of the postprocesses.
  16427. * @param doNotPresent If true the result will not be displayed to the screen.
  16428. * @param targetTexture The target texture to render to.
  16429. * @param faceIndex The index of the face to bind the target texture to.
  16430. * @param postProcesses The array of post processes to render.
  16431. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  16432. * @hidden
  16433. */
  16434. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  16435. /**
  16436. * Disposes of the post process manager.
  16437. */
  16438. dispose(): void;
  16439. }
  16440. }
  16441. declare module "babylonjs/Misc/gradients" {
  16442. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16443. /** Interface used by value gradients (color, factor, ...) */
  16444. export interface IValueGradient {
  16445. /**
  16446. * Gets or sets the gradient value (between 0 and 1)
  16447. */
  16448. gradient: number;
  16449. }
  16450. /** Class used to store color4 gradient */
  16451. export class ColorGradient implements IValueGradient {
  16452. /**
  16453. * Gets or sets the gradient value (between 0 and 1)
  16454. */
  16455. gradient: number;
  16456. /**
  16457. * Gets or sets first associated color
  16458. */
  16459. color1: Color4;
  16460. /**
  16461. * Gets or sets second associated color
  16462. */
  16463. color2?: Color4;
  16464. /**
  16465. * Will get a color picked randomly between color1 and color2.
  16466. * If color2 is undefined then color1 will be used
  16467. * @param result defines the target Color4 to store the result in
  16468. */
  16469. getColorToRef(result: Color4): void;
  16470. }
  16471. /** Class used to store color 3 gradient */
  16472. export class Color3Gradient implements IValueGradient {
  16473. /**
  16474. * Gets or sets the gradient value (between 0 and 1)
  16475. */
  16476. gradient: number;
  16477. /**
  16478. * Gets or sets the associated color
  16479. */
  16480. color: Color3;
  16481. }
  16482. /** Class used to store factor gradient */
  16483. export class FactorGradient implements IValueGradient {
  16484. /**
  16485. * Gets or sets the gradient value (between 0 and 1)
  16486. */
  16487. gradient: number;
  16488. /**
  16489. * Gets or sets first associated factor
  16490. */
  16491. factor1: number;
  16492. /**
  16493. * Gets or sets second associated factor
  16494. */
  16495. factor2?: number;
  16496. /**
  16497. * Will get a number picked randomly between factor1 and factor2.
  16498. * If factor2 is undefined then factor1 will be used
  16499. * @returns the picked number
  16500. */
  16501. getFactor(): number;
  16502. }
  16503. /**
  16504. * Helper used to simplify some generic gradient tasks
  16505. */
  16506. export class GradientHelper {
  16507. /**
  16508. * Gets the current gradient from an array of IValueGradient
  16509. * @param ratio defines the current ratio to get
  16510. * @param gradients defines the array of IValueGradient
  16511. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  16512. */
  16513. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  16514. }
  16515. }
  16516. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  16517. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16518. import { Nullable } from "babylonjs/types";
  16519. module "babylonjs/Engines/thinEngine" {
  16520. interface ThinEngine {
  16521. /**
  16522. * Creates a dynamic texture
  16523. * @param width defines the width of the texture
  16524. * @param height defines the height of the texture
  16525. * @param generateMipMaps defines if the engine should generate the mip levels
  16526. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  16527. * @returns the dynamic texture inside an InternalTexture
  16528. */
  16529. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  16530. /**
  16531. * Update the content of a dynamic texture
  16532. * @param texture defines the texture to update
  16533. * @param canvas defines the canvas containing the source
  16534. * @param invertY defines if data must be stored with Y axis inverted
  16535. * @param premulAlpha defines if alpha is stored as premultiplied
  16536. * @param format defines the format of the data
  16537. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  16538. */
  16539. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  16540. }
  16541. }
  16542. }
  16543. declare module "babylonjs/Misc/canvasGenerator" {
  16544. /**
  16545. * Helper class used to generate a canvas to manipulate images
  16546. */
  16547. export class CanvasGenerator {
  16548. /**
  16549. * Create a new canvas (or offscreen canvas depending on the context)
  16550. * @param width defines the expected width
  16551. * @param height defines the expected height
  16552. * @return a new canvas or offscreen canvas
  16553. */
  16554. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  16555. }
  16556. }
  16557. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  16558. import { Scene } from "babylonjs/scene";
  16559. import { Texture } from "babylonjs/Materials/Textures/texture";
  16560. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  16561. /**
  16562. * A class extending Texture allowing drawing on a texture
  16563. * @see http://doc.babylonjs.com/how_to/dynamictexture
  16564. */
  16565. export class DynamicTexture extends Texture {
  16566. private _generateMipMaps;
  16567. private _canvas;
  16568. private _context;
  16569. private _engine;
  16570. /**
  16571. * Creates a DynamicTexture
  16572. * @param name defines the name of the texture
  16573. * @param options provides 3 alternatives for width and height of texture, a canvas, object with width and height properties, number for both width and height
  16574. * @param scene defines the scene where you want the texture
  16575. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  16576. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  16577. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  16578. */
  16579. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  16580. /**
  16581. * Get the current class name of the texture useful for serialization or dynamic coding.
  16582. * @returns "DynamicTexture"
  16583. */
  16584. getClassName(): string;
  16585. /**
  16586. * Gets the current state of canRescale
  16587. */
  16588. readonly canRescale: boolean;
  16589. private _recreate;
  16590. /**
  16591. * Scales the texture
  16592. * @param ratio the scale factor to apply to both width and height
  16593. */
  16594. scale(ratio: number): void;
  16595. /**
  16596. * Resizes the texture
  16597. * @param width the new width
  16598. * @param height the new height
  16599. */
  16600. scaleTo(width: number, height: number): void;
  16601. /**
  16602. * Gets the context of the canvas used by the texture
  16603. * @returns the canvas context of the dynamic texture
  16604. */
  16605. getContext(): CanvasRenderingContext2D;
  16606. /**
  16607. * Clears the texture
  16608. */
  16609. clear(): void;
  16610. /**
  16611. * Updates the texture
  16612. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  16613. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  16614. */
  16615. update(invertY?: boolean, premulAlpha?: boolean): void;
  16616. /**
  16617. * Draws text onto the texture
  16618. * @param text defines the text to be drawn
  16619. * @param x defines the placement of the text from the left
  16620. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  16621. * @param font defines the font to be used with font-style, font-size, font-name
  16622. * @param color defines the color used for the text
  16623. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  16624. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  16625. * @param update defines whether texture is immediately update (default is true)
  16626. */
  16627. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  16628. /**
  16629. * Clones the texture
  16630. * @returns the clone of the texture.
  16631. */
  16632. clone(): DynamicTexture;
  16633. /**
  16634. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  16635. * @returns a serialized dynamic texture object
  16636. */
  16637. serialize(): any;
  16638. /** @hidden */
  16639. _rebuild(): void;
  16640. }
  16641. }
  16642. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  16643. import { Scene } from "babylonjs/scene";
  16644. import { ISceneComponent } from "babylonjs/sceneComponent";
  16645. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16646. module "babylonjs/abstractScene" {
  16647. interface AbstractScene {
  16648. /**
  16649. * The list of procedural textures added to the scene
  16650. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16651. */
  16652. proceduralTextures: Array<ProceduralTexture>;
  16653. }
  16654. }
  16655. /**
  16656. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  16657. * in a given scene.
  16658. */
  16659. export class ProceduralTextureSceneComponent implements ISceneComponent {
  16660. /**
  16661. * The component name helpfull to identify the component in the list of scene components.
  16662. */
  16663. readonly name: string;
  16664. /**
  16665. * The scene the component belongs to.
  16666. */
  16667. scene: Scene;
  16668. /**
  16669. * Creates a new instance of the component for the given scene
  16670. * @param scene Defines the scene to register the component in
  16671. */
  16672. constructor(scene: Scene);
  16673. /**
  16674. * Registers the component in a given scene
  16675. */
  16676. register(): void;
  16677. /**
  16678. * Rebuilds the elements related to this component in case of
  16679. * context lost for instance.
  16680. */
  16681. rebuild(): void;
  16682. /**
  16683. * Disposes the component and the associated ressources.
  16684. */
  16685. dispose(): void;
  16686. private _beforeClear;
  16687. }
  16688. }
  16689. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  16690. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16691. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  16692. module "babylonjs/Engines/thinEngine" {
  16693. interface ThinEngine {
  16694. /**
  16695. * Creates a new render target cube texture
  16696. * @param size defines the size of the texture
  16697. * @param options defines the options used to create the texture
  16698. * @returns a new render target cube texture stored in an InternalTexture
  16699. */
  16700. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  16701. }
  16702. }
  16703. }
  16704. declare module "babylonjs/Shaders/procedural.vertex" {
  16705. /** @hidden */
  16706. export var proceduralVertexShader: {
  16707. name: string;
  16708. shader: string;
  16709. };
  16710. }
  16711. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  16712. import { Observable } from "babylonjs/Misc/observable";
  16713. import { Nullable } from "babylonjs/types";
  16714. import { Scene } from "babylonjs/scene";
  16715. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  16716. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  16717. import { Effect } from "babylonjs/Materials/effect";
  16718. import { Texture } from "babylonjs/Materials/Textures/texture";
  16719. import "babylonjs/Engines/Extensions/engine.renderTarget";
  16720. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  16721. import "babylonjs/Shaders/procedural.vertex";
  16722. /**
  16723. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes calmpler' images.
  16724. * This is the base class of any Procedural texture and contains most of the shareable code.
  16725. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16726. */
  16727. export class ProceduralTexture extends Texture {
  16728. isCube: boolean;
  16729. /**
  16730. * Define if the texture is enabled or not (disabled texture will not render)
  16731. */
  16732. isEnabled: boolean;
  16733. /**
  16734. * Define if the texture must be cleared before rendering (default is true)
  16735. */
  16736. autoClear: boolean;
  16737. /**
  16738. * Callback called when the texture is generated
  16739. */
  16740. onGenerated: () => void;
  16741. /**
  16742. * Event raised when the texture is generated
  16743. */
  16744. onGeneratedObservable: Observable<ProceduralTexture>;
  16745. /** @hidden */
  16746. _generateMipMaps: boolean;
  16747. /** @hidden **/
  16748. _effect: Effect;
  16749. /** @hidden */
  16750. _textures: {
  16751. [key: string]: Texture;
  16752. };
  16753. private _size;
  16754. private _currentRefreshId;
  16755. private _refreshRate;
  16756. private _vertexBuffers;
  16757. private _indexBuffer;
  16758. private _uniforms;
  16759. private _samplers;
  16760. private _fragment;
  16761. private _floats;
  16762. private _ints;
  16763. private _floatsArrays;
  16764. private _colors3;
  16765. private _colors4;
  16766. private _vectors2;
  16767. private _vectors3;
  16768. private _matrices;
  16769. private _fallbackTexture;
  16770. private _fallbackTextureUsed;
  16771. private _engine;
  16772. private _cachedDefines;
  16773. private _contentUpdateId;
  16774. private _contentData;
  16775. /**
  16776. * Instantiates a new procedural texture.
  16777. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  16778. * This is the base class of any Procedural texture and contains most of the shareable code.
  16779. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16780. * @param name Define the name of the texture
  16781. * @param size Define the size of the texture to create
  16782. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  16783. * @param scene Define the scene the texture belongs to
  16784. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  16785. * @param generateMipMaps Define if the texture should creates mip maps or not
  16786. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  16787. */
  16788. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  16789. /**
  16790. * The effect that is created when initializing the post process.
  16791. * @returns The created effect corresponding the the postprocess.
  16792. */
  16793. getEffect(): Effect;
  16794. /**
  16795. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  16796. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  16797. */
  16798. getContent(): Nullable<ArrayBufferView>;
  16799. private _createIndexBuffer;
  16800. /** @hidden */
  16801. _rebuild(): void;
  16802. /**
  16803. * Resets the texture in order to recreate its associated resources.
  16804. * This can be called in case of context loss
  16805. */
  16806. reset(): void;
  16807. protected _getDefines(): string;
  16808. /**
  16809. * Is the texture ready to be used ? (rendered at least once)
  16810. * @returns true if ready, otherwise, false.
  16811. */
  16812. isReady(): boolean;
  16813. /**
  16814. * Resets the refresh counter of the texture and start bak from scratch.
  16815. * Could be useful to regenerate the texture if it is setup to render only once.
  16816. */
  16817. resetRefreshCounter(): void;
  16818. /**
  16819. * Set the fragment shader to use in order to render the texture.
  16820. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  16821. */
  16822. setFragment(fragment: any): void;
  16823. /**
  16824. * Define the refresh rate of the texture or the rendering frequency.
  16825. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  16826. */
  16827. refreshRate: number;
  16828. /** @hidden */
  16829. _shouldRender(): boolean;
  16830. /**
  16831. * Get the size the texture is rendering at.
  16832. * @returns the size (texture is always squared)
  16833. */
  16834. getRenderSize(): number;
  16835. /**
  16836. * Resize the texture to new value.
  16837. * @param size Define the new size the texture should have
  16838. * @param generateMipMaps Define whether the new texture should create mip maps
  16839. */
  16840. resize(size: number, generateMipMaps: boolean): void;
  16841. private _checkUniform;
  16842. /**
  16843. * Set a texture in the shader program used to render.
  16844. * @param name Define the name of the uniform samplers as defined in the shader
  16845. * @param texture Define the texture to bind to this sampler
  16846. * @return the texture itself allowing "fluent" like uniform updates
  16847. */
  16848. setTexture(name: string, texture: Texture): ProceduralTexture;
  16849. /**
  16850. * Set a float in the shader.
  16851. * @param name Define the name of the uniform as defined in the shader
  16852. * @param value Define the value to give to the uniform
  16853. * @return the texture itself allowing "fluent" like uniform updates
  16854. */
  16855. setFloat(name: string, value: number): ProceduralTexture;
  16856. /**
  16857. * Set a int in the shader.
  16858. * @param name Define the name of the uniform as defined in the shader
  16859. * @param value Define the value to give to the uniform
  16860. * @return the texture itself allowing "fluent" like uniform updates
  16861. */
  16862. setInt(name: string, value: number): ProceduralTexture;
  16863. /**
  16864. * Set an array of floats in the shader.
  16865. * @param name Define the name of the uniform as defined in the shader
  16866. * @param value Define the value to give to the uniform
  16867. * @return the texture itself allowing "fluent" like uniform updates
  16868. */
  16869. setFloats(name: string, value: number[]): ProceduralTexture;
  16870. /**
  16871. * Set a vec3 in the shader from a Color3.
  16872. * @param name Define the name of the uniform as defined in the shader
  16873. * @param value Define the value to give to the uniform
  16874. * @return the texture itself allowing "fluent" like uniform updates
  16875. */
  16876. setColor3(name: string, value: Color3): ProceduralTexture;
  16877. /**
  16878. * Set a vec4 in the shader from a Color4.
  16879. * @param name Define the name of the uniform as defined in the shader
  16880. * @param value Define the value to give to the uniform
  16881. * @return the texture itself allowing "fluent" like uniform updates
  16882. */
  16883. setColor4(name: string, value: Color4): ProceduralTexture;
  16884. /**
  16885. * Set a vec2 in the shader from a Vector2.
  16886. * @param name Define the name of the uniform as defined in the shader
  16887. * @param value Define the value to give to the uniform
  16888. * @return the texture itself allowing "fluent" like uniform updates
  16889. */
  16890. setVector2(name: string, value: Vector2): ProceduralTexture;
  16891. /**
  16892. * Set a vec3 in the shader from a Vector3.
  16893. * @param name Define the name of the uniform as defined in the shader
  16894. * @param value Define the value to give to the uniform
  16895. * @return the texture itself allowing "fluent" like uniform updates
  16896. */
  16897. setVector3(name: string, value: Vector3): ProceduralTexture;
  16898. /**
  16899. * Set a mat4 in the shader from a MAtrix.
  16900. * @param name Define the name of the uniform as defined in the shader
  16901. * @param value Define the value to give to the uniform
  16902. * @return the texture itself allowing "fluent" like uniform updates
  16903. */
  16904. setMatrix(name: string, value: Matrix): ProceduralTexture;
  16905. /**
  16906. * Render the texture to its associated render target.
  16907. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  16908. */
  16909. render(useCameraPostProcess?: boolean): void;
  16910. /**
  16911. * Clone the texture.
  16912. * @returns the cloned texture
  16913. */
  16914. clone(): ProceduralTexture;
  16915. /**
  16916. * Dispose the texture and release its asoociated resources.
  16917. */
  16918. dispose(): void;
  16919. }
  16920. }
  16921. declare module "babylonjs/Particles/baseParticleSystem" {
  16922. import { Nullable } from "babylonjs/types";
  16923. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  16924. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16925. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  16926. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16927. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16928. import { Scene } from "babylonjs/scene";
  16929. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  16930. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  16931. import { Texture } from "babylonjs/Materials/Textures/texture";
  16932. import { Color4 } from "babylonjs/Maths/math.color";
  16933. import { Animation } from "babylonjs/Animations/animation";
  16934. /**
  16935. * This represents the base class for particle system in Babylon.
  16936. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  16937. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  16938. * @example https://doc.babylonjs.com/babylon101/particles
  16939. */
  16940. export class BaseParticleSystem {
  16941. /**
  16942. * Source color is added to the destination color without alpha affecting the result
  16943. */
  16944. static BLENDMODE_ONEONE: number;
  16945. /**
  16946. * Blend current color and particle color using particle’s alpha
  16947. */
  16948. static BLENDMODE_STANDARD: number;
  16949. /**
  16950. * Add current color and particle color multiplied by particle’s alpha
  16951. */
  16952. static BLENDMODE_ADD: number;
  16953. /**
  16954. * Multiply current color with particle color
  16955. */
  16956. static BLENDMODE_MULTIPLY: number;
  16957. /**
  16958. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  16959. */
  16960. static BLENDMODE_MULTIPLYADD: number;
  16961. /**
  16962. * List of animations used by the particle system.
  16963. */
  16964. animations: Animation[];
  16965. /**
  16966. * The id of the Particle system.
  16967. */
  16968. id: string;
  16969. /**
  16970. * The friendly name of the Particle system.
  16971. */
  16972. name: string;
  16973. /**
  16974. * The rendering group used by the Particle system to chose when to render.
  16975. */
  16976. renderingGroupId: number;
  16977. /**
  16978. * The emitter represents the Mesh or position we are attaching the particle system to.
  16979. */
  16980. emitter: Nullable<AbstractMesh | Vector3>;
  16981. /**
  16982. * The maximum number of particles to emit per frame
  16983. */
  16984. emitRate: number;
  16985. /**
  16986. * If you want to launch only a few particles at once, that can be done, as well.
  16987. */
  16988. manualEmitCount: number;
  16989. /**
  16990. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  16991. */
  16992. updateSpeed: number;
  16993. /**
  16994. * The amount of time the particle system is running (depends of the overall update speed).
  16995. */
  16996. targetStopDuration: number;
  16997. /**
  16998. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  16999. */
  17000. disposeOnStop: boolean;
  17001. /**
  17002. * Minimum power of emitting particles.
  17003. */
  17004. minEmitPower: number;
  17005. /**
  17006. * Maximum power of emitting particles.
  17007. */
  17008. maxEmitPower: number;
  17009. /**
  17010. * Minimum life time of emitting particles.
  17011. */
  17012. minLifeTime: number;
  17013. /**
  17014. * Maximum life time of emitting particles.
  17015. */
  17016. maxLifeTime: number;
  17017. /**
  17018. * Minimum Size of emitting particles.
  17019. */
  17020. minSize: number;
  17021. /**
  17022. * Maximum Size of emitting particles.
  17023. */
  17024. maxSize: number;
  17025. /**
  17026. * Minimum scale of emitting particles on X axis.
  17027. */
  17028. minScaleX: number;
  17029. /**
  17030. * Maximum scale of emitting particles on X axis.
  17031. */
  17032. maxScaleX: number;
  17033. /**
  17034. * Minimum scale of emitting particles on Y axis.
  17035. */
  17036. minScaleY: number;
  17037. /**
  17038. * Maximum scale of emitting particles on Y axis.
  17039. */
  17040. maxScaleY: number;
  17041. /**
  17042. * Gets or sets the minimal initial rotation in radians.
  17043. */
  17044. minInitialRotation: number;
  17045. /**
  17046. * Gets or sets the maximal initial rotation in radians.
  17047. */
  17048. maxInitialRotation: number;
  17049. /**
  17050. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  17051. */
  17052. minAngularSpeed: number;
  17053. /**
  17054. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  17055. */
  17056. maxAngularSpeed: number;
  17057. /**
  17058. * The texture used to render each particle. (this can be a spritesheet)
  17059. */
  17060. particleTexture: Nullable<Texture>;
  17061. /**
  17062. * The layer mask we are rendering the particles through.
  17063. */
  17064. layerMask: number;
  17065. /**
  17066. * This can help using your own shader to render the particle system.
  17067. * The according effect will be created
  17068. */
  17069. customShader: any;
  17070. /**
  17071. * By default particle system starts as soon as they are created. This prevents the
  17072. * automatic start to happen and let you decide when to start emitting particles.
  17073. */
  17074. preventAutoStart: boolean;
  17075. private _noiseTexture;
  17076. /**
  17077. * Gets or sets a texture used to add random noise to particle positions
  17078. */
  17079. noiseTexture: Nullable<ProceduralTexture>;
  17080. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  17081. noiseStrength: Vector3;
  17082. /**
  17083. * Callback triggered when the particle animation is ending.
  17084. */
  17085. onAnimationEnd: Nullable<() => void>;
  17086. /**
  17087. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  17088. */
  17089. blendMode: number;
  17090. /**
  17091. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  17092. * to override the particles.
  17093. */
  17094. forceDepthWrite: boolean;
  17095. /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
  17096. preWarmCycles: number;
  17097. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  17098. preWarmStepOffset: number;
  17099. /**
  17100. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  17101. */
  17102. spriteCellChangeSpeed: number;
  17103. /**
  17104. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  17105. */
  17106. startSpriteCellID: number;
  17107. /**
  17108. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  17109. */
  17110. endSpriteCellID: number;
  17111. /**
  17112. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  17113. */
  17114. spriteCellWidth: number;
  17115. /**
  17116. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  17117. */
  17118. spriteCellHeight: number;
  17119. /**
  17120. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  17121. */
  17122. spriteRandomStartCell: boolean;
  17123. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  17124. translationPivot: Vector2;
  17125. /** @hidden */
  17126. protected _isAnimationSheetEnabled: boolean;
  17127. /**
  17128. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  17129. */
  17130. beginAnimationOnStart: boolean;
  17131. /**
  17132. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  17133. */
  17134. beginAnimationFrom: number;
  17135. /**
  17136. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  17137. */
  17138. beginAnimationTo: number;
  17139. /**
  17140. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  17141. */
  17142. beginAnimationLoop: boolean;
  17143. /**
  17144. * Gets or sets a world offset applied to all particles
  17145. */
  17146. worldOffset: Vector3;
  17147. /**
  17148. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  17149. */
  17150. isAnimationSheetEnabled: boolean;
  17151. /**
  17152. * Get hosting scene
  17153. * @returns the scene
  17154. */
  17155. getScene(): Scene;
  17156. /**
  17157. * You can use gravity if you want to give an orientation to your particles.
  17158. */
  17159. gravity: Vector3;
  17160. protected _colorGradients: Nullable<Array<ColorGradient>>;
  17161. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  17162. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  17163. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  17164. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  17165. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  17166. protected _dragGradients: Nullable<Array<FactorGradient>>;
  17167. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  17168. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  17169. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  17170. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  17171. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  17172. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  17173. /**
  17174. * Defines the delay in milliseconds before starting the system (0 by default)
  17175. */
  17176. startDelay: number;
  17177. /**
  17178. * Gets the current list of drag gradients.
  17179. * You must use addDragGradient and removeDragGradient to udpate this list
  17180. * @returns the list of drag gradients
  17181. */
  17182. getDragGradients(): Nullable<Array<FactorGradient>>;
  17183. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  17184. limitVelocityDamping: number;
  17185. /**
  17186. * Gets the current list of limit velocity gradients.
  17187. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  17188. * @returns the list of limit velocity gradients
  17189. */
  17190. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  17191. /**
  17192. * Gets the current list of color gradients.
  17193. * You must use addColorGradient and removeColorGradient to udpate this list
  17194. * @returns the list of color gradients
  17195. */
  17196. getColorGradients(): Nullable<Array<ColorGradient>>;
  17197. /**
  17198. * Gets the current list of size gradients.
  17199. * You must use addSizeGradient and removeSizeGradient to udpate this list
  17200. * @returns the list of size gradients
  17201. */
  17202. getSizeGradients(): Nullable<Array<FactorGradient>>;
  17203. /**
  17204. * Gets the current list of color remap gradients.
  17205. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  17206. * @returns the list of color remap gradients
  17207. */
  17208. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  17209. /**
  17210. * Gets the current list of alpha remap gradients.
  17211. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  17212. * @returns the list of alpha remap gradients
  17213. */
  17214. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  17215. /**
  17216. * Gets the current list of life time gradients.
  17217. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  17218. * @returns the list of life time gradients
  17219. */
  17220. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  17221. /**
  17222. * Gets the current list of angular speed gradients.
  17223. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  17224. * @returns the list of angular speed gradients
  17225. */
  17226. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  17227. /**
  17228. * Gets the current list of velocity gradients.
  17229. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  17230. * @returns the list of velocity gradients
  17231. */
  17232. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  17233. /**
  17234. * Gets the current list of start size gradients.
  17235. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  17236. * @returns the list of start size gradients
  17237. */
  17238. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  17239. /**
  17240. * Gets the current list of emit rate gradients.
  17241. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  17242. * @returns the list of emit rate gradients
  17243. */
  17244. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  17245. /**
  17246. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17247. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17248. */
  17249. direction1: Vector3;
  17250. /**
  17251. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17252. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17253. */
  17254. direction2: Vector3;
  17255. /**
  17256. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  17257. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17258. */
  17259. minEmitBox: Vector3;
  17260. /**
  17261. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  17262. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17263. */
  17264. maxEmitBox: Vector3;
  17265. /**
  17266. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  17267. */
  17268. color1: Color4;
  17269. /**
  17270. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  17271. */
  17272. color2: Color4;
  17273. /**
  17274. * Color the particle will have at the end of its lifetime
  17275. */
  17276. colorDead: Color4;
  17277. /**
  17278. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  17279. */
  17280. textureMask: Color4;
  17281. /**
  17282. * The particle emitter type defines the emitter used by the particle system.
  17283. * It can be for example box, sphere, or cone...
  17284. */
  17285. particleEmitterType: IParticleEmitterType;
  17286. /** @hidden */
  17287. _isSubEmitter: boolean;
  17288. /**
  17289. * Gets or sets the billboard mode to use when isBillboardBased = true.
  17290. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  17291. */
  17292. billboardMode: number;
  17293. protected _isBillboardBased: boolean;
  17294. /**
  17295. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  17296. */
  17297. isBillboardBased: boolean;
  17298. /**
  17299. * The scene the particle system belongs to.
  17300. */
  17301. protected _scene: Scene;
  17302. /**
  17303. * Local cache of defines for image processing.
  17304. */
  17305. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  17306. /**
  17307. * Default configuration related to image processing available in the standard Material.
  17308. */
  17309. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  17310. /**
  17311. * Gets the image processing configuration used either in this material.
  17312. */
  17313. /**
  17314. * Sets the Default image processing configuration used either in the this material.
  17315. *
  17316. * If sets to null, the scene one is in use.
  17317. */
  17318. imageProcessingConfiguration: ImageProcessingConfiguration;
  17319. /**
  17320. * Attaches a new image processing configuration to the Standard Material.
  17321. * @param configuration
  17322. */
  17323. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  17324. /** @hidden */
  17325. protected _reset(): void;
  17326. /** @hidden */
  17327. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  17328. /**
  17329. * Instantiates a particle system.
  17330. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  17331. * @param name The name of the particle system
  17332. */
  17333. constructor(name: string);
  17334. /**
  17335. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  17336. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17337. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17338. * @returns the emitter
  17339. */
  17340. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  17341. /**
  17342. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  17343. * @param radius The radius of the hemisphere to emit from
  17344. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17345. * @returns the emitter
  17346. */
  17347. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  17348. /**
  17349. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  17350. * @param radius The radius of the sphere to emit from
  17351. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17352. * @returns the emitter
  17353. */
  17354. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  17355. /**
  17356. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  17357. * @param radius The radius of the sphere to emit from
  17358. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  17359. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  17360. * @returns the emitter
  17361. */
  17362. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  17363. /**
  17364. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  17365. * @param radius The radius of the emission cylinder
  17366. * @param height The height of the emission cylinder
  17367. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  17368. * @param directionRandomizer How much to randomize the particle direction [0-1]
  17369. * @returns the emitter
  17370. */
  17371. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  17372. /**
  17373. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  17374. * @param radius The radius of the cylinder to emit from
  17375. * @param height The height of the emission cylinder
  17376. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  17377. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  17378. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  17379. * @returns the emitter
  17380. */
  17381. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  17382. /**
  17383. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  17384. * @param radius The radius of the cone to emit from
  17385. * @param angle The base angle of the cone
  17386. * @returns the emitter
  17387. */
  17388. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  17389. /**
  17390. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  17391. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17392. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17393. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17394. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17395. * @returns the emitter
  17396. */
  17397. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  17398. }
  17399. }
  17400. declare module "babylonjs/Particles/subEmitter" {
  17401. import { Scene } from "babylonjs/scene";
  17402. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17403. /**
  17404. * Type of sub emitter
  17405. */
  17406. export enum SubEmitterType {
  17407. /**
  17408. * Attached to the particle over it's lifetime
  17409. */
  17410. ATTACHED = 0,
  17411. /**
  17412. * Created when the particle dies
  17413. */
  17414. END = 1
  17415. }
  17416. /**
  17417. * Sub emitter class used to emit particles from an existing particle
  17418. */
  17419. export class SubEmitter {
  17420. /**
  17421. * the particle system to be used by the sub emitter
  17422. */
  17423. particleSystem: ParticleSystem;
  17424. /**
  17425. * Type of the submitter (Default: END)
  17426. */
  17427. type: SubEmitterType;
  17428. /**
  17429. * If the particle should inherit the direction from the particle it's attached to. (+Y will face the direction the particle is moving) (Default: false)
  17430. * Note: This only is supported when using an emitter of type Mesh
  17431. */
  17432. inheritDirection: boolean;
  17433. /**
  17434. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  17435. */
  17436. inheritedVelocityAmount: number;
  17437. /**
  17438. * Creates a sub emitter
  17439. * @param particleSystem the particle system to be used by the sub emitter
  17440. */
  17441. constructor(
  17442. /**
  17443. * the particle system to be used by the sub emitter
  17444. */
  17445. particleSystem: ParticleSystem);
  17446. /**
  17447. * Clones the sub emitter
  17448. * @returns the cloned sub emitter
  17449. */
  17450. clone(): SubEmitter;
  17451. /**
  17452. * Serialize current object to a JSON object
  17453. * @returns the serialized object
  17454. */
  17455. serialize(): any;
  17456. /** @hidden */
  17457. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  17458. /**
  17459. * Creates a new SubEmitter from a serialized JSON version
  17460. * @param serializationObject defines the JSON object to read from
  17461. * @param scene defines the hosting scene
  17462. * @param rootUrl defines the rootUrl for data loading
  17463. * @returns a new SubEmitter
  17464. */
  17465. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  17466. /** Release associated resources */
  17467. dispose(): void;
  17468. }
  17469. }
  17470. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  17471. /** @hidden */
  17472. export var clipPlaneFragmentDeclaration: {
  17473. name: string;
  17474. shader: string;
  17475. };
  17476. }
  17477. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  17478. /** @hidden */
  17479. export var imageProcessingDeclaration: {
  17480. name: string;
  17481. shader: string;
  17482. };
  17483. }
  17484. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  17485. /** @hidden */
  17486. export var imageProcessingFunctions: {
  17487. name: string;
  17488. shader: string;
  17489. };
  17490. }
  17491. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  17492. /** @hidden */
  17493. export var clipPlaneFragment: {
  17494. name: string;
  17495. shader: string;
  17496. };
  17497. }
  17498. declare module "babylonjs/Shaders/particles.fragment" {
  17499. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17500. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  17501. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  17502. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  17503. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17504. /** @hidden */
  17505. export var particlesPixelShader: {
  17506. name: string;
  17507. shader: string;
  17508. };
  17509. }
  17510. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  17511. /** @hidden */
  17512. export var clipPlaneVertexDeclaration: {
  17513. name: string;
  17514. shader: string;
  17515. };
  17516. }
  17517. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  17518. /** @hidden */
  17519. export var clipPlaneVertex: {
  17520. name: string;
  17521. shader: string;
  17522. };
  17523. }
  17524. declare module "babylonjs/Shaders/particles.vertex" {
  17525. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17526. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17527. /** @hidden */
  17528. export var particlesVertexShader: {
  17529. name: string;
  17530. shader: string;
  17531. };
  17532. }
  17533. declare module "babylonjs/Particles/particleSystem" {
  17534. import { Nullable } from "babylonjs/types";
  17535. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  17536. import { Observable } from "babylonjs/Misc/observable";
  17537. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17538. import { Effect } from "babylonjs/Materials/effect";
  17539. import { Scene, IDisposable } from "babylonjs/scene";
  17540. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17541. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  17542. import { Particle } from "babylonjs/Particles/particle";
  17543. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17544. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  17545. import "babylonjs/Shaders/particles.fragment";
  17546. import "babylonjs/Shaders/particles.vertex";
  17547. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  17548. /**
  17549. * This represents a particle system in Babylon.
  17550. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  17551. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  17552. * @example https://doc.babylonjs.com/babylon101/particles
  17553. */
  17554. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  17555. /**
  17556. * Billboard mode will only apply to Y axis
  17557. */
  17558. static readonly BILLBOARDMODE_Y: number;
  17559. /**
  17560. * Billboard mode will apply to all axes
  17561. */
  17562. static readonly BILLBOARDMODE_ALL: number;
  17563. /**
  17564. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  17565. */
  17566. static readonly BILLBOARDMODE_STRETCHED: number;
  17567. /**
  17568. * This function can be defined to provide custom update for active particles.
  17569. * This function will be called instead of regular update (age, position, color, etc.).
  17570. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  17571. */
  17572. updateFunction: (particles: Particle[]) => void;
  17573. private _emitterWorldMatrix;
  17574. /**
  17575. * This function can be defined to specify initial direction for every new particle.
  17576. * It by default use the emitterType defined function
  17577. */
  17578. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  17579. /**
  17580. * This function can be defined to specify initial position for every new particle.
  17581. * It by default use the emitterType defined function
  17582. */
  17583. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  17584. /**
  17585. * @hidden
  17586. */
  17587. _inheritedVelocityOffset: Vector3;
  17588. /**
  17589. * An event triggered when the system is disposed
  17590. */
  17591. onDisposeObservable: Observable<ParticleSystem>;
  17592. private _onDisposeObserver;
  17593. /**
  17594. * Sets a callback that will be triggered when the system is disposed
  17595. */
  17596. onDispose: () => void;
  17597. private _particles;
  17598. private _epsilon;
  17599. private _capacity;
  17600. private _stockParticles;
  17601. private _newPartsExcess;
  17602. private _vertexData;
  17603. private _vertexBuffer;
  17604. private _vertexBuffers;
  17605. private _spriteBuffer;
  17606. private _indexBuffer;
  17607. private _effect;
  17608. private _customEffect;
  17609. private _cachedDefines;
  17610. private _scaledColorStep;
  17611. private _colorDiff;
  17612. private _scaledDirection;
  17613. private _scaledGravity;
  17614. private _currentRenderId;
  17615. private _alive;
  17616. private _useInstancing;
  17617. private _started;
  17618. private _stopped;
  17619. private _actualFrame;
  17620. private _scaledUpdateSpeed;
  17621. private _vertexBufferSize;
  17622. /** @hidden */
  17623. _currentEmitRateGradient: Nullable<FactorGradient>;
  17624. /** @hidden */
  17625. _currentEmitRate1: number;
  17626. /** @hidden */
  17627. _currentEmitRate2: number;
  17628. /** @hidden */
  17629. _currentStartSizeGradient: Nullable<FactorGradient>;
  17630. /** @hidden */
  17631. _currentStartSize1: number;
  17632. /** @hidden */
  17633. _currentStartSize2: number;
  17634. private readonly _rawTextureWidth;
  17635. private _rampGradientsTexture;
  17636. private _useRampGradients;
  17637. /** Gets or sets a boolean indicating that ramp gradients must be used
  17638. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  17639. */
  17640. useRampGradients: boolean;
  17641. /**
  17642. * The Sub-emitters templates that will be used to generate the sub particle system to be associated with the system, this property is used by the root particle system only.
  17643. * When a particle is spawned, an array will be chosen at random and all the emitters in that array will be attached to the particle. (Default: [])
  17644. */
  17645. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  17646. private _subEmitters;
  17647. /**
  17648. * @hidden
  17649. * If the particle systems emitter should be disposed when the particle system is disposed
  17650. */
  17651. _disposeEmitterOnDispose: boolean;
  17652. /**
  17653. * The current active Sub-systems, this property is used by the root particle system only.
  17654. */
  17655. activeSubSystems: Array<ParticleSystem>;
  17656. private _rootParticleSystem;
  17657. /**
  17658. * Gets the current list of active particles
  17659. */
  17660. readonly particles: Particle[];
  17661. /**
  17662. * Returns the string "ParticleSystem"
  17663. * @returns a string containing the class name
  17664. */
  17665. getClassName(): string;
  17666. /**
  17667. * Instantiates a particle system.
  17668. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  17669. * @param name The name of the particle system
  17670. * @param capacity The max number of particles alive at the same time
  17671. * @param scene The scene the particle system belongs to
  17672. * @param customEffect a custom effect used to change the way particles are rendered by default
  17673. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  17674. * @param epsilon Offset used to render the particles
  17675. */
  17676. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  17677. private _addFactorGradient;
  17678. private _removeFactorGradient;
  17679. /**
  17680. * Adds a new life time gradient
  17681. * @param gradient defines the gradient to use (between 0 and 1)
  17682. * @param factor defines the life time factor to affect to the specified gradient
  17683. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17684. * @returns the current particle system
  17685. */
  17686. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17687. /**
  17688. * Remove a specific life time gradient
  17689. * @param gradient defines the gradient to remove
  17690. * @returns the current particle system
  17691. */
  17692. removeLifeTimeGradient(gradient: number): IParticleSystem;
  17693. /**
  17694. * Adds a new size gradient
  17695. * @param gradient defines the gradient to use (between 0 and 1)
  17696. * @param factor defines the size factor to affect to the specified gradient
  17697. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17698. * @returns the current particle system
  17699. */
  17700. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17701. /**
  17702. * Remove a specific size gradient
  17703. * @param gradient defines the gradient to remove
  17704. * @returns the current particle system
  17705. */
  17706. removeSizeGradient(gradient: number): IParticleSystem;
  17707. /**
  17708. * Adds a new color remap gradient
  17709. * @param gradient defines the gradient to use (between 0 and 1)
  17710. * @param min defines the color remap minimal range
  17711. * @param max defines the color remap maximal range
  17712. * @returns the current particle system
  17713. */
  17714. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17715. /**
  17716. * Remove a specific color remap gradient
  17717. * @param gradient defines the gradient to remove
  17718. * @returns the current particle system
  17719. */
  17720. removeColorRemapGradient(gradient: number): IParticleSystem;
  17721. /**
  17722. * Adds a new alpha remap gradient
  17723. * @param gradient defines the gradient to use (between 0 and 1)
  17724. * @param min defines the alpha remap minimal range
  17725. * @param max defines the alpha remap maximal range
  17726. * @returns the current particle system
  17727. */
  17728. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17729. /**
  17730. * Remove a specific alpha remap gradient
  17731. * @param gradient defines the gradient to remove
  17732. * @returns the current particle system
  17733. */
  17734. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  17735. /**
  17736. * Adds a new angular speed gradient
  17737. * @param gradient defines the gradient to use (between 0 and 1)
  17738. * @param factor defines the angular speed to affect to the specified gradient
  17739. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17740. * @returns the current particle system
  17741. */
  17742. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17743. /**
  17744. * Remove a specific angular speed gradient
  17745. * @param gradient defines the gradient to remove
  17746. * @returns the current particle system
  17747. */
  17748. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  17749. /**
  17750. * Adds a new velocity gradient
  17751. * @param gradient defines the gradient to use (between 0 and 1)
  17752. * @param factor defines the velocity to affect to the specified gradient
  17753. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17754. * @returns the current particle system
  17755. */
  17756. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17757. /**
  17758. * Remove a specific velocity gradient
  17759. * @param gradient defines the gradient to remove
  17760. * @returns the current particle system
  17761. */
  17762. removeVelocityGradient(gradient: number): IParticleSystem;
  17763. /**
  17764. * Adds a new limit velocity gradient
  17765. * @param gradient defines the gradient to use (between 0 and 1)
  17766. * @param factor defines the limit velocity value to affect to the specified gradient
  17767. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17768. * @returns the current particle system
  17769. */
  17770. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17771. /**
  17772. * Remove a specific limit velocity gradient
  17773. * @param gradient defines the gradient to remove
  17774. * @returns the current particle system
  17775. */
  17776. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  17777. /**
  17778. * Adds a new drag gradient
  17779. * @param gradient defines the gradient to use (between 0 and 1)
  17780. * @param factor defines the drag value to affect to the specified gradient
  17781. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17782. * @returns the current particle system
  17783. */
  17784. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17785. /**
  17786. * Remove a specific drag gradient
  17787. * @param gradient defines the gradient to remove
  17788. * @returns the current particle system
  17789. */
  17790. removeDragGradient(gradient: number): IParticleSystem;
  17791. /**
  17792. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  17793. * @param gradient defines the gradient to use (between 0 and 1)
  17794. * @param factor defines the emit rate value to affect to the specified gradient
  17795. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17796. * @returns the current particle system
  17797. */
  17798. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17799. /**
  17800. * Remove a specific emit rate gradient
  17801. * @param gradient defines the gradient to remove
  17802. * @returns the current particle system
  17803. */
  17804. removeEmitRateGradient(gradient: number): IParticleSystem;
  17805. /**
  17806. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  17807. * @param gradient defines the gradient to use (between 0 and 1)
  17808. * @param factor defines the start size value to affect to the specified gradient
  17809. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17810. * @returns the current particle system
  17811. */
  17812. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17813. /**
  17814. * Remove a specific start size gradient
  17815. * @param gradient defines the gradient to remove
  17816. * @returns the current particle system
  17817. */
  17818. removeStartSizeGradient(gradient: number): IParticleSystem;
  17819. private _createRampGradientTexture;
  17820. /**
  17821. * Gets the current list of ramp gradients.
  17822. * You must use addRampGradient and removeRampGradient to udpate this list
  17823. * @returns the list of ramp gradients
  17824. */
  17825. getRampGradients(): Nullable<Array<Color3Gradient>>;
  17826. /**
  17827. * Adds a new ramp gradient used to remap particle colors
  17828. * @param gradient defines the gradient to use (between 0 and 1)
  17829. * @param color defines the color to affect to the specified gradient
  17830. * @returns the current particle system
  17831. */
  17832. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  17833. /**
  17834. * Remove a specific ramp gradient
  17835. * @param gradient defines the gradient to remove
  17836. * @returns the current particle system
  17837. */
  17838. removeRampGradient(gradient: number): ParticleSystem;
  17839. /**
  17840. * Adds a new color gradient
  17841. * @param gradient defines the gradient to use (between 0 and 1)
  17842. * @param color1 defines the color to affect to the specified gradient
  17843. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  17844. * @returns this particle system
  17845. */
  17846. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  17847. /**
  17848. * Remove a specific color gradient
  17849. * @param gradient defines the gradient to remove
  17850. * @returns this particle system
  17851. */
  17852. removeColorGradient(gradient: number): IParticleSystem;
  17853. private _fetchR;
  17854. protected _reset(): void;
  17855. private _resetEffect;
  17856. private _createVertexBuffers;
  17857. private _createIndexBuffer;
  17858. /**
  17859. * Gets the maximum number of particles active at the same time.
  17860. * @returns The max number of active particles.
  17861. */
  17862. getCapacity(): number;
  17863. /**
  17864. * Gets whether there are still active particles in the system.
  17865. * @returns True if it is alive, otherwise false.
  17866. */
  17867. isAlive(): boolean;
  17868. /**
  17869. * Gets if the system has been started. (Note: this will still be true after stop is called)
  17870. * @returns True if it has been started, otherwise false.
  17871. */
  17872. isStarted(): boolean;
  17873. private _prepareSubEmitterInternalArray;
  17874. /**
  17875. * Starts the particle system and begins to emit
  17876. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  17877. */
  17878. start(delay?: number): void;
  17879. /**
  17880. * Stops the particle system.
  17881. * @param stopSubEmitters if true it will stop the current system and all created sub-Systems if false it will stop the current root system only, this param is used by the root particle system only. the default value is true.
  17882. */
  17883. stop(stopSubEmitters?: boolean): void;
  17884. /**
  17885. * Remove all active particles
  17886. */
  17887. reset(): void;
  17888. /**
  17889. * @hidden (for internal use only)
  17890. */
  17891. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  17892. /**
  17893. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  17894. * Its lifetime will start back at 0.
  17895. */
  17896. recycleParticle: (particle: Particle) => void;
  17897. private _stopSubEmitters;
  17898. private _createParticle;
  17899. private _removeFromRoot;
  17900. private _emitFromParticle;
  17901. private _update;
  17902. /** @hidden */
  17903. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  17904. /** @hidden */
  17905. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  17906. /** @hidden */
  17907. private _getEffect;
  17908. /**
  17909. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  17910. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  17911. */
  17912. animate(preWarmOnly?: boolean): void;
  17913. private _appendParticleVertices;
  17914. /**
  17915. * Rebuilds the particle system.
  17916. */
  17917. rebuild(): void;
  17918. /**
  17919. * Is this system ready to be used/rendered
  17920. * @return true if the system is ready
  17921. */
  17922. isReady(): boolean;
  17923. private _render;
  17924. /**
  17925. * Renders the particle system in its current state.
  17926. * @returns the current number of particles
  17927. */
  17928. render(): number;
  17929. /**
  17930. * Disposes the particle system and free the associated resources
  17931. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  17932. */
  17933. dispose(disposeTexture?: boolean): void;
  17934. /**
  17935. * Clones the particle system.
  17936. * @param name The name of the cloned object
  17937. * @param newEmitter The new emitter to use
  17938. * @returns the cloned particle system
  17939. */
  17940. clone(name: string, newEmitter: any): ParticleSystem;
  17941. /**
  17942. * Serializes the particle system to a JSON object.
  17943. * @returns the JSON object
  17944. */
  17945. serialize(): any;
  17946. /** @hidden */
  17947. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  17948. /** @hidden */
  17949. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  17950. /**
  17951. * Parses a JSON object to create a particle system.
  17952. * @param parsedParticleSystem The JSON object to parse
  17953. * @param scene The scene to create the particle system in
  17954. * @param rootUrl The root url to use to load external dependencies like texture
  17955. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  17956. * @returns the Parsed particle system
  17957. */
  17958. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  17959. }
  17960. }
  17961. declare module "babylonjs/Particles/particle" {
  17962. import { Nullable } from "babylonjs/types";
  17963. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  17964. import { Color4 } from "babylonjs/Maths/math.color";
  17965. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17966. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17967. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  17968. /**
  17969. * A particle represents one of the element emitted by a particle system.
  17970. * This is mainly define by its coordinates, direction, velocity and age.
  17971. */
  17972. export class Particle {
  17973. /**
  17974. * The particle system the particle belongs to.
  17975. */
  17976. particleSystem: ParticleSystem;
  17977. private static _Count;
  17978. /**
  17979. * Unique ID of the particle
  17980. */
  17981. id: number;
  17982. /**
  17983. * The world position of the particle in the scene.
  17984. */
  17985. position: Vector3;
  17986. /**
  17987. * The world direction of the particle in the scene.
  17988. */
  17989. direction: Vector3;
  17990. /**
  17991. * The color of the particle.
  17992. */
  17993. color: Color4;
  17994. /**
  17995. * The color change of the particle per step.
  17996. */
  17997. colorStep: Color4;
  17998. /**
  17999. * Defines how long will the life of the particle be.
  18000. */
  18001. lifeTime: number;
  18002. /**
  18003. * The current age of the particle.
  18004. */
  18005. age: number;
  18006. /**
  18007. * The current size of the particle.
  18008. */
  18009. size: number;
  18010. /**
  18011. * The current scale of the particle.
  18012. */
  18013. scale: Vector2;
  18014. /**
  18015. * The current angle of the particle.
  18016. */
  18017. angle: number;
  18018. /**
  18019. * Defines how fast is the angle changing.
  18020. */
  18021. angularSpeed: number;
  18022. /**
  18023. * Defines the cell index used by the particle to be rendered from a sprite.
  18024. */
  18025. cellIndex: number;
  18026. /**
  18027. * The information required to support color remapping
  18028. */
  18029. remapData: Vector4;
  18030. /** @hidden */
  18031. _randomCellOffset?: number;
  18032. /** @hidden */
  18033. _initialDirection: Nullable<Vector3>;
  18034. /** @hidden */
  18035. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  18036. /** @hidden */
  18037. _initialStartSpriteCellID: number;
  18038. /** @hidden */
  18039. _initialEndSpriteCellID: number;
  18040. /** @hidden */
  18041. _currentColorGradient: Nullable<ColorGradient>;
  18042. /** @hidden */
  18043. _currentColor1: Color4;
  18044. /** @hidden */
  18045. _currentColor2: Color4;
  18046. /** @hidden */
  18047. _currentSizeGradient: Nullable<FactorGradient>;
  18048. /** @hidden */
  18049. _currentSize1: number;
  18050. /** @hidden */
  18051. _currentSize2: number;
  18052. /** @hidden */
  18053. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  18054. /** @hidden */
  18055. _currentAngularSpeed1: number;
  18056. /** @hidden */
  18057. _currentAngularSpeed2: number;
  18058. /** @hidden */
  18059. _currentVelocityGradient: Nullable<FactorGradient>;
  18060. /** @hidden */
  18061. _currentVelocity1: number;
  18062. /** @hidden */
  18063. _currentVelocity2: number;
  18064. /** @hidden */
  18065. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  18066. /** @hidden */
  18067. _currentLimitVelocity1: number;
  18068. /** @hidden */
  18069. _currentLimitVelocity2: number;
  18070. /** @hidden */
  18071. _currentDragGradient: Nullable<FactorGradient>;
  18072. /** @hidden */
  18073. _currentDrag1: number;
  18074. /** @hidden */
  18075. _currentDrag2: number;
  18076. /** @hidden */
  18077. _randomNoiseCoordinates1: Vector3;
  18078. /** @hidden */
  18079. _randomNoiseCoordinates2: Vector3;
  18080. /**
  18081. * Creates a new instance Particle
  18082. * @param particleSystem the particle system the particle belongs to
  18083. */
  18084. constructor(
  18085. /**
  18086. * The particle system the particle belongs to.
  18087. */
  18088. particleSystem: ParticleSystem);
  18089. private updateCellInfoFromSystem;
  18090. /**
  18091. * Defines how the sprite cell index is updated for the particle
  18092. */
  18093. updateCellIndex(): void;
  18094. /** @hidden */
  18095. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  18096. /** @hidden */
  18097. _inheritParticleInfoToSubEmitters(): void;
  18098. /** @hidden */
  18099. _reset(): void;
  18100. /**
  18101. * Copy the properties of particle to another one.
  18102. * @param other the particle to copy the information to.
  18103. */
  18104. copyTo(other: Particle): void;
  18105. }
  18106. }
  18107. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  18108. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18109. import { Effect } from "babylonjs/Materials/effect";
  18110. import { Particle } from "babylonjs/Particles/particle";
  18111. /**
  18112. * Particle emitter represents a volume emitting particles.
  18113. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  18114. */
  18115. export interface IParticleEmitterType {
  18116. /**
  18117. * Called by the particle System when the direction is computed for the created particle.
  18118. * @param worldMatrix is the world matrix of the particle system
  18119. * @param directionToUpdate is the direction vector to update with the result
  18120. * @param particle is the particle we are computed the direction for
  18121. */
  18122. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18123. /**
  18124. * Called by the particle System when the position is computed for the created particle.
  18125. * @param worldMatrix is the world matrix of the particle system
  18126. * @param positionToUpdate is the position vector to update with the result
  18127. * @param particle is the particle we are computed the position for
  18128. */
  18129. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18130. /**
  18131. * Clones the current emitter and returns a copy of it
  18132. * @returns the new emitter
  18133. */
  18134. clone(): IParticleEmitterType;
  18135. /**
  18136. * Called by the GPUParticleSystem to setup the update shader
  18137. * @param effect defines the update shader
  18138. */
  18139. applyToShader(effect: Effect): void;
  18140. /**
  18141. * Returns a string to use to update the GPU particles update shader
  18142. * @returns the effect defines string
  18143. */
  18144. getEffectDefines(): string;
  18145. /**
  18146. * Returns a string representing the class name
  18147. * @returns a string containing the class name
  18148. */
  18149. getClassName(): string;
  18150. /**
  18151. * Serializes the particle system to a JSON object.
  18152. * @returns the JSON object
  18153. */
  18154. serialize(): any;
  18155. /**
  18156. * Parse properties from a JSON object
  18157. * @param serializationObject defines the JSON object
  18158. */
  18159. parse(serializationObject: any): void;
  18160. }
  18161. }
  18162. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  18163. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18164. import { Effect } from "babylonjs/Materials/effect";
  18165. import { Particle } from "babylonjs/Particles/particle";
  18166. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18167. /**
  18168. * Particle emitter emitting particles from the inside of a box.
  18169. * It emits the particles randomly between 2 given directions.
  18170. */
  18171. export class BoxParticleEmitter implements IParticleEmitterType {
  18172. /**
  18173. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18174. */
  18175. direction1: Vector3;
  18176. /**
  18177. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18178. */
  18179. direction2: Vector3;
  18180. /**
  18181. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  18182. */
  18183. minEmitBox: Vector3;
  18184. /**
  18185. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  18186. */
  18187. maxEmitBox: Vector3;
  18188. /**
  18189. * Creates a new instance BoxParticleEmitter
  18190. */
  18191. constructor();
  18192. /**
  18193. * Called by the particle System when the direction is computed for the created particle.
  18194. * @param worldMatrix is the world matrix of the particle system
  18195. * @param directionToUpdate is the direction vector to update with the result
  18196. * @param particle is the particle we are computed the direction for
  18197. */
  18198. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18199. /**
  18200. * Called by the particle System when the position is computed for the created particle.
  18201. * @param worldMatrix is the world matrix of the particle system
  18202. * @param positionToUpdate is the position vector to update with the result
  18203. * @param particle is the particle we are computed the position for
  18204. */
  18205. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18206. /**
  18207. * Clones the current emitter and returns a copy of it
  18208. * @returns the new emitter
  18209. */
  18210. clone(): BoxParticleEmitter;
  18211. /**
  18212. * Called by the GPUParticleSystem to setup the update shader
  18213. * @param effect defines the update shader
  18214. */
  18215. applyToShader(effect: Effect): void;
  18216. /**
  18217. * Returns a string to use to update the GPU particles update shader
  18218. * @returns a string containng the defines string
  18219. */
  18220. getEffectDefines(): string;
  18221. /**
  18222. * Returns the string "BoxParticleEmitter"
  18223. * @returns a string containing the class name
  18224. */
  18225. getClassName(): string;
  18226. /**
  18227. * Serializes the particle system to a JSON object.
  18228. * @returns the JSON object
  18229. */
  18230. serialize(): any;
  18231. /**
  18232. * Parse properties from a JSON object
  18233. * @param serializationObject defines the JSON object
  18234. */
  18235. parse(serializationObject: any): void;
  18236. }
  18237. }
  18238. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  18239. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18240. import { Effect } from "babylonjs/Materials/effect";
  18241. import { Particle } from "babylonjs/Particles/particle";
  18242. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18243. /**
  18244. * Particle emitter emitting particles from the inside of a cone.
  18245. * It emits the particles alongside the cone volume from the base to the particle.
  18246. * The emission direction might be randomized.
  18247. */
  18248. export class ConeParticleEmitter implements IParticleEmitterType {
  18249. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  18250. directionRandomizer: number;
  18251. private _radius;
  18252. private _angle;
  18253. private _height;
  18254. /**
  18255. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  18256. */
  18257. radiusRange: number;
  18258. /**
  18259. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  18260. */
  18261. heightRange: number;
  18262. /**
  18263. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  18264. */
  18265. emitFromSpawnPointOnly: boolean;
  18266. /**
  18267. * Gets or sets the radius of the emission cone
  18268. */
  18269. radius: number;
  18270. /**
  18271. * Gets or sets the angle of the emission cone
  18272. */
  18273. angle: number;
  18274. private _buildHeight;
  18275. /**
  18276. * Creates a new instance ConeParticleEmitter
  18277. * @param radius the radius of the emission cone (1 by default)
  18278. * @param angle the cone base angle (PI by default)
  18279. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  18280. */
  18281. constructor(radius?: number, angle?: number,
  18282. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  18283. directionRandomizer?: number);
  18284. /**
  18285. * Called by the particle System when the direction is computed for the created particle.
  18286. * @param worldMatrix is the world matrix of the particle system
  18287. * @param directionToUpdate is the direction vector to update with the result
  18288. * @param particle is the particle we are computed the direction for
  18289. */
  18290. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18291. /**
  18292. * Called by the particle System when the position is computed for the created particle.
  18293. * @param worldMatrix is the world matrix of the particle system
  18294. * @param positionToUpdate is the position vector to update with the result
  18295. * @param particle is the particle we are computed the position for
  18296. */
  18297. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18298. /**
  18299. * Clones the current emitter and returns a copy of it
  18300. * @returns the new emitter
  18301. */
  18302. clone(): ConeParticleEmitter;
  18303. /**
  18304. * Called by the GPUParticleSystem to setup the update shader
  18305. * @param effect defines the update shader
  18306. */
  18307. applyToShader(effect: Effect): void;
  18308. /**
  18309. * Returns a string to use to update the GPU particles update shader
  18310. * @returns a string containng the defines string
  18311. */
  18312. getEffectDefines(): string;
  18313. /**
  18314. * Returns the string "ConeParticleEmitter"
  18315. * @returns a string containing the class name
  18316. */
  18317. getClassName(): string;
  18318. /**
  18319. * Serializes the particle system to a JSON object.
  18320. * @returns the JSON object
  18321. */
  18322. serialize(): any;
  18323. /**
  18324. * Parse properties from a JSON object
  18325. * @param serializationObject defines the JSON object
  18326. */
  18327. parse(serializationObject: any): void;
  18328. }
  18329. }
  18330. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  18331. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18332. import { Effect } from "babylonjs/Materials/effect";
  18333. import { Particle } from "babylonjs/Particles/particle";
  18334. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18335. /**
  18336. * Particle emitter emitting particles from the inside of a cylinder.
  18337. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  18338. */
  18339. export class CylinderParticleEmitter implements IParticleEmitterType {
  18340. /**
  18341. * The radius of the emission cylinder.
  18342. */
  18343. radius: number;
  18344. /**
  18345. * The height of the emission cylinder.
  18346. */
  18347. height: number;
  18348. /**
  18349. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18350. */
  18351. radiusRange: number;
  18352. /**
  18353. * How much to randomize the particle direction [0-1].
  18354. */
  18355. directionRandomizer: number;
  18356. /**
  18357. * Creates a new instance CylinderParticleEmitter
  18358. * @param radius the radius of the emission cylinder (1 by default)
  18359. * @param height the height of the emission cylinder (1 by default)
  18360. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18361. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18362. */
  18363. constructor(
  18364. /**
  18365. * The radius of the emission cylinder.
  18366. */
  18367. radius?: number,
  18368. /**
  18369. * The height of the emission cylinder.
  18370. */
  18371. height?: number,
  18372. /**
  18373. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18374. */
  18375. radiusRange?: number,
  18376. /**
  18377. * How much to randomize the particle direction [0-1].
  18378. */
  18379. directionRandomizer?: number);
  18380. /**
  18381. * Called by the particle System when the direction is computed for the created particle.
  18382. * @param worldMatrix is the world matrix of the particle system
  18383. * @param directionToUpdate is the direction vector to update with the result
  18384. * @param particle is the particle we are computed the direction for
  18385. */
  18386. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18387. /**
  18388. * Called by the particle System when the position is computed for the created particle.
  18389. * @param worldMatrix is the world matrix of the particle system
  18390. * @param positionToUpdate is the position vector to update with the result
  18391. * @param particle is the particle we are computed the position for
  18392. */
  18393. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18394. /**
  18395. * Clones the current emitter and returns a copy of it
  18396. * @returns the new emitter
  18397. */
  18398. clone(): CylinderParticleEmitter;
  18399. /**
  18400. * Called by the GPUParticleSystem to setup the update shader
  18401. * @param effect defines the update shader
  18402. */
  18403. applyToShader(effect: Effect): void;
  18404. /**
  18405. * Returns a string to use to update the GPU particles update shader
  18406. * @returns a string containng the defines string
  18407. */
  18408. getEffectDefines(): string;
  18409. /**
  18410. * Returns the string "CylinderParticleEmitter"
  18411. * @returns a string containing the class name
  18412. */
  18413. getClassName(): string;
  18414. /**
  18415. * Serializes the particle system to a JSON object.
  18416. * @returns the JSON object
  18417. */
  18418. serialize(): any;
  18419. /**
  18420. * Parse properties from a JSON object
  18421. * @param serializationObject defines the JSON object
  18422. */
  18423. parse(serializationObject: any): void;
  18424. }
  18425. /**
  18426. * Particle emitter emitting particles from the inside of a cylinder.
  18427. * It emits the particles randomly between two vectors.
  18428. */
  18429. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  18430. /**
  18431. * The min limit of the emission direction.
  18432. */
  18433. direction1: Vector3;
  18434. /**
  18435. * The max limit of the emission direction.
  18436. */
  18437. direction2: Vector3;
  18438. /**
  18439. * Creates a new instance CylinderDirectedParticleEmitter
  18440. * @param radius the radius of the emission cylinder (1 by default)
  18441. * @param height the height of the emission cylinder (1 by default)
  18442. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18443. * @param direction1 the min limit of the emission direction (up vector by default)
  18444. * @param direction2 the max limit of the emission direction (up vector by default)
  18445. */
  18446. constructor(radius?: number, height?: number, radiusRange?: number,
  18447. /**
  18448. * The min limit of the emission direction.
  18449. */
  18450. direction1?: Vector3,
  18451. /**
  18452. * The max limit of the emission direction.
  18453. */
  18454. direction2?: Vector3);
  18455. /**
  18456. * Called by the particle System when the direction is computed for the created particle.
  18457. * @param worldMatrix is the world matrix of the particle system
  18458. * @param directionToUpdate is the direction vector to update with the result
  18459. * @param particle is the particle we are computed the direction for
  18460. */
  18461. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18462. /**
  18463. * Clones the current emitter and returns a copy of it
  18464. * @returns the new emitter
  18465. */
  18466. clone(): CylinderDirectedParticleEmitter;
  18467. /**
  18468. * Called by the GPUParticleSystem to setup the update shader
  18469. * @param effect defines the update shader
  18470. */
  18471. applyToShader(effect: Effect): void;
  18472. /**
  18473. * Returns a string to use to update the GPU particles update shader
  18474. * @returns a string containng the defines string
  18475. */
  18476. getEffectDefines(): string;
  18477. /**
  18478. * Returns the string "CylinderDirectedParticleEmitter"
  18479. * @returns a string containing the class name
  18480. */
  18481. getClassName(): string;
  18482. /**
  18483. * Serializes the particle system to a JSON object.
  18484. * @returns the JSON object
  18485. */
  18486. serialize(): any;
  18487. /**
  18488. * Parse properties from a JSON object
  18489. * @param serializationObject defines the JSON object
  18490. */
  18491. parse(serializationObject: any): void;
  18492. }
  18493. }
  18494. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  18495. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18496. import { Effect } from "babylonjs/Materials/effect";
  18497. import { Particle } from "babylonjs/Particles/particle";
  18498. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18499. /**
  18500. * Particle emitter emitting particles from the inside of a hemisphere.
  18501. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  18502. */
  18503. export class HemisphericParticleEmitter implements IParticleEmitterType {
  18504. /**
  18505. * The radius of the emission hemisphere.
  18506. */
  18507. radius: number;
  18508. /**
  18509. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18510. */
  18511. radiusRange: number;
  18512. /**
  18513. * How much to randomize the particle direction [0-1].
  18514. */
  18515. directionRandomizer: number;
  18516. /**
  18517. * Creates a new instance HemisphericParticleEmitter
  18518. * @param radius the radius of the emission hemisphere (1 by default)
  18519. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18520. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18521. */
  18522. constructor(
  18523. /**
  18524. * The radius of the emission hemisphere.
  18525. */
  18526. radius?: number,
  18527. /**
  18528. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18529. */
  18530. radiusRange?: number,
  18531. /**
  18532. * How much to randomize the particle direction [0-1].
  18533. */
  18534. directionRandomizer?: number);
  18535. /**
  18536. * Called by the particle System when the direction is computed for the created particle.
  18537. * @param worldMatrix is the world matrix of the particle system
  18538. * @param directionToUpdate is the direction vector to update with the result
  18539. * @param particle is the particle we are computed the direction for
  18540. */
  18541. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18542. /**
  18543. * Called by the particle System when the position is computed for the created particle.
  18544. * @param worldMatrix is the world matrix of the particle system
  18545. * @param positionToUpdate is the position vector to update with the result
  18546. * @param particle is the particle we are computed the position for
  18547. */
  18548. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18549. /**
  18550. * Clones the current emitter and returns a copy of it
  18551. * @returns the new emitter
  18552. */
  18553. clone(): HemisphericParticleEmitter;
  18554. /**
  18555. * Called by the GPUParticleSystem to setup the update shader
  18556. * @param effect defines the update shader
  18557. */
  18558. applyToShader(effect: Effect): void;
  18559. /**
  18560. * Returns a string to use to update the GPU particles update shader
  18561. * @returns a string containng the defines string
  18562. */
  18563. getEffectDefines(): string;
  18564. /**
  18565. * Returns the string "HemisphericParticleEmitter"
  18566. * @returns a string containing the class name
  18567. */
  18568. getClassName(): string;
  18569. /**
  18570. * Serializes the particle system to a JSON object.
  18571. * @returns the JSON object
  18572. */
  18573. serialize(): any;
  18574. /**
  18575. * Parse properties from a JSON object
  18576. * @param serializationObject defines the JSON object
  18577. */
  18578. parse(serializationObject: any): void;
  18579. }
  18580. }
  18581. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  18582. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18583. import { Effect } from "babylonjs/Materials/effect";
  18584. import { Particle } from "babylonjs/Particles/particle";
  18585. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18586. /**
  18587. * Particle emitter emitting particles from a point.
  18588. * It emits the particles randomly between 2 given directions.
  18589. */
  18590. export class PointParticleEmitter implements IParticleEmitterType {
  18591. /**
  18592. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18593. */
  18594. direction1: Vector3;
  18595. /**
  18596. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18597. */
  18598. direction2: Vector3;
  18599. /**
  18600. * Creates a new instance PointParticleEmitter
  18601. */
  18602. constructor();
  18603. /**
  18604. * Called by the particle System when the direction is computed for the created particle.
  18605. * @param worldMatrix is the world matrix of the particle system
  18606. * @param directionToUpdate is the direction vector to update with the result
  18607. * @param particle is the particle we are computed the direction for
  18608. */
  18609. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18610. /**
  18611. * Called by the particle System when the position is computed for the created particle.
  18612. * @param worldMatrix is the world matrix of the particle system
  18613. * @param positionToUpdate is the position vector to update with the result
  18614. * @param particle is the particle we are computed the position for
  18615. */
  18616. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18617. /**
  18618. * Clones the current emitter and returns a copy of it
  18619. * @returns the new emitter
  18620. */
  18621. clone(): PointParticleEmitter;
  18622. /**
  18623. * Called by the GPUParticleSystem to setup the update shader
  18624. * @param effect defines the update shader
  18625. */
  18626. applyToShader(effect: Effect): void;
  18627. /**
  18628. * Returns a string to use to update the GPU particles update shader
  18629. * @returns a string containng the defines string
  18630. */
  18631. getEffectDefines(): string;
  18632. /**
  18633. * Returns the string "PointParticleEmitter"
  18634. * @returns a string containing the class name
  18635. */
  18636. getClassName(): string;
  18637. /**
  18638. * Serializes the particle system to a JSON object.
  18639. * @returns the JSON object
  18640. */
  18641. serialize(): any;
  18642. /**
  18643. * Parse properties from a JSON object
  18644. * @param serializationObject defines the JSON object
  18645. */
  18646. parse(serializationObject: any): void;
  18647. }
  18648. }
  18649. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  18650. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18651. import { Effect } from "babylonjs/Materials/effect";
  18652. import { Particle } from "babylonjs/Particles/particle";
  18653. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18654. /**
  18655. * Particle emitter emitting particles from the inside of a sphere.
  18656. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  18657. */
  18658. export class SphereParticleEmitter implements IParticleEmitterType {
  18659. /**
  18660. * The radius of the emission sphere.
  18661. */
  18662. radius: number;
  18663. /**
  18664. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18665. */
  18666. radiusRange: number;
  18667. /**
  18668. * How much to randomize the particle direction [0-1].
  18669. */
  18670. directionRandomizer: number;
  18671. /**
  18672. * Creates a new instance SphereParticleEmitter
  18673. * @param radius the radius of the emission sphere (1 by default)
  18674. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18675. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18676. */
  18677. constructor(
  18678. /**
  18679. * The radius of the emission sphere.
  18680. */
  18681. radius?: number,
  18682. /**
  18683. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18684. */
  18685. radiusRange?: number,
  18686. /**
  18687. * How much to randomize the particle direction [0-1].
  18688. */
  18689. directionRandomizer?: number);
  18690. /**
  18691. * Called by the particle System when the direction is computed for the created particle.
  18692. * @param worldMatrix is the world matrix of the particle system
  18693. * @param directionToUpdate is the direction vector to update with the result
  18694. * @param particle is the particle we are computed the direction for
  18695. */
  18696. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18697. /**
  18698. * Called by the particle System when the position is computed for the created particle.
  18699. * @param worldMatrix is the world matrix of the particle system
  18700. * @param positionToUpdate is the position vector to update with the result
  18701. * @param particle is the particle we are computed the position for
  18702. */
  18703. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18704. /**
  18705. * Clones the current emitter and returns a copy of it
  18706. * @returns the new emitter
  18707. */
  18708. clone(): SphereParticleEmitter;
  18709. /**
  18710. * Called by the GPUParticleSystem to setup the update shader
  18711. * @param effect defines the update shader
  18712. */
  18713. applyToShader(effect: Effect): void;
  18714. /**
  18715. * Returns a string to use to update the GPU particles update shader
  18716. * @returns a string containng the defines string
  18717. */
  18718. getEffectDefines(): string;
  18719. /**
  18720. * Returns the string "SphereParticleEmitter"
  18721. * @returns a string containing the class name
  18722. */
  18723. getClassName(): string;
  18724. /**
  18725. * Serializes the particle system to a JSON object.
  18726. * @returns the JSON object
  18727. */
  18728. serialize(): any;
  18729. /**
  18730. * Parse properties from a JSON object
  18731. * @param serializationObject defines the JSON object
  18732. */
  18733. parse(serializationObject: any): void;
  18734. }
  18735. /**
  18736. * Particle emitter emitting particles from the inside of a sphere.
  18737. * It emits the particles randomly between two vectors.
  18738. */
  18739. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  18740. /**
  18741. * The min limit of the emission direction.
  18742. */
  18743. direction1: Vector3;
  18744. /**
  18745. * The max limit of the emission direction.
  18746. */
  18747. direction2: Vector3;
  18748. /**
  18749. * Creates a new instance SphereDirectedParticleEmitter
  18750. * @param radius the radius of the emission sphere (1 by default)
  18751. * @param direction1 the min limit of the emission direction (up vector by default)
  18752. * @param direction2 the max limit of the emission direction (up vector by default)
  18753. */
  18754. constructor(radius?: number,
  18755. /**
  18756. * The min limit of the emission direction.
  18757. */
  18758. direction1?: Vector3,
  18759. /**
  18760. * The max limit of the emission direction.
  18761. */
  18762. direction2?: Vector3);
  18763. /**
  18764. * Called by the particle System when the direction is computed for the created particle.
  18765. * @param worldMatrix is the world matrix of the particle system
  18766. * @param directionToUpdate is the direction vector to update with the result
  18767. * @param particle is the particle we are computed the direction for
  18768. */
  18769. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18770. /**
  18771. * Clones the current emitter and returns a copy of it
  18772. * @returns the new emitter
  18773. */
  18774. clone(): SphereDirectedParticleEmitter;
  18775. /**
  18776. * Called by the GPUParticleSystem to setup the update shader
  18777. * @param effect defines the update shader
  18778. */
  18779. applyToShader(effect: Effect): void;
  18780. /**
  18781. * Returns a string to use to update the GPU particles update shader
  18782. * @returns a string containng the defines string
  18783. */
  18784. getEffectDefines(): string;
  18785. /**
  18786. * Returns the string "SphereDirectedParticleEmitter"
  18787. * @returns a string containing the class name
  18788. */
  18789. getClassName(): string;
  18790. /**
  18791. * Serializes the particle system to a JSON object.
  18792. * @returns the JSON object
  18793. */
  18794. serialize(): any;
  18795. /**
  18796. * Parse properties from a JSON object
  18797. * @param serializationObject defines the JSON object
  18798. */
  18799. parse(serializationObject: any): void;
  18800. }
  18801. }
  18802. declare module "babylonjs/Particles/EmitterTypes/index" {
  18803. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  18804. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  18805. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  18806. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  18807. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18808. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  18809. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  18810. }
  18811. declare module "babylonjs/Particles/IParticleSystem" {
  18812. import { Nullable } from "babylonjs/types";
  18813. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  18814. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  18815. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18816. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  18817. import { Texture } from "babylonjs/Materials/Textures/texture";
  18818. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  18819. import { Scene } from "babylonjs/scene";
  18820. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  18821. import { Animation } from "babylonjs/Animations/animation";
  18822. /**
  18823. * Interface representing a particle system in Babylon.js.
  18824. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  18825. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  18826. */
  18827. export interface IParticleSystem {
  18828. /**
  18829. * List of animations used by the particle system.
  18830. */
  18831. animations: Animation[];
  18832. /**
  18833. * The id of the Particle system.
  18834. */
  18835. id: string;
  18836. /**
  18837. * The name of the Particle system.
  18838. */
  18839. name: string;
  18840. /**
  18841. * The emitter represents the Mesh or position we are attaching the particle system to.
  18842. */
  18843. emitter: Nullable<AbstractMesh | Vector3>;
  18844. /**
  18845. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  18846. */
  18847. isBillboardBased: boolean;
  18848. /**
  18849. * The rendering group used by the Particle system to chose when to render.
  18850. */
  18851. renderingGroupId: number;
  18852. /**
  18853. * The layer mask we are rendering the particles through.
  18854. */
  18855. layerMask: number;
  18856. /**
  18857. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  18858. */
  18859. updateSpeed: number;
  18860. /**
  18861. * The amount of time the particle system is running (depends of the overall update speed).
  18862. */
  18863. targetStopDuration: number;
  18864. /**
  18865. * The texture used to render each particle. (this can be a spritesheet)
  18866. */
  18867. particleTexture: Nullable<Texture>;
  18868. /**
  18869. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  18870. */
  18871. blendMode: number;
  18872. /**
  18873. * Minimum life time of emitting particles.
  18874. */
  18875. minLifeTime: number;
  18876. /**
  18877. * Maximum life time of emitting particles.
  18878. */
  18879. maxLifeTime: number;
  18880. /**
  18881. * Minimum Size of emitting particles.
  18882. */
  18883. minSize: number;
  18884. /**
  18885. * Maximum Size of emitting particles.
  18886. */
  18887. maxSize: number;
  18888. /**
  18889. * Minimum scale of emitting particles on X axis.
  18890. */
  18891. minScaleX: number;
  18892. /**
  18893. * Maximum scale of emitting particles on X axis.
  18894. */
  18895. maxScaleX: number;
  18896. /**
  18897. * Minimum scale of emitting particles on Y axis.
  18898. */
  18899. minScaleY: number;
  18900. /**
  18901. * Maximum scale of emitting particles on Y axis.
  18902. */
  18903. maxScaleY: number;
  18904. /**
  18905. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18906. */
  18907. color1: Color4;
  18908. /**
  18909. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18910. */
  18911. color2: Color4;
  18912. /**
  18913. * Color the particle will have at the end of its lifetime.
  18914. */
  18915. colorDead: Color4;
  18916. /**
  18917. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  18918. */
  18919. emitRate: number;
  18920. /**
  18921. * You can use gravity if you want to give an orientation to your particles.
  18922. */
  18923. gravity: Vector3;
  18924. /**
  18925. * Minimum power of emitting particles.
  18926. */
  18927. minEmitPower: number;
  18928. /**
  18929. * Maximum power of emitting particles.
  18930. */
  18931. maxEmitPower: number;
  18932. /**
  18933. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  18934. */
  18935. minAngularSpeed: number;
  18936. /**
  18937. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  18938. */
  18939. maxAngularSpeed: number;
  18940. /**
  18941. * Gets or sets the minimal initial rotation in radians.
  18942. */
  18943. minInitialRotation: number;
  18944. /**
  18945. * Gets or sets the maximal initial rotation in radians.
  18946. */
  18947. maxInitialRotation: number;
  18948. /**
  18949. * The particle emitter type defines the emitter used by the particle system.
  18950. * It can be for example box, sphere, or cone...
  18951. */
  18952. particleEmitterType: Nullable<IParticleEmitterType>;
  18953. /**
  18954. * Defines the delay in milliseconds before starting the system (0 by default)
  18955. */
  18956. startDelay: number;
  18957. /**
  18958. * Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0
  18959. */
  18960. preWarmCycles: number;
  18961. /**
  18962. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  18963. */
  18964. preWarmStepOffset: number;
  18965. /**
  18966. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  18967. */
  18968. spriteCellChangeSpeed: number;
  18969. /**
  18970. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  18971. */
  18972. startSpriteCellID: number;
  18973. /**
  18974. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  18975. */
  18976. endSpriteCellID: number;
  18977. /**
  18978. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  18979. */
  18980. spriteCellWidth: number;
  18981. /**
  18982. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  18983. */
  18984. spriteCellHeight: number;
  18985. /**
  18986. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  18987. */
  18988. spriteRandomStartCell: boolean;
  18989. /**
  18990. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  18991. */
  18992. isAnimationSheetEnabled: boolean;
  18993. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  18994. translationPivot: Vector2;
  18995. /**
  18996. * Gets or sets a texture used to add random noise to particle positions
  18997. */
  18998. noiseTexture: Nullable<BaseTexture>;
  18999. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  19000. noiseStrength: Vector3;
  19001. /**
  19002. * Gets or sets the billboard mode to use when isBillboardBased = true.
  19003. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  19004. */
  19005. billboardMode: number;
  19006. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  19007. limitVelocityDamping: number;
  19008. /**
  19009. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  19010. */
  19011. beginAnimationOnStart: boolean;
  19012. /**
  19013. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  19014. */
  19015. beginAnimationFrom: number;
  19016. /**
  19017. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  19018. */
  19019. beginAnimationTo: number;
  19020. /**
  19021. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  19022. */
  19023. beginAnimationLoop: boolean;
  19024. /**
  19025. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  19026. */
  19027. disposeOnStop: boolean;
  19028. /**
  19029. * Gets the maximum number of particles active at the same time.
  19030. * @returns The max number of active particles.
  19031. */
  19032. getCapacity(): number;
  19033. /**
  19034. * Gets if the system has been started. (Note: this will still be true after stop is called)
  19035. * @returns True if it has been started, otherwise false.
  19036. */
  19037. isStarted(): boolean;
  19038. /**
  19039. * Animates the particle system for this frame.
  19040. */
  19041. animate(): void;
  19042. /**
  19043. * Renders the particle system in its current state.
  19044. * @returns the current number of particles
  19045. */
  19046. render(): number;
  19047. /**
  19048. * Dispose the particle system and frees its associated resources.
  19049. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  19050. */
  19051. dispose(disposeTexture?: boolean): void;
  19052. /**
  19053. * Clones the particle system.
  19054. * @param name The name of the cloned object
  19055. * @param newEmitter The new emitter to use
  19056. * @returns the cloned particle system
  19057. */
  19058. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  19059. /**
  19060. * Serializes the particle system to a JSON object.
  19061. * @returns the JSON object
  19062. */
  19063. serialize(): any;
  19064. /**
  19065. * Rebuild the particle system
  19066. */
  19067. rebuild(): void;
  19068. /**
  19069. * Starts the particle system and begins to emit
  19070. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  19071. */
  19072. start(delay?: number): void;
  19073. /**
  19074. * Stops the particle system.
  19075. */
  19076. stop(): void;
  19077. /**
  19078. * Remove all active particles
  19079. */
  19080. reset(): void;
  19081. /**
  19082. * Is this system ready to be used/rendered
  19083. * @return true if the system is ready
  19084. */
  19085. isReady(): boolean;
  19086. /**
  19087. * Adds a new color gradient
  19088. * @param gradient defines the gradient to use (between 0 and 1)
  19089. * @param color1 defines the color to affect to the specified gradient
  19090. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  19091. * @returns the current particle system
  19092. */
  19093. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  19094. /**
  19095. * Remove a specific color gradient
  19096. * @param gradient defines the gradient to remove
  19097. * @returns the current particle system
  19098. */
  19099. removeColorGradient(gradient: number): IParticleSystem;
  19100. /**
  19101. * Adds a new size gradient
  19102. * @param gradient defines the gradient to use (between 0 and 1)
  19103. * @param factor defines the size factor to affect to the specified gradient
  19104. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19105. * @returns the current particle system
  19106. */
  19107. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19108. /**
  19109. * Remove a specific size gradient
  19110. * @param gradient defines the gradient to remove
  19111. * @returns the current particle system
  19112. */
  19113. removeSizeGradient(gradient: number): IParticleSystem;
  19114. /**
  19115. * Gets the current list of color gradients.
  19116. * You must use addColorGradient and removeColorGradient to udpate this list
  19117. * @returns the list of color gradients
  19118. */
  19119. getColorGradients(): Nullable<Array<ColorGradient>>;
  19120. /**
  19121. * Gets the current list of size gradients.
  19122. * You must use addSizeGradient and removeSizeGradient to udpate this list
  19123. * @returns the list of size gradients
  19124. */
  19125. getSizeGradients(): Nullable<Array<FactorGradient>>;
  19126. /**
  19127. * Gets the current list of angular speed gradients.
  19128. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  19129. * @returns the list of angular speed gradients
  19130. */
  19131. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  19132. /**
  19133. * Adds a new angular speed gradient
  19134. * @param gradient defines the gradient to use (between 0 and 1)
  19135. * @param factor defines the angular speed to affect to the specified gradient
  19136. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19137. * @returns the current particle system
  19138. */
  19139. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19140. /**
  19141. * Remove a specific angular speed gradient
  19142. * @param gradient defines the gradient to remove
  19143. * @returns the current particle system
  19144. */
  19145. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  19146. /**
  19147. * Gets the current list of velocity gradients.
  19148. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  19149. * @returns the list of velocity gradients
  19150. */
  19151. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  19152. /**
  19153. * Adds a new velocity gradient
  19154. * @param gradient defines the gradient to use (between 0 and 1)
  19155. * @param factor defines the velocity to affect to the specified gradient
  19156. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19157. * @returns the current particle system
  19158. */
  19159. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19160. /**
  19161. * Remove a specific velocity gradient
  19162. * @param gradient defines the gradient to remove
  19163. * @returns the current particle system
  19164. */
  19165. removeVelocityGradient(gradient: number): IParticleSystem;
  19166. /**
  19167. * Gets the current list of limit velocity gradients.
  19168. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  19169. * @returns the list of limit velocity gradients
  19170. */
  19171. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  19172. /**
  19173. * Adds a new limit velocity gradient
  19174. * @param gradient defines the gradient to use (between 0 and 1)
  19175. * @param factor defines the limit velocity to affect to the specified gradient
  19176. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19177. * @returns the current particle system
  19178. */
  19179. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19180. /**
  19181. * Remove a specific limit velocity gradient
  19182. * @param gradient defines the gradient to remove
  19183. * @returns the current particle system
  19184. */
  19185. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  19186. /**
  19187. * Adds a new drag gradient
  19188. * @param gradient defines the gradient to use (between 0 and 1)
  19189. * @param factor defines the drag to affect to the specified gradient
  19190. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19191. * @returns the current particle system
  19192. */
  19193. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19194. /**
  19195. * Remove a specific drag gradient
  19196. * @param gradient defines the gradient to remove
  19197. * @returns the current particle system
  19198. */
  19199. removeDragGradient(gradient: number): IParticleSystem;
  19200. /**
  19201. * Gets the current list of drag gradients.
  19202. * You must use addDragGradient and removeDragGradient to udpate this list
  19203. * @returns the list of drag gradients
  19204. */
  19205. getDragGradients(): Nullable<Array<FactorGradient>>;
  19206. /**
  19207. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  19208. * @param gradient defines the gradient to use (between 0 and 1)
  19209. * @param factor defines the emit rate to affect to the specified gradient
  19210. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19211. * @returns the current particle system
  19212. */
  19213. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19214. /**
  19215. * Remove a specific emit rate gradient
  19216. * @param gradient defines the gradient to remove
  19217. * @returns the current particle system
  19218. */
  19219. removeEmitRateGradient(gradient: number): IParticleSystem;
  19220. /**
  19221. * Gets the current list of emit rate gradients.
  19222. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  19223. * @returns the list of emit rate gradients
  19224. */
  19225. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  19226. /**
  19227. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  19228. * @param gradient defines the gradient to use (between 0 and 1)
  19229. * @param factor defines the start size to affect to the specified gradient
  19230. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19231. * @returns the current particle system
  19232. */
  19233. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19234. /**
  19235. * Remove a specific start size gradient
  19236. * @param gradient defines the gradient to remove
  19237. * @returns the current particle system
  19238. */
  19239. removeStartSizeGradient(gradient: number): IParticleSystem;
  19240. /**
  19241. * Gets the current list of start size gradients.
  19242. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  19243. * @returns the list of start size gradients
  19244. */
  19245. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  19246. /**
  19247. * Adds a new life time gradient
  19248. * @param gradient defines the gradient to use (between 0 and 1)
  19249. * @param factor defines the life time factor to affect to the specified gradient
  19250. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19251. * @returns the current particle system
  19252. */
  19253. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19254. /**
  19255. * Remove a specific life time gradient
  19256. * @param gradient defines the gradient to remove
  19257. * @returns the current particle system
  19258. */
  19259. removeLifeTimeGradient(gradient: number): IParticleSystem;
  19260. /**
  19261. * Gets the current list of life time gradients.
  19262. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  19263. * @returns the list of life time gradients
  19264. */
  19265. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  19266. /**
  19267. * Gets the current list of color gradients.
  19268. * You must use addColorGradient and removeColorGradient to udpate this list
  19269. * @returns the list of color gradients
  19270. */
  19271. getColorGradients(): Nullable<Array<ColorGradient>>;
  19272. /**
  19273. * Adds a new ramp gradient used to remap particle colors
  19274. * @param gradient defines the gradient to use (between 0 and 1)
  19275. * @param color defines the color to affect to the specified gradient
  19276. * @returns the current particle system
  19277. */
  19278. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  19279. /**
  19280. * Gets the current list of ramp gradients.
  19281. * You must use addRampGradient and removeRampGradient to udpate this list
  19282. * @returns the list of ramp gradients
  19283. */
  19284. getRampGradients(): Nullable<Array<Color3Gradient>>;
  19285. /** Gets or sets a boolean indicating that ramp gradients must be used
  19286. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  19287. */
  19288. useRampGradients: boolean;
  19289. /**
  19290. * Adds a new color remap gradient
  19291. * @param gradient defines the gradient to use (between 0 and 1)
  19292. * @param min defines the color remap minimal range
  19293. * @param max defines the color remap maximal range
  19294. * @returns the current particle system
  19295. */
  19296. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  19297. /**
  19298. * Gets the current list of color remap gradients.
  19299. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  19300. * @returns the list of color remap gradients
  19301. */
  19302. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  19303. /**
  19304. * Adds a new alpha remap gradient
  19305. * @param gradient defines the gradient to use (between 0 and 1)
  19306. * @param min defines the alpha remap minimal range
  19307. * @param max defines the alpha remap maximal range
  19308. * @returns the current particle system
  19309. */
  19310. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  19311. /**
  19312. * Gets the current list of alpha remap gradients.
  19313. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  19314. * @returns the list of alpha remap gradients
  19315. */
  19316. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  19317. /**
  19318. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  19319. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19320. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19321. * @returns the emitter
  19322. */
  19323. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  19324. /**
  19325. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  19326. * @param radius The radius of the hemisphere to emit from
  19327. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19328. * @returns the emitter
  19329. */
  19330. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  19331. /**
  19332. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  19333. * @param radius The radius of the sphere to emit from
  19334. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19335. * @returns the emitter
  19336. */
  19337. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  19338. /**
  19339. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  19340. * @param radius The radius of the sphere to emit from
  19341. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  19342. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  19343. * @returns the emitter
  19344. */
  19345. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19346. /**
  19347. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  19348. * @param radius The radius of the emission cylinder
  19349. * @param height The height of the emission cylinder
  19350. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  19351. * @param directionRandomizer How much to randomize the particle direction [0-1]
  19352. * @returns the emitter
  19353. */
  19354. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  19355. /**
  19356. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  19357. * @param radius The radius of the cylinder to emit from
  19358. * @param height The height of the emission cylinder
  19359. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  19360. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  19361. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  19362. * @returns the emitter
  19363. */
  19364. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19365. /**
  19366. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  19367. * @param radius The radius of the cone to emit from
  19368. * @param angle The base angle of the cone
  19369. * @returns the emitter
  19370. */
  19371. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  19372. /**
  19373. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  19374. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19375. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19376. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19377. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19378. * @returns the emitter
  19379. */
  19380. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  19381. /**
  19382. * Get hosting scene
  19383. * @returns the scene
  19384. */
  19385. getScene(): Scene;
  19386. }
  19387. }
  19388. declare module "babylonjs/Meshes/instancedMesh" {
  19389. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  19390. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  19391. import { Camera } from "babylonjs/Cameras/camera";
  19392. import { Node } from "babylonjs/node";
  19393. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19394. import { Mesh } from "babylonjs/Meshes/mesh";
  19395. import { Material } from "babylonjs/Materials/material";
  19396. import { Skeleton } from "babylonjs/Bones/skeleton";
  19397. import { Light } from "babylonjs/Lights/light";
  19398. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  19399. /**
  19400. * Creates an instance based on a source mesh.
  19401. */
  19402. export class InstancedMesh extends AbstractMesh {
  19403. private _sourceMesh;
  19404. private _currentLOD;
  19405. /** @hidden */
  19406. _indexInSourceMeshInstanceArray: number;
  19407. constructor(name: string, source: Mesh);
  19408. /**
  19409. * Returns the string "InstancedMesh".
  19410. */
  19411. getClassName(): string;
  19412. /** Gets the list of lights affecting that mesh */
  19413. readonly lightSources: Light[];
  19414. _resyncLightSources(): void;
  19415. _resyncLighSource(light: Light): void;
  19416. _removeLightSource(light: Light, dispose: boolean): void;
  19417. /**
  19418. * If the source mesh receives shadows
  19419. */
  19420. readonly receiveShadows: boolean;
  19421. /**
  19422. * The material of the source mesh
  19423. */
  19424. readonly material: Nullable<Material>;
  19425. /**
  19426. * Visibility of the source mesh
  19427. */
  19428. readonly visibility: number;
  19429. /**
  19430. * Skeleton of the source mesh
  19431. */
  19432. readonly skeleton: Nullable<Skeleton>;
  19433. /**
  19434. * Rendering ground id of the source mesh
  19435. */
  19436. renderingGroupId: number;
  19437. /**
  19438. * Returns the total number of vertices (integer).
  19439. */
  19440. getTotalVertices(): number;
  19441. /**
  19442. * Returns a positive integer : the total number of indices in this mesh geometry.
  19443. * @returns the numner of indices or zero if the mesh has no geometry.
  19444. */
  19445. getTotalIndices(): number;
  19446. /**
  19447. * The source mesh of the instance
  19448. */
  19449. readonly sourceMesh: Mesh;
  19450. /**
  19451. * Is this node ready to be used/rendered
  19452. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  19453. * @return {boolean} is it ready
  19454. */
  19455. isReady(completeCheck?: boolean): boolean;
  19456. /**
  19457. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  19458. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  19459. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  19460. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  19461. */
  19462. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  19463. /**
  19464. * Sets the vertex data of the mesh geometry for the requested `kind`.
  19465. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  19466. * The `data` are either a numeric array either a Float32Array.
  19467. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  19468. * The parameter `stride` is an optional positive integer, it is usually automatically deducted from the `kind` (3 for positions or normals, 2 for UV, etc).
  19469. * Note that a new underlying VertexBuffer object is created each call.
  19470. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  19471. *
  19472. * Possible `kind` values :
  19473. * - VertexBuffer.PositionKind
  19474. * - VertexBuffer.UVKind
  19475. * - VertexBuffer.UV2Kind
  19476. * - VertexBuffer.UV3Kind
  19477. * - VertexBuffer.UV4Kind
  19478. * - VertexBuffer.UV5Kind
  19479. * - VertexBuffer.UV6Kind
  19480. * - VertexBuffer.ColorKind
  19481. * - VertexBuffer.MatricesIndicesKind
  19482. * - VertexBuffer.MatricesIndicesExtraKind
  19483. * - VertexBuffer.MatricesWeightsKind
  19484. * - VertexBuffer.MatricesWeightsExtraKind
  19485. *
  19486. * Returns the Mesh.
  19487. */
  19488. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  19489. /**
  19490. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  19491. * If the mesh has no geometry, it is simply returned as it is.
  19492. * The `data` are either a numeric array either a Float32Array.
  19493. * No new underlying VertexBuffer object is created.
  19494. * If the `kind` is the `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  19495. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  19496. *
  19497. * Possible `kind` values :
  19498. * - VertexBuffer.PositionKind
  19499. * - VertexBuffer.UVKind
  19500. * - VertexBuffer.UV2Kind
  19501. * - VertexBuffer.UV3Kind
  19502. * - VertexBuffer.UV4Kind
  19503. * - VertexBuffer.UV5Kind
  19504. * - VertexBuffer.UV6Kind
  19505. * - VertexBuffer.ColorKind
  19506. * - VertexBuffer.MatricesIndicesKind
  19507. * - VertexBuffer.MatricesIndicesExtraKind
  19508. * - VertexBuffer.MatricesWeightsKind
  19509. * - VertexBuffer.MatricesWeightsExtraKind
  19510. *
  19511. * Returns the Mesh.
  19512. */
  19513. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  19514. /**
  19515. * Sets the mesh indices.
  19516. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  19517. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  19518. * This method creates a new index buffer each call.
  19519. * Returns the Mesh.
  19520. */
  19521. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  19522. /**
  19523. * Boolean : True if the mesh owns the requested kind of data.
  19524. */
  19525. isVerticesDataPresent(kind: string): boolean;
  19526. /**
  19527. * Returns an array of indices (IndicesArray).
  19528. */
  19529. getIndices(): Nullable<IndicesArray>;
  19530. readonly _positions: Nullable<Vector3[]>;
  19531. /**
  19532. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  19533. * This means the mesh underlying bounding box and sphere are recomputed.
  19534. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  19535. * @returns the current mesh
  19536. */
  19537. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  19538. /** @hidden */
  19539. _preActivate(): InstancedMesh;
  19540. /** @hidden */
  19541. _activate(renderId: number, intermediateRendering: boolean): boolean;
  19542. /** @hidden */
  19543. _postActivate(): void;
  19544. getWorldMatrix(): Matrix;
  19545. readonly isAnInstance: boolean;
  19546. /**
  19547. * Returns the current associated LOD AbstractMesh.
  19548. */
  19549. getLOD(camera: Camera): AbstractMesh;
  19550. /** @hidden */
  19551. _syncSubMeshes(): InstancedMesh;
  19552. /** @hidden */
  19553. _generatePointsArray(): boolean;
  19554. /**
  19555. * Creates a new InstancedMesh from the current mesh.
  19556. * - name (string) : the cloned mesh name
  19557. * - newParent (optional Node) : the optional Node to parent the clone to.
  19558. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  19559. *
  19560. * Returns the clone.
  19561. */
  19562. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  19563. /**
  19564. * Disposes the InstancedMesh.
  19565. * Returns nothing.
  19566. */
  19567. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  19568. }
  19569. module "babylonjs/Meshes/mesh" {
  19570. interface Mesh {
  19571. /**
  19572. * Register a custom buffer that will be instanced
  19573. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  19574. * @param kind defines the buffer kind
  19575. * @param stride defines the stride in floats
  19576. */
  19577. registerInstancedBuffer(kind: string, stride: number): void;
  19578. /** @hidden */
  19579. _userInstancedBuffersStorage: {
  19580. data: {
  19581. [key: string]: Float32Array;
  19582. };
  19583. sizes: {
  19584. [key: string]: number;
  19585. };
  19586. vertexBuffers: {
  19587. [key: string]: Nullable<VertexBuffer>;
  19588. };
  19589. strides: {
  19590. [key: string]: number;
  19591. };
  19592. };
  19593. }
  19594. }
  19595. module "babylonjs/Meshes/abstractMesh" {
  19596. interface AbstractMesh {
  19597. /**
  19598. * Object used to store instanced buffers defined by user
  19599. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  19600. */
  19601. instancedBuffers: {
  19602. [key: string]: any;
  19603. };
  19604. }
  19605. }
  19606. }
  19607. declare module "babylonjs/Materials/shaderMaterial" {
  19608. import { Scene } from "babylonjs/scene";
  19609. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  19610. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19611. import { Mesh } from "babylonjs/Meshes/mesh";
  19612. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  19613. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  19614. import { Texture } from "babylonjs/Materials/Textures/texture";
  19615. import { Material } from "babylonjs/Materials/material";
  19616. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  19617. /**
  19618. * Defines the options associated with the creation of a shader material.
  19619. */
  19620. export interface IShaderMaterialOptions {
  19621. /**
  19622. * Does the material work in alpha blend mode
  19623. */
  19624. needAlphaBlending: boolean;
  19625. /**
  19626. * Does the material work in alpha test mode
  19627. */
  19628. needAlphaTesting: boolean;
  19629. /**
  19630. * The list of attribute names used in the shader
  19631. */
  19632. attributes: string[];
  19633. /**
  19634. * The list of unifrom names used in the shader
  19635. */
  19636. uniforms: string[];
  19637. /**
  19638. * The list of UBO names used in the shader
  19639. */
  19640. uniformBuffers: string[];
  19641. /**
  19642. * The list of sampler names used in the shader
  19643. */
  19644. samplers: string[];
  19645. /**
  19646. * The list of defines used in the shader
  19647. */
  19648. defines: string[];
  19649. }
  19650. /**
  19651. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  19652. *
  19653. * This returned material effects how the mesh will look based on the code in the shaders.
  19654. *
  19655. * @see http://doc.babylonjs.com/how_to/shader_material
  19656. */
  19657. export class ShaderMaterial extends Material {
  19658. private _shaderPath;
  19659. private _options;
  19660. private _textures;
  19661. private _textureArrays;
  19662. private _floats;
  19663. private _ints;
  19664. private _floatsArrays;
  19665. private _colors3;
  19666. private _colors3Arrays;
  19667. private _colors4;
  19668. private _colors4Arrays;
  19669. private _vectors2;
  19670. private _vectors3;
  19671. private _vectors4;
  19672. private _matrices;
  19673. private _matrixArrays;
  19674. private _matrices3x3;
  19675. private _matrices2x2;
  19676. private _vectors2Arrays;
  19677. private _vectors3Arrays;
  19678. private _vectors4Arrays;
  19679. private _cachedWorldViewMatrix;
  19680. private _cachedWorldViewProjectionMatrix;
  19681. private _renderId;
  19682. /**
  19683. * Instantiate a new shader material.
  19684. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  19685. * This returned material effects how the mesh will look based on the code in the shaders.
  19686. * @see http://doc.babylonjs.com/how_to/shader_material
  19687. * @param name Define the name of the material in the scene
  19688. * @param scene Define the scene the material belongs to
  19689. * @param shaderPath Defines the route to the shader code in one of three ways:
  19690. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  19691. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  19692. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  19693. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  19694. * @param options Define the options used to create the shader
  19695. */
  19696. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  19697. /**
  19698. * Gets the shader path used to define the shader code
  19699. * It can be modified to trigger a new compilation
  19700. */
  19701. /**
  19702. * Sets the shader path used to define the shader code
  19703. * It can be modified to trigger a new compilation
  19704. */
  19705. shaderPath: any;
  19706. /**
  19707. * Gets the options used to compile the shader.
  19708. * They can be modified to trigger a new compilation
  19709. */
  19710. readonly options: IShaderMaterialOptions;
  19711. /**
  19712. * Gets the current class name of the material e.g. "ShaderMaterial"
  19713. * Mainly use in serialization.
  19714. * @returns the class name
  19715. */
  19716. getClassName(): string;
  19717. /**
  19718. * Specifies if the material will require alpha blending
  19719. * @returns a boolean specifying if alpha blending is needed
  19720. */
  19721. needAlphaBlending(): boolean;
  19722. /**
  19723. * Specifies if this material should be rendered in alpha test mode
  19724. * @returns a boolean specifying if an alpha test is needed.
  19725. */
  19726. needAlphaTesting(): boolean;
  19727. private _checkUniform;
  19728. /**
  19729. * Set a texture in the shader.
  19730. * @param name Define the name of the uniform samplers as defined in the shader
  19731. * @param texture Define the texture to bind to this sampler
  19732. * @return the material itself allowing "fluent" like uniform updates
  19733. */
  19734. setTexture(name: string, texture: Texture): ShaderMaterial;
  19735. /**
  19736. * Set a texture array in the shader.
  19737. * @param name Define the name of the uniform sampler array as defined in the shader
  19738. * @param textures Define the list of textures to bind to this sampler
  19739. * @return the material itself allowing "fluent" like uniform updates
  19740. */
  19741. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  19742. /**
  19743. * Set a float in the shader.
  19744. * @param name Define the name of the uniform as defined in the shader
  19745. * @param value Define the value to give to the uniform
  19746. * @return the material itself allowing "fluent" like uniform updates
  19747. */
  19748. setFloat(name: string, value: number): ShaderMaterial;
  19749. /**
  19750. * Set a int in the shader.
  19751. * @param name Define the name of the uniform as defined in the shader
  19752. * @param value Define the value to give to the uniform
  19753. * @return the material itself allowing "fluent" like uniform updates
  19754. */
  19755. setInt(name: string, value: number): ShaderMaterial;
  19756. /**
  19757. * Set an array of floats in the shader.
  19758. * @param name Define the name of the uniform as defined in the shader
  19759. * @param value Define the value to give to the uniform
  19760. * @return the material itself allowing "fluent" like uniform updates
  19761. */
  19762. setFloats(name: string, value: number[]): ShaderMaterial;
  19763. /**
  19764. * Set a vec3 in the shader from a Color3.
  19765. * @param name Define the name of the uniform as defined in the shader
  19766. * @param value Define the value to give to the uniform
  19767. * @return the material itself allowing "fluent" like uniform updates
  19768. */
  19769. setColor3(name: string, value: Color3): ShaderMaterial;
  19770. /**
  19771. * Set a vec3 array in the shader from a Color3 array.
  19772. * @param name Define the name of the uniform as defined in the shader
  19773. * @param value Define the value to give to the uniform
  19774. * @return the material itself allowing "fluent" like uniform updates
  19775. */
  19776. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  19777. /**
  19778. * Set a vec4 in the shader from a Color4.
  19779. * @param name Define the name of the uniform as defined in the shader
  19780. * @param value Define the value to give to the uniform
  19781. * @return the material itself allowing "fluent" like uniform updates
  19782. */
  19783. setColor4(name: string, value: Color4): ShaderMaterial;
  19784. /**
  19785. * Set a vec4 array in the shader from a Color4 array.
  19786. * @param name Define the name of the uniform as defined in the shader
  19787. * @param value Define the value to give to the uniform
  19788. * @return the material itself allowing "fluent" like uniform updates
  19789. */
  19790. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  19791. /**
  19792. * Set a vec2 in the shader from a Vector2.
  19793. * @param name Define the name of the uniform as defined in the shader
  19794. * @param value Define the value to give to the uniform
  19795. * @return the material itself allowing "fluent" like uniform updates
  19796. */
  19797. setVector2(name: string, value: Vector2): ShaderMaterial;
  19798. /**
  19799. * Set a vec3 in the shader from a Vector3.
  19800. * @param name Define the name of the uniform as defined in the shader
  19801. * @param value Define the value to give to the uniform
  19802. * @return the material itself allowing "fluent" like uniform updates
  19803. */
  19804. setVector3(name: string, value: Vector3): ShaderMaterial;
  19805. /**
  19806. * Set a vec4 in the shader from a Vector4.
  19807. * @param name Define the name of the uniform as defined in the shader
  19808. * @param value Define the value to give to the uniform
  19809. * @return the material itself allowing "fluent" like uniform updates
  19810. */
  19811. setVector4(name: string, value: Vector4): ShaderMaterial;
  19812. /**
  19813. * Set a mat4 in the shader from a Matrix.
  19814. * @param name Define the name of the uniform as defined in the shader
  19815. * @param value Define the value to give to the uniform
  19816. * @return the material itself allowing "fluent" like uniform updates
  19817. */
  19818. setMatrix(name: string, value: Matrix): ShaderMaterial;
  19819. /**
  19820. * Set a float32Array in the shader from a matrix array.
  19821. * @param name Define the name of the uniform as defined in the shader
  19822. * @param value Define the value to give to the uniform
  19823. * @return the material itself allowing "fluent" like uniform updates
  19824. */
  19825. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  19826. /**
  19827. * Set a mat3 in the shader from a Float32Array.
  19828. * @param name Define the name of the uniform as defined in the shader
  19829. * @param value Define the value to give to the uniform
  19830. * @return the material itself allowing "fluent" like uniform updates
  19831. */
  19832. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  19833. /**
  19834. * Set a mat2 in the shader from a Float32Array.
  19835. * @param name Define the name of the uniform as defined in the shader
  19836. * @param value Define the value to give to the uniform
  19837. * @return the material itself allowing "fluent" like uniform updates
  19838. */
  19839. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  19840. /**
  19841. * Set a vec2 array in the shader from a number array.
  19842. * @param name Define the name of the uniform as defined in the shader
  19843. * @param value Define the value to give to the uniform
  19844. * @return the material itself allowing "fluent" like uniform updates
  19845. */
  19846. setArray2(name: string, value: number[]): ShaderMaterial;
  19847. /**
  19848. * Set a vec3 array in the shader from a number array.
  19849. * @param name Define the name of the uniform as defined in the shader
  19850. * @param value Define the value to give to the uniform
  19851. * @return the material itself allowing "fluent" like uniform updates
  19852. */
  19853. setArray3(name: string, value: number[]): ShaderMaterial;
  19854. /**
  19855. * Set a vec4 array in the shader from a number array.
  19856. * @param name Define the name of the uniform as defined in the shader
  19857. * @param value Define the value to give to the uniform
  19858. * @return the material itself allowing "fluent" like uniform updates
  19859. */
  19860. setArray4(name: string, value: number[]): ShaderMaterial;
  19861. private _checkCache;
  19862. /**
  19863. * Specifies that the submesh is ready to be used
  19864. * @param mesh defines the mesh to check
  19865. * @param subMesh defines which submesh to check
  19866. * @param useInstances specifies that instances should be used
  19867. * @returns a boolean indicating that the submesh is ready or not
  19868. */
  19869. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  19870. /**
  19871. * Checks if the material is ready to render the requested mesh
  19872. * @param mesh Define the mesh to render
  19873. * @param useInstances Define whether or not the material is used with instances
  19874. * @returns true if ready, otherwise false
  19875. */
  19876. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  19877. /**
  19878. * Binds the world matrix to the material
  19879. * @param world defines the world transformation matrix
  19880. */
  19881. bindOnlyWorldMatrix(world: Matrix): void;
  19882. /**
  19883. * Binds the material to the mesh
  19884. * @param world defines the world transformation matrix
  19885. * @param mesh defines the mesh to bind the material to
  19886. */
  19887. bind(world: Matrix, mesh?: Mesh): void;
  19888. /**
  19889. * Gets the active textures from the material
  19890. * @returns an array of textures
  19891. */
  19892. getActiveTextures(): BaseTexture[];
  19893. /**
  19894. * Specifies if the material uses a texture
  19895. * @param texture defines the texture to check against the material
  19896. * @returns a boolean specifying if the material uses the texture
  19897. */
  19898. hasTexture(texture: BaseTexture): boolean;
  19899. /**
  19900. * Makes a duplicate of the material, and gives it a new name
  19901. * @param name defines the new name for the duplicated material
  19902. * @returns the cloned material
  19903. */
  19904. clone(name: string): ShaderMaterial;
  19905. /**
  19906. * Disposes the material
  19907. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  19908. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  19909. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  19910. */
  19911. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  19912. /**
  19913. * Serializes this material in a JSON representation
  19914. * @returns the serialized material object
  19915. */
  19916. serialize(): any;
  19917. /**
  19918. * Creates a shader material from parsed shader material data
  19919. * @param source defines the JSON represnetation of the material
  19920. * @param scene defines the hosting scene
  19921. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  19922. * @returns a new material
  19923. */
  19924. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  19925. }
  19926. }
  19927. declare module "babylonjs/Shaders/color.fragment" {
  19928. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  19929. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  19930. /** @hidden */
  19931. export var colorPixelShader: {
  19932. name: string;
  19933. shader: string;
  19934. };
  19935. }
  19936. declare module "babylonjs/Shaders/color.vertex" {
  19937. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  19938. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  19939. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  19940. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  19941. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  19942. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  19943. /** @hidden */
  19944. export var colorVertexShader: {
  19945. name: string;
  19946. shader: string;
  19947. };
  19948. }
  19949. declare module "babylonjs/Meshes/linesMesh" {
  19950. import { Nullable } from "babylonjs/types";
  19951. import { Scene } from "babylonjs/scene";
  19952. import { Color3 } from "babylonjs/Maths/math.color";
  19953. import { Node } from "babylonjs/node";
  19954. import { SubMesh } from "babylonjs/Meshes/subMesh";
  19955. import { Mesh } from "babylonjs/Meshes/mesh";
  19956. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  19957. import { Effect } from "babylonjs/Materials/effect";
  19958. import { Material } from "babylonjs/Materials/material";
  19959. import "babylonjs/Shaders/color.fragment";
  19960. import "babylonjs/Shaders/color.vertex";
  19961. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19962. /**
  19963. * Line mesh
  19964. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  19965. */
  19966. export class LinesMesh extends Mesh {
  19967. /**
  19968. * If vertex color should be applied to the mesh
  19969. */
  19970. readonly useVertexColor?: boolean | undefined;
  19971. /**
  19972. * If vertex alpha should be applied to the mesh
  19973. */
  19974. readonly useVertexAlpha?: boolean | undefined;
  19975. /**
  19976. * Color of the line (Default: White)
  19977. */
  19978. color: Color3;
  19979. /**
  19980. * Alpha of the line (Default: 1)
  19981. */
  19982. alpha: number;
  19983. /**
  19984. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  19985. * This margin is expressed in world space coordinates, so its value may vary.
  19986. * Default value is 0.1
  19987. */
  19988. intersectionThreshold: number;
  19989. private _colorShader;
  19990. private color4;
  19991. /**
  19992. * Creates a new LinesMesh
  19993. * @param name defines the name
  19994. * @param scene defines the hosting scene
  19995. * @param parent defines the parent mesh if any
  19996. * @param source defines the optional source LinesMesh used to clone data from
  19997. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  19998. * When false, achieved by calling a clone(), also passing False.
  19999. * This will make creation of children, recursive.
  20000. * @param useVertexColor defines if this LinesMesh supports vertex color
  20001. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  20002. */
  20003. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  20004. /**
  20005. * If vertex color should be applied to the mesh
  20006. */
  20007. useVertexColor?: boolean | undefined,
  20008. /**
  20009. * If vertex alpha should be applied to the mesh
  20010. */
  20011. useVertexAlpha?: boolean | undefined);
  20012. private _addClipPlaneDefine;
  20013. private _removeClipPlaneDefine;
  20014. isReady(): boolean;
  20015. /**
  20016. * Returns the string "LineMesh"
  20017. */
  20018. getClassName(): string;
  20019. /**
  20020. * @hidden
  20021. */
  20022. /**
  20023. * @hidden
  20024. */
  20025. material: Material;
  20026. /**
  20027. * @hidden
  20028. */
  20029. readonly checkCollisions: boolean;
  20030. /** @hidden */
  20031. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  20032. /** @hidden */
  20033. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  20034. /**
  20035. * Disposes of the line mesh
  20036. * @param doNotRecurse If children should be disposed
  20037. */
  20038. dispose(doNotRecurse?: boolean): void;
  20039. /**
  20040. * Returns a new LineMesh object cloned from the current one.
  20041. */
  20042. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  20043. /**
  20044. * Creates a new InstancedLinesMesh object from the mesh model.
  20045. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  20046. * @param name defines the name of the new instance
  20047. * @returns a new InstancedLinesMesh
  20048. */
  20049. createInstance(name: string): InstancedLinesMesh;
  20050. }
  20051. /**
  20052. * Creates an instance based on a source LinesMesh
  20053. */
  20054. export class InstancedLinesMesh extends InstancedMesh {
  20055. /**
  20056. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  20057. * This margin is expressed in world space coordinates, so its value may vary.
  20058. * Initilized with the intersectionThreshold value of the source LinesMesh
  20059. */
  20060. intersectionThreshold: number;
  20061. constructor(name: string, source: LinesMesh);
  20062. /**
  20063. * Returns the string "InstancedLinesMesh".
  20064. */
  20065. getClassName(): string;
  20066. }
  20067. }
  20068. declare module "babylonjs/Shaders/line.fragment" {
  20069. /** @hidden */
  20070. export var linePixelShader: {
  20071. name: string;
  20072. shader: string;
  20073. };
  20074. }
  20075. declare module "babylonjs/Shaders/line.vertex" {
  20076. /** @hidden */
  20077. export var lineVertexShader: {
  20078. name: string;
  20079. shader: string;
  20080. };
  20081. }
  20082. declare module "babylonjs/Rendering/edgesRenderer" {
  20083. import { Nullable } from "babylonjs/types";
  20084. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  20085. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20086. import { Vector3 } from "babylonjs/Maths/math.vector";
  20087. import { IDisposable } from "babylonjs/scene";
  20088. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  20089. import "babylonjs/Shaders/line.fragment";
  20090. import "babylonjs/Shaders/line.vertex";
  20091. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  20092. module "babylonjs/Meshes/abstractMesh" {
  20093. interface AbstractMesh {
  20094. /**
  20095. * Gets the edgesRenderer associated with the mesh
  20096. */
  20097. edgesRenderer: Nullable<EdgesRenderer>;
  20098. }
  20099. }
  20100. module "babylonjs/Meshes/linesMesh" {
  20101. interface LinesMesh {
  20102. /**
  20103. * Enables the edge rendering mode on the mesh.
  20104. * This mode makes the mesh edges visible
  20105. * @param epsilon defines the maximal distance between two angles to detect a face
  20106. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  20107. * @returns the currentAbstractMesh
  20108. * @see https://www.babylonjs-playground.com/#19O9TU#0
  20109. */
  20110. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  20111. }
  20112. }
  20113. module "babylonjs/Meshes/linesMesh" {
  20114. interface InstancedLinesMesh {
  20115. /**
  20116. * Enables the edge rendering mode on the mesh.
  20117. * This mode makes the mesh edges visible
  20118. * @param epsilon defines the maximal distance between two angles to detect a face
  20119. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  20120. * @returns the current InstancedLinesMesh
  20121. * @see https://www.babylonjs-playground.com/#19O9TU#0
  20122. */
  20123. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  20124. }
  20125. }
  20126. /**
  20127. * Defines the minimum contract an Edges renderer should follow.
  20128. */
  20129. export interface IEdgesRenderer extends IDisposable {
  20130. /**
  20131. * Gets or sets a boolean indicating if the edgesRenderer is active
  20132. */
  20133. isEnabled: boolean;
  20134. /**
  20135. * Renders the edges of the attached mesh,
  20136. */
  20137. render(): void;
  20138. /**
  20139. * Checks wether or not the edges renderer is ready to render.
  20140. * @return true if ready, otherwise false.
  20141. */
  20142. isReady(): boolean;
  20143. }
  20144. /**
  20145. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  20146. */
  20147. export class EdgesRenderer implements IEdgesRenderer {
  20148. /**
  20149. * Define the size of the edges with an orthographic camera
  20150. */
  20151. edgesWidthScalerForOrthographic: number;
  20152. /**
  20153. * Define the size of the edges with a perspective camera
  20154. */
  20155. edgesWidthScalerForPerspective: number;
  20156. protected _source: AbstractMesh;
  20157. protected _linesPositions: number[];
  20158. protected _linesNormals: number[];
  20159. protected _linesIndices: number[];
  20160. protected _epsilon: number;
  20161. protected _indicesCount: number;
  20162. protected _lineShader: ShaderMaterial;
  20163. protected _ib: DataBuffer;
  20164. protected _buffers: {
  20165. [key: string]: Nullable<VertexBuffer>;
  20166. };
  20167. protected _checkVerticesInsteadOfIndices: boolean;
  20168. private _meshRebuildObserver;
  20169. private _meshDisposeObserver;
  20170. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  20171. isEnabled: boolean;
  20172. /**
  20173. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  20174. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  20175. * @param source Mesh used to create edges
  20176. * @param epsilon sum of angles in adjacency to check for edge
  20177. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  20178. * @param generateEdgesLines - should generate Lines or only prepare resources.
  20179. */
  20180. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  20181. protected _prepareRessources(): void;
  20182. /** @hidden */
  20183. _rebuild(): void;
  20184. /**
  20185. * Releases the required resources for the edges renderer
  20186. */
  20187. dispose(): void;
  20188. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  20189. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  20190. /**
  20191. * Checks if the pair of p0 and p1 is en edge
  20192. * @param faceIndex
  20193. * @param edge
  20194. * @param faceNormals
  20195. * @param p0
  20196. * @param p1
  20197. * @private
  20198. */
  20199. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  20200. /**
  20201. * push line into the position, normal and index buffer
  20202. * @protected
  20203. */
  20204. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  20205. /**
  20206. * Generates lines edges from adjacencjes
  20207. * @private
  20208. */
  20209. _generateEdgesLines(): void;
  20210. /**
  20211. * Checks wether or not the edges renderer is ready to render.
  20212. * @return true if ready, otherwise false.
  20213. */
  20214. isReady(): boolean;
  20215. /**
  20216. * Renders the edges of the attached mesh,
  20217. */
  20218. render(): void;
  20219. }
  20220. /**
  20221. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  20222. */
  20223. export class LineEdgesRenderer extends EdgesRenderer {
  20224. /**
  20225. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  20226. * @param source LineMesh used to generate edges
  20227. * @param epsilon not important (specified angle for edge detection)
  20228. * @param checkVerticesInsteadOfIndices not important for LineMesh
  20229. */
  20230. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  20231. /**
  20232. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  20233. */
  20234. _generateEdgesLines(): void;
  20235. }
  20236. }
  20237. declare module "babylonjs/Rendering/renderingGroup" {
  20238. import { SmartArray } from "babylonjs/Misc/smartArray";
  20239. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20240. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20241. import { Nullable } from "babylonjs/types";
  20242. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20243. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  20244. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20245. import { Material } from "babylonjs/Materials/material";
  20246. import { Scene } from "babylonjs/scene";
  20247. /**
  20248. * This represents the object necessary to create a rendering group.
  20249. * This is exclusively used and created by the rendering manager.
  20250. * To modify the behavior, you use the available helpers in your scene or meshes.
  20251. * @hidden
  20252. */
  20253. export class RenderingGroup {
  20254. index: number;
  20255. private static _zeroVector;
  20256. private _scene;
  20257. private _opaqueSubMeshes;
  20258. private _transparentSubMeshes;
  20259. private _alphaTestSubMeshes;
  20260. private _depthOnlySubMeshes;
  20261. private _particleSystems;
  20262. private _spriteManagers;
  20263. private _opaqueSortCompareFn;
  20264. private _alphaTestSortCompareFn;
  20265. private _transparentSortCompareFn;
  20266. private _renderOpaque;
  20267. private _renderAlphaTest;
  20268. private _renderTransparent;
  20269. /** @hidden */
  20270. _edgesRenderers: SmartArray<IEdgesRenderer>;
  20271. onBeforeTransparentRendering: () => void;
  20272. /**
  20273. * Set the opaque sort comparison function.
  20274. * If null the sub meshes will be render in the order they were created
  20275. */
  20276. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20277. /**
  20278. * Set the alpha test sort comparison function.
  20279. * If null the sub meshes will be render in the order they were created
  20280. */
  20281. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20282. /**
  20283. * Set the transparent sort comparison function.
  20284. * If null the sub meshes will be render in the order they were created
  20285. */
  20286. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20287. /**
  20288. * Creates a new rendering group.
  20289. * @param index The rendering group index
  20290. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  20291. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  20292. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  20293. */
  20294. constructor(index: number, scene: Scene, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>);
  20295. /**
  20296. * Render all the sub meshes contained in the group.
  20297. * @param customRenderFunction Used to override the default render behaviour of the group.
  20298. * @returns true if rendered some submeshes.
  20299. */
  20300. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  20301. /**
  20302. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  20303. * @param subMeshes The submeshes to render
  20304. */
  20305. private renderOpaqueSorted;
  20306. /**
  20307. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  20308. * @param subMeshes The submeshes to render
  20309. */
  20310. private renderAlphaTestSorted;
  20311. /**
  20312. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  20313. * @param subMeshes The submeshes to render
  20314. */
  20315. private renderTransparentSorted;
  20316. /**
  20317. * Renders the submeshes in a specified order.
  20318. * @param subMeshes The submeshes to sort before render
  20319. * @param sortCompareFn The comparison function use to sort
  20320. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  20321. * @param transparent Specifies to activate blending if true
  20322. */
  20323. private static renderSorted;
  20324. /**
  20325. * Renders the submeshes in the order they were dispatched (no sort applied).
  20326. * @param subMeshes The submeshes to render
  20327. */
  20328. private static renderUnsorted;
  20329. /**
  20330. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20331. * are rendered back to front if in the same alpha index.
  20332. *
  20333. * @param a The first submesh
  20334. * @param b The second submesh
  20335. * @returns The result of the comparison
  20336. */
  20337. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  20338. /**
  20339. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20340. * are rendered back to front.
  20341. *
  20342. * @param a The first submesh
  20343. * @param b The second submesh
  20344. * @returns The result of the comparison
  20345. */
  20346. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  20347. /**
  20348. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20349. * are rendered front to back (prevent overdraw).
  20350. *
  20351. * @param a The first submesh
  20352. * @param b The second submesh
  20353. * @returns The result of the comparison
  20354. */
  20355. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  20356. /**
  20357. * Resets the different lists of submeshes to prepare a new frame.
  20358. */
  20359. prepare(): void;
  20360. dispose(): void;
  20361. /**
  20362. * Inserts the submesh in its correct queue depending on its material.
  20363. * @param subMesh The submesh to dispatch
  20364. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20365. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20366. */
  20367. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20368. dispatchSprites(spriteManager: ISpriteManager): void;
  20369. dispatchParticles(particleSystem: IParticleSystem): void;
  20370. private _renderParticles;
  20371. private _renderSprites;
  20372. }
  20373. }
  20374. declare module "babylonjs/Rendering/renderingManager" {
  20375. import { Nullable } from "babylonjs/types";
  20376. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20377. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20378. import { SmartArray } from "babylonjs/Misc/smartArray";
  20379. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20380. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20381. import { Material } from "babylonjs/Materials/material";
  20382. import { Scene } from "babylonjs/scene";
  20383. import { Camera } from "babylonjs/Cameras/camera";
  20384. /**
  20385. * Interface describing the different options available in the rendering manager
  20386. * regarding Auto Clear between groups.
  20387. */
  20388. export interface IRenderingManagerAutoClearSetup {
  20389. /**
  20390. * Defines whether or not autoclear is enable.
  20391. */
  20392. autoClear: boolean;
  20393. /**
  20394. * Defines whether or not to autoclear the depth buffer.
  20395. */
  20396. depth: boolean;
  20397. /**
  20398. * Defines whether or not to autoclear the stencil buffer.
  20399. */
  20400. stencil: boolean;
  20401. }
  20402. /**
  20403. * This class is used by the onRenderingGroupObservable
  20404. */
  20405. export class RenderingGroupInfo {
  20406. /**
  20407. * The Scene that being rendered
  20408. */
  20409. scene: Scene;
  20410. /**
  20411. * The camera currently used for the rendering pass
  20412. */
  20413. camera: Nullable<Camera>;
  20414. /**
  20415. * The ID of the renderingGroup being processed
  20416. */
  20417. renderingGroupId: number;
  20418. }
  20419. /**
  20420. * This is the manager responsible of all the rendering for meshes sprites and particles.
  20421. * It is enable to manage the different groups as well as the different necessary sort functions.
  20422. * This should not be used directly aside of the few static configurations
  20423. */
  20424. export class RenderingManager {
  20425. /**
  20426. * The max id used for rendering groups (not included)
  20427. */
  20428. static MAX_RENDERINGGROUPS: number;
  20429. /**
  20430. * The min id used for rendering groups (included)
  20431. */
  20432. static MIN_RENDERINGGROUPS: number;
  20433. /**
  20434. * Used to globally prevent autoclearing scenes.
  20435. */
  20436. static AUTOCLEAR: boolean;
  20437. /**
  20438. * @hidden
  20439. */
  20440. _useSceneAutoClearSetup: boolean;
  20441. private _scene;
  20442. private _renderingGroups;
  20443. private _depthStencilBufferAlreadyCleaned;
  20444. private _autoClearDepthStencil;
  20445. private _customOpaqueSortCompareFn;
  20446. private _customAlphaTestSortCompareFn;
  20447. private _customTransparentSortCompareFn;
  20448. private _renderingGroupInfo;
  20449. /**
  20450. * Instantiates a new rendering group for a particular scene
  20451. * @param scene Defines the scene the groups belongs to
  20452. */
  20453. constructor(scene: Scene);
  20454. private _clearDepthStencilBuffer;
  20455. /**
  20456. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  20457. * @hidden
  20458. */
  20459. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  20460. /**
  20461. * Resets the different information of the group to prepare a new frame
  20462. * @hidden
  20463. */
  20464. reset(): void;
  20465. /**
  20466. * Dispose and release the group and its associated resources.
  20467. * @hidden
  20468. */
  20469. dispose(): void;
  20470. /**
  20471. * Clear the info related to rendering groups preventing retention points during dispose.
  20472. */
  20473. freeRenderingGroups(): void;
  20474. private _prepareRenderingGroup;
  20475. /**
  20476. * Add a sprite manager to the rendering manager in order to render it this frame.
  20477. * @param spriteManager Define the sprite manager to render
  20478. */
  20479. dispatchSprites(spriteManager: ISpriteManager): void;
  20480. /**
  20481. * Add a particle system to the rendering manager in order to render it this frame.
  20482. * @param particleSystem Define the particle system to render
  20483. */
  20484. dispatchParticles(particleSystem: IParticleSystem): void;
  20485. /**
  20486. * Add a submesh to the manager in order to render it this frame
  20487. * @param subMesh The submesh to dispatch
  20488. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20489. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20490. */
  20491. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20492. /**
  20493. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20494. * This allowed control for front to back rendering or reversly depending of the special needs.
  20495. *
  20496. * @param renderingGroupId The rendering group id corresponding to its index
  20497. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20498. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20499. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20500. */
  20501. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  20502. /**
  20503. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20504. *
  20505. * @param renderingGroupId The rendering group id corresponding to its index
  20506. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20507. * @param depth Automatically clears depth between groups if true and autoClear is true.
  20508. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  20509. */
  20510. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  20511. /**
  20512. * Gets the current auto clear configuration for one rendering group of the rendering
  20513. * manager.
  20514. * @param index the rendering group index to get the information for
  20515. * @returns The auto clear setup for the requested rendering group
  20516. */
  20517. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  20518. }
  20519. }
  20520. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  20521. import { Observable } from "babylonjs/Misc/observable";
  20522. import { SmartArray } from "babylonjs/Misc/smartArray";
  20523. import { Nullable } from "babylonjs/types";
  20524. import { Camera } from "babylonjs/Cameras/camera";
  20525. import { Scene } from "babylonjs/scene";
  20526. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20527. import { Color4 } from "babylonjs/Maths/math.color";
  20528. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  20529. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20530. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20531. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20532. import { Texture } from "babylonjs/Materials/Textures/texture";
  20533. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20534. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  20535. import "babylonjs/Engines/Extensions/engine.renderTarget";
  20536. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  20537. import { Engine } from "babylonjs/Engines/engine";
  20538. /**
  20539. * This Helps creating a texture that will be created from a camera in your scene.
  20540. * It is basically a dynamic texture that could be used to create special effects for instance.
  20541. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  20542. */
  20543. export class RenderTargetTexture extends Texture {
  20544. isCube: boolean;
  20545. /**
  20546. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  20547. */
  20548. static readonly REFRESHRATE_RENDER_ONCE: number;
  20549. /**
  20550. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  20551. */
  20552. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  20553. /**
  20554. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  20555. * the central point of your effect and can save a lot of performances.
  20556. */
  20557. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  20558. /**
  20559. * Use this predicate to dynamically define the list of mesh you want to render.
  20560. * If set, the renderList property will be overwritten.
  20561. */
  20562. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  20563. private _renderList;
  20564. /**
  20565. * Use this list to define the list of mesh you want to render.
  20566. */
  20567. renderList: Nullable<Array<AbstractMesh>>;
  20568. private _hookArray;
  20569. /**
  20570. * Define if particles should be rendered in your texture.
  20571. */
  20572. renderParticles: boolean;
  20573. /**
  20574. * Define if sprites should be rendered in your texture.
  20575. */
  20576. renderSprites: boolean;
  20577. /**
  20578. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  20579. */
  20580. coordinatesMode: number;
  20581. /**
  20582. * Define the camera used to render the texture.
  20583. */
  20584. activeCamera: Nullable<Camera>;
  20585. /**
  20586. * Override the render function of the texture with your own one.
  20587. */
  20588. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  20589. /**
  20590. * Define if camera post processes should be use while rendering the texture.
  20591. */
  20592. useCameraPostProcesses: boolean;
  20593. /**
  20594. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  20595. */
  20596. ignoreCameraViewport: boolean;
  20597. private _postProcessManager;
  20598. private _postProcesses;
  20599. private _resizeObserver;
  20600. /**
  20601. * An event triggered when the texture is unbind.
  20602. */
  20603. onBeforeBindObservable: Observable<RenderTargetTexture>;
  20604. /**
  20605. * An event triggered when the texture is unbind.
  20606. */
  20607. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  20608. private _onAfterUnbindObserver;
  20609. /**
  20610. * Set a after unbind callback in the texture.
  20611. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  20612. */
  20613. onAfterUnbind: () => void;
  20614. /**
  20615. * An event triggered before rendering the texture
  20616. */
  20617. onBeforeRenderObservable: Observable<number>;
  20618. private _onBeforeRenderObserver;
  20619. /**
  20620. * Set a before render callback in the texture.
  20621. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  20622. */
  20623. onBeforeRender: (faceIndex: number) => void;
  20624. /**
  20625. * An event triggered after rendering the texture
  20626. */
  20627. onAfterRenderObservable: Observable<number>;
  20628. private _onAfterRenderObserver;
  20629. /**
  20630. * Set a after render callback in the texture.
  20631. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  20632. */
  20633. onAfterRender: (faceIndex: number) => void;
  20634. /**
  20635. * An event triggered after the texture clear
  20636. */
  20637. onClearObservable: Observable<Engine>;
  20638. private _onClearObserver;
  20639. /**
  20640. * Set a clear callback in the texture.
  20641. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  20642. */
  20643. onClear: (Engine: Engine) => void;
  20644. /**
  20645. * An event triggered when the texture is resized.
  20646. */
  20647. onResizeObservable: Observable<RenderTargetTexture>;
  20648. /**
  20649. * Define the clear color of the Render Target if it should be different from the scene.
  20650. */
  20651. clearColor: Color4;
  20652. protected _size: number | {
  20653. width: number;
  20654. height: number;
  20655. };
  20656. protected _initialSizeParameter: number | {
  20657. width: number;
  20658. height: number;
  20659. } | {
  20660. ratio: number;
  20661. };
  20662. protected _sizeRatio: Nullable<number>;
  20663. /** @hidden */
  20664. _generateMipMaps: boolean;
  20665. protected _renderingManager: RenderingManager;
  20666. /** @hidden */
  20667. _waitingRenderList: string[];
  20668. protected _doNotChangeAspectRatio: boolean;
  20669. protected _currentRefreshId: number;
  20670. protected _refreshRate: number;
  20671. protected _textureMatrix: Matrix;
  20672. protected _samples: number;
  20673. protected _renderTargetOptions: RenderTargetCreationOptions;
  20674. /**
  20675. * Gets render target creation options that were used.
  20676. */
  20677. readonly renderTargetOptions: RenderTargetCreationOptions;
  20678. protected _engine: Engine;
  20679. protected _onRatioRescale(): void;
  20680. /**
  20681. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  20682. * It must define where the camera used to render the texture is set
  20683. */
  20684. boundingBoxPosition: Vector3;
  20685. private _boundingBoxSize;
  20686. /**
  20687. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  20688. * When defined, the cubemap will switch to local mode
  20689. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  20690. * @example https://www.babylonjs-playground.com/#RNASML
  20691. */
  20692. boundingBoxSize: Vector3;
  20693. /**
  20694. * In case the RTT has been created with a depth texture, get the associated
  20695. * depth texture.
  20696. * Otherwise, return null.
  20697. */
  20698. depthStencilTexture: Nullable<InternalTexture>;
  20699. /**
  20700. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  20701. * or used a shadow, depth texture...
  20702. * @param name The friendly name of the texture
  20703. * @param size The size of the RTT (number if square, or {width: number, height:number} or {ratio:} to define a ratio from the main scene)
  20704. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  20705. * @param generateMipMaps True if mip maps need to be generated after render.
  20706. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  20707. * @param type The type of the buffer in the RTT (int, half float, float...)
  20708. * @param isCube True if a cube texture needs to be created
  20709. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  20710. * @param generateDepthBuffer True to generate a depth buffer
  20711. * @param generateStencilBuffer True to generate a stencil buffer
  20712. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  20713. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  20714. * @param delayAllocation if the texture allocation should be delayed (default: false)
  20715. */
  20716. constructor(name: string, size: number | {
  20717. width: number;
  20718. height: number;
  20719. } | {
  20720. ratio: number;
  20721. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  20722. /**
  20723. * Creates a depth stencil texture.
  20724. * This is only available in WebGL 2 or with the depth texture extension available.
  20725. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  20726. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  20727. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  20728. */
  20729. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  20730. private _processSizeParameter;
  20731. /**
  20732. * Define the number of samples to use in case of MSAA.
  20733. * It defaults to one meaning no MSAA has been enabled.
  20734. */
  20735. samples: number;
  20736. /**
  20737. * Resets the refresh counter of the texture and start bak from scratch.
  20738. * Could be useful to regenerate the texture if it is setup to render only once.
  20739. */
  20740. resetRefreshCounter(): void;
  20741. /**
  20742. * Define the refresh rate of the texture or the rendering frequency.
  20743. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  20744. */
  20745. refreshRate: number;
  20746. /**
  20747. * Adds a post process to the render target rendering passes.
  20748. * @param postProcess define the post process to add
  20749. */
  20750. addPostProcess(postProcess: PostProcess): void;
  20751. /**
  20752. * Clear all the post processes attached to the render target
  20753. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  20754. */
  20755. clearPostProcesses(dispose?: boolean): void;
  20756. /**
  20757. * Remove one of the post process from the list of attached post processes to the texture
  20758. * @param postProcess define the post process to remove from the list
  20759. */
  20760. removePostProcess(postProcess: PostProcess): void;
  20761. /** @hidden */
  20762. _shouldRender(): boolean;
  20763. /**
  20764. * Gets the actual render size of the texture.
  20765. * @returns the width of the render size
  20766. */
  20767. getRenderSize(): number;
  20768. /**
  20769. * Gets the actual render width of the texture.
  20770. * @returns the width of the render size
  20771. */
  20772. getRenderWidth(): number;
  20773. /**
  20774. * Gets the actual render height of the texture.
  20775. * @returns the height of the render size
  20776. */
  20777. getRenderHeight(): number;
  20778. /**
  20779. * Get if the texture can be rescaled or not.
  20780. */
  20781. readonly canRescale: boolean;
  20782. /**
  20783. * Resize the texture using a ratio.
  20784. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  20785. */
  20786. scale(ratio: number): void;
  20787. /**
  20788. * Get the texture reflection matrix used to rotate/transform the reflection.
  20789. * @returns the reflection matrix
  20790. */
  20791. getReflectionTextureMatrix(): Matrix;
  20792. /**
  20793. * Resize the texture to a new desired size.
  20794. * Be carrefull as it will recreate all the data in the new texture.
  20795. * @param size Define the new size. It can be:
  20796. * - a number for squared texture,
  20797. * - an object containing { width: number, height: number }
  20798. * - or an object containing a ratio { ratio: number }
  20799. */
  20800. resize(size: number | {
  20801. width: number;
  20802. height: number;
  20803. } | {
  20804. ratio: number;
  20805. }): void;
  20806. /**
  20807. * Renders all the objects from the render list into the texture.
  20808. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  20809. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  20810. */
  20811. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  20812. private _bestReflectionRenderTargetDimension;
  20813. /**
  20814. * @hidden
  20815. * @param faceIndex face index to bind to if this is a cubetexture
  20816. */
  20817. _bindFrameBuffer(faceIndex?: number): void;
  20818. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  20819. private renderToTarget;
  20820. /**
  20821. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20822. * This allowed control for front to back rendering or reversly depending of the special needs.
  20823. *
  20824. * @param renderingGroupId The rendering group id corresponding to its index
  20825. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20826. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20827. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20828. */
  20829. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  20830. /**
  20831. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20832. *
  20833. * @param renderingGroupId The rendering group id corresponding to its index
  20834. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20835. */
  20836. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  20837. /**
  20838. * Clones the texture.
  20839. * @returns the cloned texture
  20840. */
  20841. clone(): RenderTargetTexture;
  20842. /**
  20843. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  20844. * @returns The JSON representation of the texture
  20845. */
  20846. serialize(): any;
  20847. /**
  20848. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  20849. */
  20850. disposeFramebufferObjects(): void;
  20851. /**
  20852. * Dispose the texture and release its associated resources.
  20853. */
  20854. dispose(): void;
  20855. /** @hidden */
  20856. _rebuild(): void;
  20857. /**
  20858. * Clear the info related to rendering groups preventing retention point in material dispose.
  20859. */
  20860. freeRenderingGroups(): void;
  20861. /**
  20862. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20863. * @returns the view count
  20864. */
  20865. getViewCount(): number;
  20866. }
  20867. }
  20868. declare module "babylonjs/Materials/material" {
  20869. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  20870. import { SmartArray } from "babylonjs/Misc/smartArray";
  20871. import { Observable } from "babylonjs/Misc/observable";
  20872. import { Nullable } from "babylonjs/types";
  20873. import { Scene } from "babylonjs/scene";
  20874. import { Matrix } from "babylonjs/Maths/math.vector";
  20875. import { BaseSubMesh, SubMesh } from "babylonjs/Meshes/subMesh";
  20876. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20877. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20878. import { Effect } from "babylonjs/Materials/effect";
  20879. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20880. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20881. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20882. import { IInspectable } from "babylonjs/Misc/iInspectable";
  20883. import { Mesh } from "babylonjs/Meshes/mesh";
  20884. import { Animation } from "babylonjs/Animations/animation";
  20885. /**
  20886. * Options for compiling materials.
  20887. */
  20888. export interface IMaterialCompilationOptions {
  20889. /**
  20890. * Defines whether clip planes are enabled.
  20891. */
  20892. clipPlane: boolean;
  20893. /**
  20894. * Defines whether instances are enabled.
  20895. */
  20896. useInstances: boolean;
  20897. }
  20898. /**
  20899. * Base class for the main features of a material in Babylon.js
  20900. */
  20901. export class Material implements IAnimatable {
  20902. /**
  20903. * Returns the triangle fill mode
  20904. */
  20905. static readonly TriangleFillMode: number;
  20906. /**
  20907. * Returns the wireframe mode
  20908. */
  20909. static readonly WireFrameFillMode: number;
  20910. /**
  20911. * Returns the point fill mode
  20912. */
  20913. static readonly PointFillMode: number;
  20914. /**
  20915. * Returns the point list draw mode
  20916. */
  20917. static readonly PointListDrawMode: number;
  20918. /**
  20919. * Returns the line list draw mode
  20920. */
  20921. static readonly LineListDrawMode: number;
  20922. /**
  20923. * Returns the line loop draw mode
  20924. */
  20925. static readonly LineLoopDrawMode: number;
  20926. /**
  20927. * Returns the line strip draw mode
  20928. */
  20929. static readonly LineStripDrawMode: number;
  20930. /**
  20931. * Returns the triangle strip draw mode
  20932. */
  20933. static readonly TriangleStripDrawMode: number;
  20934. /**
  20935. * Returns the triangle fan draw mode
  20936. */
  20937. static readonly TriangleFanDrawMode: number;
  20938. /**
  20939. * Stores the clock-wise side orientation
  20940. */
  20941. static readonly ClockWiseSideOrientation: number;
  20942. /**
  20943. * Stores the counter clock-wise side orientation
  20944. */
  20945. static readonly CounterClockWiseSideOrientation: number;
  20946. /**
  20947. * The dirty texture flag value
  20948. */
  20949. static readonly TextureDirtyFlag: number;
  20950. /**
  20951. * The dirty light flag value
  20952. */
  20953. static readonly LightDirtyFlag: number;
  20954. /**
  20955. * The dirty fresnel flag value
  20956. */
  20957. static readonly FresnelDirtyFlag: number;
  20958. /**
  20959. * The dirty attribute flag value
  20960. */
  20961. static readonly AttributesDirtyFlag: number;
  20962. /**
  20963. * The dirty misc flag value
  20964. */
  20965. static readonly MiscDirtyFlag: number;
  20966. /**
  20967. * The all dirty flag value
  20968. */
  20969. static readonly AllDirtyFlag: number;
  20970. /**
  20971. * The ID of the material
  20972. */
  20973. id: string;
  20974. /**
  20975. * Gets or sets the unique id of the material
  20976. */
  20977. uniqueId: number;
  20978. /**
  20979. * The name of the material
  20980. */
  20981. name: string;
  20982. /**
  20983. * Gets or sets user defined metadata
  20984. */
  20985. metadata: any;
  20986. /**
  20987. * For internal use only. Please do not use.
  20988. */
  20989. reservedDataStore: any;
  20990. /**
  20991. * Specifies if the ready state should be checked on each call
  20992. */
  20993. checkReadyOnEveryCall: boolean;
  20994. /**
  20995. * Specifies if the ready state should be checked once
  20996. */
  20997. checkReadyOnlyOnce: boolean;
  20998. /**
  20999. * The state of the material
  21000. */
  21001. state: string;
  21002. /**
  21003. * The alpha value of the material
  21004. */
  21005. protected _alpha: number;
  21006. /**
  21007. * List of inspectable custom properties (used by the Inspector)
  21008. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  21009. */
  21010. inspectableCustomProperties: IInspectable[];
  21011. /**
  21012. * Sets the alpha value of the material
  21013. */
  21014. /**
  21015. * Gets the alpha value of the material
  21016. */
  21017. alpha: number;
  21018. /**
  21019. * Specifies if back face culling is enabled
  21020. */
  21021. protected _backFaceCulling: boolean;
  21022. /**
  21023. * Sets the back-face culling state
  21024. */
  21025. /**
  21026. * Gets the back-face culling state
  21027. */
  21028. backFaceCulling: boolean;
  21029. /**
  21030. * Stores the value for side orientation
  21031. */
  21032. sideOrientation: number;
  21033. /**
  21034. * Callback triggered when the material is compiled
  21035. */
  21036. onCompiled: Nullable<(effect: Effect) => void>;
  21037. /**
  21038. * Callback triggered when an error occurs
  21039. */
  21040. onError: Nullable<(effect: Effect, errors: string) => void>;
  21041. /**
  21042. * Callback triggered to get the render target textures
  21043. */
  21044. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  21045. /**
  21046. * Gets a boolean indicating that current material needs to register RTT
  21047. */
  21048. readonly hasRenderTargetTextures: boolean;
  21049. /**
  21050. * Specifies if the material should be serialized
  21051. */
  21052. doNotSerialize: boolean;
  21053. /**
  21054. * @hidden
  21055. */
  21056. _storeEffectOnSubMeshes: boolean;
  21057. /**
  21058. * Stores the animations for the material
  21059. */
  21060. animations: Nullable<Array<Animation>>;
  21061. /**
  21062. * An event triggered when the material is disposed
  21063. */
  21064. onDisposeObservable: Observable<Material>;
  21065. /**
  21066. * An observer which watches for dispose events
  21067. */
  21068. private _onDisposeObserver;
  21069. private _onUnBindObservable;
  21070. /**
  21071. * Called during a dispose event
  21072. */
  21073. onDispose: () => void;
  21074. private _onBindObservable;
  21075. /**
  21076. * An event triggered when the material is bound
  21077. */
  21078. readonly onBindObservable: Observable<AbstractMesh>;
  21079. /**
  21080. * An observer which watches for bind events
  21081. */
  21082. private _onBindObserver;
  21083. /**
  21084. * Called during a bind event
  21085. */
  21086. onBind: (Mesh: AbstractMesh) => void;
  21087. /**
  21088. * An event triggered when the material is unbound
  21089. */
  21090. readonly onUnBindObservable: Observable<Material>;
  21091. /**
  21092. * Stores the value of the alpha mode
  21093. */
  21094. private _alphaMode;
  21095. /**
  21096. * Sets the value of the alpha mode.
  21097. *
  21098. * | Value | Type | Description |
  21099. * | --- | --- | --- |
  21100. * | 0 | ALPHA_DISABLE | |
  21101. * | 1 | ALPHA_ADD | |
  21102. * | 2 | ALPHA_COMBINE | |
  21103. * | 3 | ALPHA_SUBTRACT | |
  21104. * | 4 | ALPHA_MULTIPLY | |
  21105. * | 5 | ALPHA_MAXIMIZED | |
  21106. * | 6 | ALPHA_ONEONE | |
  21107. * | 7 | ALPHA_PREMULTIPLIED | |
  21108. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  21109. * | 9 | ALPHA_INTERPOLATE | |
  21110. * | 10 | ALPHA_SCREENMODE | |
  21111. *
  21112. */
  21113. /**
  21114. * Gets the value of the alpha mode
  21115. */
  21116. alphaMode: number;
  21117. /**
  21118. * Stores the state of the need depth pre-pass value
  21119. */
  21120. private _needDepthPrePass;
  21121. /**
  21122. * Sets the need depth pre-pass value
  21123. */
  21124. /**
  21125. * Gets the depth pre-pass value
  21126. */
  21127. needDepthPrePass: boolean;
  21128. /**
  21129. * Specifies if depth writing should be disabled
  21130. */
  21131. disableDepthWrite: boolean;
  21132. /**
  21133. * Specifies if depth writing should be forced
  21134. */
  21135. forceDepthWrite: boolean;
  21136. /**
  21137. * Specifies if there should be a separate pass for culling
  21138. */
  21139. separateCullingPass: boolean;
  21140. /**
  21141. * Stores the state specifing if fog should be enabled
  21142. */
  21143. private _fogEnabled;
  21144. /**
  21145. * Sets the state for enabling fog
  21146. */
  21147. /**
  21148. * Gets the value of the fog enabled state
  21149. */
  21150. fogEnabled: boolean;
  21151. /**
  21152. * Stores the size of points
  21153. */
  21154. pointSize: number;
  21155. /**
  21156. * Stores the z offset value
  21157. */
  21158. zOffset: number;
  21159. /**
  21160. * Gets a value specifying if wireframe mode is enabled
  21161. */
  21162. /**
  21163. * Sets the state of wireframe mode
  21164. */
  21165. wireframe: boolean;
  21166. /**
  21167. * Gets the value specifying if point clouds are enabled
  21168. */
  21169. /**
  21170. * Sets the state of point cloud mode
  21171. */
  21172. pointsCloud: boolean;
  21173. /**
  21174. * Gets the material fill mode
  21175. */
  21176. /**
  21177. * Sets the material fill mode
  21178. */
  21179. fillMode: number;
  21180. /**
  21181. * @hidden
  21182. * Stores the effects for the material
  21183. */
  21184. _effect: Nullable<Effect>;
  21185. /**
  21186. * @hidden
  21187. * Specifies if the material was previously ready
  21188. */
  21189. _wasPreviouslyReady: boolean;
  21190. /**
  21191. * Specifies if uniform buffers should be used
  21192. */
  21193. private _useUBO;
  21194. /**
  21195. * Stores a reference to the scene
  21196. */
  21197. private _scene;
  21198. /**
  21199. * Stores the fill mode state
  21200. */
  21201. private _fillMode;
  21202. /**
  21203. * Specifies if the depth write state should be cached
  21204. */
  21205. private _cachedDepthWriteState;
  21206. /**
  21207. * Stores the uniform buffer
  21208. */
  21209. protected _uniformBuffer: UniformBuffer;
  21210. /** @hidden */
  21211. _indexInSceneMaterialArray: number;
  21212. /** @hidden */
  21213. meshMap: Nullable<{
  21214. [id: string]: AbstractMesh | undefined;
  21215. }>;
  21216. /**
  21217. * Creates a material instance
  21218. * @param name defines the name of the material
  21219. * @param scene defines the scene to reference
  21220. * @param doNotAdd specifies if the material should be added to the scene
  21221. */
  21222. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  21223. /**
  21224. * Returns a string representation of the current material
  21225. * @param fullDetails defines a boolean indicating which levels of logging is desired
  21226. * @returns a string with material information
  21227. */
  21228. toString(fullDetails?: boolean): string;
  21229. /**
  21230. * Gets the class name of the material
  21231. * @returns a string with the class name of the material
  21232. */
  21233. getClassName(): string;
  21234. /**
  21235. * Specifies if updates for the material been locked
  21236. */
  21237. readonly isFrozen: boolean;
  21238. /**
  21239. * Locks updates for the material
  21240. */
  21241. freeze(): void;
  21242. /**
  21243. * Unlocks updates for the material
  21244. */
  21245. unfreeze(): void;
  21246. /**
  21247. * Specifies if the material is ready to be used
  21248. * @param mesh defines the mesh to check
  21249. * @param useInstances specifies if instances should be used
  21250. * @returns a boolean indicating if the material is ready to be used
  21251. */
  21252. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  21253. /**
  21254. * Specifies that the submesh is ready to be used
  21255. * @param mesh defines the mesh to check
  21256. * @param subMesh defines which submesh to check
  21257. * @param useInstances specifies that instances should be used
  21258. * @returns a boolean indicating that the submesh is ready or not
  21259. */
  21260. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21261. /**
  21262. * Returns the material effect
  21263. * @returns the effect associated with the material
  21264. */
  21265. getEffect(): Nullable<Effect>;
  21266. /**
  21267. * Returns the current scene
  21268. * @returns a Scene
  21269. */
  21270. getScene(): Scene;
  21271. /**
  21272. * Specifies if the material will require alpha blending
  21273. * @returns a boolean specifying if alpha blending is needed
  21274. */
  21275. needAlphaBlending(): boolean;
  21276. /**
  21277. * Specifies if the mesh will require alpha blending
  21278. * @param mesh defines the mesh to check
  21279. * @returns a boolean specifying if alpha blending is needed for the mesh
  21280. */
  21281. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  21282. /**
  21283. * Specifies if this material should be rendered in alpha test mode
  21284. * @returns a boolean specifying if an alpha test is needed.
  21285. */
  21286. needAlphaTesting(): boolean;
  21287. /**
  21288. * Gets the texture used for the alpha test
  21289. * @returns the texture to use for alpha testing
  21290. */
  21291. getAlphaTestTexture(): Nullable<BaseTexture>;
  21292. /**
  21293. * Marks the material to indicate that it needs to be re-calculated
  21294. */
  21295. markDirty(): void;
  21296. /** @hidden */
  21297. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  21298. /**
  21299. * Binds the material to the mesh
  21300. * @param world defines the world transformation matrix
  21301. * @param mesh defines the mesh to bind the material to
  21302. */
  21303. bind(world: Matrix, mesh?: Mesh): void;
  21304. /**
  21305. * Binds the submesh to the material
  21306. * @param world defines the world transformation matrix
  21307. * @param mesh defines the mesh containing the submesh
  21308. * @param subMesh defines the submesh to bind the material to
  21309. */
  21310. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  21311. /**
  21312. * Binds the world matrix to the material
  21313. * @param world defines the world transformation matrix
  21314. */
  21315. bindOnlyWorldMatrix(world: Matrix): void;
  21316. /**
  21317. * Binds the scene's uniform buffer to the effect.
  21318. * @param effect defines the effect to bind to the scene uniform buffer
  21319. * @param sceneUbo defines the uniform buffer storing scene data
  21320. */
  21321. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  21322. /**
  21323. * Binds the view matrix to the effect
  21324. * @param effect defines the effect to bind the view matrix to
  21325. */
  21326. bindView(effect: Effect): void;
  21327. /**
  21328. * Binds the view projection matrix to the effect
  21329. * @param effect defines the effect to bind the view projection matrix to
  21330. */
  21331. bindViewProjection(effect: Effect): void;
  21332. /**
  21333. * Specifies if material alpha testing should be turned on for the mesh
  21334. * @param mesh defines the mesh to check
  21335. */
  21336. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  21337. /**
  21338. * Processes to execute after binding the material to a mesh
  21339. * @param mesh defines the rendered mesh
  21340. */
  21341. protected _afterBind(mesh?: Mesh): void;
  21342. /**
  21343. * Unbinds the material from the mesh
  21344. */
  21345. unbind(): void;
  21346. /**
  21347. * Gets the active textures from the material
  21348. * @returns an array of textures
  21349. */
  21350. getActiveTextures(): BaseTexture[];
  21351. /**
  21352. * Specifies if the material uses a texture
  21353. * @param texture defines the texture to check against the material
  21354. * @returns a boolean specifying if the material uses the texture
  21355. */
  21356. hasTexture(texture: BaseTexture): boolean;
  21357. /**
  21358. * Makes a duplicate of the material, and gives it a new name
  21359. * @param name defines the new name for the duplicated material
  21360. * @returns the cloned material
  21361. */
  21362. clone(name: string): Nullable<Material>;
  21363. /**
  21364. * Gets the meshes bound to the material
  21365. * @returns an array of meshes bound to the material
  21366. */
  21367. getBindedMeshes(): AbstractMesh[];
  21368. /**
  21369. * Force shader compilation
  21370. * @param mesh defines the mesh associated with this material
  21371. * @param onCompiled defines a function to execute once the material is compiled
  21372. * @param options defines the options to configure the compilation
  21373. * @param onError defines a function to execute if the material fails compiling
  21374. */
  21375. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  21376. /**
  21377. * Force shader compilation
  21378. * @param mesh defines the mesh that will use this material
  21379. * @param options defines additional options for compiling the shaders
  21380. * @returns a promise that resolves when the compilation completes
  21381. */
  21382. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  21383. private static readonly _AllDirtyCallBack;
  21384. private static readonly _ImageProcessingDirtyCallBack;
  21385. private static readonly _TextureDirtyCallBack;
  21386. private static readonly _FresnelDirtyCallBack;
  21387. private static readonly _MiscDirtyCallBack;
  21388. private static readonly _LightsDirtyCallBack;
  21389. private static readonly _AttributeDirtyCallBack;
  21390. private static _FresnelAndMiscDirtyCallBack;
  21391. private static _TextureAndMiscDirtyCallBack;
  21392. private static readonly _DirtyCallbackArray;
  21393. private static readonly _RunDirtyCallBacks;
  21394. /**
  21395. * Marks a define in the material to indicate that it needs to be re-computed
  21396. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  21397. */
  21398. markAsDirty(flag: number): void;
  21399. /**
  21400. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  21401. * @param func defines a function which checks material defines against the submeshes
  21402. */
  21403. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  21404. /**
  21405. * Indicates that we need to re-calculated for all submeshes
  21406. */
  21407. protected _markAllSubMeshesAsAllDirty(): void;
  21408. /**
  21409. * Indicates that image processing needs to be re-calculated for all submeshes
  21410. */
  21411. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  21412. /**
  21413. * Indicates that textures need to be re-calculated for all submeshes
  21414. */
  21415. protected _markAllSubMeshesAsTexturesDirty(): void;
  21416. /**
  21417. * Indicates that fresnel needs to be re-calculated for all submeshes
  21418. */
  21419. protected _markAllSubMeshesAsFresnelDirty(): void;
  21420. /**
  21421. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  21422. */
  21423. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  21424. /**
  21425. * Indicates that lights need to be re-calculated for all submeshes
  21426. */
  21427. protected _markAllSubMeshesAsLightsDirty(): void;
  21428. /**
  21429. * Indicates that attributes need to be re-calculated for all submeshes
  21430. */
  21431. protected _markAllSubMeshesAsAttributesDirty(): void;
  21432. /**
  21433. * Indicates that misc needs to be re-calculated for all submeshes
  21434. */
  21435. protected _markAllSubMeshesAsMiscDirty(): void;
  21436. /**
  21437. * Indicates that textures and misc need to be re-calculated for all submeshes
  21438. */
  21439. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  21440. /**
  21441. * Disposes the material
  21442. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  21443. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  21444. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  21445. */
  21446. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  21447. /** @hidden */
  21448. private releaseVertexArrayObject;
  21449. /**
  21450. * Serializes this material
  21451. * @returns the serialized material object
  21452. */
  21453. serialize(): any;
  21454. /**
  21455. * Creates a material from parsed material data
  21456. * @param parsedMaterial defines parsed material data
  21457. * @param scene defines the hosting scene
  21458. * @param rootUrl defines the root URL to use to load textures
  21459. * @returns a new material
  21460. */
  21461. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  21462. }
  21463. }
  21464. declare module "babylonjs/Materials/multiMaterial" {
  21465. import { Nullable } from "babylonjs/types";
  21466. import { Scene } from "babylonjs/scene";
  21467. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21468. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  21469. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21470. import { Material } from "babylonjs/Materials/material";
  21471. /**
  21472. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21473. * separate meshes. This can be use to improve performances.
  21474. * @see http://doc.babylonjs.com/how_to/multi_materials
  21475. */
  21476. export class MultiMaterial extends Material {
  21477. private _subMaterials;
  21478. /**
  21479. * Gets or Sets the list of Materials used within the multi material.
  21480. * They need to be ordered according to the submeshes order in the associated mesh
  21481. */
  21482. subMaterials: Nullable<Material>[];
  21483. /**
  21484. * Function used to align with Node.getChildren()
  21485. * @returns the list of Materials used within the multi material
  21486. */
  21487. getChildren(): Nullable<Material>[];
  21488. /**
  21489. * Instantiates a new Multi Material
  21490. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21491. * separate meshes. This can be use to improve performances.
  21492. * @see http://doc.babylonjs.com/how_to/multi_materials
  21493. * @param name Define the name in the scene
  21494. * @param scene Define the scene the material belongs to
  21495. */
  21496. constructor(name: string, scene: Scene);
  21497. private _hookArray;
  21498. /**
  21499. * Get one of the submaterial by its index in the submaterials array
  21500. * @param index The index to look the sub material at
  21501. * @returns The Material if the index has been defined
  21502. */
  21503. getSubMaterial(index: number): Nullable<Material>;
  21504. /**
  21505. * Get the list of active textures for the whole sub materials list.
  21506. * @returns All the textures that will be used during the rendering
  21507. */
  21508. getActiveTextures(): BaseTexture[];
  21509. /**
  21510. * Gets the current class name of the material e.g. "MultiMaterial"
  21511. * Mainly use in serialization.
  21512. * @returns the class name
  21513. */
  21514. getClassName(): string;
  21515. /**
  21516. * Checks if the material is ready to render the requested sub mesh
  21517. * @param mesh Define the mesh the submesh belongs to
  21518. * @param subMesh Define the sub mesh to look readyness for
  21519. * @param useInstances Define whether or not the material is used with instances
  21520. * @returns true if ready, otherwise false
  21521. */
  21522. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21523. /**
  21524. * Clones the current material and its related sub materials
  21525. * @param name Define the name of the newly cloned material
  21526. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  21527. * @returns the cloned material
  21528. */
  21529. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  21530. /**
  21531. * Serializes the materials into a JSON representation.
  21532. * @returns the JSON representation
  21533. */
  21534. serialize(): any;
  21535. /**
  21536. * Dispose the material and release its associated resources
  21537. * @param forceDisposeEffect Define if we want to force disposing the associated effect (if false the shader is not released and could be reuse later on)
  21538. * @param forceDisposeTextures Define if we want to force disposing the associated textures (if false, they will not be disposed and can still be use elsewhere in the app)
  21539. * @param forceDisposeChildren Define if we want to force disposing the associated submaterials (if false, they will not be disposed and can still be use elsewhere in the app)
  21540. */
  21541. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  21542. /**
  21543. * Creates a MultiMaterial from parsed MultiMaterial data.
  21544. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  21545. * @param scene defines the hosting scene
  21546. * @returns a new MultiMaterial
  21547. */
  21548. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  21549. }
  21550. }
  21551. declare module "babylonjs/Meshes/subMesh" {
  21552. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  21553. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  21554. import { Engine } from "babylonjs/Engines/engine";
  21555. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  21556. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21557. import { Effect } from "babylonjs/Materials/effect";
  21558. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21559. import { Plane } from "babylonjs/Maths/math.plane";
  21560. import { Collider } from "babylonjs/Collisions/collider";
  21561. import { Material } from "babylonjs/Materials/material";
  21562. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  21563. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21564. import { Mesh } from "babylonjs/Meshes/mesh";
  21565. import { Ray } from "babylonjs/Culling/ray";
  21566. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  21567. /**
  21568. * Base class for submeshes
  21569. */
  21570. export class BaseSubMesh {
  21571. /** @hidden */
  21572. _materialDefines: Nullable<MaterialDefines>;
  21573. /** @hidden */
  21574. _materialEffect: Nullable<Effect>;
  21575. /**
  21576. * Gets associated effect
  21577. */
  21578. readonly effect: Nullable<Effect>;
  21579. /**
  21580. * Sets associated effect (effect used to render this submesh)
  21581. * @param effect defines the effect to associate with
  21582. * @param defines defines the set of defines used to compile this effect
  21583. */
  21584. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  21585. }
  21586. /**
  21587. * Defines a subdivision inside a mesh
  21588. */
  21589. export class SubMesh extends BaseSubMesh implements ICullable {
  21590. /** the material index to use */
  21591. materialIndex: number;
  21592. /** vertex index start */
  21593. verticesStart: number;
  21594. /** vertices count */
  21595. verticesCount: number;
  21596. /** index start */
  21597. indexStart: number;
  21598. /** indices count */
  21599. indexCount: number;
  21600. /** @hidden */
  21601. _linesIndexCount: number;
  21602. private _mesh;
  21603. private _renderingMesh;
  21604. private _boundingInfo;
  21605. private _linesIndexBuffer;
  21606. /** @hidden */
  21607. _lastColliderWorldVertices: Nullable<Vector3[]>;
  21608. /** @hidden */
  21609. _trianglePlanes: Plane[];
  21610. /** @hidden */
  21611. _lastColliderTransformMatrix: Nullable<Matrix>;
  21612. /** @hidden */
  21613. _renderId: number;
  21614. /** @hidden */
  21615. _alphaIndex: number;
  21616. /** @hidden */
  21617. _distanceToCamera: number;
  21618. /** @hidden */
  21619. _id: number;
  21620. private _currentMaterial;
  21621. /**
  21622. * Add a new submesh to a mesh
  21623. * @param materialIndex defines the material index to use
  21624. * @param verticesStart defines vertex index start
  21625. * @param verticesCount defines vertices count
  21626. * @param indexStart defines index start
  21627. * @param indexCount defines indices count
  21628. * @param mesh defines the parent mesh
  21629. * @param renderingMesh defines an optional rendering mesh
  21630. * @param createBoundingBox defines if bounding box should be created for this submesh
  21631. * @returns the new submesh
  21632. */
  21633. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  21634. /**
  21635. * Creates a new submesh
  21636. * @param materialIndex defines the material index to use
  21637. * @param verticesStart defines vertex index start
  21638. * @param verticesCount defines vertices count
  21639. * @param indexStart defines index start
  21640. * @param indexCount defines indices count
  21641. * @param mesh defines the parent mesh
  21642. * @param renderingMesh defines an optional rendering mesh
  21643. * @param createBoundingBox defines if bounding box should be created for this submesh
  21644. */
  21645. constructor(
  21646. /** the material index to use */
  21647. materialIndex: number,
  21648. /** vertex index start */
  21649. verticesStart: number,
  21650. /** vertices count */
  21651. verticesCount: number,
  21652. /** index start */
  21653. indexStart: number,
  21654. /** indices count */
  21655. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  21656. /**
  21657. * Returns true if this submesh covers the entire parent mesh
  21658. * @ignorenaming
  21659. */
  21660. readonly IsGlobal: boolean;
  21661. /**
  21662. * Returns the submesh BoudingInfo object
  21663. * @returns current bounding info (or mesh's one if the submesh is global)
  21664. */
  21665. getBoundingInfo(): BoundingInfo;
  21666. /**
  21667. * Sets the submesh BoundingInfo
  21668. * @param boundingInfo defines the new bounding info to use
  21669. * @returns the SubMesh
  21670. */
  21671. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  21672. /**
  21673. * Returns the mesh of the current submesh
  21674. * @return the parent mesh
  21675. */
  21676. getMesh(): AbstractMesh;
  21677. /**
  21678. * Returns the rendering mesh of the submesh
  21679. * @returns the rendering mesh (could be different from parent mesh)
  21680. */
  21681. getRenderingMesh(): Mesh;
  21682. /**
  21683. * Returns the submesh material
  21684. * @returns null or the current material
  21685. */
  21686. getMaterial(): Nullable<Material>;
  21687. /**
  21688. * Sets a new updated BoundingInfo object to the submesh
  21689. * @param data defines an optional position array to use to determine the bounding info
  21690. * @returns the SubMesh
  21691. */
  21692. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  21693. /** @hidden */
  21694. _checkCollision(collider: Collider): boolean;
  21695. /**
  21696. * Updates the submesh BoundingInfo
  21697. * @param world defines the world matrix to use to update the bounding info
  21698. * @returns the submesh
  21699. */
  21700. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  21701. /**
  21702. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  21703. * @param frustumPlanes defines the frustum planes
  21704. * @returns true if the submesh is intersecting with the frustum
  21705. */
  21706. isInFrustum(frustumPlanes: Plane[]): boolean;
  21707. /**
  21708. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  21709. * @param frustumPlanes defines the frustum planes
  21710. * @returns true if the submesh is inside the frustum
  21711. */
  21712. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  21713. /**
  21714. * Renders the submesh
  21715. * @param enableAlphaMode defines if alpha needs to be used
  21716. * @returns the submesh
  21717. */
  21718. render(enableAlphaMode: boolean): SubMesh;
  21719. /**
  21720. * @hidden
  21721. */
  21722. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  21723. /**
  21724. * Checks if the submesh intersects with a ray
  21725. * @param ray defines the ray to test
  21726. * @returns true is the passed ray intersects the submesh bounding box
  21727. */
  21728. canIntersects(ray: Ray): boolean;
  21729. /**
  21730. * Intersects current submesh with a ray
  21731. * @param ray defines the ray to test
  21732. * @param positions defines mesh's positions array
  21733. * @param indices defines mesh's indices array
  21734. * @param fastCheck defines if only bounding info should be used
  21735. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  21736. * @returns intersection info or null if no intersection
  21737. */
  21738. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  21739. /** @hidden */
  21740. private _intersectLines;
  21741. /** @hidden */
  21742. private _intersectUnIndexedLines;
  21743. /** @hidden */
  21744. private _intersectTriangles;
  21745. /** @hidden */
  21746. private _intersectUnIndexedTriangles;
  21747. /** @hidden */
  21748. _rebuild(): void;
  21749. /**
  21750. * Creates a new submesh from the passed mesh
  21751. * @param newMesh defines the new hosting mesh
  21752. * @param newRenderingMesh defines an optional rendering mesh
  21753. * @returns the new submesh
  21754. */
  21755. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  21756. /**
  21757. * Release associated resources
  21758. */
  21759. dispose(): void;
  21760. /**
  21761. * Gets the class name
  21762. * @returns the string "SubMesh".
  21763. */
  21764. getClassName(): string;
  21765. /**
  21766. * Creates a new submesh from indices data
  21767. * @param materialIndex the index of the main mesh material
  21768. * @param startIndex the index where to start the copy in the mesh indices array
  21769. * @param indexCount the number of indices to copy then from the startIndex
  21770. * @param mesh the main mesh to create the submesh from
  21771. * @param renderingMesh the optional rendering mesh
  21772. * @returns a new submesh
  21773. */
  21774. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  21775. }
  21776. }
  21777. declare module "babylonjs/Loading/sceneLoaderFlags" {
  21778. /**
  21779. * Class used to represent data loading progression
  21780. */
  21781. export class SceneLoaderFlags {
  21782. private static _ForceFullSceneLoadingForIncremental;
  21783. private static _ShowLoadingScreen;
  21784. private static _CleanBoneMatrixWeights;
  21785. private static _loggingLevel;
  21786. /**
  21787. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  21788. */
  21789. static ForceFullSceneLoadingForIncremental: boolean;
  21790. /**
  21791. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  21792. */
  21793. static ShowLoadingScreen: boolean;
  21794. /**
  21795. * Defines the current logging level (while loading the scene)
  21796. * @ignorenaming
  21797. */
  21798. static loggingLevel: number;
  21799. /**
  21800. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  21801. */
  21802. static CleanBoneMatrixWeights: boolean;
  21803. }
  21804. }
  21805. declare module "babylonjs/Meshes/geometry" {
  21806. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  21807. import { Scene } from "babylonjs/scene";
  21808. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  21809. import { Engine } from "babylonjs/Engines/engine";
  21810. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  21811. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  21812. import { Effect } from "babylonjs/Materials/effect";
  21813. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21814. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21815. import { Mesh } from "babylonjs/Meshes/mesh";
  21816. /**
  21817. * Class used to store geometry data (vertex buffers + index buffer)
  21818. */
  21819. export class Geometry implements IGetSetVerticesData {
  21820. /**
  21821. * Gets or sets the ID of the geometry
  21822. */
  21823. id: string;
  21824. /**
  21825. * Gets or sets the unique ID of the geometry
  21826. */
  21827. uniqueId: number;
  21828. /**
  21829. * Gets the delay loading state of the geometry (none by default which means not delayed)
  21830. */
  21831. delayLoadState: number;
  21832. /**
  21833. * Gets the file containing the data to load when running in delay load state
  21834. */
  21835. delayLoadingFile: Nullable<string>;
  21836. /**
  21837. * Callback called when the geometry is updated
  21838. */
  21839. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  21840. private _scene;
  21841. private _engine;
  21842. private _meshes;
  21843. private _totalVertices;
  21844. /** @hidden */
  21845. _indices: IndicesArray;
  21846. /** @hidden */
  21847. _vertexBuffers: {
  21848. [key: string]: VertexBuffer;
  21849. };
  21850. private _isDisposed;
  21851. private _extend;
  21852. private _boundingBias;
  21853. /** @hidden */
  21854. _delayInfo: Array<string>;
  21855. private _indexBuffer;
  21856. private _indexBufferIsUpdatable;
  21857. /** @hidden */
  21858. _boundingInfo: Nullable<BoundingInfo>;
  21859. /** @hidden */
  21860. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  21861. /** @hidden */
  21862. _softwareSkinningFrameId: number;
  21863. private _vertexArrayObjects;
  21864. private _updatable;
  21865. /** @hidden */
  21866. _positions: Nullable<Vector3[]>;
  21867. /**
  21868. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  21869. */
  21870. /**
  21871. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  21872. */
  21873. boundingBias: Vector2;
  21874. /**
  21875. * Static function used to attach a new empty geometry to a mesh
  21876. * @param mesh defines the mesh to attach the geometry to
  21877. * @returns the new Geometry
  21878. */
  21879. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  21880. /**
  21881. * Creates a new geometry
  21882. * @param id defines the unique ID
  21883. * @param scene defines the hosting scene
  21884. * @param vertexData defines the VertexData used to get geometry data
  21885. * @param updatable defines if geometry must be updatable (false by default)
  21886. * @param mesh defines the mesh that will be associated with the geometry
  21887. */
  21888. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  21889. /**
  21890. * Gets the current extend of the geometry
  21891. */
  21892. readonly extend: {
  21893. minimum: Vector3;
  21894. maximum: Vector3;
  21895. };
  21896. /**
  21897. * Gets the hosting scene
  21898. * @returns the hosting Scene
  21899. */
  21900. getScene(): Scene;
  21901. /**
  21902. * Gets the hosting engine
  21903. * @returns the hosting Engine
  21904. */
  21905. getEngine(): Engine;
  21906. /**
  21907. * Defines if the geometry is ready to use
  21908. * @returns true if the geometry is ready to be used
  21909. */
  21910. isReady(): boolean;
  21911. /**
  21912. * Gets a value indicating that the geometry should not be serialized
  21913. */
  21914. readonly doNotSerialize: boolean;
  21915. /** @hidden */
  21916. _rebuild(): void;
  21917. /**
  21918. * Affects all geometry data in one call
  21919. * @param vertexData defines the geometry data
  21920. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  21921. */
  21922. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  21923. /**
  21924. * Set specific vertex data
  21925. * @param kind defines the data kind (Position, normal, etc...)
  21926. * @param data defines the vertex data to use
  21927. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  21928. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  21929. */
  21930. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  21931. /**
  21932. * Removes a specific vertex data
  21933. * @param kind defines the data kind (Position, normal, etc...)
  21934. */
  21935. removeVerticesData(kind: string): void;
  21936. /**
  21937. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  21938. * @param buffer defines the vertex buffer to use
  21939. * @param totalVertices defines the total number of vertices for position kind (could be null)
  21940. */
  21941. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  21942. /**
  21943. * Update a specific vertex buffer
  21944. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  21945. * It will do nothing if the buffer is not updatable
  21946. * @param kind defines the data kind (Position, normal, etc...)
  21947. * @param data defines the data to use
  21948. * @param offset defines the offset in the target buffer where to store the data
  21949. * @param useBytes set to true if the offset is in bytes
  21950. */
  21951. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  21952. /**
  21953. * Update a specific vertex buffer
  21954. * This function will create a new buffer if the current one is not updatable
  21955. * @param kind defines the data kind (Position, normal, etc...)
  21956. * @param data defines the data to use
  21957. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  21958. */
  21959. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  21960. private _updateBoundingInfo;
  21961. /** @hidden */
  21962. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  21963. /**
  21964. * Gets total number of vertices
  21965. * @returns the total number of vertices
  21966. */
  21967. getTotalVertices(): number;
  21968. /**
  21969. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  21970. * @param kind defines the data kind (Position, normal, etc...)
  21971. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  21972. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  21973. * @returns a float array containing vertex data
  21974. */
  21975. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  21976. /**
  21977. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  21978. * @param kind defines the data kind (Position, normal, etc...)
  21979. * @returns true if the vertex buffer with the specified kind is updatable
  21980. */
  21981. isVertexBufferUpdatable(kind: string): boolean;
  21982. /**
  21983. * Gets a specific vertex buffer
  21984. * @param kind defines the data kind (Position, normal, etc...)
  21985. * @returns a VertexBuffer
  21986. */
  21987. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  21988. /**
  21989. * Returns all vertex buffers
  21990. * @return an object holding all vertex buffers indexed by kind
  21991. */
  21992. getVertexBuffers(): Nullable<{
  21993. [key: string]: VertexBuffer;
  21994. }>;
  21995. /**
  21996. * Gets a boolean indicating if specific vertex buffer is present
  21997. * @param kind defines the data kind (Position, normal, etc...)
  21998. * @returns true if data is present
  21999. */
  22000. isVerticesDataPresent(kind: string): boolean;
  22001. /**
  22002. * Gets a list of all attached data kinds (Position, normal, etc...)
  22003. * @returns a list of string containing all kinds
  22004. */
  22005. getVerticesDataKinds(): string[];
  22006. /**
  22007. * Update index buffer
  22008. * @param indices defines the indices to store in the index buffer
  22009. * @param offset defines the offset in the target buffer where to store the data
  22010. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  22011. */
  22012. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  22013. /**
  22014. * Creates a new index buffer
  22015. * @param indices defines the indices to store in the index buffer
  22016. * @param totalVertices defines the total number of vertices (could be null)
  22017. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  22018. */
  22019. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  22020. /**
  22021. * Return the total number of indices
  22022. * @returns the total number of indices
  22023. */
  22024. getTotalIndices(): number;
  22025. /**
  22026. * Gets the index buffer array
  22027. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  22028. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22029. * @returns the index buffer array
  22030. */
  22031. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  22032. /**
  22033. * Gets the index buffer
  22034. * @return the index buffer
  22035. */
  22036. getIndexBuffer(): Nullable<DataBuffer>;
  22037. /** @hidden */
  22038. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  22039. /**
  22040. * Release the associated resources for a specific mesh
  22041. * @param mesh defines the source mesh
  22042. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  22043. */
  22044. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  22045. /**
  22046. * Apply current geometry to a given mesh
  22047. * @param mesh defines the mesh to apply geometry to
  22048. */
  22049. applyToMesh(mesh: Mesh): void;
  22050. private _updateExtend;
  22051. private _applyToMesh;
  22052. private notifyUpdate;
  22053. /**
  22054. * Load the geometry if it was flagged as delay loaded
  22055. * @param scene defines the hosting scene
  22056. * @param onLoaded defines a callback called when the geometry is loaded
  22057. */
  22058. load(scene: Scene, onLoaded?: () => void): void;
  22059. private _queueLoad;
  22060. /**
  22061. * Invert the geometry to move from a right handed system to a left handed one.
  22062. */
  22063. toLeftHanded(): void;
  22064. /** @hidden */
  22065. _resetPointsArrayCache(): void;
  22066. /** @hidden */
  22067. _generatePointsArray(): boolean;
  22068. /**
  22069. * Gets a value indicating if the geometry is disposed
  22070. * @returns true if the geometry was disposed
  22071. */
  22072. isDisposed(): boolean;
  22073. private _disposeVertexArrayObjects;
  22074. /**
  22075. * Free all associated resources
  22076. */
  22077. dispose(): void;
  22078. /**
  22079. * Clone the current geometry into a new geometry
  22080. * @param id defines the unique ID of the new geometry
  22081. * @returns a new geometry object
  22082. */
  22083. copy(id: string): Geometry;
  22084. /**
  22085. * Serialize the current geometry info (and not the vertices data) into a JSON object
  22086. * @return a JSON representation of the current geometry data (without the vertices data)
  22087. */
  22088. serialize(): any;
  22089. private toNumberArray;
  22090. /**
  22091. * Serialize all vertices data into a JSON oject
  22092. * @returns a JSON representation of the current geometry data
  22093. */
  22094. serializeVerticeData(): any;
  22095. /**
  22096. * Extracts a clone of a mesh geometry
  22097. * @param mesh defines the source mesh
  22098. * @param id defines the unique ID of the new geometry object
  22099. * @returns the new geometry object
  22100. */
  22101. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  22102. /**
  22103. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  22104. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  22105. * Be aware Math.random() could cause collisions, but:
  22106. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  22107. * @returns a string containing a new GUID
  22108. */
  22109. static RandomId(): string;
  22110. /** @hidden */
  22111. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  22112. private static _CleanMatricesWeights;
  22113. /**
  22114. * Create a new geometry from persisted data (Using .babylon file format)
  22115. * @param parsedVertexData defines the persisted data
  22116. * @param scene defines the hosting scene
  22117. * @param rootUrl defines the root url to use to load assets (like delayed data)
  22118. * @returns the new geometry object
  22119. */
  22120. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  22121. }
  22122. }
  22123. declare module "babylonjs/Meshes/mesh.vertexData" {
  22124. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  22125. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  22126. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  22127. import { Geometry } from "babylonjs/Meshes/geometry";
  22128. import { Mesh } from "babylonjs/Meshes/mesh";
  22129. /**
  22130. * Define an interface for all classes that will get and set the data on vertices
  22131. */
  22132. export interface IGetSetVerticesData {
  22133. /**
  22134. * Gets a boolean indicating if specific vertex data is present
  22135. * @param kind defines the vertex data kind to use
  22136. * @returns true is data kind is present
  22137. */
  22138. isVerticesDataPresent(kind: string): boolean;
  22139. /**
  22140. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  22141. * @param kind defines the data kind (Position, normal, etc...)
  22142. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  22143. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22144. * @returns a float array containing vertex data
  22145. */
  22146. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  22147. /**
  22148. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  22149. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  22150. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22151. * @returns the indices array or an empty array if the mesh has no geometry
  22152. */
  22153. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  22154. /**
  22155. * Set specific vertex data
  22156. * @param kind defines the data kind (Position, normal, etc...)
  22157. * @param data defines the vertex data to use
  22158. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  22159. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  22160. */
  22161. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  22162. /**
  22163. * Update a specific associated vertex buffer
  22164. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  22165. * - VertexBuffer.PositionKind
  22166. * - VertexBuffer.UVKind
  22167. * - VertexBuffer.UV2Kind
  22168. * - VertexBuffer.UV3Kind
  22169. * - VertexBuffer.UV4Kind
  22170. * - VertexBuffer.UV5Kind
  22171. * - VertexBuffer.UV6Kind
  22172. * - VertexBuffer.ColorKind
  22173. * - VertexBuffer.MatricesIndicesKind
  22174. * - VertexBuffer.MatricesIndicesExtraKind
  22175. * - VertexBuffer.MatricesWeightsKind
  22176. * - VertexBuffer.MatricesWeightsExtraKind
  22177. * @param data defines the data source
  22178. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  22179. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  22180. */
  22181. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  22182. /**
  22183. * Creates a new index buffer
  22184. * @param indices defines the indices to store in the index buffer
  22185. * @param totalVertices defines the total number of vertices (could be null)
  22186. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  22187. */
  22188. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  22189. }
  22190. /**
  22191. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  22192. */
  22193. export class VertexData {
  22194. /**
  22195. * Mesh side orientation : usually the external or front surface
  22196. */
  22197. static readonly FRONTSIDE: number;
  22198. /**
  22199. * Mesh side orientation : usually the internal or back surface
  22200. */
  22201. static readonly BACKSIDE: number;
  22202. /**
  22203. * Mesh side orientation : both internal and external or front and back surfaces
  22204. */
  22205. static readonly DOUBLESIDE: number;
  22206. /**
  22207. * Mesh side orientation : by default, `FRONTSIDE`
  22208. */
  22209. static readonly DEFAULTSIDE: number;
  22210. /**
  22211. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  22212. */
  22213. positions: Nullable<FloatArray>;
  22214. /**
  22215. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  22216. */
  22217. normals: Nullable<FloatArray>;
  22218. /**
  22219. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  22220. */
  22221. tangents: Nullable<FloatArray>;
  22222. /**
  22223. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22224. */
  22225. uvs: Nullable<FloatArray>;
  22226. /**
  22227. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22228. */
  22229. uvs2: Nullable<FloatArray>;
  22230. /**
  22231. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22232. */
  22233. uvs3: Nullable<FloatArray>;
  22234. /**
  22235. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22236. */
  22237. uvs4: Nullable<FloatArray>;
  22238. /**
  22239. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22240. */
  22241. uvs5: Nullable<FloatArray>;
  22242. /**
  22243. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22244. */
  22245. uvs6: Nullable<FloatArray>;
  22246. /**
  22247. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  22248. */
  22249. colors: Nullable<FloatArray>;
  22250. /**
  22251. * An array containing the list of indices to the array of matrices produced by bones, each vertex have up to 4 indices (8 if the matricesIndicesExtra is set).
  22252. */
  22253. matricesIndices: Nullable<FloatArray>;
  22254. /**
  22255. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  22256. */
  22257. matricesWeights: Nullable<FloatArray>;
  22258. /**
  22259. * An array extending the number of possible indices
  22260. */
  22261. matricesIndicesExtra: Nullable<FloatArray>;
  22262. /**
  22263. * An array extending the number of possible weights when the number of indices is extended
  22264. */
  22265. matricesWeightsExtra: Nullable<FloatArray>;
  22266. /**
  22267. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  22268. */
  22269. indices: Nullable<IndicesArray>;
  22270. /**
  22271. * Uses the passed data array to set the set the values for the specified kind of data
  22272. * @param data a linear array of floating numbers
  22273. * @param kind the type of data that is being set, eg positions, colors etc
  22274. */
  22275. set(data: FloatArray, kind: string): void;
  22276. /**
  22277. * Associates the vertexData to the passed Mesh.
  22278. * Sets it as updatable or not (default `false`)
  22279. * @param mesh the mesh the vertexData is applied to
  22280. * @param updatable when used and having the value true allows new data to update the vertexData
  22281. * @returns the VertexData
  22282. */
  22283. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  22284. /**
  22285. * Associates the vertexData to the passed Geometry.
  22286. * Sets it as updatable or not (default `false`)
  22287. * @param geometry the geometry the vertexData is applied to
  22288. * @param updatable when used and having the value true allows new data to update the vertexData
  22289. * @returns VertexData
  22290. */
  22291. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  22292. /**
  22293. * Updates the associated mesh
  22294. * @param mesh the mesh to be updated
  22295. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  22296. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  22297. * @returns VertexData
  22298. */
  22299. updateMesh(mesh: Mesh): VertexData;
  22300. /**
  22301. * Updates the associated geometry
  22302. * @param geometry the geometry to be updated
  22303. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  22304. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  22305. * @returns VertexData.
  22306. */
  22307. updateGeometry(geometry: Geometry): VertexData;
  22308. private _applyTo;
  22309. private _update;
  22310. /**
  22311. * Transforms each position and each normal of the vertexData according to the passed Matrix
  22312. * @param matrix the transforming matrix
  22313. * @returns the VertexData
  22314. */
  22315. transform(matrix: Matrix): VertexData;
  22316. /**
  22317. * Merges the passed VertexData into the current one
  22318. * @param other the VertexData to be merged into the current one
  22319. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  22320. * @returns the modified VertexData
  22321. */
  22322. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  22323. private _mergeElement;
  22324. private _validate;
  22325. /**
  22326. * Serializes the VertexData
  22327. * @returns a serialized object
  22328. */
  22329. serialize(): any;
  22330. /**
  22331. * Extracts the vertexData from a mesh
  22332. * @param mesh the mesh from which to extract the VertexData
  22333. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  22334. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  22335. * @returns the object VertexData associated to the passed mesh
  22336. */
  22337. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  22338. /**
  22339. * Extracts the vertexData from the geometry
  22340. * @param geometry the geometry from which to extract the VertexData
  22341. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  22342. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  22343. * @returns the object VertexData associated to the passed mesh
  22344. */
  22345. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  22346. private static _ExtractFrom;
  22347. /**
  22348. * Creates the VertexData for a Ribbon
  22349. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  22350. * * pathArray array of paths, each of which an array of successive Vector3
  22351. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  22352. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  22353. * * offset a positive integer, only used when pathArray contains a single path (offset = 10 means the point 1 is joined to the point 11), default rounded half size of the pathArray length
  22354. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22355. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22356. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22357. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  22358. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  22359. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  22360. * @returns the VertexData of the ribbon
  22361. */
  22362. static CreateRibbon(options: {
  22363. pathArray: Vector3[][];
  22364. closeArray?: boolean;
  22365. closePath?: boolean;
  22366. offset?: number;
  22367. sideOrientation?: number;
  22368. frontUVs?: Vector4;
  22369. backUVs?: Vector4;
  22370. invertUV?: boolean;
  22371. uvs?: Vector2[];
  22372. colors?: Color4[];
  22373. }): VertexData;
  22374. /**
  22375. * Creates the VertexData for a box
  22376. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22377. * * size sets the width, height and depth of the box to the value of size, optional default 1
  22378. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  22379. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  22380. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  22381. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22382. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22383. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22384. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22385. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22386. * @returns the VertexData of the box
  22387. */
  22388. static CreateBox(options: {
  22389. size?: number;
  22390. width?: number;
  22391. height?: number;
  22392. depth?: number;
  22393. faceUV?: Vector4[];
  22394. faceColors?: Color4[];
  22395. sideOrientation?: number;
  22396. frontUVs?: Vector4;
  22397. backUVs?: Vector4;
  22398. }): VertexData;
  22399. /**
  22400. * Creates the VertexData for a tiled box
  22401. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22402. * * faceTiles sets the pattern, tile size and number of tiles for a face
  22403. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22404. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22405. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22406. * @returns the VertexData of the box
  22407. */
  22408. static CreateTiledBox(options: {
  22409. pattern?: number;
  22410. width?: number;
  22411. height?: number;
  22412. depth?: number;
  22413. tileSize?: number;
  22414. tileWidth?: number;
  22415. tileHeight?: number;
  22416. alignHorizontal?: number;
  22417. alignVertical?: number;
  22418. faceUV?: Vector4[];
  22419. faceColors?: Color4[];
  22420. sideOrientation?: number;
  22421. }): VertexData;
  22422. /**
  22423. * Creates the VertexData for a tiled plane
  22424. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22425. * * pattern a limited pattern arrangement depending on the number
  22426. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  22427. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  22428. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  22429. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22430. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22431. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22432. * @returns the VertexData of the tiled plane
  22433. */
  22434. static CreateTiledPlane(options: {
  22435. pattern?: number;
  22436. tileSize?: number;
  22437. tileWidth?: number;
  22438. tileHeight?: number;
  22439. size?: number;
  22440. width?: number;
  22441. height?: number;
  22442. alignHorizontal?: number;
  22443. alignVertical?: number;
  22444. sideOrientation?: number;
  22445. frontUVs?: Vector4;
  22446. backUVs?: Vector4;
  22447. }): VertexData;
  22448. /**
  22449. * Creates the VertexData for an ellipsoid, defaults to a sphere
  22450. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22451. * * segments sets the number of horizontal strips optional, default 32
  22452. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  22453. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  22454. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  22455. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  22456. * * arc a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the circumference (latitude) given by the arc value, optional, default 1
  22457. * * slice a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the height (latitude) given by the arc value, optional, default 1
  22458. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22459. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22460. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22461. * @returns the VertexData of the ellipsoid
  22462. */
  22463. static CreateSphere(options: {
  22464. segments?: number;
  22465. diameter?: number;
  22466. diameterX?: number;
  22467. diameterY?: number;
  22468. diameterZ?: number;
  22469. arc?: number;
  22470. slice?: number;
  22471. sideOrientation?: number;
  22472. frontUVs?: Vector4;
  22473. backUVs?: Vector4;
  22474. }): VertexData;
  22475. /**
  22476. * Creates the VertexData for a cylinder, cone or prism
  22477. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22478. * * height sets the height (y direction) of the cylinder, optional, default 2
  22479. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  22480. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  22481. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  22482. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22483. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  22484. * * arc a number from 0 to 1, to create an unclosed cylinder based on the fraction of the circumference given by the arc value, optional, default 1
  22485. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22486. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22487. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  22488. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  22489. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22490. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22491. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22492. * @returns the VertexData of the cylinder, cone or prism
  22493. */
  22494. static CreateCylinder(options: {
  22495. height?: number;
  22496. diameterTop?: number;
  22497. diameterBottom?: number;
  22498. diameter?: number;
  22499. tessellation?: number;
  22500. subdivisions?: number;
  22501. arc?: number;
  22502. faceColors?: Color4[];
  22503. faceUV?: Vector4[];
  22504. hasRings?: boolean;
  22505. enclose?: boolean;
  22506. sideOrientation?: number;
  22507. frontUVs?: Vector4;
  22508. backUVs?: Vector4;
  22509. }): VertexData;
  22510. /**
  22511. * Creates the VertexData for a torus
  22512. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22513. * * diameter the diameter of the torus, optional default 1
  22514. * * thickness the diameter of the tube forming the torus, optional default 0.5
  22515. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22516. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22517. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22518. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22519. * @returns the VertexData of the torus
  22520. */
  22521. static CreateTorus(options: {
  22522. diameter?: number;
  22523. thickness?: number;
  22524. tessellation?: number;
  22525. sideOrientation?: number;
  22526. frontUVs?: Vector4;
  22527. backUVs?: Vector4;
  22528. }): VertexData;
  22529. /**
  22530. * Creates the VertexData of the LineSystem
  22531. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  22532. * - lines an array of lines, each line being an array of successive Vector3
  22533. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  22534. * @returns the VertexData of the LineSystem
  22535. */
  22536. static CreateLineSystem(options: {
  22537. lines: Vector3[][];
  22538. colors?: Nullable<Color4[][]>;
  22539. }): VertexData;
  22540. /**
  22541. * Create the VertexData for a DashedLines
  22542. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  22543. * - points an array successive Vector3
  22544. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  22545. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  22546. * - dashNb the intended total number of dashes, optional, default 200
  22547. * @returns the VertexData for the DashedLines
  22548. */
  22549. static CreateDashedLines(options: {
  22550. points: Vector3[];
  22551. dashSize?: number;
  22552. gapSize?: number;
  22553. dashNb?: number;
  22554. }): VertexData;
  22555. /**
  22556. * Creates the VertexData for a Ground
  22557. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22558. * - width the width (x direction) of the ground, optional, default 1
  22559. * - height the height (z direction) of the ground, optional, default 1
  22560. * - subdivisions the number of subdivisions per side, optional, default 1
  22561. * @returns the VertexData of the Ground
  22562. */
  22563. static CreateGround(options: {
  22564. width?: number;
  22565. height?: number;
  22566. subdivisions?: number;
  22567. subdivisionsX?: number;
  22568. subdivisionsY?: number;
  22569. }): VertexData;
  22570. /**
  22571. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  22572. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22573. * * xmin the ground minimum X coordinate, optional, default -1
  22574. * * zmin the ground minimum Z coordinate, optional, default -1
  22575. * * xmax the ground maximum X coordinate, optional, default 1
  22576. * * zmax the ground maximum Z coordinate, optional, default 1
  22577. * * subdivisions a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the ground width and height creating 'tiles', default {w: 6, h: 6}
  22578. * * precision a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the tile width and height, default {w: 2, h: 2}
  22579. * @returns the VertexData of the TiledGround
  22580. */
  22581. static CreateTiledGround(options: {
  22582. xmin: number;
  22583. zmin: number;
  22584. xmax: number;
  22585. zmax: number;
  22586. subdivisions?: {
  22587. w: number;
  22588. h: number;
  22589. };
  22590. precision?: {
  22591. w: number;
  22592. h: number;
  22593. };
  22594. }): VertexData;
  22595. /**
  22596. * Creates the VertexData of the Ground designed from a heightmap
  22597. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  22598. * * width the width (x direction) of the ground
  22599. * * height the height (z direction) of the ground
  22600. * * subdivisions the number of subdivisions per side
  22601. * * minHeight the minimum altitude on the ground, optional, default 0
  22602. * * maxHeight the maximum altitude on the ground, optional default 1
  22603. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  22604. * * buffer the array holding the image color data
  22605. * * bufferWidth the width of image
  22606. * * bufferHeight the height of image
  22607. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  22608. * @returns the VertexData of the Ground designed from a heightmap
  22609. */
  22610. static CreateGroundFromHeightMap(options: {
  22611. width: number;
  22612. height: number;
  22613. subdivisions: number;
  22614. minHeight: number;
  22615. maxHeight: number;
  22616. colorFilter: Color3;
  22617. buffer: Uint8Array;
  22618. bufferWidth: number;
  22619. bufferHeight: number;
  22620. alphaFilter: number;
  22621. }): VertexData;
  22622. /**
  22623. * Creates the VertexData for a Plane
  22624. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  22625. * * size sets the width and height of the plane to the value of size, optional default 1
  22626. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  22627. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  22628. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22629. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22630. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22631. * @returns the VertexData of the box
  22632. */
  22633. static CreatePlane(options: {
  22634. size?: number;
  22635. width?: number;
  22636. height?: number;
  22637. sideOrientation?: number;
  22638. frontUVs?: Vector4;
  22639. backUVs?: Vector4;
  22640. }): VertexData;
  22641. /**
  22642. * Creates the VertexData of the Disc or regular Polygon
  22643. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  22644. * * radius the radius of the disc, optional default 0.5
  22645. * * tessellation the number of polygon sides, optional, default 64
  22646. * * arc a number from 0 to 1, to create an unclosed polygon based on the fraction of the circumference given by the arc value, optional, default 1
  22647. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22648. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22649. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22650. * @returns the VertexData of the box
  22651. */
  22652. static CreateDisc(options: {
  22653. radius?: number;
  22654. tessellation?: number;
  22655. arc?: number;
  22656. sideOrientation?: number;
  22657. frontUVs?: Vector4;
  22658. backUVs?: Vector4;
  22659. }): VertexData;
  22660. /**
  22661. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  22662. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  22663. * @param polygon a mesh built from polygonTriangulation.build()
  22664. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22665. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22666. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22667. * @param frontUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22668. * @param backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22669. * @returns the VertexData of the Polygon
  22670. */
  22671. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  22672. /**
  22673. * Creates the VertexData of the IcoSphere
  22674. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  22675. * * radius the radius of the IcoSphere, optional default 1
  22676. * * radiusX allows stretching in the x direction, optional, default radius
  22677. * * radiusY allows stretching in the y direction, optional, default radius
  22678. * * radiusZ allows stretching in the z direction, optional, default radius
  22679. * * flat when true creates a flat shaded mesh, optional, default true
  22680. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22681. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22682. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22683. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22684. * @returns the VertexData of the IcoSphere
  22685. */
  22686. static CreateIcoSphere(options: {
  22687. radius?: number;
  22688. radiusX?: number;
  22689. radiusY?: number;
  22690. radiusZ?: number;
  22691. flat?: boolean;
  22692. subdivisions?: number;
  22693. sideOrientation?: number;
  22694. frontUVs?: Vector4;
  22695. backUVs?: Vector4;
  22696. }): VertexData;
  22697. /**
  22698. * Creates the VertexData for a Polyhedron
  22699. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  22700. * * type provided types are:
  22701. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  22702. * * 9 : Pentagonal Pyramid (J2), 10 : Triangular Dipyramid (J12), 11 : Pentagonal Dipyramid (J13), 12 : Elongated Square Dipyramid (J15), 13 : Elongated Pentagonal Dipyramid (J16), 14 : Elongated Pentagonal Cupola (J20)
  22703. * * size the size of the IcoSphere, optional default 1
  22704. * * sizeX allows stretching in the x direction, optional, default size
  22705. * * sizeY allows stretching in the y direction, optional, default size
  22706. * * sizeZ allows stretching in the z direction, optional, default size
  22707. * * custom a number that overwrites the type to create from an extended set of polyhedron from https://www.babylonjs-playground.com/#21QRSK#15 with minimised editor
  22708. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22709. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22710. * * flat when true creates a flat shaded mesh, optional, default true
  22711. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22712. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22713. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22714. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22715. * @returns the VertexData of the Polyhedron
  22716. */
  22717. static CreatePolyhedron(options: {
  22718. type?: number;
  22719. size?: number;
  22720. sizeX?: number;
  22721. sizeY?: number;
  22722. sizeZ?: number;
  22723. custom?: any;
  22724. faceUV?: Vector4[];
  22725. faceColors?: Color4[];
  22726. flat?: boolean;
  22727. sideOrientation?: number;
  22728. frontUVs?: Vector4;
  22729. backUVs?: Vector4;
  22730. }): VertexData;
  22731. /**
  22732. * Creates the VertexData for a TorusKnot
  22733. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  22734. * * radius the radius of the torus knot, optional, default 2
  22735. * * tube the thickness of the tube, optional, default 0.5
  22736. * * radialSegments the number of sides on each tube segments, optional, default 32
  22737. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  22738. * * p the number of windings around the z axis, optional, default 2
  22739. * * q the number of windings around the x axis, optional, default 3
  22740. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22741. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22742. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22743. * @returns the VertexData of the Torus Knot
  22744. */
  22745. static CreateTorusKnot(options: {
  22746. radius?: number;
  22747. tube?: number;
  22748. radialSegments?: number;
  22749. tubularSegments?: number;
  22750. p?: number;
  22751. q?: number;
  22752. sideOrientation?: number;
  22753. frontUVs?: Vector4;
  22754. backUVs?: Vector4;
  22755. }): VertexData;
  22756. /**
  22757. * Compute normals for given positions and indices
  22758. * @param positions an array of vertex positions, [...., x, y, z, ......]
  22759. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  22760. * @param normals an array of vertex normals, [...., x, y, z, ......]
  22761. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  22762. * * facetNormals : optional array of facet normals (vector3)
  22763. * * facetPositions : optional array of facet positions (vector3)
  22764. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  22765. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  22766. * * bInfo : optional bounding info, required for facetPartitioning computation
  22767. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  22768. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  22769. * * useRightHandedSystem: optional boolean to for right handed system computation
  22770. * * depthSort : optional boolean to enable the facet depth sort computation
  22771. * * distanceTo : optional Vector3 to compute the facet depth from this location
  22772. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  22773. */
  22774. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  22775. facetNormals?: any;
  22776. facetPositions?: any;
  22777. facetPartitioning?: any;
  22778. ratio?: number;
  22779. bInfo?: any;
  22780. bbSize?: Vector3;
  22781. subDiv?: any;
  22782. useRightHandedSystem?: boolean;
  22783. depthSort?: boolean;
  22784. distanceTo?: Vector3;
  22785. depthSortedFacets?: any;
  22786. }): void;
  22787. /** @hidden */
  22788. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  22789. /**
  22790. * Applies VertexData created from the imported parameters to the geometry
  22791. * @param parsedVertexData the parsed data from an imported file
  22792. * @param geometry the geometry to apply the VertexData to
  22793. */
  22794. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  22795. }
  22796. }
  22797. declare module "babylonjs/Morph/morphTarget" {
  22798. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  22799. import { Observable } from "babylonjs/Misc/observable";
  22800. import { Nullable, FloatArray } from "babylonjs/types";
  22801. import { Scene } from "babylonjs/scene";
  22802. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22803. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  22804. /**
  22805. * Defines a target to use with MorphTargetManager
  22806. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22807. */
  22808. export class MorphTarget implements IAnimatable {
  22809. /** defines the name of the target */
  22810. name: string;
  22811. /**
  22812. * Gets or sets the list of animations
  22813. */
  22814. animations: import("babylonjs/Animations/animation").Animation[];
  22815. private _scene;
  22816. private _positions;
  22817. private _normals;
  22818. private _tangents;
  22819. private _uvs;
  22820. private _influence;
  22821. private _uniqueId;
  22822. /**
  22823. * Observable raised when the influence changes
  22824. */
  22825. onInfluenceChanged: Observable<boolean>;
  22826. /** @hidden */
  22827. _onDataLayoutChanged: Observable<void>;
  22828. /**
  22829. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  22830. */
  22831. influence: number;
  22832. /**
  22833. * Gets or sets the id of the morph Target
  22834. */
  22835. id: string;
  22836. private _animationPropertiesOverride;
  22837. /**
  22838. * Gets or sets the animation properties override
  22839. */
  22840. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  22841. /**
  22842. * Creates a new MorphTarget
  22843. * @param name defines the name of the target
  22844. * @param influence defines the influence to use
  22845. * @param scene defines the scene the morphtarget belongs to
  22846. */
  22847. constructor(
  22848. /** defines the name of the target */
  22849. name: string, influence?: number, scene?: Nullable<Scene>);
  22850. /**
  22851. * Gets the unique ID of this manager
  22852. */
  22853. readonly uniqueId: number;
  22854. /**
  22855. * Gets a boolean defining if the target contains position data
  22856. */
  22857. readonly hasPositions: boolean;
  22858. /**
  22859. * Gets a boolean defining if the target contains normal data
  22860. */
  22861. readonly hasNormals: boolean;
  22862. /**
  22863. * Gets a boolean defining if the target contains tangent data
  22864. */
  22865. readonly hasTangents: boolean;
  22866. /**
  22867. * Gets a boolean defining if the target contains texture coordinates data
  22868. */
  22869. readonly hasUVs: boolean;
  22870. /**
  22871. * Affects position data to this target
  22872. * @param data defines the position data to use
  22873. */
  22874. setPositions(data: Nullable<FloatArray>): void;
  22875. /**
  22876. * Gets the position data stored in this target
  22877. * @returns a FloatArray containing the position data (or null if not present)
  22878. */
  22879. getPositions(): Nullable<FloatArray>;
  22880. /**
  22881. * Affects normal data to this target
  22882. * @param data defines the normal data to use
  22883. */
  22884. setNormals(data: Nullable<FloatArray>): void;
  22885. /**
  22886. * Gets the normal data stored in this target
  22887. * @returns a FloatArray containing the normal data (or null if not present)
  22888. */
  22889. getNormals(): Nullable<FloatArray>;
  22890. /**
  22891. * Affects tangent data to this target
  22892. * @param data defines the tangent data to use
  22893. */
  22894. setTangents(data: Nullable<FloatArray>): void;
  22895. /**
  22896. * Gets the tangent data stored in this target
  22897. * @returns a FloatArray containing the tangent data (or null if not present)
  22898. */
  22899. getTangents(): Nullable<FloatArray>;
  22900. /**
  22901. * Affects texture coordinates data to this target
  22902. * @param data defines the texture coordinates data to use
  22903. */
  22904. setUVs(data: Nullable<FloatArray>): void;
  22905. /**
  22906. * Gets the texture coordinates data stored in this target
  22907. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  22908. */
  22909. getUVs(): Nullable<FloatArray>;
  22910. /**
  22911. * Clone the current target
  22912. * @returns a new MorphTarget
  22913. */
  22914. clone(): MorphTarget;
  22915. /**
  22916. * Serializes the current target into a Serialization object
  22917. * @returns the serialized object
  22918. */
  22919. serialize(): any;
  22920. /**
  22921. * Returns the string "MorphTarget"
  22922. * @returns "MorphTarget"
  22923. */
  22924. getClassName(): string;
  22925. /**
  22926. * Creates a new target from serialized data
  22927. * @param serializationObject defines the serialized data to use
  22928. * @returns a new MorphTarget
  22929. */
  22930. static Parse(serializationObject: any): MorphTarget;
  22931. /**
  22932. * Creates a MorphTarget from mesh data
  22933. * @param mesh defines the source mesh
  22934. * @param name defines the name to use for the new target
  22935. * @param influence defines the influence to attach to the target
  22936. * @returns a new MorphTarget
  22937. */
  22938. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  22939. }
  22940. }
  22941. declare module "babylonjs/Morph/morphTargetManager" {
  22942. import { Nullable } from "babylonjs/types";
  22943. import { Scene } from "babylonjs/scene";
  22944. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  22945. /**
  22946. * This class is used to deform meshes using morphing between different targets
  22947. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22948. */
  22949. export class MorphTargetManager {
  22950. private _targets;
  22951. private _targetInfluenceChangedObservers;
  22952. private _targetDataLayoutChangedObservers;
  22953. private _activeTargets;
  22954. private _scene;
  22955. private _influences;
  22956. private _supportsNormals;
  22957. private _supportsTangents;
  22958. private _supportsUVs;
  22959. private _vertexCount;
  22960. private _uniqueId;
  22961. private _tempInfluences;
  22962. /**
  22963. * Gets or sets a boolean indicating if normals must be morphed
  22964. */
  22965. enableNormalMorphing: boolean;
  22966. /**
  22967. * Gets or sets a boolean indicating if tangents must be morphed
  22968. */
  22969. enableTangentMorphing: boolean;
  22970. /**
  22971. * Gets or sets a boolean indicating if UV must be morphed
  22972. */
  22973. enableUVMorphing: boolean;
  22974. /**
  22975. * Creates a new MorphTargetManager
  22976. * @param scene defines the current scene
  22977. */
  22978. constructor(scene?: Nullable<Scene>);
  22979. /**
  22980. * Gets the unique ID of this manager
  22981. */
  22982. readonly uniqueId: number;
  22983. /**
  22984. * Gets the number of vertices handled by this manager
  22985. */
  22986. readonly vertexCount: number;
  22987. /**
  22988. * Gets a boolean indicating if this manager supports morphing of normals
  22989. */
  22990. readonly supportsNormals: boolean;
  22991. /**
  22992. * Gets a boolean indicating if this manager supports morphing of tangents
  22993. */
  22994. readonly supportsTangents: boolean;
  22995. /**
  22996. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  22997. */
  22998. readonly supportsUVs: boolean;
  22999. /**
  23000. * Gets the number of targets stored in this manager
  23001. */
  23002. readonly numTargets: number;
  23003. /**
  23004. * Gets the number of influencers (ie. the number of targets with influences > 0)
  23005. */
  23006. readonly numInfluencers: number;
  23007. /**
  23008. * Gets the list of influences (one per target)
  23009. */
  23010. readonly influences: Float32Array;
  23011. /**
  23012. * Gets the active target at specified index. An active target is a target with an influence > 0
  23013. * @param index defines the index to check
  23014. * @returns the requested target
  23015. */
  23016. getActiveTarget(index: number): MorphTarget;
  23017. /**
  23018. * Gets the target at specified index
  23019. * @param index defines the index to check
  23020. * @returns the requested target
  23021. */
  23022. getTarget(index: number): MorphTarget;
  23023. /**
  23024. * Add a new target to this manager
  23025. * @param target defines the target to add
  23026. */
  23027. addTarget(target: MorphTarget): void;
  23028. /**
  23029. * Removes a target from the manager
  23030. * @param target defines the target to remove
  23031. */
  23032. removeTarget(target: MorphTarget): void;
  23033. /**
  23034. * Clone the current manager
  23035. * @returns a new MorphTargetManager
  23036. */
  23037. clone(): MorphTargetManager;
  23038. /**
  23039. * Serializes the current manager into a Serialization object
  23040. * @returns the serialized object
  23041. */
  23042. serialize(): any;
  23043. private _syncActiveTargets;
  23044. /**
  23045. * Syncrhonize the targets with all the meshes using this morph target manager
  23046. */
  23047. synchronize(): void;
  23048. /**
  23049. * Creates a new MorphTargetManager from serialized data
  23050. * @param serializationObject defines the serialized data
  23051. * @param scene defines the hosting scene
  23052. * @returns the new MorphTargetManager
  23053. */
  23054. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  23055. }
  23056. }
  23057. declare module "babylonjs/Meshes/meshLODLevel" {
  23058. import { Mesh } from "babylonjs/Meshes/mesh";
  23059. import { Nullable } from "babylonjs/types";
  23060. /**
  23061. * Class used to represent a specific level of detail of a mesh
  23062. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  23063. */
  23064. export class MeshLODLevel {
  23065. /** Defines the distance where this level should start being displayed */
  23066. distance: number;
  23067. /** Defines the mesh to use to render this level */
  23068. mesh: Nullable<Mesh>;
  23069. /**
  23070. * Creates a new LOD level
  23071. * @param distance defines the distance where this level should star being displayed
  23072. * @param mesh defines the mesh to use to render this level
  23073. */
  23074. constructor(
  23075. /** Defines the distance where this level should start being displayed */
  23076. distance: number,
  23077. /** Defines the mesh to use to render this level */
  23078. mesh: Nullable<Mesh>);
  23079. }
  23080. }
  23081. declare module "babylonjs/Meshes/groundMesh" {
  23082. import { Scene } from "babylonjs/scene";
  23083. import { Vector3 } from "babylonjs/Maths/math.vector";
  23084. import { Mesh } from "babylonjs/Meshes/mesh";
  23085. /**
  23086. * Mesh representing the gorund
  23087. */
  23088. export class GroundMesh extends Mesh {
  23089. /** If octree should be generated */
  23090. generateOctree: boolean;
  23091. private _heightQuads;
  23092. /** @hidden */
  23093. _subdivisionsX: number;
  23094. /** @hidden */
  23095. _subdivisionsY: number;
  23096. /** @hidden */
  23097. _width: number;
  23098. /** @hidden */
  23099. _height: number;
  23100. /** @hidden */
  23101. _minX: number;
  23102. /** @hidden */
  23103. _maxX: number;
  23104. /** @hidden */
  23105. _minZ: number;
  23106. /** @hidden */
  23107. _maxZ: number;
  23108. constructor(name: string, scene: Scene);
  23109. /**
  23110. * "GroundMesh"
  23111. * @returns "GroundMesh"
  23112. */
  23113. getClassName(): string;
  23114. /**
  23115. * The minimum of x and y subdivisions
  23116. */
  23117. readonly subdivisions: number;
  23118. /**
  23119. * X subdivisions
  23120. */
  23121. readonly subdivisionsX: number;
  23122. /**
  23123. * Y subdivisions
  23124. */
  23125. readonly subdivisionsY: number;
  23126. /**
  23127. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  23128. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  23129. * @param chunksCount the number of subdivisions for x and y
  23130. * @param octreeBlocksSize (Default: 32)
  23131. */
  23132. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  23133. /**
  23134. * Returns a height (y) value in the Worl system :
  23135. * the ground altitude at the coordinates (x, z) expressed in the World system.
  23136. * @param x x coordinate
  23137. * @param z z coordinate
  23138. * @returns the ground y position if (x, z) are outside the ground surface.
  23139. */
  23140. getHeightAtCoordinates(x: number, z: number): number;
  23141. /**
  23142. * Returns a normalized vector (Vector3) orthogonal to the ground
  23143. * at the ground coordinates (x, z) expressed in the World system.
  23144. * @param x x coordinate
  23145. * @param z z coordinate
  23146. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  23147. */
  23148. getNormalAtCoordinates(x: number, z: number): Vector3;
  23149. /**
  23150. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  23151. * at the ground coordinates (x, z) expressed in the World system.
  23152. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  23153. * @param x x coordinate
  23154. * @param z z coordinate
  23155. * @param ref vector to store the result
  23156. * @returns the GroundMesh.
  23157. */
  23158. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  23159. /**
  23160. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  23161. * if the ground has been updated.
  23162. * This can be used in the render loop.
  23163. * @returns the GroundMesh.
  23164. */
  23165. updateCoordinateHeights(): GroundMesh;
  23166. private _getFacetAt;
  23167. private _initHeightQuads;
  23168. private _computeHeightQuads;
  23169. /**
  23170. * Serializes this ground mesh
  23171. * @param serializationObject object to write serialization to
  23172. */
  23173. serialize(serializationObject: any): void;
  23174. /**
  23175. * Parses a serialized ground mesh
  23176. * @param parsedMesh the serialized mesh
  23177. * @param scene the scene to create the ground mesh in
  23178. * @returns the created ground mesh
  23179. */
  23180. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  23181. }
  23182. }
  23183. declare module "babylonjs/Physics/physicsJoint" {
  23184. import { Vector3 } from "babylonjs/Maths/math.vector";
  23185. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  23186. /**
  23187. * Interface for Physics-Joint data
  23188. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23189. */
  23190. export interface PhysicsJointData {
  23191. /**
  23192. * The main pivot of the joint
  23193. */
  23194. mainPivot?: Vector3;
  23195. /**
  23196. * The connected pivot of the joint
  23197. */
  23198. connectedPivot?: Vector3;
  23199. /**
  23200. * The main axis of the joint
  23201. */
  23202. mainAxis?: Vector3;
  23203. /**
  23204. * The connected axis of the joint
  23205. */
  23206. connectedAxis?: Vector3;
  23207. /**
  23208. * The collision of the joint
  23209. */
  23210. collision?: boolean;
  23211. /**
  23212. * Native Oimo/Cannon/Energy data
  23213. */
  23214. nativeParams?: any;
  23215. }
  23216. /**
  23217. * This is a holder class for the physics joint created by the physics plugin
  23218. * It holds a set of functions to control the underlying joint
  23219. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23220. */
  23221. export class PhysicsJoint {
  23222. /**
  23223. * The type of the physics joint
  23224. */
  23225. type: number;
  23226. /**
  23227. * The data for the physics joint
  23228. */
  23229. jointData: PhysicsJointData;
  23230. private _physicsJoint;
  23231. protected _physicsPlugin: IPhysicsEnginePlugin;
  23232. /**
  23233. * Initializes the physics joint
  23234. * @param type The type of the physics joint
  23235. * @param jointData The data for the physics joint
  23236. */
  23237. constructor(
  23238. /**
  23239. * The type of the physics joint
  23240. */
  23241. type: number,
  23242. /**
  23243. * The data for the physics joint
  23244. */
  23245. jointData: PhysicsJointData);
  23246. /**
  23247. * Gets the physics joint
  23248. */
  23249. /**
  23250. * Sets the physics joint
  23251. */
  23252. physicsJoint: any;
  23253. /**
  23254. * Sets the physics plugin
  23255. */
  23256. physicsPlugin: IPhysicsEnginePlugin;
  23257. /**
  23258. * Execute a function that is physics-plugin specific.
  23259. * @param {Function} func the function that will be executed.
  23260. * It accepts two parameters: the physics world and the physics joint
  23261. */
  23262. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  23263. /**
  23264. * Distance-Joint type
  23265. */
  23266. static DistanceJoint: number;
  23267. /**
  23268. * Hinge-Joint type
  23269. */
  23270. static HingeJoint: number;
  23271. /**
  23272. * Ball-and-Socket joint type
  23273. */
  23274. static BallAndSocketJoint: number;
  23275. /**
  23276. * Wheel-Joint type
  23277. */
  23278. static WheelJoint: number;
  23279. /**
  23280. * Slider-Joint type
  23281. */
  23282. static SliderJoint: number;
  23283. /**
  23284. * Prismatic-Joint type
  23285. */
  23286. static PrismaticJoint: number;
  23287. /**
  23288. * Universal-Joint type
  23289. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  23290. */
  23291. static UniversalJoint: number;
  23292. /**
  23293. * Hinge-Joint 2 type
  23294. */
  23295. static Hinge2Joint: number;
  23296. /**
  23297. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  23298. */
  23299. static PointToPointJoint: number;
  23300. /**
  23301. * Spring-Joint type
  23302. */
  23303. static SpringJoint: number;
  23304. /**
  23305. * Lock-Joint type
  23306. */
  23307. static LockJoint: number;
  23308. }
  23309. /**
  23310. * A class representing a physics distance joint
  23311. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23312. */
  23313. export class DistanceJoint extends PhysicsJoint {
  23314. /**
  23315. *
  23316. * @param jointData The data for the Distance-Joint
  23317. */
  23318. constructor(jointData: DistanceJointData);
  23319. /**
  23320. * Update the predefined distance.
  23321. * @param maxDistance The maximum preferred distance
  23322. * @param minDistance The minimum preferred distance
  23323. */
  23324. updateDistance(maxDistance: number, minDistance?: number): void;
  23325. }
  23326. /**
  23327. * Represents a Motor-Enabled Joint
  23328. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23329. */
  23330. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  23331. /**
  23332. * Initializes the Motor-Enabled Joint
  23333. * @param type The type of the joint
  23334. * @param jointData The physica joint data for the joint
  23335. */
  23336. constructor(type: number, jointData: PhysicsJointData);
  23337. /**
  23338. * Set the motor values.
  23339. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23340. * @param force the force to apply
  23341. * @param maxForce max force for this motor.
  23342. */
  23343. setMotor(force?: number, maxForce?: number): void;
  23344. /**
  23345. * Set the motor's limits.
  23346. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23347. * @param upperLimit The upper limit of the motor
  23348. * @param lowerLimit The lower limit of the motor
  23349. */
  23350. setLimit(upperLimit: number, lowerLimit?: number): void;
  23351. }
  23352. /**
  23353. * This class represents a single physics Hinge-Joint
  23354. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23355. */
  23356. export class HingeJoint extends MotorEnabledJoint {
  23357. /**
  23358. * Initializes the Hinge-Joint
  23359. * @param jointData The joint data for the Hinge-Joint
  23360. */
  23361. constructor(jointData: PhysicsJointData);
  23362. /**
  23363. * Set the motor values.
  23364. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23365. * @param {number} force the force to apply
  23366. * @param {number} maxForce max force for this motor.
  23367. */
  23368. setMotor(force?: number, maxForce?: number): void;
  23369. /**
  23370. * Set the motor's limits.
  23371. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23372. * @param upperLimit The upper limit of the motor
  23373. * @param lowerLimit The lower limit of the motor
  23374. */
  23375. setLimit(upperLimit: number, lowerLimit?: number): void;
  23376. }
  23377. /**
  23378. * This class represents a dual hinge physics joint (same as wheel joint)
  23379. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23380. */
  23381. export class Hinge2Joint extends MotorEnabledJoint {
  23382. /**
  23383. * Initializes the Hinge2-Joint
  23384. * @param jointData The joint data for the Hinge2-Joint
  23385. */
  23386. constructor(jointData: PhysicsJointData);
  23387. /**
  23388. * Set the motor values.
  23389. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23390. * @param {number} targetSpeed the speed the motor is to reach
  23391. * @param {number} maxForce max force for this motor.
  23392. * @param {motorIndex} the motor's index, 0 or 1.
  23393. */
  23394. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  23395. /**
  23396. * Set the motor limits.
  23397. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23398. * @param {number} upperLimit the upper limit
  23399. * @param {number} lowerLimit lower limit
  23400. * @param {motorIndex} the motor's index, 0 or 1.
  23401. */
  23402. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23403. }
  23404. /**
  23405. * Interface for a motor enabled joint
  23406. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23407. */
  23408. export interface IMotorEnabledJoint {
  23409. /**
  23410. * Physics joint
  23411. */
  23412. physicsJoint: any;
  23413. /**
  23414. * Sets the motor of the motor-enabled joint
  23415. * @param force The force of the motor
  23416. * @param maxForce The maximum force of the motor
  23417. * @param motorIndex The index of the motor
  23418. */
  23419. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  23420. /**
  23421. * Sets the limit of the motor
  23422. * @param upperLimit The upper limit of the motor
  23423. * @param lowerLimit The lower limit of the motor
  23424. * @param motorIndex The index of the motor
  23425. */
  23426. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23427. }
  23428. /**
  23429. * Joint data for a Distance-Joint
  23430. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23431. */
  23432. export interface DistanceJointData extends PhysicsJointData {
  23433. /**
  23434. * Max distance the 2 joint objects can be apart
  23435. */
  23436. maxDistance: number;
  23437. }
  23438. /**
  23439. * Joint data from a spring joint
  23440. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23441. */
  23442. export interface SpringJointData extends PhysicsJointData {
  23443. /**
  23444. * Length of the spring
  23445. */
  23446. length: number;
  23447. /**
  23448. * Stiffness of the spring
  23449. */
  23450. stiffness: number;
  23451. /**
  23452. * Damping of the spring
  23453. */
  23454. damping: number;
  23455. /** this callback will be called when applying the force to the impostors. */
  23456. forceApplicationCallback: () => void;
  23457. }
  23458. }
  23459. declare module "babylonjs/Physics/physicsRaycastResult" {
  23460. import { Vector3 } from "babylonjs/Maths/math.vector";
  23461. /**
  23462. * Holds the data for the raycast result
  23463. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23464. */
  23465. export class PhysicsRaycastResult {
  23466. private _hasHit;
  23467. private _hitDistance;
  23468. private _hitNormalWorld;
  23469. private _hitPointWorld;
  23470. private _rayFromWorld;
  23471. private _rayToWorld;
  23472. /**
  23473. * Gets if there was a hit
  23474. */
  23475. readonly hasHit: boolean;
  23476. /**
  23477. * Gets the distance from the hit
  23478. */
  23479. readonly hitDistance: number;
  23480. /**
  23481. * Gets the hit normal/direction in the world
  23482. */
  23483. readonly hitNormalWorld: Vector3;
  23484. /**
  23485. * Gets the hit point in the world
  23486. */
  23487. readonly hitPointWorld: Vector3;
  23488. /**
  23489. * Gets the ray "start point" of the ray in the world
  23490. */
  23491. readonly rayFromWorld: Vector3;
  23492. /**
  23493. * Gets the ray "end point" of the ray in the world
  23494. */
  23495. readonly rayToWorld: Vector3;
  23496. /**
  23497. * Sets the hit data (normal & point in world space)
  23498. * @param hitNormalWorld defines the normal in world space
  23499. * @param hitPointWorld defines the point in world space
  23500. */
  23501. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  23502. /**
  23503. * Sets the distance from the start point to the hit point
  23504. * @param distance
  23505. */
  23506. setHitDistance(distance: number): void;
  23507. /**
  23508. * Calculates the distance manually
  23509. */
  23510. calculateHitDistance(): void;
  23511. /**
  23512. * Resets all the values to default
  23513. * @param from The from point on world space
  23514. * @param to The to point on world space
  23515. */
  23516. reset(from?: Vector3, to?: Vector3): void;
  23517. }
  23518. /**
  23519. * Interface for the size containing width and height
  23520. */
  23521. interface IXYZ {
  23522. /**
  23523. * X
  23524. */
  23525. x: number;
  23526. /**
  23527. * Y
  23528. */
  23529. y: number;
  23530. /**
  23531. * Z
  23532. */
  23533. z: number;
  23534. }
  23535. }
  23536. declare module "babylonjs/Physics/IPhysicsEngine" {
  23537. import { Nullable } from "babylonjs/types";
  23538. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  23539. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23540. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  23541. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  23542. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  23543. /**
  23544. * Interface used to describe a physics joint
  23545. */
  23546. export interface PhysicsImpostorJoint {
  23547. /** Defines the main impostor to which the joint is linked */
  23548. mainImpostor: PhysicsImpostor;
  23549. /** Defines the impostor that is connected to the main impostor using this joint */
  23550. connectedImpostor: PhysicsImpostor;
  23551. /** Defines the joint itself */
  23552. joint: PhysicsJoint;
  23553. }
  23554. /** @hidden */
  23555. export interface IPhysicsEnginePlugin {
  23556. world: any;
  23557. name: string;
  23558. setGravity(gravity: Vector3): void;
  23559. setTimeStep(timeStep: number): void;
  23560. getTimeStep(): number;
  23561. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  23562. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23563. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23564. generatePhysicsBody(impostor: PhysicsImpostor): void;
  23565. removePhysicsBody(impostor: PhysicsImpostor): void;
  23566. generateJoint(joint: PhysicsImpostorJoint): void;
  23567. removeJoint(joint: PhysicsImpostorJoint): void;
  23568. isSupported(): boolean;
  23569. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  23570. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  23571. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23572. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23573. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23574. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23575. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  23576. getBodyMass(impostor: PhysicsImpostor): number;
  23577. getBodyFriction(impostor: PhysicsImpostor): number;
  23578. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  23579. getBodyRestitution(impostor: PhysicsImpostor): number;
  23580. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  23581. getBodyPressure?(impostor: PhysicsImpostor): number;
  23582. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  23583. getBodyStiffness?(impostor: PhysicsImpostor): number;
  23584. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  23585. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  23586. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  23587. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  23588. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  23589. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23590. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23591. sleepBody(impostor: PhysicsImpostor): void;
  23592. wakeUpBody(impostor: PhysicsImpostor): void;
  23593. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23594. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  23595. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  23596. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23597. getRadius(impostor: PhysicsImpostor): number;
  23598. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  23599. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  23600. dispose(): void;
  23601. }
  23602. /**
  23603. * Interface used to define a physics engine
  23604. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  23605. */
  23606. export interface IPhysicsEngine {
  23607. /**
  23608. * Gets the gravity vector used by the simulation
  23609. */
  23610. gravity: Vector3;
  23611. /**
  23612. * Sets the gravity vector used by the simulation
  23613. * @param gravity defines the gravity vector to use
  23614. */
  23615. setGravity(gravity: Vector3): void;
  23616. /**
  23617. * Set the time step of the physics engine.
  23618. * Default is 1/60.
  23619. * To slow it down, enter 1/600 for example.
  23620. * To speed it up, 1/30
  23621. * @param newTimeStep the new timestep to apply to this world.
  23622. */
  23623. setTimeStep(newTimeStep: number): void;
  23624. /**
  23625. * Get the time step of the physics engine.
  23626. * @returns the current time step
  23627. */
  23628. getTimeStep(): number;
  23629. /**
  23630. * Release all resources
  23631. */
  23632. dispose(): void;
  23633. /**
  23634. * Gets the name of the current physics plugin
  23635. * @returns the name of the plugin
  23636. */
  23637. getPhysicsPluginName(): string;
  23638. /**
  23639. * Adding a new impostor for the impostor tracking.
  23640. * This will be done by the impostor itself.
  23641. * @param impostor the impostor to add
  23642. */
  23643. addImpostor(impostor: PhysicsImpostor): void;
  23644. /**
  23645. * Remove an impostor from the engine.
  23646. * This impostor and its mesh will not longer be updated by the physics engine.
  23647. * @param impostor the impostor to remove
  23648. */
  23649. removeImpostor(impostor: PhysicsImpostor): void;
  23650. /**
  23651. * Add a joint to the physics engine
  23652. * @param mainImpostor defines the main impostor to which the joint is added.
  23653. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  23654. * @param joint defines the joint that will connect both impostors.
  23655. */
  23656. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23657. /**
  23658. * Removes a joint from the simulation
  23659. * @param mainImpostor defines the impostor used with the joint
  23660. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  23661. * @param joint defines the joint to remove
  23662. */
  23663. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23664. /**
  23665. * Gets the current plugin used to run the simulation
  23666. * @returns current plugin
  23667. */
  23668. getPhysicsPlugin(): IPhysicsEnginePlugin;
  23669. /**
  23670. * Gets the list of physic impostors
  23671. * @returns an array of PhysicsImpostor
  23672. */
  23673. getImpostors(): Array<PhysicsImpostor>;
  23674. /**
  23675. * Gets the impostor for a physics enabled object
  23676. * @param object defines the object impersonated by the impostor
  23677. * @returns the PhysicsImpostor or null if not found
  23678. */
  23679. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  23680. /**
  23681. * Gets the impostor for a physics body object
  23682. * @param body defines physics body used by the impostor
  23683. * @returns the PhysicsImpostor or null if not found
  23684. */
  23685. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  23686. /**
  23687. * Does a raycast in the physics world
  23688. * @param from when should the ray start?
  23689. * @param to when should the ray end?
  23690. * @returns PhysicsRaycastResult
  23691. */
  23692. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23693. /**
  23694. * Called by the scene. No need to call it.
  23695. * @param delta defines the timespam between frames
  23696. */
  23697. _step(delta: number): void;
  23698. }
  23699. }
  23700. declare module "babylonjs/Physics/physicsImpostor" {
  23701. import { Nullable, IndicesArray } from "babylonjs/types";
  23702. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  23703. import { TransformNode } from "babylonjs/Meshes/transformNode";
  23704. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23705. import { Scene } from "babylonjs/scene";
  23706. import { Bone } from "babylonjs/Bones/bone";
  23707. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  23708. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  23709. import { Space } from "babylonjs/Maths/math.axis";
  23710. /**
  23711. * The interface for the physics imposter parameters
  23712. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23713. */
  23714. export interface PhysicsImpostorParameters {
  23715. /**
  23716. * The mass of the physics imposter
  23717. */
  23718. mass: number;
  23719. /**
  23720. * The friction of the physics imposter
  23721. */
  23722. friction?: number;
  23723. /**
  23724. * The coefficient of restitution of the physics imposter
  23725. */
  23726. restitution?: number;
  23727. /**
  23728. * The native options of the physics imposter
  23729. */
  23730. nativeOptions?: any;
  23731. /**
  23732. * Specifies if the parent should be ignored
  23733. */
  23734. ignoreParent?: boolean;
  23735. /**
  23736. * Specifies if bi-directional transformations should be disabled
  23737. */
  23738. disableBidirectionalTransformation?: boolean;
  23739. /**
  23740. * The pressure inside the physics imposter, soft object only
  23741. */
  23742. pressure?: number;
  23743. /**
  23744. * The stiffness the physics imposter, soft object only
  23745. */
  23746. stiffness?: number;
  23747. /**
  23748. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  23749. */
  23750. velocityIterations?: number;
  23751. /**
  23752. * The number of iterations used in maintaining consistent vertex positions, soft object only
  23753. */
  23754. positionIterations?: number;
  23755. /**
  23756. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  23757. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  23758. * Add to fix multiple points
  23759. */
  23760. fixedPoints?: number;
  23761. /**
  23762. * The collision margin around a soft object
  23763. */
  23764. margin?: number;
  23765. /**
  23766. * The collision margin around a soft object
  23767. */
  23768. damping?: number;
  23769. /**
  23770. * The path for a rope based on an extrusion
  23771. */
  23772. path?: any;
  23773. /**
  23774. * The shape of an extrusion used for a rope based on an extrusion
  23775. */
  23776. shape?: any;
  23777. }
  23778. /**
  23779. * Interface for a physics-enabled object
  23780. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23781. */
  23782. export interface IPhysicsEnabledObject {
  23783. /**
  23784. * The position of the physics-enabled object
  23785. */
  23786. position: Vector3;
  23787. /**
  23788. * The rotation of the physics-enabled object
  23789. */
  23790. rotationQuaternion: Nullable<Quaternion>;
  23791. /**
  23792. * The scale of the physics-enabled object
  23793. */
  23794. scaling: Vector3;
  23795. /**
  23796. * The rotation of the physics-enabled object
  23797. */
  23798. rotation?: Vector3;
  23799. /**
  23800. * The parent of the physics-enabled object
  23801. */
  23802. parent?: any;
  23803. /**
  23804. * The bounding info of the physics-enabled object
  23805. * @returns The bounding info of the physics-enabled object
  23806. */
  23807. getBoundingInfo(): BoundingInfo;
  23808. /**
  23809. * Computes the world matrix
  23810. * @param force Specifies if the world matrix should be computed by force
  23811. * @returns A world matrix
  23812. */
  23813. computeWorldMatrix(force: boolean): Matrix;
  23814. /**
  23815. * Gets the world matrix
  23816. * @returns A world matrix
  23817. */
  23818. getWorldMatrix?(): Matrix;
  23819. /**
  23820. * Gets the child meshes
  23821. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  23822. * @returns An array of abstract meshes
  23823. */
  23824. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  23825. /**
  23826. * Gets the vertex data
  23827. * @param kind The type of vertex data
  23828. * @returns A nullable array of numbers, or a float32 array
  23829. */
  23830. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  23831. /**
  23832. * Gets the indices from the mesh
  23833. * @returns A nullable array of index arrays
  23834. */
  23835. getIndices?(): Nullable<IndicesArray>;
  23836. /**
  23837. * Gets the scene from the mesh
  23838. * @returns the indices array or null
  23839. */
  23840. getScene?(): Scene;
  23841. /**
  23842. * Gets the absolute position from the mesh
  23843. * @returns the absolute position
  23844. */
  23845. getAbsolutePosition(): Vector3;
  23846. /**
  23847. * Gets the absolute pivot point from the mesh
  23848. * @returns the absolute pivot point
  23849. */
  23850. getAbsolutePivotPoint(): Vector3;
  23851. /**
  23852. * Rotates the mesh
  23853. * @param axis The axis of rotation
  23854. * @param amount The amount of rotation
  23855. * @param space The space of the rotation
  23856. * @returns The rotation transform node
  23857. */
  23858. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  23859. /**
  23860. * Translates the mesh
  23861. * @param axis The axis of translation
  23862. * @param distance The distance of translation
  23863. * @param space The space of the translation
  23864. * @returns The transform node
  23865. */
  23866. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  23867. /**
  23868. * Sets the absolute position of the mesh
  23869. * @param absolutePosition The absolute position of the mesh
  23870. * @returns The transform node
  23871. */
  23872. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  23873. /**
  23874. * Gets the class name of the mesh
  23875. * @returns The class name
  23876. */
  23877. getClassName(): string;
  23878. }
  23879. /**
  23880. * Represents a physics imposter
  23881. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23882. */
  23883. export class PhysicsImpostor {
  23884. /**
  23885. * The physics-enabled object used as the physics imposter
  23886. */
  23887. object: IPhysicsEnabledObject;
  23888. /**
  23889. * The type of the physics imposter
  23890. */
  23891. type: number;
  23892. private _options;
  23893. private _scene?;
  23894. /**
  23895. * The default object size of the imposter
  23896. */
  23897. static DEFAULT_OBJECT_SIZE: Vector3;
  23898. /**
  23899. * The identity quaternion of the imposter
  23900. */
  23901. static IDENTITY_QUATERNION: Quaternion;
  23902. /** @hidden */
  23903. _pluginData: any;
  23904. private _physicsEngine;
  23905. private _physicsBody;
  23906. private _bodyUpdateRequired;
  23907. private _onBeforePhysicsStepCallbacks;
  23908. private _onAfterPhysicsStepCallbacks;
  23909. /** @hidden */
  23910. _onPhysicsCollideCallbacks: Array<{
  23911. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  23912. otherImpostors: Array<PhysicsImpostor>;
  23913. }>;
  23914. private _deltaPosition;
  23915. private _deltaRotation;
  23916. private _deltaRotationConjugated;
  23917. /** @hidden */
  23918. _isFromLine: boolean;
  23919. private _parent;
  23920. private _isDisposed;
  23921. private static _tmpVecs;
  23922. private static _tmpQuat;
  23923. /**
  23924. * Specifies if the physics imposter is disposed
  23925. */
  23926. readonly isDisposed: boolean;
  23927. /**
  23928. * Gets the mass of the physics imposter
  23929. */
  23930. mass: number;
  23931. /**
  23932. * Gets the coefficient of friction
  23933. */
  23934. /**
  23935. * Sets the coefficient of friction
  23936. */
  23937. friction: number;
  23938. /**
  23939. * Gets the coefficient of restitution
  23940. */
  23941. /**
  23942. * Sets the coefficient of restitution
  23943. */
  23944. restitution: number;
  23945. /**
  23946. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  23947. */
  23948. /**
  23949. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  23950. */
  23951. pressure: number;
  23952. /**
  23953. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  23954. */
  23955. /**
  23956. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  23957. */
  23958. stiffness: number;
  23959. /**
  23960. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  23961. */
  23962. /**
  23963. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  23964. */
  23965. velocityIterations: number;
  23966. /**
  23967. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  23968. */
  23969. /**
  23970. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  23971. */
  23972. positionIterations: number;
  23973. /**
  23974. * The unique id of the physics imposter
  23975. * set by the physics engine when adding this impostor to the array
  23976. */
  23977. uniqueId: number;
  23978. /**
  23979. * @hidden
  23980. */
  23981. soft: boolean;
  23982. /**
  23983. * @hidden
  23984. */
  23985. segments: number;
  23986. private _joints;
  23987. /**
  23988. * Initializes the physics imposter
  23989. * @param object The physics-enabled object used as the physics imposter
  23990. * @param type The type of the physics imposter
  23991. * @param _options The options for the physics imposter
  23992. * @param _scene The Babylon scene
  23993. */
  23994. constructor(
  23995. /**
  23996. * The physics-enabled object used as the physics imposter
  23997. */
  23998. object: IPhysicsEnabledObject,
  23999. /**
  24000. * The type of the physics imposter
  24001. */
  24002. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  24003. /**
  24004. * This function will completly initialize this impostor.
  24005. * It will create a new body - but only if this mesh has no parent.
  24006. * If it has, this impostor will not be used other than to define the impostor
  24007. * of the child mesh.
  24008. * @hidden
  24009. */
  24010. _init(): void;
  24011. private _getPhysicsParent;
  24012. /**
  24013. * Should a new body be generated.
  24014. * @returns boolean specifying if body initialization is required
  24015. */
  24016. isBodyInitRequired(): boolean;
  24017. /**
  24018. * Sets the updated scaling
  24019. * @param updated Specifies if the scaling is updated
  24020. */
  24021. setScalingUpdated(): void;
  24022. /**
  24023. * Force a regeneration of this or the parent's impostor's body.
  24024. * Use under cautious - This will remove all joints already implemented.
  24025. */
  24026. forceUpdate(): void;
  24027. /**
  24028. * Gets the body that holds this impostor. Either its own, or its parent.
  24029. */
  24030. /**
  24031. * Set the physics body. Used mainly by the physics engine/plugin
  24032. */
  24033. physicsBody: any;
  24034. /**
  24035. * Get the parent of the physics imposter
  24036. * @returns Physics imposter or null
  24037. */
  24038. /**
  24039. * Sets the parent of the physics imposter
  24040. */
  24041. parent: Nullable<PhysicsImpostor>;
  24042. /**
  24043. * Resets the update flags
  24044. */
  24045. resetUpdateFlags(): void;
  24046. /**
  24047. * Gets the object extend size
  24048. * @returns the object extend size
  24049. */
  24050. getObjectExtendSize(): Vector3;
  24051. /**
  24052. * Gets the object center
  24053. * @returns The object center
  24054. */
  24055. getObjectCenter(): Vector3;
  24056. /**
  24057. * Get a specific parametes from the options parameter
  24058. * @param paramName The object parameter name
  24059. * @returns The object parameter
  24060. */
  24061. getParam(paramName: string): any;
  24062. /**
  24063. * Sets a specific parameter in the options given to the physics plugin
  24064. * @param paramName The parameter name
  24065. * @param value The value of the parameter
  24066. */
  24067. setParam(paramName: string, value: number): void;
  24068. /**
  24069. * Specifically change the body's mass option. Won't recreate the physics body object
  24070. * @param mass The mass of the physics imposter
  24071. */
  24072. setMass(mass: number): void;
  24073. /**
  24074. * Gets the linear velocity
  24075. * @returns linear velocity or null
  24076. */
  24077. getLinearVelocity(): Nullable<Vector3>;
  24078. /**
  24079. * Sets the linear velocity
  24080. * @param velocity linear velocity or null
  24081. */
  24082. setLinearVelocity(velocity: Nullable<Vector3>): void;
  24083. /**
  24084. * Gets the angular velocity
  24085. * @returns angular velocity or null
  24086. */
  24087. getAngularVelocity(): Nullable<Vector3>;
  24088. /**
  24089. * Sets the angular velocity
  24090. * @param velocity The velocity or null
  24091. */
  24092. setAngularVelocity(velocity: Nullable<Vector3>): void;
  24093. /**
  24094. * Execute a function with the physics plugin native code
  24095. * Provide a function the will have two variables - the world object and the physics body object
  24096. * @param func The function to execute with the physics plugin native code
  24097. */
  24098. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  24099. /**
  24100. * Register a function that will be executed before the physics world is stepping forward
  24101. * @param func The function to execute before the physics world is stepped forward
  24102. */
  24103. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24104. /**
  24105. * Unregister a function that will be executed before the physics world is stepping forward
  24106. * @param func The function to execute before the physics world is stepped forward
  24107. */
  24108. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24109. /**
  24110. * Register a function that will be executed after the physics step
  24111. * @param func The function to execute after physics step
  24112. */
  24113. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24114. /**
  24115. * Unregisters a function that will be executed after the physics step
  24116. * @param func The function to execute after physics step
  24117. */
  24118. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24119. /**
  24120. * register a function that will be executed when this impostor collides against a different body
  24121. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  24122. * @param func Callback that is executed on collision
  24123. */
  24124. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  24125. /**
  24126. * Unregisters the physics imposter on contact
  24127. * @param collideAgainst The physics object to collide against
  24128. * @param func Callback to execute on collision
  24129. */
  24130. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  24131. private _tmpQuat;
  24132. private _tmpQuat2;
  24133. /**
  24134. * Get the parent rotation
  24135. * @returns The parent rotation
  24136. */
  24137. getParentsRotation(): Quaternion;
  24138. /**
  24139. * this function is executed by the physics engine.
  24140. */
  24141. beforeStep: () => void;
  24142. /**
  24143. * this function is executed by the physics engine
  24144. */
  24145. afterStep: () => void;
  24146. /**
  24147. * Legacy collision detection event support
  24148. */
  24149. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  24150. /**
  24151. * event and body object due to cannon's event-based architecture.
  24152. */
  24153. onCollide: (e: {
  24154. body: any;
  24155. }) => void;
  24156. /**
  24157. * Apply a force
  24158. * @param force The force to apply
  24159. * @param contactPoint The contact point for the force
  24160. * @returns The physics imposter
  24161. */
  24162. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  24163. /**
  24164. * Apply an impulse
  24165. * @param force The impulse force
  24166. * @param contactPoint The contact point for the impulse force
  24167. * @returns The physics imposter
  24168. */
  24169. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  24170. /**
  24171. * A help function to create a joint
  24172. * @param otherImpostor A physics imposter used to create a joint
  24173. * @param jointType The type of joint
  24174. * @param jointData The data for the joint
  24175. * @returns The physics imposter
  24176. */
  24177. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  24178. /**
  24179. * Add a joint to this impostor with a different impostor
  24180. * @param otherImpostor A physics imposter used to add a joint
  24181. * @param joint The joint to add
  24182. * @returns The physics imposter
  24183. */
  24184. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  24185. /**
  24186. * Add an anchor to a cloth impostor
  24187. * @param otherImpostor rigid impostor to anchor to
  24188. * @param width ratio across width from 0 to 1
  24189. * @param height ratio up height from 0 to 1
  24190. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  24191. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  24192. * @returns impostor the soft imposter
  24193. */
  24194. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  24195. /**
  24196. * Add a hook to a rope impostor
  24197. * @param otherImpostor rigid impostor to anchor to
  24198. * @param length ratio across rope from 0 to 1
  24199. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  24200. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  24201. * @returns impostor the rope imposter
  24202. */
  24203. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  24204. /**
  24205. * Will keep this body still, in a sleep mode.
  24206. * @returns the physics imposter
  24207. */
  24208. sleep(): PhysicsImpostor;
  24209. /**
  24210. * Wake the body up.
  24211. * @returns The physics imposter
  24212. */
  24213. wakeUp(): PhysicsImpostor;
  24214. /**
  24215. * Clones the physics imposter
  24216. * @param newObject The physics imposter clones to this physics-enabled object
  24217. * @returns A nullable physics imposter
  24218. */
  24219. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  24220. /**
  24221. * Disposes the physics imposter
  24222. */
  24223. dispose(): void;
  24224. /**
  24225. * Sets the delta position
  24226. * @param position The delta position amount
  24227. */
  24228. setDeltaPosition(position: Vector3): void;
  24229. /**
  24230. * Sets the delta rotation
  24231. * @param rotation The delta rotation amount
  24232. */
  24233. setDeltaRotation(rotation: Quaternion): void;
  24234. /**
  24235. * Gets the box size of the physics imposter and stores the result in the input parameter
  24236. * @param result Stores the box size
  24237. * @returns The physics imposter
  24238. */
  24239. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  24240. /**
  24241. * Gets the radius of the physics imposter
  24242. * @returns Radius of the physics imposter
  24243. */
  24244. getRadius(): number;
  24245. /**
  24246. * Sync a bone with this impostor
  24247. * @param bone The bone to sync to the impostor.
  24248. * @param boneMesh The mesh that the bone is influencing.
  24249. * @param jointPivot The pivot of the joint / bone in local space.
  24250. * @param distToJoint Optional distance from the impostor to the joint.
  24251. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  24252. */
  24253. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  24254. /**
  24255. * Sync impostor to a bone
  24256. * @param bone The bone that the impostor will be synced to.
  24257. * @param boneMesh The mesh that the bone is influencing.
  24258. * @param jointPivot The pivot of the joint / bone in local space.
  24259. * @param distToJoint Optional distance from the impostor to the joint.
  24260. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  24261. * @param boneAxis Optional vector3 axis the bone is aligned with
  24262. */
  24263. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  24264. /**
  24265. * No-Imposter type
  24266. */
  24267. static NoImpostor: number;
  24268. /**
  24269. * Sphere-Imposter type
  24270. */
  24271. static SphereImpostor: number;
  24272. /**
  24273. * Box-Imposter type
  24274. */
  24275. static BoxImpostor: number;
  24276. /**
  24277. * Plane-Imposter type
  24278. */
  24279. static PlaneImpostor: number;
  24280. /**
  24281. * Mesh-imposter type
  24282. */
  24283. static MeshImpostor: number;
  24284. /**
  24285. * Capsule-Impostor type (Ammo.js plugin only)
  24286. */
  24287. static CapsuleImpostor: number;
  24288. /**
  24289. * Cylinder-Imposter type
  24290. */
  24291. static CylinderImpostor: number;
  24292. /**
  24293. * Particle-Imposter type
  24294. */
  24295. static ParticleImpostor: number;
  24296. /**
  24297. * Heightmap-Imposter type
  24298. */
  24299. static HeightmapImpostor: number;
  24300. /**
  24301. * ConvexHull-Impostor type (Ammo.js plugin only)
  24302. */
  24303. static ConvexHullImpostor: number;
  24304. /**
  24305. * Rope-Imposter type
  24306. */
  24307. static RopeImpostor: number;
  24308. /**
  24309. * Cloth-Imposter type
  24310. */
  24311. static ClothImpostor: number;
  24312. /**
  24313. * Softbody-Imposter type
  24314. */
  24315. static SoftbodyImpostor: number;
  24316. }
  24317. }
  24318. declare module "babylonjs/Meshes/mesh" {
  24319. import { Observable } from "babylonjs/Misc/observable";
  24320. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  24321. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  24322. import { Camera } from "babylonjs/Cameras/camera";
  24323. import { Scene } from "babylonjs/scene";
  24324. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  24325. import { Color4 } from "babylonjs/Maths/math.color";
  24326. import { Engine } from "babylonjs/Engines/engine";
  24327. import { Node } from "babylonjs/node";
  24328. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  24329. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  24330. import { Buffer } from "babylonjs/Meshes/buffer";
  24331. import { Geometry } from "babylonjs/Meshes/geometry";
  24332. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24333. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24334. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  24335. import { Effect } from "babylonjs/Materials/effect";
  24336. import { Material } from "babylonjs/Materials/material";
  24337. import { Skeleton } from "babylonjs/Bones/skeleton";
  24338. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  24339. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  24340. import { Path3D } from "babylonjs/Maths/math.path";
  24341. import { Plane } from "babylonjs/Maths/math.plane";
  24342. import { TransformNode } from "babylonjs/Meshes/transformNode";
  24343. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  24344. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  24345. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  24346. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  24347. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  24348. /**
  24349. * @hidden
  24350. **/
  24351. export class _CreationDataStorage {
  24352. closePath?: boolean;
  24353. closeArray?: boolean;
  24354. idx: number[];
  24355. dashSize: number;
  24356. gapSize: number;
  24357. path3D: Path3D;
  24358. pathArray: Vector3[][];
  24359. arc: number;
  24360. radius: number;
  24361. cap: number;
  24362. tessellation: number;
  24363. }
  24364. /**
  24365. * @hidden
  24366. **/
  24367. class _InstanceDataStorage {
  24368. visibleInstances: any;
  24369. batchCache: _InstancesBatch;
  24370. instancesBufferSize: number;
  24371. instancesBuffer: Nullable<Buffer>;
  24372. instancesData: Float32Array;
  24373. overridenInstanceCount: number;
  24374. isFrozen: boolean;
  24375. previousBatch: Nullable<_InstancesBatch>;
  24376. hardwareInstancedRendering: boolean;
  24377. sideOrientation: number;
  24378. }
  24379. /**
  24380. * @hidden
  24381. **/
  24382. export class _InstancesBatch {
  24383. mustReturn: boolean;
  24384. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  24385. renderSelf: boolean[];
  24386. hardwareInstancedRendering: boolean[];
  24387. }
  24388. /**
  24389. * Class used to represent renderable models
  24390. */
  24391. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  24392. /**
  24393. * Mesh side orientation : usually the external or front surface
  24394. */
  24395. static readonly FRONTSIDE: number;
  24396. /**
  24397. * Mesh side orientation : usually the internal or back surface
  24398. */
  24399. static readonly BACKSIDE: number;
  24400. /**
  24401. * Mesh side orientation : both internal and external or front and back surfaces
  24402. */
  24403. static readonly DOUBLESIDE: number;
  24404. /**
  24405. * Mesh side orientation : by default, `FRONTSIDE`
  24406. */
  24407. static readonly DEFAULTSIDE: number;
  24408. /**
  24409. * Mesh cap setting : no cap
  24410. */
  24411. static readonly NO_CAP: number;
  24412. /**
  24413. * Mesh cap setting : one cap at the beginning of the mesh
  24414. */
  24415. static readonly CAP_START: number;
  24416. /**
  24417. * Mesh cap setting : one cap at the end of the mesh
  24418. */
  24419. static readonly CAP_END: number;
  24420. /**
  24421. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  24422. */
  24423. static readonly CAP_ALL: number;
  24424. /**
  24425. * Mesh pattern setting : no flip or rotate
  24426. */
  24427. static readonly NO_FLIP: number;
  24428. /**
  24429. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  24430. */
  24431. static readonly FLIP_TILE: number;
  24432. /**
  24433. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  24434. */
  24435. static readonly ROTATE_TILE: number;
  24436. /**
  24437. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  24438. */
  24439. static readonly FLIP_ROW: number;
  24440. /**
  24441. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  24442. */
  24443. static readonly ROTATE_ROW: number;
  24444. /**
  24445. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  24446. */
  24447. static readonly FLIP_N_ROTATE_TILE: number;
  24448. /**
  24449. * Mesh pattern setting : rotate pattern and rotate
  24450. */
  24451. static readonly FLIP_N_ROTATE_ROW: number;
  24452. /**
  24453. * Mesh tile positioning : part tiles same on left/right or top/bottom
  24454. */
  24455. static readonly CENTER: number;
  24456. /**
  24457. * Mesh tile positioning : part tiles on left
  24458. */
  24459. static readonly LEFT: number;
  24460. /**
  24461. * Mesh tile positioning : part tiles on right
  24462. */
  24463. static readonly RIGHT: number;
  24464. /**
  24465. * Mesh tile positioning : part tiles on top
  24466. */
  24467. static readonly TOP: number;
  24468. /**
  24469. * Mesh tile positioning : part tiles on bottom
  24470. */
  24471. static readonly BOTTOM: number;
  24472. /**
  24473. * Gets the default side orientation.
  24474. * @param orientation the orientation to value to attempt to get
  24475. * @returns the default orientation
  24476. * @hidden
  24477. */
  24478. static _GetDefaultSideOrientation(orientation?: number): number;
  24479. private _internalMeshDataInfo;
  24480. /**
  24481. * An event triggered before rendering the mesh
  24482. */
  24483. readonly onBeforeRenderObservable: Observable<Mesh>;
  24484. /**
  24485. * An event triggered before binding the mesh
  24486. */
  24487. readonly onBeforeBindObservable: Observable<Mesh>;
  24488. /**
  24489. * An event triggered after rendering the mesh
  24490. */
  24491. readonly onAfterRenderObservable: Observable<Mesh>;
  24492. /**
  24493. * An event triggered before drawing the mesh
  24494. */
  24495. readonly onBeforeDrawObservable: Observable<Mesh>;
  24496. private _onBeforeDrawObserver;
  24497. /**
  24498. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  24499. */
  24500. onBeforeDraw: () => void;
  24501. readonly hasInstances: boolean;
  24502. /**
  24503. * Gets the delay loading state of the mesh (when delay loading is turned on)
  24504. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  24505. */
  24506. delayLoadState: number;
  24507. /**
  24508. * Gets the list of instances created from this mesh
  24509. * it is not supposed to be modified manually.
  24510. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  24511. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  24512. */
  24513. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  24514. /**
  24515. * Gets the file containing delay loading data for this mesh
  24516. */
  24517. delayLoadingFile: string;
  24518. /** @hidden */
  24519. _binaryInfo: any;
  24520. /**
  24521. * User defined function used to change how LOD level selection is done
  24522. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  24523. */
  24524. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  24525. /**
  24526. * Gets or sets the morph target manager
  24527. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  24528. */
  24529. morphTargetManager: Nullable<MorphTargetManager>;
  24530. /** @hidden */
  24531. _creationDataStorage: Nullable<_CreationDataStorage>;
  24532. /** @hidden */
  24533. _geometry: Nullable<Geometry>;
  24534. /** @hidden */
  24535. _delayInfo: Array<string>;
  24536. /** @hidden */
  24537. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  24538. /** @hidden */
  24539. _instanceDataStorage: _InstanceDataStorage;
  24540. private _effectiveMaterial;
  24541. /** @hidden */
  24542. _shouldGenerateFlatShading: boolean;
  24543. /** @hidden */
  24544. _originalBuilderSideOrientation: number;
  24545. /**
  24546. * Use this property to change the original side orientation defined at construction time
  24547. */
  24548. overrideMaterialSideOrientation: Nullable<number>;
  24549. /**
  24550. * Gets the source mesh (the one used to clone this one from)
  24551. */
  24552. readonly source: Nullable<Mesh>;
  24553. /**
  24554. * Gets or sets a boolean indicating that this mesh does not use index buffer
  24555. */
  24556. isUnIndexed: boolean;
  24557. /**
  24558. * @constructor
  24559. * @param name The value used by scene.getMeshByName() to do a lookup.
  24560. * @param scene The scene to add this mesh to.
  24561. * @param parent The parent of this mesh, if it has one
  24562. * @param source An optional Mesh from which geometry is shared, cloned.
  24563. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  24564. * When false, achieved by calling a clone(), also passing False.
  24565. * This will make creation of children, recursive.
  24566. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  24567. */
  24568. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  24569. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  24570. doNotInstantiate: boolean;
  24571. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  24572. /**
  24573. * Gets the class name
  24574. * @returns the string "Mesh".
  24575. */
  24576. getClassName(): string;
  24577. /** @hidden */
  24578. readonly _isMesh: boolean;
  24579. /**
  24580. * Returns a description of this mesh
  24581. * @param fullDetails define if full details about this mesh must be used
  24582. * @returns a descriptive string representing this mesh
  24583. */
  24584. toString(fullDetails?: boolean): string;
  24585. /** @hidden */
  24586. _unBindEffect(): void;
  24587. /**
  24588. * Gets a boolean indicating if this mesh has LOD
  24589. */
  24590. readonly hasLODLevels: boolean;
  24591. /**
  24592. * Gets the list of MeshLODLevel associated with the current mesh
  24593. * @returns an array of MeshLODLevel
  24594. */
  24595. getLODLevels(): MeshLODLevel[];
  24596. private _sortLODLevels;
  24597. /**
  24598. * Add a mesh as LOD level triggered at the given distance.
  24599. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24600. * @param distance The distance from the center of the object to show this level
  24601. * @param mesh The mesh to be added as LOD level (can be null)
  24602. * @return This mesh (for chaining)
  24603. */
  24604. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  24605. /**
  24606. * Returns the LOD level mesh at the passed distance or null if not found.
  24607. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24608. * @param distance The distance from the center of the object to show this level
  24609. * @returns a Mesh or `null`
  24610. */
  24611. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  24612. /**
  24613. * Remove a mesh from the LOD array
  24614. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24615. * @param mesh defines the mesh to be removed
  24616. * @return This mesh (for chaining)
  24617. */
  24618. removeLODLevel(mesh: Mesh): Mesh;
  24619. /**
  24620. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  24621. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24622. * @param camera defines the camera to use to compute distance
  24623. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  24624. * @return This mesh (for chaining)
  24625. */
  24626. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  24627. /**
  24628. * Gets the mesh internal Geometry object
  24629. */
  24630. readonly geometry: Nullable<Geometry>;
  24631. /**
  24632. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  24633. * @returns the total number of vertices
  24634. */
  24635. getTotalVertices(): number;
  24636. /**
  24637. * Returns the content of an associated vertex buffer
  24638. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24639. * - VertexBuffer.PositionKind
  24640. * - VertexBuffer.UVKind
  24641. * - VertexBuffer.UV2Kind
  24642. * - VertexBuffer.UV3Kind
  24643. * - VertexBuffer.UV4Kind
  24644. * - VertexBuffer.UV5Kind
  24645. * - VertexBuffer.UV6Kind
  24646. * - VertexBuffer.ColorKind
  24647. * - VertexBuffer.MatricesIndicesKind
  24648. * - VertexBuffer.MatricesIndicesExtraKind
  24649. * - VertexBuffer.MatricesWeightsKind
  24650. * - VertexBuffer.MatricesWeightsExtraKind
  24651. * @param copyWhenShared defines a boolean indicating that if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one
  24652. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  24653. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  24654. */
  24655. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  24656. /**
  24657. * Returns the mesh VertexBuffer object from the requested `kind`
  24658. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24659. * - VertexBuffer.PositionKind
  24660. * - VertexBuffer.NormalKind
  24661. * - VertexBuffer.UVKind
  24662. * - VertexBuffer.UV2Kind
  24663. * - VertexBuffer.UV3Kind
  24664. * - VertexBuffer.UV4Kind
  24665. * - VertexBuffer.UV5Kind
  24666. * - VertexBuffer.UV6Kind
  24667. * - VertexBuffer.ColorKind
  24668. * - VertexBuffer.MatricesIndicesKind
  24669. * - VertexBuffer.MatricesIndicesExtraKind
  24670. * - VertexBuffer.MatricesWeightsKind
  24671. * - VertexBuffer.MatricesWeightsExtraKind
  24672. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  24673. */
  24674. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  24675. /**
  24676. * Tests if a specific vertex buffer is associated with this mesh
  24677. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24678. * - VertexBuffer.PositionKind
  24679. * - VertexBuffer.NormalKind
  24680. * - VertexBuffer.UVKind
  24681. * - VertexBuffer.UV2Kind
  24682. * - VertexBuffer.UV3Kind
  24683. * - VertexBuffer.UV4Kind
  24684. * - VertexBuffer.UV5Kind
  24685. * - VertexBuffer.UV6Kind
  24686. * - VertexBuffer.ColorKind
  24687. * - VertexBuffer.MatricesIndicesKind
  24688. * - VertexBuffer.MatricesIndicesExtraKind
  24689. * - VertexBuffer.MatricesWeightsKind
  24690. * - VertexBuffer.MatricesWeightsExtraKind
  24691. * @returns a boolean
  24692. */
  24693. isVerticesDataPresent(kind: string): boolean;
  24694. /**
  24695. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  24696. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24697. * - VertexBuffer.PositionKind
  24698. * - VertexBuffer.UVKind
  24699. * - VertexBuffer.UV2Kind
  24700. * - VertexBuffer.UV3Kind
  24701. * - VertexBuffer.UV4Kind
  24702. * - VertexBuffer.UV5Kind
  24703. * - VertexBuffer.UV6Kind
  24704. * - VertexBuffer.ColorKind
  24705. * - VertexBuffer.MatricesIndicesKind
  24706. * - VertexBuffer.MatricesIndicesExtraKind
  24707. * - VertexBuffer.MatricesWeightsKind
  24708. * - VertexBuffer.MatricesWeightsExtraKind
  24709. * @returns a boolean
  24710. */
  24711. isVertexBufferUpdatable(kind: string): boolean;
  24712. /**
  24713. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  24714. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24715. * - VertexBuffer.PositionKind
  24716. * - VertexBuffer.NormalKind
  24717. * - VertexBuffer.UVKind
  24718. * - VertexBuffer.UV2Kind
  24719. * - VertexBuffer.UV3Kind
  24720. * - VertexBuffer.UV4Kind
  24721. * - VertexBuffer.UV5Kind
  24722. * - VertexBuffer.UV6Kind
  24723. * - VertexBuffer.ColorKind
  24724. * - VertexBuffer.MatricesIndicesKind
  24725. * - VertexBuffer.MatricesIndicesExtraKind
  24726. * - VertexBuffer.MatricesWeightsKind
  24727. * - VertexBuffer.MatricesWeightsExtraKind
  24728. * @returns an array of strings
  24729. */
  24730. getVerticesDataKinds(): string[];
  24731. /**
  24732. * Returns a positive integer : the total number of indices in this mesh geometry.
  24733. * @returns the numner of indices or zero if the mesh has no geometry.
  24734. */
  24735. getTotalIndices(): number;
  24736. /**
  24737. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  24738. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  24739. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  24740. * @returns the indices array or an empty array if the mesh has no geometry
  24741. */
  24742. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  24743. readonly isBlocked: boolean;
  24744. /**
  24745. * Determine if the current mesh is ready to be rendered
  24746. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  24747. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  24748. * @returns true if all associated assets are ready (material, textures, shaders)
  24749. */
  24750. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  24751. /**
  24752. * Gets a boolean indicating if the normals aren't to be recomputed on next mesh `positions` array update. This property is pertinent only for updatable parametric shapes.
  24753. */
  24754. readonly areNormalsFrozen: boolean;
  24755. /**
  24756. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It prevents the mesh normals from being recomputed on next `positions` array update.
  24757. * @returns the current mesh
  24758. */
  24759. freezeNormals(): Mesh;
  24760. /**
  24761. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It reactivates the mesh normals computation if it was previously frozen
  24762. * @returns the current mesh
  24763. */
  24764. unfreezeNormals(): Mesh;
  24765. /**
  24766. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  24767. */
  24768. overridenInstanceCount: number;
  24769. /** @hidden */
  24770. _preActivate(): Mesh;
  24771. /** @hidden */
  24772. _preActivateForIntermediateRendering(renderId: number): Mesh;
  24773. /** @hidden */
  24774. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  24775. /**
  24776. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  24777. * This means the mesh underlying bounding box and sphere are recomputed.
  24778. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  24779. * @returns the current mesh
  24780. */
  24781. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  24782. /** @hidden */
  24783. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  24784. /**
  24785. * This function will subdivide the mesh into multiple submeshes
  24786. * @param count defines the expected number of submeshes
  24787. */
  24788. subdivide(count: number): void;
  24789. /**
  24790. * Copy a FloatArray into a specific associated vertex buffer
  24791. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24792. * - VertexBuffer.PositionKind
  24793. * - VertexBuffer.UVKind
  24794. * - VertexBuffer.UV2Kind
  24795. * - VertexBuffer.UV3Kind
  24796. * - VertexBuffer.UV4Kind
  24797. * - VertexBuffer.UV5Kind
  24798. * - VertexBuffer.UV6Kind
  24799. * - VertexBuffer.ColorKind
  24800. * - VertexBuffer.MatricesIndicesKind
  24801. * - VertexBuffer.MatricesIndicesExtraKind
  24802. * - VertexBuffer.MatricesWeightsKind
  24803. * - VertexBuffer.MatricesWeightsExtraKind
  24804. * @param data defines the data source
  24805. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24806. * @param stride defines the data stride size (can be null)
  24807. * @returns the current mesh
  24808. */
  24809. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  24810. /**
  24811. * Delete a vertex buffer associated with this mesh
  24812. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  24813. * - VertexBuffer.PositionKind
  24814. * - VertexBuffer.UVKind
  24815. * - VertexBuffer.UV2Kind
  24816. * - VertexBuffer.UV3Kind
  24817. * - VertexBuffer.UV4Kind
  24818. * - VertexBuffer.UV5Kind
  24819. * - VertexBuffer.UV6Kind
  24820. * - VertexBuffer.ColorKind
  24821. * - VertexBuffer.MatricesIndicesKind
  24822. * - VertexBuffer.MatricesIndicesExtraKind
  24823. * - VertexBuffer.MatricesWeightsKind
  24824. * - VertexBuffer.MatricesWeightsExtraKind
  24825. */
  24826. removeVerticesData(kind: string): void;
  24827. /**
  24828. * Flags an associated vertex buffer as updatable
  24829. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  24830. * - VertexBuffer.PositionKind
  24831. * - VertexBuffer.UVKind
  24832. * - VertexBuffer.UV2Kind
  24833. * - VertexBuffer.UV3Kind
  24834. * - VertexBuffer.UV4Kind
  24835. * - VertexBuffer.UV5Kind
  24836. * - VertexBuffer.UV6Kind
  24837. * - VertexBuffer.ColorKind
  24838. * - VertexBuffer.MatricesIndicesKind
  24839. * - VertexBuffer.MatricesIndicesExtraKind
  24840. * - VertexBuffer.MatricesWeightsKind
  24841. * - VertexBuffer.MatricesWeightsExtraKind
  24842. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24843. */
  24844. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  24845. /**
  24846. * Sets the mesh global Vertex Buffer
  24847. * @param buffer defines the buffer to use
  24848. * @returns the current mesh
  24849. */
  24850. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  24851. /**
  24852. * Update a specific associated vertex buffer
  24853. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24854. * - VertexBuffer.PositionKind
  24855. * - VertexBuffer.UVKind
  24856. * - VertexBuffer.UV2Kind
  24857. * - VertexBuffer.UV3Kind
  24858. * - VertexBuffer.UV4Kind
  24859. * - VertexBuffer.UV5Kind
  24860. * - VertexBuffer.UV6Kind
  24861. * - VertexBuffer.ColorKind
  24862. * - VertexBuffer.MatricesIndicesKind
  24863. * - VertexBuffer.MatricesIndicesExtraKind
  24864. * - VertexBuffer.MatricesWeightsKind
  24865. * - VertexBuffer.MatricesWeightsExtraKind
  24866. * @param data defines the data source
  24867. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  24868. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  24869. * @returns the current mesh
  24870. */
  24871. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  24872. /**
  24873. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  24874. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  24875. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  24876. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  24877. * @returns the current mesh
  24878. */
  24879. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  24880. /**
  24881. * Creates a un-shared specific occurence of the geometry for the mesh.
  24882. * @returns the current mesh
  24883. */
  24884. makeGeometryUnique(): Mesh;
  24885. /**
  24886. * Set the index buffer of this mesh
  24887. * @param indices defines the source data
  24888. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  24889. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  24890. * @returns the current mesh
  24891. */
  24892. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  24893. /**
  24894. * Update the current index buffer
  24895. * @param indices defines the source data
  24896. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  24897. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  24898. * @returns the current mesh
  24899. */
  24900. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  24901. /**
  24902. * Invert the geometry to move from a right handed system to a left handed one.
  24903. * @returns the current mesh
  24904. */
  24905. toLeftHanded(): Mesh;
  24906. /** @hidden */
  24907. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  24908. /** @hidden */
  24909. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  24910. /**
  24911. * Registers for this mesh a javascript function called just before the rendering process
  24912. * @param func defines the function to call before rendering this mesh
  24913. * @returns the current mesh
  24914. */
  24915. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  24916. /**
  24917. * Disposes a previously registered javascript function called before the rendering
  24918. * @param func defines the function to remove
  24919. * @returns the current mesh
  24920. */
  24921. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  24922. /**
  24923. * Registers for this mesh a javascript function called just after the rendering is complete
  24924. * @param func defines the function to call after rendering this mesh
  24925. * @returns the current mesh
  24926. */
  24927. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  24928. /**
  24929. * Disposes a previously registered javascript function called after the rendering.
  24930. * @param func defines the function to remove
  24931. * @returns the current mesh
  24932. */
  24933. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  24934. /** @hidden */
  24935. _getInstancesRenderList(subMeshId: number): _InstancesBatch;
  24936. /** @hidden */
  24937. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  24938. /** @hidden */
  24939. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  24940. /** @hidden */
  24941. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  24942. /** @hidden */
  24943. _rebuild(): void;
  24944. /** @hidden */
  24945. _freeze(): void;
  24946. /** @hidden */
  24947. _unFreeze(): void;
  24948. /**
  24949. * Triggers the draw call for the mesh. Usually, you don't need to call this method by your own because the mesh rendering is handled by the scene rendering manager
  24950. * @param subMesh defines the subMesh to render
  24951. * @param enableAlphaMode defines if alpha mode can be changed
  24952. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  24953. * @returns the current mesh
  24954. */
  24955. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  24956. private _onBeforeDraw;
  24957. /**
  24958. * Renormalize the mesh and patch it up if there are no weights
  24959. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  24960. * However in the case of zero weights then we set just a single influence to 1.
  24961. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  24962. */
  24963. cleanMatrixWeights(): void;
  24964. private normalizeSkinFourWeights;
  24965. private normalizeSkinWeightsAndExtra;
  24966. /**
  24967. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  24968. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  24969. * the user know there was an issue with importing the mesh
  24970. * @returns a validation object with skinned, valid and report string
  24971. */
  24972. validateSkinning(): {
  24973. skinned: boolean;
  24974. valid: boolean;
  24975. report: string;
  24976. };
  24977. /** @hidden */
  24978. _checkDelayState(): Mesh;
  24979. private _queueLoad;
  24980. /**
  24981. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  24982. * A mesh is in the frustum if its bounding box intersects the frustum
  24983. * @param frustumPlanes defines the frustum to test
  24984. * @returns true if the mesh is in the frustum planes
  24985. */
  24986. isInFrustum(frustumPlanes: Plane[]): boolean;
  24987. /**
  24988. * Sets the mesh material by the material or multiMaterial `id` property
  24989. * @param id is a string identifying the material or the multiMaterial
  24990. * @returns the current mesh
  24991. */
  24992. setMaterialByID(id: string): Mesh;
  24993. /**
  24994. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  24995. * @returns an array of IAnimatable
  24996. */
  24997. getAnimatables(): IAnimatable[];
  24998. /**
  24999. * Modifies the mesh geometry according to the passed transformation matrix.
  25000. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  25001. * The mesh normals are modified using the same transformation.
  25002. * Note that, under the hood, this method sets a new VertexBuffer each call.
  25003. * @param transform defines the transform matrix to use
  25004. * @see http://doc.babylonjs.com/resources/baking_transformations
  25005. * @returns the current mesh
  25006. */
  25007. bakeTransformIntoVertices(transform: Matrix): Mesh;
  25008. /**
  25009. * Modifies the mesh geometry according to its own current World Matrix.
  25010. * The mesh World Matrix is then reset.
  25011. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  25012. * Note that, under the hood, this method sets a new VertexBuffer each call.
  25013. * @see http://doc.babylonjs.com/resources/baking_transformations
  25014. * @returns the current mesh
  25015. */
  25016. bakeCurrentTransformIntoVertices(): Mesh;
  25017. /** @hidden */
  25018. readonly _positions: Nullable<Vector3[]>;
  25019. /** @hidden */
  25020. _resetPointsArrayCache(): Mesh;
  25021. /** @hidden */
  25022. _generatePointsArray(): boolean;
  25023. /**
  25024. * Returns a new Mesh object generated from the current mesh properties.
  25025. * This method must not get confused with createInstance()
  25026. * @param name is a string, the name given to the new mesh
  25027. * @param newParent can be any Node object (default `null`)
  25028. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  25029. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  25030. * @returns a new mesh
  25031. */
  25032. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  25033. /**
  25034. * Releases resources associated with this mesh.
  25035. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  25036. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  25037. */
  25038. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  25039. /** @hidden */
  25040. _disposeInstanceSpecificData(): void;
  25041. /**
  25042. * Modifies the mesh geometry according to a displacement map.
  25043. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  25044. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  25045. * @param url is a string, the URL from the image file is to be downloaded.
  25046. * @param minHeight is the lower limit of the displacement.
  25047. * @param maxHeight is the upper limit of the displacement.
  25048. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  25049. * @param uvOffset is an optional vector2 used to offset UV.
  25050. * @param uvScale is an optional vector2 used to scale UV.
  25051. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  25052. * @returns the Mesh.
  25053. */
  25054. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  25055. /**
  25056. * Modifies the mesh geometry according to a displacementMap buffer.
  25057. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  25058. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  25059. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  25060. * @param heightMapWidth is the width of the buffer image.
  25061. * @param heightMapHeight is the height of the buffer image.
  25062. * @param minHeight is the lower limit of the displacement.
  25063. * @param maxHeight is the upper limit of the displacement.
  25064. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  25065. * @param uvOffset is an optional vector2 used to offset UV.
  25066. * @param uvScale is an optional vector2 used to scale UV.
  25067. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  25068. * @returns the Mesh.
  25069. */
  25070. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  25071. /**
  25072. * Modify the mesh to get a flat shading rendering.
  25073. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  25074. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  25075. * @returns current mesh
  25076. */
  25077. convertToFlatShadedMesh(): Mesh;
  25078. /**
  25079. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  25080. * In other words, more vertices, no more indices and a single bigger VBO.
  25081. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  25082. * @returns current mesh
  25083. */
  25084. convertToUnIndexedMesh(): Mesh;
  25085. /**
  25086. * Inverses facet orientations.
  25087. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25088. * @param flipNormals will also inverts the normals
  25089. * @returns current mesh
  25090. */
  25091. flipFaces(flipNormals?: boolean): Mesh;
  25092. /**
  25093. * Increase the number of facets and hence vertices in a mesh
  25094. * Vertex normals are interpolated from existing vertex normals
  25095. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25096. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  25097. */
  25098. increaseVertices(numberPerEdge: number): void;
  25099. /**
  25100. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  25101. * This will undo any application of covertToFlatShadedMesh
  25102. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25103. */
  25104. forceSharedVertices(): void;
  25105. /** @hidden */
  25106. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  25107. /** @hidden */
  25108. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  25109. /**
  25110. * Creates a new InstancedMesh object from the mesh model.
  25111. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  25112. * @param name defines the name of the new instance
  25113. * @returns a new InstancedMesh
  25114. */
  25115. createInstance(name: string): InstancedMesh;
  25116. /**
  25117. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  25118. * After this call, all the mesh instances have the same submeshes than the current mesh.
  25119. * @returns the current mesh
  25120. */
  25121. synchronizeInstances(): Mesh;
  25122. /**
  25123. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  25124. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  25125. * This should be used together with the simplification to avoid disappearing triangles.
  25126. * @param successCallback an optional success callback to be called after the optimization finished.
  25127. * @returns the current mesh
  25128. */
  25129. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  25130. /**
  25131. * Serialize current mesh
  25132. * @param serializationObject defines the object which will receive the serialization data
  25133. */
  25134. serialize(serializationObject: any): void;
  25135. /** @hidden */
  25136. _syncGeometryWithMorphTargetManager(): void;
  25137. /** @hidden */
  25138. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  25139. /**
  25140. * Returns a new Mesh object parsed from the source provided.
  25141. * @param parsedMesh is the source
  25142. * @param scene defines the hosting scene
  25143. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  25144. * @returns a new Mesh
  25145. */
  25146. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  25147. /**
  25148. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  25149. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25150. * @param name defines the name of the mesh to create
  25151. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  25152. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  25153. * @param closePath creates a seam between the first and the last points of each path of the path array
  25154. * @param offset is taken in account only if the `pathArray` is containing a single path
  25155. * @param scene defines the hosting scene
  25156. * @param updatable defines if the mesh must be flagged as updatable
  25157. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25158. * @param instance defines an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#ribbon)
  25159. * @returns a new Mesh
  25160. */
  25161. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25162. /**
  25163. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  25164. * @param name defines the name of the mesh to create
  25165. * @param radius sets the radius size (float) of the polygon (default 0.5)
  25166. * @param tessellation sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  25167. * @param scene defines the hosting scene
  25168. * @param updatable defines if the mesh must be flagged as updatable
  25169. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25170. * @returns a new Mesh
  25171. */
  25172. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  25173. /**
  25174. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  25175. * @param name defines the name of the mesh to create
  25176. * @param size sets the size (float) of each box side (default 1)
  25177. * @param scene defines the hosting scene
  25178. * @param updatable defines if the mesh must be flagged as updatable
  25179. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25180. * @returns a new Mesh
  25181. */
  25182. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  25183. /**
  25184. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  25185. * @param name defines the name of the mesh to create
  25186. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  25187. * @param diameter sets the diameter size (float) of the sphere (default 1)
  25188. * @param scene defines the hosting scene
  25189. * @param updatable defines if the mesh must be flagged as updatable
  25190. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25191. * @returns a new Mesh
  25192. */
  25193. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25194. /**
  25195. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  25196. * @param name defines the name of the mesh to create
  25197. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  25198. * @param diameter sets the diameter size (float) of the sphere (default 1)
  25199. * @param scene defines the hosting scene
  25200. * @returns a new Mesh
  25201. */
  25202. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  25203. /**
  25204. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  25205. * @param name defines the name of the mesh to create
  25206. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  25207. * @param diameterTop set the top cap diameter (floats, default 1)
  25208. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  25209. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  25210. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  25211. * @param scene defines the hosting scene
  25212. * @param updatable defines if the mesh must be flagged as updatable
  25213. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25214. * @returns a new Mesh
  25215. */
  25216. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  25217. /**
  25218. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  25219. * @param name defines the name of the mesh to create
  25220. * @param diameter sets the diameter size (float) of the torus (default 1)
  25221. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  25222. * @param tessellation sets the number of torus sides (postive integer, default 16)
  25223. * @param scene defines the hosting scene
  25224. * @param updatable defines if the mesh must be flagged as updatable
  25225. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25226. * @returns a new Mesh
  25227. */
  25228. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25229. /**
  25230. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  25231. * @param name defines the name of the mesh to create
  25232. * @param radius sets the global radius size (float) of the torus knot (default 2)
  25233. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  25234. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  25235. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  25236. * @param p the number of windings on X axis (positive integers, default 2)
  25237. * @param q the number of windings on Y axis (positive integers, default 3)
  25238. * @param scene defines the hosting scene
  25239. * @param updatable defines if the mesh must be flagged as updatable
  25240. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25241. * @returns a new Mesh
  25242. */
  25243. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25244. /**
  25245. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  25246. * @param name defines the name of the mesh to create
  25247. * @param points is an array successive Vector3
  25248. * @param scene defines the hosting scene
  25249. * @param updatable defines if the mesh must be flagged as updatable
  25250. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines).
  25251. * @returns a new Mesh
  25252. */
  25253. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  25254. /**
  25255. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  25256. * @param name defines the name of the mesh to create
  25257. * @param points is an array successive Vector3
  25258. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  25259. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  25260. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  25261. * @param scene defines the hosting scene
  25262. * @param updatable defines if the mesh must be flagged as updatable
  25263. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines)
  25264. * @returns a new Mesh
  25265. */
  25266. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  25267. /**
  25268. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  25269. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  25270. * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors.
  25271. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25272. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  25273. * Remember you can only change the shape positions, not their number when updating a polygon.
  25274. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  25275. * @param name defines the name of the mesh to create
  25276. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  25277. * @param scene defines the hosting scene
  25278. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  25279. * @param updatable defines if the mesh must be flagged as updatable
  25280. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25281. * @param earcutInjection can be used to inject your own earcut reference
  25282. * @returns a new Mesh
  25283. */
  25284. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  25285. /**
  25286. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  25287. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  25288. * @param name defines the name of the mesh to create
  25289. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  25290. * @param depth defines the height of extrusion
  25291. * @param scene defines the hosting scene
  25292. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  25293. * @param updatable defines if the mesh must be flagged as updatable
  25294. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25295. * @param earcutInjection can be used to inject your own earcut reference
  25296. * @returns a new Mesh
  25297. */
  25298. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  25299. /**
  25300. * Creates an extruded shape mesh.
  25301. * The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters. Please consider using the same method from the MeshBuilder class instead
  25302. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25303. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  25304. * @param name defines the name of the mesh to create
  25305. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  25306. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  25307. * @param scale is the value to scale the shape
  25308. * @param rotation is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve
  25309. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  25310. * @param scene defines the hosting scene
  25311. * @param updatable defines if the mesh must be flagged as updatable
  25312. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25313. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#extruded-shape)
  25314. * @returns a new Mesh
  25315. */
  25316. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25317. /**
  25318. * Creates an custom extruded shape mesh.
  25319. * The custom extrusion is a parametric shape.
  25320. * It has no predefined shape. Its final shape will depend on the input parameters.
  25321. * Please consider using the same method from the MeshBuilder class instead
  25322. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  25323. * @param name defines the name of the mesh to create
  25324. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  25325. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  25326. * @param scaleFunction is a custom Javascript function called on each path point
  25327. * @param rotationFunction is a custom Javascript function called on each path point
  25328. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  25329. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  25330. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  25331. * @param scene defines the hosting scene
  25332. * @param updatable defines if the mesh must be flagged as updatable
  25333. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25334. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape)
  25335. * @returns a new Mesh
  25336. */
  25337. static ExtrudeShapeCustom(name: string, shape: Vector3[], path: Vector3[], scaleFunction: Function, rotationFunction: Function, ribbonCloseArray: boolean, ribbonClosePath: boolean, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25338. /**
  25339. * Creates lathe mesh.
  25340. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  25341. * Please consider using the same method from the MeshBuilder class instead
  25342. * @param name defines the name of the mesh to create
  25343. * @param shape is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  25344. * @param radius is the radius value of the lathe
  25345. * @param tessellation is the side number of the lathe.
  25346. * @param scene defines the hosting scene
  25347. * @param updatable defines if the mesh must be flagged as updatable
  25348. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25349. * @returns a new Mesh
  25350. */
  25351. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25352. /**
  25353. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  25354. * @param name defines the name of the mesh to create
  25355. * @param size sets the size (float) of both sides of the plane at once (default 1)
  25356. * @param scene defines the hosting scene
  25357. * @param updatable defines if the mesh must be flagged as updatable
  25358. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25359. * @returns a new Mesh
  25360. */
  25361. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25362. /**
  25363. * Creates a ground mesh.
  25364. * Please consider using the same method from the MeshBuilder class instead
  25365. * @param name defines the name of the mesh to create
  25366. * @param width set the width of the ground
  25367. * @param height set the height of the ground
  25368. * @param subdivisions sets the number of subdivisions per side
  25369. * @param scene defines the hosting scene
  25370. * @param updatable defines if the mesh must be flagged as updatable
  25371. * @returns a new Mesh
  25372. */
  25373. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  25374. /**
  25375. * Creates a tiled ground mesh.
  25376. * Please consider using the same method from the MeshBuilder class instead
  25377. * @param name defines the name of the mesh to create
  25378. * @param xmin set the ground minimum X coordinate
  25379. * @param zmin set the ground minimum Y coordinate
  25380. * @param xmax set the ground maximum X coordinate
  25381. * @param zmax set the ground maximum Z coordinate
  25382. * @param subdivisions is an object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  25383. * @param precision is an object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  25384. * @param scene defines the hosting scene
  25385. * @param updatable defines if the mesh must be flagged as updatable
  25386. * @returns a new Mesh
  25387. */
  25388. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  25389. w: number;
  25390. h: number;
  25391. }, precision: {
  25392. w: number;
  25393. h: number;
  25394. }, scene: Scene, updatable?: boolean): Mesh;
  25395. /**
  25396. * Creates a ground mesh from a height map.
  25397. * Please consider using the same method from the MeshBuilder class instead
  25398. * @see http://doc.babylonjs.com/babylon101/height_map
  25399. * @param name defines the name of the mesh to create
  25400. * @param url sets the URL of the height map image resource
  25401. * @param width set the ground width size
  25402. * @param height set the ground height size
  25403. * @param subdivisions sets the number of subdivision per side
  25404. * @param minHeight is the minimum altitude on the ground
  25405. * @param maxHeight is the maximum altitude on the ground
  25406. * @param scene defines the hosting scene
  25407. * @param updatable defines if the mesh must be flagged as updatable
  25408. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  25409. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  25410. * @returns a new Mesh
  25411. */
  25412. static CreateGroundFromHeightMap(name: string, url: string, width: number, height: number, subdivisions: number, minHeight: number, maxHeight: number, scene: Scene, updatable?: boolean, onReady?: (mesh: GroundMesh) => void, alphaFilter?: number): GroundMesh;
  25413. /**
  25414. * Creates a tube mesh.
  25415. * The tube is a parametric shape.
  25416. * It has no predefined shape. Its final shape will depend on the input parameters.
  25417. * Please consider using the same method from the MeshBuilder class instead
  25418. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25419. * @param name defines the name of the mesh to create
  25420. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  25421. * @param radius sets the tube radius size
  25422. * @param tessellation is the number of sides on the tubular surface
  25423. * @param radiusFunction is a custom function. If it is not null, it overwrittes the parameter `radius`. This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path
  25424. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  25425. * @param scene defines the hosting scene
  25426. * @param updatable defines if the mesh must be flagged as updatable
  25427. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25428. * @param instance is an instance of an existing Tube object to be updated with the passed `pathArray` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#tube)
  25429. * @returns a new Mesh
  25430. */
  25431. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  25432. (i: number, distance: number): number;
  25433. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25434. /**
  25435. * Creates a polyhedron mesh.
  25436. * Please consider using the same method from the MeshBuilder class instead.
  25437. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  25438. * * The parameter `size` (positive float, default 1) sets the polygon size
  25439. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  25440. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  25441. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  25442. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  25443. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  25444. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  25445. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25446. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  25447. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25448. * @param name defines the name of the mesh to create
  25449. * @param options defines the options used to create the mesh
  25450. * @param scene defines the hosting scene
  25451. * @returns a new Mesh
  25452. */
  25453. static CreatePolyhedron(name: string, options: {
  25454. type?: number;
  25455. size?: number;
  25456. sizeX?: number;
  25457. sizeY?: number;
  25458. sizeZ?: number;
  25459. custom?: any;
  25460. faceUV?: Vector4[];
  25461. faceColors?: Color4[];
  25462. updatable?: boolean;
  25463. sideOrientation?: number;
  25464. }, scene: Scene): Mesh;
  25465. /**
  25466. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  25467. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  25468. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value than `radius`)
  25469. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  25470. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  25471. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25472. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  25473. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25474. * @param name defines the name of the mesh
  25475. * @param options defines the options used to create the mesh
  25476. * @param scene defines the hosting scene
  25477. * @returns a new Mesh
  25478. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  25479. */
  25480. static CreateIcoSphere(name: string, options: {
  25481. radius?: number;
  25482. flat?: boolean;
  25483. subdivisions?: number;
  25484. sideOrientation?: number;
  25485. updatable?: boolean;
  25486. }, scene: Scene): Mesh;
  25487. /**
  25488. * Creates a decal mesh.
  25489. * Please consider using the same method from the MeshBuilder class instead.
  25490. * A decal is a mesh usually applied as a model onto the surface of another mesh
  25491. * @param name defines the name of the mesh
  25492. * @param sourceMesh defines the mesh receiving the decal
  25493. * @param position sets the position of the decal in world coordinates
  25494. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  25495. * @param size sets the decal scaling
  25496. * @param angle sets the angle to rotate the decal
  25497. * @returns a new Mesh
  25498. */
  25499. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  25500. /**
  25501. * Prepare internal position array for software CPU skinning
  25502. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  25503. */
  25504. setPositionsForCPUSkinning(): Float32Array;
  25505. /**
  25506. * Prepare internal normal array for software CPU skinning
  25507. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  25508. */
  25509. setNormalsForCPUSkinning(): Float32Array;
  25510. /**
  25511. * Updates the vertex buffer by applying transformation from the bones
  25512. * @param skeleton defines the skeleton to apply to current mesh
  25513. * @returns the current mesh
  25514. */
  25515. applySkeleton(skeleton: Skeleton): Mesh;
  25516. /**
  25517. * Returns an object containing a min and max Vector3 which are the minimum and maximum vectors of each mesh bounding box from the passed array, in the world coordinates
  25518. * @param meshes defines the list of meshes to scan
  25519. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  25520. */
  25521. static MinMax(meshes: AbstractMesh[]): {
  25522. min: Vector3;
  25523. max: Vector3;
  25524. };
  25525. /**
  25526. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  25527. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  25528. * @returns a vector3
  25529. */
  25530. static Center(meshesOrMinMaxVector: {
  25531. min: Vector3;
  25532. max: Vector3;
  25533. } | AbstractMesh[]): Vector3;
  25534. /**
  25535. * Merge the array of meshes into a single mesh for performance reasons.
  25536. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  25537. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  25538. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  25539. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  25540. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  25541. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  25542. * @returns a new mesh
  25543. */
  25544. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  25545. /** @hidden */
  25546. addInstance(instance: InstancedMesh): void;
  25547. /** @hidden */
  25548. removeInstance(instance: InstancedMesh): void;
  25549. }
  25550. }
  25551. declare module "babylonjs/Cameras/camera" {
  25552. import { SmartArray } from "babylonjs/Misc/smartArray";
  25553. import { Observable } from "babylonjs/Misc/observable";
  25554. import { Nullable } from "babylonjs/types";
  25555. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  25556. import { Scene } from "babylonjs/scene";
  25557. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  25558. import { Node } from "babylonjs/node";
  25559. import { Mesh } from "babylonjs/Meshes/mesh";
  25560. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25561. import { ICullable } from "babylonjs/Culling/boundingInfo";
  25562. import { Viewport } from "babylonjs/Maths/math.viewport";
  25563. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25564. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25565. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  25566. import { Ray } from "babylonjs/Culling/ray";
  25567. /**
  25568. * This is the base class of all the camera used in the application.
  25569. * @see http://doc.babylonjs.com/features/cameras
  25570. */
  25571. export class Camera extends Node {
  25572. /** @hidden */
  25573. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  25574. /**
  25575. * This is the default projection mode used by the cameras.
  25576. * It helps recreating a feeling of perspective and better appreciate depth.
  25577. * This is the best way to simulate real life cameras.
  25578. */
  25579. static readonly PERSPECTIVE_CAMERA: number;
  25580. /**
  25581. * This helps creating camera with an orthographic mode.
  25582. * Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.
  25583. */
  25584. static readonly ORTHOGRAPHIC_CAMERA: number;
  25585. /**
  25586. * This is the default FOV mode for perspective cameras.
  25587. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  25588. */
  25589. static readonly FOVMODE_VERTICAL_FIXED: number;
  25590. /**
  25591. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  25592. */
  25593. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  25594. /**
  25595. * This specifies ther is no need for a camera rig.
  25596. * Basically only one eye is rendered corresponding to the camera.
  25597. */
  25598. static readonly RIG_MODE_NONE: number;
  25599. /**
  25600. * Simulates a camera Rig with one blue eye and one red eye.
  25601. * This can be use with 3d blue and red glasses.
  25602. */
  25603. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  25604. /**
  25605. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  25606. */
  25607. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  25608. /**
  25609. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  25610. */
  25611. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  25612. /**
  25613. * Defines that both eyes of the camera will be rendered over under each other.
  25614. */
  25615. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  25616. /**
  25617. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  25618. */
  25619. static readonly RIG_MODE_VR: number;
  25620. /**
  25621. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  25622. */
  25623. static readonly RIG_MODE_WEBVR: number;
  25624. /**
  25625. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  25626. */
  25627. static readonly RIG_MODE_CUSTOM: number;
  25628. /**
  25629. * Defines if by default attaching controls should prevent the default javascript event to continue.
  25630. */
  25631. static ForceAttachControlToAlwaysPreventDefault: boolean;
  25632. /**
  25633. * Define the input manager associated with the camera.
  25634. */
  25635. inputs: CameraInputsManager<Camera>;
  25636. /** @hidden */
  25637. _position: Vector3;
  25638. /**
  25639. * Define the current local position of the camera in the scene
  25640. */
  25641. position: Vector3;
  25642. /**
  25643. * The vector the camera should consider as up.
  25644. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  25645. */
  25646. upVector: Vector3;
  25647. /**
  25648. * Define the current limit on the left side for an orthographic camera
  25649. * In scene unit
  25650. */
  25651. orthoLeft: Nullable<number>;
  25652. /**
  25653. * Define the current limit on the right side for an orthographic camera
  25654. * In scene unit
  25655. */
  25656. orthoRight: Nullable<number>;
  25657. /**
  25658. * Define the current limit on the bottom side for an orthographic camera
  25659. * In scene unit
  25660. */
  25661. orthoBottom: Nullable<number>;
  25662. /**
  25663. * Define the current limit on the top side for an orthographic camera
  25664. * In scene unit
  25665. */
  25666. orthoTop: Nullable<number>;
  25667. /**
  25668. * Field Of View is set in Radians. (default is 0.8)
  25669. */
  25670. fov: number;
  25671. /**
  25672. * Define the minimum distance the camera can see from.
  25673. * This is important to note that the depth buffer are not infinite and the closer it starts
  25674. * the more your scene might encounter depth fighting issue.
  25675. */
  25676. minZ: number;
  25677. /**
  25678. * Define the maximum distance the camera can see to.
  25679. * This is important to note that the depth buffer are not infinite and the further it end
  25680. * the more your scene might encounter depth fighting issue.
  25681. */
  25682. maxZ: number;
  25683. /**
  25684. * Define the default inertia of the camera.
  25685. * This helps giving a smooth feeling to the camera movement.
  25686. */
  25687. inertia: number;
  25688. /**
  25689. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  25690. */
  25691. mode: number;
  25692. /**
  25693. * Define wether the camera is intermediate.
  25694. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  25695. */
  25696. isIntermediate: boolean;
  25697. /**
  25698. * Define the viewport of the camera.
  25699. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  25700. */
  25701. viewport: Viewport;
  25702. /**
  25703. * Restricts the camera to viewing objects with the same layerMask.
  25704. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  25705. */
  25706. layerMask: number;
  25707. /**
  25708. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  25709. */
  25710. fovMode: number;
  25711. /**
  25712. * Rig mode of the camera.
  25713. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  25714. * This is normally controlled byt the camera themselves as internal use.
  25715. */
  25716. cameraRigMode: number;
  25717. /**
  25718. * Defines the distance between both "eyes" in case of a RIG
  25719. */
  25720. interaxialDistance: number;
  25721. /**
  25722. * Defines if stereoscopic rendering is done side by side or over under.
  25723. */
  25724. isStereoscopicSideBySide: boolean;
  25725. /**
  25726. * Defines the list of custom render target which are rendered to and then used as the input to this camera's render. Eg. display another camera view on a TV in the main scene
  25727. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  25728. * else in the scene. (Eg. security camera)
  25729. *
  25730. * To change the final output target of the camera, camera.outputRenderTarget should be used instead (eg. webXR renders to a render target corrisponding to an HMD)
  25731. */
  25732. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  25733. /**
  25734. * When set, the camera will render to this render target instead of the default canvas
  25735. *
  25736. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  25737. */
  25738. outputRenderTarget: Nullable<RenderTargetTexture>;
  25739. /**
  25740. * Observable triggered when the camera view matrix has changed.
  25741. */
  25742. onViewMatrixChangedObservable: Observable<Camera>;
  25743. /**
  25744. * Observable triggered when the camera Projection matrix has changed.
  25745. */
  25746. onProjectionMatrixChangedObservable: Observable<Camera>;
  25747. /**
  25748. * Observable triggered when the inputs have been processed.
  25749. */
  25750. onAfterCheckInputsObservable: Observable<Camera>;
  25751. /**
  25752. * Observable triggered when reset has been called and applied to the camera.
  25753. */
  25754. onRestoreStateObservable: Observable<Camera>;
  25755. /** @hidden */
  25756. _cameraRigParams: any;
  25757. /** @hidden */
  25758. _rigCameras: Camera[];
  25759. /** @hidden */
  25760. _rigPostProcess: Nullable<PostProcess>;
  25761. protected _webvrViewMatrix: Matrix;
  25762. /** @hidden */
  25763. _skipRendering: boolean;
  25764. /** @hidden */
  25765. _projectionMatrix: Matrix;
  25766. /** @hidden */
  25767. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  25768. /** @hidden */
  25769. _activeMeshes: SmartArray<AbstractMesh>;
  25770. protected _globalPosition: Vector3;
  25771. /** @hidden */
  25772. _computedViewMatrix: Matrix;
  25773. private _doNotComputeProjectionMatrix;
  25774. private _transformMatrix;
  25775. private _frustumPlanes;
  25776. private _refreshFrustumPlanes;
  25777. private _storedFov;
  25778. private _stateStored;
  25779. /**
  25780. * Instantiates a new camera object.
  25781. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  25782. * @see http://doc.babylonjs.com/features/cameras
  25783. * @param name Defines the name of the camera in the scene
  25784. * @param position Defines the position of the camera
  25785. * @param scene Defines the scene the camera belongs too
  25786. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  25787. */
  25788. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  25789. /**
  25790. * Store current camera state (fov, position, etc..)
  25791. * @returns the camera
  25792. */
  25793. storeState(): Camera;
  25794. /**
  25795. * Restores the camera state values if it has been stored. You must call storeState() first
  25796. */
  25797. protected _restoreStateValues(): boolean;
  25798. /**
  25799. * Restored camera state. You must call storeState() first.
  25800. * @returns true if restored and false otherwise
  25801. */
  25802. restoreState(): boolean;
  25803. /**
  25804. * Gets the class name of the camera.
  25805. * @returns the class name
  25806. */
  25807. getClassName(): string;
  25808. /** @hidden */
  25809. readonly _isCamera: boolean;
  25810. /**
  25811. * Gets a string representation of the camera useful for debug purpose.
  25812. * @param fullDetails Defines that a more verboe level of logging is required
  25813. * @returns the string representation
  25814. */
  25815. toString(fullDetails?: boolean): string;
  25816. /**
  25817. * Gets the current world space position of the camera.
  25818. */
  25819. readonly globalPosition: Vector3;
  25820. /**
  25821. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  25822. * @returns the active meshe list
  25823. */
  25824. getActiveMeshes(): SmartArray<AbstractMesh>;
  25825. /**
  25826. * Check wether a mesh is part of the current active mesh list of the camera
  25827. * @param mesh Defines the mesh to check
  25828. * @returns true if active, false otherwise
  25829. */
  25830. isActiveMesh(mesh: Mesh): boolean;
  25831. /**
  25832. * Is this camera ready to be used/rendered
  25833. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  25834. * @return true if the camera is ready
  25835. */
  25836. isReady(completeCheck?: boolean): boolean;
  25837. /** @hidden */
  25838. _initCache(): void;
  25839. /** @hidden */
  25840. _updateCache(ignoreParentClass?: boolean): void;
  25841. /** @hidden */
  25842. _isSynchronized(): boolean;
  25843. /** @hidden */
  25844. _isSynchronizedViewMatrix(): boolean;
  25845. /** @hidden */
  25846. _isSynchronizedProjectionMatrix(): boolean;
  25847. /**
  25848. * Attach the input controls to a specific dom element to get the input from.
  25849. * @param element Defines the element the controls should be listened from
  25850. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  25851. */
  25852. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  25853. /**
  25854. * Detach the current controls from the specified dom element.
  25855. * @param element Defines the element to stop listening the inputs from
  25856. */
  25857. detachControl(element: HTMLElement): void;
  25858. /**
  25859. * Update the camera state according to the different inputs gathered during the frame.
  25860. */
  25861. update(): void;
  25862. /** @hidden */
  25863. _checkInputs(): void;
  25864. /** @hidden */
  25865. readonly rigCameras: Camera[];
  25866. /**
  25867. * Gets the post process used by the rig cameras
  25868. */
  25869. readonly rigPostProcess: Nullable<PostProcess>;
  25870. /**
  25871. * Internal, gets the first post proces.
  25872. * @returns the first post process to be run on this camera.
  25873. */
  25874. _getFirstPostProcess(): Nullable<PostProcess>;
  25875. private _cascadePostProcessesToRigCams;
  25876. /**
  25877. * Attach a post process to the camera.
  25878. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25879. * @param postProcess The post process to attach to the camera
  25880. * @param insertAt The position of the post process in case several of them are in use in the scene
  25881. * @returns the position the post process has been inserted at
  25882. */
  25883. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  25884. /**
  25885. * Detach a post process to the camera.
  25886. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25887. * @param postProcess The post process to detach from the camera
  25888. */
  25889. detachPostProcess(postProcess: PostProcess): void;
  25890. /**
  25891. * Gets the current world matrix of the camera
  25892. */
  25893. getWorldMatrix(): Matrix;
  25894. /** @hidden */
  25895. _getViewMatrix(): Matrix;
  25896. /**
  25897. * Gets the current view matrix of the camera.
  25898. * @param force forces the camera to recompute the matrix without looking at the cached state
  25899. * @returns the view matrix
  25900. */
  25901. getViewMatrix(force?: boolean): Matrix;
  25902. /**
  25903. * Freeze the projection matrix.
  25904. * It will prevent the cache check of the camera projection compute and can speed up perf
  25905. * if no parameter of the camera are meant to change
  25906. * @param projection Defines manually a projection if necessary
  25907. */
  25908. freezeProjectionMatrix(projection?: Matrix): void;
  25909. /**
  25910. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  25911. */
  25912. unfreezeProjectionMatrix(): void;
  25913. /**
  25914. * Gets the current projection matrix of the camera.
  25915. * @param force forces the camera to recompute the matrix without looking at the cached state
  25916. * @returns the projection matrix
  25917. */
  25918. getProjectionMatrix(force?: boolean): Matrix;
  25919. /**
  25920. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  25921. * @returns a Matrix
  25922. */
  25923. getTransformationMatrix(): Matrix;
  25924. private _updateFrustumPlanes;
  25925. /**
  25926. * Checks if a cullable object (mesh...) is in the camera frustum
  25927. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  25928. * @param target The object to check
  25929. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  25930. * @returns true if the object is in frustum otherwise false
  25931. */
  25932. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  25933. /**
  25934. * Checks if a cullable object (mesh...) is in the camera frustum
  25935. * Unlike isInFrustum this cheks the full bounding box
  25936. * @param target The object to check
  25937. * @returns true if the object is in frustum otherwise false
  25938. */
  25939. isCompletelyInFrustum(target: ICullable): boolean;
  25940. /**
  25941. * Gets a ray in the forward direction from the camera.
  25942. * @param length Defines the length of the ray to create
  25943. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  25944. * @param origin Defines the start point of the ray which defaults to the camera position
  25945. * @returns the forward ray
  25946. */
  25947. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  25948. /**
  25949. * Releases resources associated with this node.
  25950. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  25951. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  25952. */
  25953. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  25954. /** @hidden */
  25955. _isLeftCamera: boolean;
  25956. /**
  25957. * Gets the left camera of a rig setup in case of Rigged Camera
  25958. */
  25959. readonly isLeftCamera: boolean;
  25960. /** @hidden */
  25961. _isRightCamera: boolean;
  25962. /**
  25963. * Gets the right camera of a rig setup in case of Rigged Camera
  25964. */
  25965. readonly isRightCamera: boolean;
  25966. /**
  25967. * Gets the left camera of a rig setup in case of Rigged Camera
  25968. */
  25969. readonly leftCamera: Nullable<FreeCamera>;
  25970. /**
  25971. * Gets the right camera of a rig setup in case of Rigged Camera
  25972. */
  25973. readonly rightCamera: Nullable<FreeCamera>;
  25974. /**
  25975. * Gets the left camera target of a rig setup in case of Rigged Camera
  25976. * @returns the target position
  25977. */
  25978. getLeftTarget(): Nullable<Vector3>;
  25979. /**
  25980. * Gets the right camera target of a rig setup in case of Rigged Camera
  25981. * @returns the target position
  25982. */
  25983. getRightTarget(): Nullable<Vector3>;
  25984. /**
  25985. * @hidden
  25986. */
  25987. setCameraRigMode(mode: number, rigParams: any): void;
  25988. /** @hidden */
  25989. static _setStereoscopicRigMode(camera: Camera): void;
  25990. /** @hidden */
  25991. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  25992. /** @hidden */
  25993. static _setVRRigMode(camera: Camera, rigParams: any): void;
  25994. /** @hidden */
  25995. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  25996. /** @hidden */
  25997. _getVRProjectionMatrix(): Matrix;
  25998. protected _updateCameraRotationMatrix(): void;
  25999. protected _updateWebVRCameraRotationMatrix(): void;
  26000. /**
  26001. * This function MUST be overwritten by the different WebVR cameras available.
  26002. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  26003. * @hidden
  26004. */
  26005. _getWebVRProjectionMatrix(): Matrix;
  26006. /**
  26007. * This function MUST be overwritten by the different WebVR cameras available.
  26008. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  26009. * @hidden
  26010. */
  26011. _getWebVRViewMatrix(): Matrix;
  26012. /** @hidden */
  26013. setCameraRigParameter(name: string, value: any): void;
  26014. /**
  26015. * needs to be overridden by children so sub has required properties to be copied
  26016. * @hidden
  26017. */
  26018. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  26019. /**
  26020. * May need to be overridden by children
  26021. * @hidden
  26022. */
  26023. _updateRigCameras(): void;
  26024. /** @hidden */
  26025. _setupInputs(): void;
  26026. /**
  26027. * Serialiaze the camera setup to a json represention
  26028. * @returns the JSON representation
  26029. */
  26030. serialize(): any;
  26031. /**
  26032. * Clones the current camera.
  26033. * @param name The cloned camera name
  26034. * @returns the cloned camera
  26035. */
  26036. clone(name: string): Camera;
  26037. /**
  26038. * Gets the direction of the camera relative to a given local axis.
  26039. * @param localAxis Defines the reference axis to provide a relative direction.
  26040. * @return the direction
  26041. */
  26042. getDirection(localAxis: Vector3): Vector3;
  26043. /**
  26044. * Returns the current camera absolute rotation
  26045. */
  26046. readonly absoluteRotation: Quaternion;
  26047. /**
  26048. * Gets the direction of the camera relative to a given local axis into a passed vector.
  26049. * @param localAxis Defines the reference axis to provide a relative direction.
  26050. * @param result Defines the vector to store the result in
  26051. */
  26052. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  26053. /**
  26054. * Gets a camera constructor for a given camera type
  26055. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  26056. * @param name The name of the camera the result will be able to instantiate
  26057. * @param scene The scene the result will construct the camera in
  26058. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  26059. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  26060. * @returns a factory method to construc the camera
  26061. */
  26062. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  26063. /**
  26064. * Compute the world matrix of the camera.
  26065. * @returns the camera world matrix
  26066. */
  26067. computeWorldMatrix(): Matrix;
  26068. /**
  26069. * Parse a JSON and creates the camera from the parsed information
  26070. * @param parsedCamera The JSON to parse
  26071. * @param scene The scene to instantiate the camera in
  26072. * @returns the newly constructed camera
  26073. */
  26074. static Parse(parsedCamera: any, scene: Scene): Camera;
  26075. }
  26076. }
  26077. declare module "babylonjs/Meshes/Builders/discBuilder" {
  26078. import { Nullable } from "babylonjs/types";
  26079. import { Scene } from "babylonjs/scene";
  26080. import { Vector4 } from "babylonjs/Maths/math.vector";
  26081. import { Mesh } from "babylonjs/Meshes/mesh";
  26082. /**
  26083. * Class containing static functions to help procedurally build meshes
  26084. */
  26085. export class DiscBuilder {
  26086. /**
  26087. * Creates a plane polygonal mesh. By default, this is a disc
  26088. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  26089. * * The parameter `tessellation` sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  26090. * * You can create an unclosed polygon with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference : 2 x PI x ratio
  26091. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  26092. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  26093. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  26094. * @param name defines the name of the mesh
  26095. * @param options defines the options used to create the mesh
  26096. * @param scene defines the hosting scene
  26097. * @returns the plane polygonal mesh
  26098. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  26099. */
  26100. static CreateDisc(name: string, options: {
  26101. radius?: number;
  26102. tessellation?: number;
  26103. arc?: number;
  26104. updatable?: boolean;
  26105. sideOrientation?: number;
  26106. frontUVs?: Vector4;
  26107. backUVs?: Vector4;
  26108. }, scene?: Nullable<Scene>): Mesh;
  26109. }
  26110. }
  26111. declare module "babylonjs/Particles/solidParticleSystem" {
  26112. import { Nullable } from "babylonjs/types";
  26113. import { Vector3 } from "babylonjs/Maths/math.vector";
  26114. import { Mesh } from "babylonjs/Meshes/mesh";
  26115. import { Scene, IDisposable } from "babylonjs/scene";
  26116. import { DepthSortedParticle, SolidParticle } from "babylonjs/Particles/solidParticle";
  26117. /**
  26118. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  26119. *As it is just a mesh, the SPS has all the same properties than any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  26120. * The SPS is also a particle system. It provides some methods to manage the particles.
  26121. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  26122. *
  26123. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  26124. */
  26125. export class SolidParticleSystem implements IDisposable {
  26126. /**
  26127. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  26128. * Example : var p = SPS.particles[i];
  26129. */
  26130. particles: SolidParticle[];
  26131. /**
  26132. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  26133. */
  26134. nbParticles: number;
  26135. /**
  26136. * If the particles must ever face the camera (default false). Useful for planar particles.
  26137. */
  26138. billboard: boolean;
  26139. /**
  26140. * Recompute normals when adding a shape
  26141. */
  26142. recomputeNormals: boolean;
  26143. /**
  26144. * This a counter ofr your own usage. It's not set by any SPS functions.
  26145. */
  26146. counter: number;
  26147. /**
  26148. * The SPS name. This name is also given to the underlying mesh.
  26149. */
  26150. name: string;
  26151. /**
  26152. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  26153. */
  26154. mesh: Mesh;
  26155. /**
  26156. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  26157. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  26158. */
  26159. vars: any;
  26160. /**
  26161. * This array is populated when the SPS is set as 'pickable'.
  26162. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  26163. * Each element of this array is an object `{idx: int, faceId: int}`.
  26164. * `idx` is the picked particle index in the `SPS.particles` array
  26165. * `faceId` is the picked face index counted within this particle.
  26166. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  26167. */
  26168. pickedParticles: {
  26169. idx: number;
  26170. faceId: number;
  26171. }[];
  26172. /**
  26173. * This array is populated when `enableDepthSort` is set to true.
  26174. * Each element of this array is an instance of the class DepthSortedParticle.
  26175. */
  26176. depthSortedParticles: DepthSortedParticle[];
  26177. /**
  26178. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  26179. * @hidden
  26180. */
  26181. _bSphereOnly: boolean;
  26182. /**
  26183. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  26184. * @hidden
  26185. */
  26186. _bSphereRadiusFactor: number;
  26187. private _scene;
  26188. private _positions;
  26189. private _indices;
  26190. private _normals;
  26191. private _colors;
  26192. private _uvs;
  26193. private _indices32;
  26194. private _positions32;
  26195. private _normals32;
  26196. private _fixedNormal32;
  26197. private _colors32;
  26198. private _uvs32;
  26199. private _index;
  26200. private _updatable;
  26201. private _pickable;
  26202. private _isVisibilityBoxLocked;
  26203. private _alwaysVisible;
  26204. private _depthSort;
  26205. private _expandable;
  26206. private _shapeCounter;
  26207. private _copy;
  26208. private _mustResetCopy;
  26209. private _color;
  26210. private _computeParticleColor;
  26211. private _computeParticleTexture;
  26212. private _computeParticleRotation;
  26213. private _computeParticleVertex;
  26214. private _computeBoundingBox;
  26215. private _depthSortParticles;
  26216. private _camera;
  26217. private _mustUnrotateFixedNormals;
  26218. private _particlesIntersect;
  26219. private _needs32Bits;
  26220. private _isNotBuilt;
  26221. private _lastParticleId;
  26222. private _idxOfId;
  26223. /**
  26224. * Creates a SPS (Solid Particle System) object.
  26225. * @param name (String) is the SPS name, this will be the underlying mesh name.
  26226. * @param scene (Scene) is the scene in which the SPS is added.
  26227. * @param options defines the options of the sps e.g.
  26228. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  26229. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  26230. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  26231. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  26232. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  26233. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  26234. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  26235. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  26236. */
  26237. constructor(name: string, scene: Scene, options?: {
  26238. updatable?: boolean;
  26239. isPickable?: boolean;
  26240. enableDepthSort?: boolean;
  26241. particleIntersection?: boolean;
  26242. boundingSphereOnly?: boolean;
  26243. bSphereRadiusFactor?: number;
  26244. expandable?: boolean;
  26245. });
  26246. /**
  26247. * Builds the SPS underlying mesh. Returns a standard Mesh.
  26248. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  26249. * @returns the created mesh
  26250. */
  26251. buildMesh(): Mesh;
  26252. /**
  26253. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  26254. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  26255. * Thus the particles generated from `digest()` have their property `position` set yet.
  26256. * @param mesh ( Mesh ) is the mesh to be digested
  26257. * @param options {facetNb} (optional integer, default 1) is the number of mesh facets per particle, this parameter is overriden by the parameter `number` if any
  26258. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  26259. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  26260. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  26261. * @returns the current SPS
  26262. */
  26263. digest(mesh: Mesh, options?: {
  26264. facetNb?: number;
  26265. number?: number;
  26266. delta?: number;
  26267. storage?: [];
  26268. }): SolidParticleSystem;
  26269. /**
  26270. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  26271. * @hidden
  26272. */
  26273. private _unrotateFixedNormals;
  26274. /**
  26275. * Resets the temporary working copy particle
  26276. * @hidden
  26277. */
  26278. private _resetCopy;
  26279. /**
  26280. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  26281. * @param p the current index in the positions array to be updated
  26282. * @param shape a Vector3 array, the shape geometry
  26283. * @param positions the positions array to be updated
  26284. * @param meshInd the shape indices array
  26285. * @param indices the indices array to be updated
  26286. * @param meshUV the shape uv array
  26287. * @param uvs the uv array to be updated
  26288. * @param meshCol the shape color array
  26289. * @param colors the color array to be updated
  26290. * @param meshNor the shape normals array
  26291. * @param normals the normals array to be updated
  26292. * @param idx the particle index
  26293. * @param idxInShape the particle index in its shape
  26294. * @param options the addShape() method passed options
  26295. * @hidden
  26296. */
  26297. private _meshBuilder;
  26298. /**
  26299. * Returns a shape Vector3 array from positions float array
  26300. * @param positions float array
  26301. * @returns a vector3 array
  26302. * @hidden
  26303. */
  26304. private _posToShape;
  26305. /**
  26306. * Returns a shapeUV array from a float uvs (array deep copy)
  26307. * @param uvs as a float array
  26308. * @returns a shapeUV array
  26309. * @hidden
  26310. */
  26311. private _uvsToShapeUV;
  26312. /**
  26313. * Adds a new particle object in the particles array
  26314. * @param idx particle index in particles array
  26315. * @param id particle id
  26316. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  26317. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  26318. * @param model particle ModelShape object
  26319. * @param shapeId model shape identifier
  26320. * @param idxInShape index of the particle in the current model
  26321. * @param bInfo model bounding info object
  26322. * @param storage target storage array, if any
  26323. * @hidden
  26324. */
  26325. private _addParticle;
  26326. /**
  26327. * Adds some particles to the SPS from the model shape. Returns the shape id.
  26328. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  26329. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  26330. * @param nb (positive integer) the number of particles to be created from this model
  26331. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  26332. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  26333. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  26334. * @returns the number of shapes in the system
  26335. */
  26336. addShape(mesh: Mesh, nb: number, options?: {
  26337. positionFunction?: any;
  26338. vertexFunction?: any;
  26339. storage?: [];
  26340. }): number;
  26341. /**
  26342. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  26343. * @hidden
  26344. */
  26345. private _rebuildParticle;
  26346. /**
  26347. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  26348. * @param reset boolean, default false : if the particles must be reset at position and rotation zero, scaling 1, color white, initial UVs and not parented.
  26349. * @returns the SPS.
  26350. */
  26351. rebuildMesh(reset?: boolean): SolidParticleSystem;
  26352. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  26353. * Returns an array with the removed particles.
  26354. * If the number of particles to remove is lower than zero or greater than the global remaining particle number, then an empty array is returned.
  26355. * The SPS can't be empty so at least one particle needs to remain in place.
  26356. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  26357. * @param start index of the first particle to remove
  26358. * @param end index of the last particle to remove (included)
  26359. * @returns an array populated with the removed particles
  26360. */
  26361. removeParticles(start: number, end: number): SolidParticle[];
  26362. /**
  26363. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  26364. * @param solidParticleArray an array populated with Solid Particles objects
  26365. * @returns the SPS
  26366. */
  26367. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  26368. /**
  26369. * Creates a new particle and modifies the SPS mesh geometry :
  26370. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  26371. * - calls _addParticle() to populate the particle array
  26372. * factorized code from addShape() and insertParticlesFromArray()
  26373. * @param idx particle index in the particles array
  26374. * @param i particle index in its shape
  26375. * @param modelShape particle ModelShape object
  26376. * @param shape shape vertex array
  26377. * @param meshInd shape indices array
  26378. * @param meshUV shape uv array
  26379. * @param meshCol shape color array
  26380. * @param meshNor shape normals array
  26381. * @param bbInfo shape bounding info
  26382. * @param storage target particle storage
  26383. * @options addShape() passed options
  26384. * @hidden
  26385. */
  26386. private _insertNewParticle;
  26387. /**
  26388. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  26389. * This method calls `updateParticle()` for each particle of the SPS.
  26390. * For an animated SPS, it is usually called within the render loop.
  26391. * This methods does nothing if called on a non updatable or not yet built SPS. Example : buildMesh() not called after having added or removed particles from an expandable SPS.
  26392. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  26393. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  26394. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  26395. * @returns the SPS.
  26396. */
  26397. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  26398. /**
  26399. * Disposes the SPS.
  26400. */
  26401. dispose(): void;
  26402. /**
  26403. * Returns a SolidParticle object from its identifier : particle.id
  26404. * @param id (integer) the particle Id
  26405. * @returns the searched particle or null if not found in the SPS.
  26406. */
  26407. getParticleById(id: number): Nullable<SolidParticle>;
  26408. /**
  26409. * Returns a new array populated with the particles having the passed shapeId.
  26410. * @param shapeId (integer) the shape identifier
  26411. * @returns a new solid particle array
  26412. */
  26413. getParticlesByShapeId(shapeId: number): SolidParticle[];
  26414. /**
  26415. * Populates the passed array "ref" with the particles having the passed shapeId.
  26416. * @param shapeId the shape identifier
  26417. * @returns the SPS
  26418. * @param ref
  26419. */
  26420. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  26421. /**
  26422. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  26423. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26424. * @returns the SPS.
  26425. */
  26426. refreshVisibleSize(): SolidParticleSystem;
  26427. /**
  26428. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  26429. * @param size the size (float) of the visibility box
  26430. * note : this doesn't lock the SPS mesh bounding box.
  26431. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26432. */
  26433. setVisibilityBox(size: number): void;
  26434. /**
  26435. * Gets whether the SPS as always visible or not
  26436. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26437. */
  26438. /**
  26439. * Sets the SPS as always visible or not
  26440. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26441. */
  26442. isAlwaysVisible: boolean;
  26443. /**
  26444. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  26445. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26446. */
  26447. /**
  26448. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  26449. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26450. */
  26451. isVisibilityBoxLocked: boolean;
  26452. /**
  26453. * Tells to `setParticles()` to compute the particle rotations or not.
  26454. * Default value : true. The SPS is faster when it's set to false.
  26455. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  26456. */
  26457. /**
  26458. * Gets if `setParticles()` computes the particle rotations or not.
  26459. * Default value : true. The SPS is faster when it's set to false.
  26460. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  26461. */
  26462. computeParticleRotation: boolean;
  26463. /**
  26464. * Tells to `setParticles()` to compute the particle colors or not.
  26465. * Default value : true. The SPS is faster when it's set to false.
  26466. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  26467. */
  26468. /**
  26469. * Gets if `setParticles()` computes the particle colors or not.
  26470. * Default value : true. The SPS is faster when it's set to false.
  26471. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  26472. */
  26473. computeParticleColor: boolean;
  26474. /**
  26475. * Gets if `setParticles()` computes the particle textures or not.
  26476. * Default value : true. The SPS is faster when it's set to false.
  26477. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  26478. */
  26479. computeParticleTexture: boolean;
  26480. /**
  26481. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  26482. * Default value : false. The SPS is faster when it's set to false.
  26483. * Note : the particle custom vertex positions aren't stored values.
  26484. */
  26485. /**
  26486. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  26487. * Default value : false. The SPS is faster when it's set to false.
  26488. * Note : the particle custom vertex positions aren't stored values.
  26489. */
  26490. computeParticleVertex: boolean;
  26491. /**
  26492. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  26493. */
  26494. /**
  26495. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  26496. */
  26497. computeBoundingBox: boolean;
  26498. /**
  26499. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  26500. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  26501. * Default : `true`
  26502. */
  26503. /**
  26504. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  26505. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  26506. * Default : `true`
  26507. */
  26508. depthSortParticles: boolean;
  26509. /**
  26510. * Gets if the SPS is created as expandable at construction time.
  26511. * Default : `false`
  26512. */
  26513. readonly expandable: boolean;
  26514. /**
  26515. * This function does nothing. It may be overwritten to set all the particle first values.
  26516. * The SPS doesn't call this function, you may have to call it by your own.
  26517. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26518. */
  26519. initParticles(): void;
  26520. /**
  26521. * This function does nothing. It may be overwritten to recycle a particle.
  26522. * The SPS doesn't call this function, you may have to call it by your own.
  26523. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26524. * @param particle The particle to recycle
  26525. * @returns the recycled particle
  26526. */
  26527. recycleParticle(particle: SolidParticle): SolidParticle;
  26528. /**
  26529. * Updates a particle : this function should be overwritten by the user.
  26530. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  26531. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26532. * @example : just set a particle position or velocity and recycle conditions
  26533. * @param particle The particle to update
  26534. * @returns the updated particle
  26535. */
  26536. updateParticle(particle: SolidParticle): SolidParticle;
  26537. /**
  26538. * Updates a vertex of a particle : it can be overwritten by the user.
  26539. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  26540. * @param particle the current particle
  26541. * @param vertex the current index of the current particle
  26542. * @param pt the index of the current vertex in the particle shape
  26543. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  26544. * @example : just set a vertex particle position
  26545. * @returns the updated vertex
  26546. */
  26547. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  26548. /**
  26549. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  26550. * This does nothing and may be overwritten by the user.
  26551. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26552. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26553. * @param update the boolean update value actually passed to setParticles()
  26554. */
  26555. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26556. /**
  26557. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  26558. * This will be passed three parameters.
  26559. * This does nothing and may be overwritten by the user.
  26560. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26561. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26562. * @param update the boolean update value actually passed to setParticles()
  26563. */
  26564. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26565. }
  26566. }
  26567. declare module "babylonjs/Particles/solidParticle" {
  26568. import { Nullable } from "babylonjs/types";
  26569. import { Vector3, Matrix, Quaternion, Vector4 } from "babylonjs/Maths/math.vector";
  26570. import { Color4 } from "babylonjs/Maths/math.color";
  26571. import { Mesh } from "babylonjs/Meshes/mesh";
  26572. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26573. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  26574. import { Plane } from "babylonjs/Maths/math.plane";
  26575. /**
  26576. * Represents one particle of a solid particle system.
  26577. */
  26578. export class SolidParticle {
  26579. /**
  26580. * particle global index
  26581. */
  26582. idx: number;
  26583. /**
  26584. * particle identifier
  26585. */
  26586. id: number;
  26587. /**
  26588. * The color of the particle
  26589. */
  26590. color: Nullable<Color4>;
  26591. /**
  26592. * The world space position of the particle.
  26593. */
  26594. position: Vector3;
  26595. /**
  26596. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  26597. */
  26598. rotation: Vector3;
  26599. /**
  26600. * The world space rotation quaternion of the particle.
  26601. */
  26602. rotationQuaternion: Nullable<Quaternion>;
  26603. /**
  26604. * The scaling of the particle.
  26605. */
  26606. scaling: Vector3;
  26607. /**
  26608. * The uvs of the particle.
  26609. */
  26610. uvs: Vector4;
  26611. /**
  26612. * The current speed of the particle.
  26613. */
  26614. velocity: Vector3;
  26615. /**
  26616. * The pivot point in the particle local space.
  26617. */
  26618. pivot: Vector3;
  26619. /**
  26620. * Must the particle be translated from its pivot point in its local space ?
  26621. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  26622. * Default : false
  26623. */
  26624. translateFromPivot: boolean;
  26625. /**
  26626. * Is the particle active or not ?
  26627. */
  26628. alive: boolean;
  26629. /**
  26630. * Is the particle visible or not ?
  26631. */
  26632. isVisible: boolean;
  26633. /**
  26634. * Index of this particle in the global "positions" array (Internal use)
  26635. * @hidden
  26636. */
  26637. _pos: number;
  26638. /**
  26639. * @hidden Index of this particle in the global "indices" array (Internal use)
  26640. */
  26641. _ind: number;
  26642. /**
  26643. * @hidden ModelShape of this particle (Internal use)
  26644. */
  26645. _model: ModelShape;
  26646. /**
  26647. * ModelShape id of this particle
  26648. */
  26649. shapeId: number;
  26650. /**
  26651. * Index of the particle in its shape id
  26652. */
  26653. idxInShape: number;
  26654. /**
  26655. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  26656. */
  26657. _modelBoundingInfo: BoundingInfo;
  26658. /**
  26659. * @hidden Particle BoundingInfo object (Internal use)
  26660. */
  26661. _boundingInfo: BoundingInfo;
  26662. /**
  26663. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  26664. */
  26665. _sps: SolidParticleSystem;
  26666. /**
  26667. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  26668. */
  26669. _stillInvisible: boolean;
  26670. /**
  26671. * @hidden Last computed particle rotation matrix
  26672. */
  26673. _rotationMatrix: number[];
  26674. /**
  26675. * Parent particle Id, if any.
  26676. * Default null.
  26677. */
  26678. parentId: Nullable<number>;
  26679. /**
  26680. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  26681. * The possible values are :
  26682. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26683. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26684. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26685. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26686. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26687. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  26688. * */
  26689. cullingStrategy: number;
  26690. /**
  26691. * @hidden Internal global position in the SPS.
  26692. */
  26693. _globalPosition: Vector3;
  26694. /**
  26695. * Creates a Solid Particle object.
  26696. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  26697. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  26698. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  26699. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  26700. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  26701. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  26702. * @param shapeId (integer) is the model shape identifier in the SPS.
  26703. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  26704. * @param sps defines the sps it is associated to
  26705. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  26706. */
  26707. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  26708. /**
  26709. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  26710. * @param target the particle target
  26711. * @returns the current particle
  26712. */
  26713. copyToRef(target: SolidParticle): SolidParticle;
  26714. /**
  26715. * Legacy support, changed scale to scaling
  26716. */
  26717. /**
  26718. * Legacy support, changed scale to scaling
  26719. */
  26720. scale: Vector3;
  26721. /**
  26722. * Legacy support, changed quaternion to rotationQuaternion
  26723. */
  26724. /**
  26725. * Legacy support, changed quaternion to rotationQuaternion
  26726. */
  26727. quaternion: Nullable<Quaternion>;
  26728. /**
  26729. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  26730. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  26731. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  26732. * @returns true if it intersects
  26733. */
  26734. intersectsMesh(target: Mesh | SolidParticle): boolean;
  26735. /**
  26736. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  26737. * A particle is in the frustum if its bounding box intersects the frustum
  26738. * @param frustumPlanes defines the frustum to test
  26739. * @returns true if the particle is in the frustum planes
  26740. */
  26741. isInFrustum(frustumPlanes: Plane[]): boolean;
  26742. /**
  26743. * get the rotation matrix of the particle
  26744. * @hidden
  26745. */
  26746. getRotationMatrix(m: Matrix): void;
  26747. }
  26748. /**
  26749. * Represents the shape of the model used by one particle of a solid particle system.
  26750. * SPS internal tool, don't use it manually.
  26751. */
  26752. export class ModelShape {
  26753. /**
  26754. * The shape id
  26755. * @hidden
  26756. */
  26757. shapeID: number;
  26758. /**
  26759. * flat array of model positions (internal use)
  26760. * @hidden
  26761. */
  26762. _shape: Vector3[];
  26763. /**
  26764. * flat array of model UVs (internal use)
  26765. * @hidden
  26766. */
  26767. _shapeUV: number[];
  26768. /**
  26769. * color array of the model
  26770. * @hidden
  26771. */
  26772. _shapeColors: number[];
  26773. /**
  26774. * indices array of the model
  26775. * @hidden
  26776. */
  26777. _indices: number[];
  26778. /**
  26779. * normals array of the model
  26780. * @hidden
  26781. */
  26782. _normals: number[];
  26783. /**
  26784. * length of the shape in the model indices array (internal use)
  26785. * @hidden
  26786. */
  26787. _indicesLength: number;
  26788. /**
  26789. * Custom position function (internal use)
  26790. * @hidden
  26791. */
  26792. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  26793. /**
  26794. * Custom vertex function (internal use)
  26795. * @hidden
  26796. */
  26797. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  26798. /**
  26799. * Creates a ModelShape object. This is an internal simplified reference to a mesh used as for a model to replicate particles from by the SPS.
  26800. * SPS internal tool, don't use it manually.
  26801. * @hidden
  26802. */
  26803. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>);
  26804. }
  26805. /**
  26806. * Represents a Depth Sorted Particle in the solid particle system.
  26807. */
  26808. export class DepthSortedParticle {
  26809. /**
  26810. * Index of the particle in the "indices" array
  26811. */
  26812. ind: number;
  26813. /**
  26814. * Length of the particle shape in the "indices" array
  26815. */
  26816. indicesLength: number;
  26817. /**
  26818. * Squared distance from the particle to the camera
  26819. */
  26820. sqDistance: number;
  26821. }
  26822. }
  26823. declare module "babylonjs/Collisions/meshCollisionData" {
  26824. import { Collider } from "babylonjs/Collisions/collider";
  26825. import { Vector3 } from "babylonjs/Maths/math.vector";
  26826. import { Nullable } from "babylonjs/types";
  26827. import { Observer } from "babylonjs/Misc/observable";
  26828. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26829. /**
  26830. * @hidden
  26831. */
  26832. export class _MeshCollisionData {
  26833. _checkCollisions: boolean;
  26834. _collisionMask: number;
  26835. _collisionGroup: number;
  26836. _collider: Nullable<Collider>;
  26837. _oldPositionForCollisions: Vector3;
  26838. _diffPositionForCollisions: Vector3;
  26839. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  26840. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  26841. }
  26842. }
  26843. declare module "babylonjs/Meshes/abstractMesh" {
  26844. import { Observable } from "babylonjs/Misc/observable";
  26845. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  26846. import { Camera } from "babylonjs/Cameras/camera";
  26847. import { Scene, IDisposable } from "babylonjs/scene";
  26848. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26849. import { Node } from "babylonjs/node";
  26850. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  26851. import { TransformNode } from "babylonjs/Meshes/transformNode";
  26852. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26853. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  26854. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26855. import { Material } from "babylonjs/Materials/material";
  26856. import { Light } from "babylonjs/Lights/light";
  26857. import { Skeleton } from "babylonjs/Bones/skeleton";
  26858. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  26859. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  26860. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  26861. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  26862. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  26863. import { Plane } from "babylonjs/Maths/math.plane";
  26864. import { Ray } from "babylonjs/Culling/ray";
  26865. import { Collider } from "babylonjs/Collisions/collider";
  26866. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26867. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  26868. /** @hidden */
  26869. class _FacetDataStorage {
  26870. facetPositions: Vector3[];
  26871. facetNormals: Vector3[];
  26872. facetPartitioning: number[][];
  26873. facetNb: number;
  26874. partitioningSubdivisions: number;
  26875. partitioningBBoxRatio: number;
  26876. facetDataEnabled: boolean;
  26877. facetParameters: any;
  26878. bbSize: Vector3;
  26879. subDiv: {
  26880. max: number;
  26881. X: number;
  26882. Y: number;
  26883. Z: number;
  26884. };
  26885. facetDepthSort: boolean;
  26886. facetDepthSortEnabled: boolean;
  26887. depthSortedIndices: IndicesArray;
  26888. depthSortedFacets: {
  26889. ind: number;
  26890. sqDistance: number;
  26891. }[];
  26892. facetDepthSortFunction: (f1: {
  26893. ind: number;
  26894. sqDistance: number;
  26895. }, f2: {
  26896. ind: number;
  26897. sqDistance: number;
  26898. }) => number;
  26899. facetDepthSortFrom: Vector3;
  26900. facetDepthSortOrigin: Vector3;
  26901. invertedMatrix: Matrix;
  26902. }
  26903. /**
  26904. * @hidden
  26905. **/
  26906. class _InternalAbstractMeshDataInfo {
  26907. _hasVertexAlpha: boolean;
  26908. _useVertexColors: boolean;
  26909. _numBoneInfluencers: number;
  26910. _applyFog: boolean;
  26911. _receiveShadows: boolean;
  26912. _facetData: _FacetDataStorage;
  26913. _visibility: number;
  26914. _skeleton: Nullable<Skeleton>;
  26915. _layerMask: number;
  26916. _computeBonesUsingShaders: boolean;
  26917. _isActive: boolean;
  26918. _onlyForInstances: boolean;
  26919. _isActiveIntermediate: boolean;
  26920. _onlyForInstancesIntermediate: boolean;
  26921. _actAsRegularMesh: boolean;
  26922. }
  26923. /**
  26924. * Class used to store all common mesh properties
  26925. */
  26926. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  26927. /** No occlusion */
  26928. static OCCLUSION_TYPE_NONE: number;
  26929. /** Occlusion set to optimisitic */
  26930. static OCCLUSION_TYPE_OPTIMISTIC: number;
  26931. /** Occlusion set to strict */
  26932. static OCCLUSION_TYPE_STRICT: number;
  26933. /** Use an accurante occlusion algorithm */
  26934. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  26935. /** Use a conservative occlusion algorithm */
  26936. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  26937. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  26938. * Test order :
  26939. * Is the bounding sphere outside the frustum ?
  26940. * If not, are the bounding box vertices outside the frustum ?
  26941. * It not, then the cullable object is in the frustum.
  26942. */
  26943. static readonly CULLINGSTRATEGY_STANDARD: number;
  26944. /** Culling strategy : Bounding Sphere Only.
  26945. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  26946. * It's also less accurate than the standard because some not visible objects can still be selected.
  26947. * Test : is the bounding sphere outside the frustum ?
  26948. * If not, then the cullable object is in the frustum.
  26949. */
  26950. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  26951. /** Culling strategy : Optimistic Inclusion.
  26952. * This in an inclusion test first, then the standard exclusion test.
  26953. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  26954. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  26955. * Anyway, it's as accurate as the standard strategy.
  26956. * Test :
  26957. * Is the cullable object bounding sphere center in the frustum ?
  26958. * If not, apply the default culling strategy.
  26959. */
  26960. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  26961. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  26962. * This in an inclusion test first, then the bounding sphere only exclusion test.
  26963. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  26964. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  26965. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  26966. * Test :
  26967. * Is the cullable object bounding sphere center in the frustum ?
  26968. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  26969. */
  26970. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  26971. /**
  26972. * No billboard
  26973. */
  26974. static readonly BILLBOARDMODE_NONE: number;
  26975. /** Billboard on X axis */
  26976. static readonly BILLBOARDMODE_X: number;
  26977. /** Billboard on Y axis */
  26978. static readonly BILLBOARDMODE_Y: number;
  26979. /** Billboard on Z axis */
  26980. static readonly BILLBOARDMODE_Z: number;
  26981. /** Billboard on all axes */
  26982. static readonly BILLBOARDMODE_ALL: number;
  26983. /** Billboard on using position instead of orientation */
  26984. static readonly BILLBOARDMODE_USE_POSITION: number;
  26985. /** @hidden */
  26986. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  26987. /**
  26988. * The culling strategy to use to check whether the mesh must be rendered or not.
  26989. * This value can be changed at any time and will be used on the next render mesh selection.
  26990. * The possible values are :
  26991. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26992. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26993. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26994. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26995. * Please read each static variable documentation to get details about the culling process.
  26996. * */
  26997. cullingStrategy: number;
  26998. /**
  26999. * Gets the number of facets in the mesh
  27000. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  27001. */
  27002. readonly facetNb: number;
  27003. /**
  27004. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  27005. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  27006. */
  27007. partitioningSubdivisions: number;
  27008. /**
  27009. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  27010. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  27011. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  27012. */
  27013. partitioningBBoxRatio: number;
  27014. /**
  27015. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  27016. * Works only for updatable meshes.
  27017. * Doesn't work with multi-materials
  27018. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  27019. */
  27020. mustDepthSortFacets: boolean;
  27021. /**
  27022. * The location (Vector3) where the facet depth sort must be computed from.
  27023. * By default, the active camera position.
  27024. * Used only when facet depth sort is enabled
  27025. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  27026. */
  27027. facetDepthSortFrom: Vector3;
  27028. /**
  27029. * gets a boolean indicating if facetData is enabled
  27030. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  27031. */
  27032. readonly isFacetDataEnabled: boolean;
  27033. /** @hidden */
  27034. _updateNonUniformScalingState(value: boolean): boolean;
  27035. /**
  27036. * An event triggered when this mesh collides with another one
  27037. */
  27038. onCollideObservable: Observable<AbstractMesh>;
  27039. /** Set a function to call when this mesh collides with another one */
  27040. onCollide: () => void;
  27041. /**
  27042. * An event triggered when the collision's position changes
  27043. */
  27044. onCollisionPositionChangeObservable: Observable<Vector3>;
  27045. /** Set a function to call when the collision's position changes */
  27046. onCollisionPositionChange: () => void;
  27047. /**
  27048. * An event triggered when material is changed
  27049. */
  27050. onMaterialChangedObservable: Observable<AbstractMesh>;
  27051. /**
  27052. * Gets or sets the orientation for POV movement & rotation
  27053. */
  27054. definedFacingForward: boolean;
  27055. /** @hidden */
  27056. _occlusionQuery: Nullable<WebGLQuery>;
  27057. /** @hidden */
  27058. _renderingGroup: Nullable<RenderingGroup>;
  27059. /**
  27060. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  27061. */
  27062. /**
  27063. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  27064. */
  27065. visibility: number;
  27066. /** Gets or sets the alpha index used to sort transparent meshes
  27067. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  27068. */
  27069. alphaIndex: number;
  27070. /**
  27071. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  27072. */
  27073. isVisible: boolean;
  27074. /**
  27075. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  27076. */
  27077. isPickable: boolean;
  27078. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  27079. showSubMeshesBoundingBox: boolean;
  27080. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  27081. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  27082. */
  27083. isBlocker: boolean;
  27084. /**
  27085. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  27086. */
  27087. enablePointerMoveEvents: boolean;
  27088. /**
  27089. * Specifies the rendering group id for this mesh (0 by default)
  27090. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  27091. */
  27092. renderingGroupId: number;
  27093. private _material;
  27094. /** Gets or sets current material */
  27095. material: Nullable<Material>;
  27096. /**
  27097. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  27098. * @see http://doc.babylonjs.com/babylon101/shadows
  27099. */
  27100. receiveShadows: boolean;
  27101. /** Defines color to use when rendering outline */
  27102. outlineColor: Color3;
  27103. /** Define width to use when rendering outline */
  27104. outlineWidth: number;
  27105. /** Defines color to use when rendering overlay */
  27106. overlayColor: Color3;
  27107. /** Defines alpha to use when rendering overlay */
  27108. overlayAlpha: number;
  27109. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  27110. hasVertexAlpha: boolean;
  27111. /** Gets or sets a boolean indicating that this mesh needs to use vertex color data to render (if this kind of vertex data is available in the geometry) */
  27112. useVertexColors: boolean;
  27113. /**
  27114. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  27115. */
  27116. computeBonesUsingShaders: boolean;
  27117. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  27118. numBoneInfluencers: number;
  27119. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  27120. applyFog: boolean;
  27121. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  27122. useOctreeForRenderingSelection: boolean;
  27123. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  27124. useOctreeForPicking: boolean;
  27125. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  27126. useOctreeForCollisions: boolean;
  27127. /**
  27128. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  27129. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  27130. */
  27131. layerMask: number;
  27132. /**
  27133. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  27134. */
  27135. alwaysSelectAsActiveMesh: boolean;
  27136. /**
  27137. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  27138. */
  27139. doNotSyncBoundingInfo: boolean;
  27140. /**
  27141. * Gets or sets the current action manager
  27142. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  27143. */
  27144. actionManager: Nullable<AbstractActionManager>;
  27145. private _meshCollisionData;
  27146. /**
  27147. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  27148. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27149. */
  27150. ellipsoid: Vector3;
  27151. /**
  27152. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  27153. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27154. */
  27155. ellipsoidOffset: Vector3;
  27156. /**
  27157. * Gets or sets a collision mask used to mask collisions (default is -1).
  27158. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  27159. */
  27160. collisionMask: number;
  27161. /**
  27162. * Gets or sets the current collision group mask (-1 by default).
  27163. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  27164. */
  27165. collisionGroup: number;
  27166. /**
  27167. * Defines edge width used when edgesRenderer is enabled
  27168. * @see https://www.babylonjs-playground.com/#10OJSG#13
  27169. */
  27170. edgesWidth: number;
  27171. /**
  27172. * Defines edge color used when edgesRenderer is enabled
  27173. * @see https://www.babylonjs-playground.com/#10OJSG#13
  27174. */
  27175. edgesColor: Color4;
  27176. /** @hidden */
  27177. _edgesRenderer: Nullable<IEdgesRenderer>;
  27178. /** @hidden */
  27179. _masterMesh: Nullable<AbstractMesh>;
  27180. /** @hidden */
  27181. _boundingInfo: Nullable<BoundingInfo>;
  27182. /** @hidden */
  27183. _renderId: number;
  27184. /**
  27185. * Gets or sets the list of subMeshes
  27186. * @see http://doc.babylonjs.com/how_to/multi_materials
  27187. */
  27188. subMeshes: SubMesh[];
  27189. /** @hidden */
  27190. _intersectionsInProgress: AbstractMesh[];
  27191. /** @hidden */
  27192. _unIndexed: boolean;
  27193. /** @hidden */
  27194. _lightSources: Light[];
  27195. /** Gets the list of lights affecting that mesh */
  27196. readonly lightSources: Light[];
  27197. /** @hidden */
  27198. readonly _positions: Nullable<Vector3[]>;
  27199. /** @hidden */
  27200. _waitingData: {
  27201. lods: Nullable<any>;
  27202. actions: Nullable<any>;
  27203. freezeWorldMatrix: Nullable<boolean>;
  27204. };
  27205. /** @hidden */
  27206. _bonesTransformMatrices: Nullable<Float32Array>;
  27207. /** @hidden */
  27208. _transformMatrixTexture: Nullable<RawTexture>;
  27209. /**
  27210. * Gets or sets a skeleton to apply skining transformations
  27211. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  27212. */
  27213. skeleton: Nullable<Skeleton>;
  27214. /**
  27215. * An event triggered when the mesh is rebuilt.
  27216. */
  27217. onRebuildObservable: Observable<AbstractMesh>;
  27218. /**
  27219. * Creates a new AbstractMesh
  27220. * @param name defines the name of the mesh
  27221. * @param scene defines the hosting scene
  27222. */
  27223. constructor(name: string, scene?: Nullable<Scene>);
  27224. /**
  27225. * Returns the string "AbstractMesh"
  27226. * @returns "AbstractMesh"
  27227. */
  27228. getClassName(): string;
  27229. /**
  27230. * Gets a string representation of the current mesh
  27231. * @param fullDetails defines a boolean indicating if full details must be included
  27232. * @returns a string representation of the current mesh
  27233. */
  27234. toString(fullDetails?: boolean): string;
  27235. /**
  27236. * @hidden
  27237. */
  27238. protected _getEffectiveParent(): Nullable<Node>;
  27239. /** @hidden */
  27240. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  27241. /** @hidden */
  27242. _rebuild(): void;
  27243. /** @hidden */
  27244. _resyncLightSources(): void;
  27245. /** @hidden */
  27246. _resyncLighSource(light: Light): void;
  27247. /** @hidden */
  27248. _unBindEffect(): void;
  27249. /** @hidden */
  27250. _removeLightSource(light: Light, dispose: boolean): void;
  27251. private _markSubMeshesAsDirty;
  27252. /** @hidden */
  27253. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  27254. /** @hidden */
  27255. _markSubMeshesAsAttributesDirty(): void;
  27256. /** @hidden */
  27257. _markSubMeshesAsMiscDirty(): void;
  27258. /**
  27259. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  27260. */
  27261. scaling: Vector3;
  27262. /**
  27263. * Returns true if the mesh is blocked. Implemented by child classes
  27264. */
  27265. readonly isBlocked: boolean;
  27266. /**
  27267. * Returns the mesh itself by default. Implemented by child classes
  27268. * @param camera defines the camera to use to pick the right LOD level
  27269. * @returns the currentAbstractMesh
  27270. */
  27271. getLOD(camera: Camera): Nullable<AbstractMesh>;
  27272. /**
  27273. * Returns 0 by default. Implemented by child classes
  27274. * @returns an integer
  27275. */
  27276. getTotalVertices(): number;
  27277. /**
  27278. * Returns a positive integer : the total number of indices in this mesh geometry.
  27279. * @returns the numner of indices or zero if the mesh has no geometry.
  27280. */
  27281. getTotalIndices(): number;
  27282. /**
  27283. * Returns null by default. Implemented by child classes
  27284. * @returns null
  27285. */
  27286. getIndices(): Nullable<IndicesArray>;
  27287. /**
  27288. * Returns the array of the requested vertex data kind. Implemented by child classes
  27289. * @param kind defines the vertex data kind to use
  27290. * @returns null
  27291. */
  27292. getVerticesData(kind: string): Nullable<FloatArray>;
  27293. /**
  27294. * Sets the vertex data of the mesh geometry for the requested `kind`.
  27295. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  27296. * Note that a new underlying VertexBuffer object is created each call.
  27297. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  27298. * @param kind defines vertex data kind:
  27299. * * VertexBuffer.PositionKind
  27300. * * VertexBuffer.UVKind
  27301. * * VertexBuffer.UV2Kind
  27302. * * VertexBuffer.UV3Kind
  27303. * * VertexBuffer.UV4Kind
  27304. * * VertexBuffer.UV5Kind
  27305. * * VertexBuffer.UV6Kind
  27306. * * VertexBuffer.ColorKind
  27307. * * VertexBuffer.MatricesIndicesKind
  27308. * * VertexBuffer.MatricesIndicesExtraKind
  27309. * * VertexBuffer.MatricesWeightsKind
  27310. * * VertexBuffer.MatricesWeightsExtraKind
  27311. * @param data defines the data source
  27312. * @param updatable defines if the data must be flagged as updatable (or static)
  27313. * @param stride defines the vertex stride (size of an entire vertex). Can be null and in this case will be deduced from vertex data kind
  27314. * @returns the current mesh
  27315. */
  27316. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  27317. /**
  27318. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  27319. * If the mesh has no geometry, it is simply returned as it is.
  27320. * @param kind defines vertex data kind:
  27321. * * VertexBuffer.PositionKind
  27322. * * VertexBuffer.UVKind
  27323. * * VertexBuffer.UV2Kind
  27324. * * VertexBuffer.UV3Kind
  27325. * * VertexBuffer.UV4Kind
  27326. * * VertexBuffer.UV5Kind
  27327. * * VertexBuffer.UV6Kind
  27328. * * VertexBuffer.ColorKind
  27329. * * VertexBuffer.MatricesIndicesKind
  27330. * * VertexBuffer.MatricesIndicesExtraKind
  27331. * * VertexBuffer.MatricesWeightsKind
  27332. * * VertexBuffer.MatricesWeightsExtraKind
  27333. * @param data defines the data source
  27334. * @param updateExtends If `kind` is `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed
  27335. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  27336. * @returns the current mesh
  27337. */
  27338. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  27339. /**
  27340. * Sets the mesh indices,
  27341. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  27342. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  27343. * @param totalVertices Defines the total number of vertices
  27344. * @returns the current mesh
  27345. */
  27346. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  27347. /**
  27348. * Gets a boolean indicating if specific vertex data is present
  27349. * @param kind defines the vertex data kind to use
  27350. * @returns true is data kind is present
  27351. */
  27352. isVerticesDataPresent(kind: string): boolean;
  27353. /**
  27354. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  27355. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  27356. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  27357. * @returns a BoundingInfo
  27358. */
  27359. getBoundingInfo(): BoundingInfo;
  27360. /**
  27361. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  27362. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  27363. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  27364. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  27365. * @returns the current mesh
  27366. */
  27367. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  27368. /**
  27369. * Overwrite the current bounding info
  27370. * @param boundingInfo defines the new bounding info
  27371. * @returns the current mesh
  27372. */
  27373. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  27374. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  27375. readonly useBones: boolean;
  27376. /** @hidden */
  27377. _preActivate(): void;
  27378. /** @hidden */
  27379. _preActivateForIntermediateRendering(renderId: number): void;
  27380. /** @hidden */
  27381. _activate(renderId: number, intermediateRendering: boolean): boolean;
  27382. /** @hidden */
  27383. _postActivate(): void;
  27384. /** @hidden */
  27385. _freeze(): void;
  27386. /** @hidden */
  27387. _unFreeze(): void;
  27388. /**
  27389. * Gets the current world matrix
  27390. * @returns a Matrix
  27391. */
  27392. getWorldMatrix(): Matrix;
  27393. /** @hidden */
  27394. _getWorldMatrixDeterminant(): number;
  27395. /**
  27396. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  27397. */
  27398. readonly isAnInstance: boolean;
  27399. /**
  27400. * Gets a boolean indicating if this mesh has instances
  27401. */
  27402. readonly hasInstances: boolean;
  27403. /**
  27404. * Perform relative position change from the point of view of behind the front of the mesh.
  27405. * This is performed taking into account the meshes current rotation, so you do not have to care.
  27406. * Supports definition of mesh facing forward or backward
  27407. * @param amountRight defines the distance on the right axis
  27408. * @param amountUp defines the distance on the up axis
  27409. * @param amountForward defines the distance on the forward axis
  27410. * @returns the current mesh
  27411. */
  27412. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  27413. /**
  27414. * Calculate relative position change from the point of view of behind the front of the mesh.
  27415. * This is performed taking into account the meshes current rotation, so you do not have to care.
  27416. * Supports definition of mesh facing forward or backward
  27417. * @param amountRight defines the distance on the right axis
  27418. * @param amountUp defines the distance on the up axis
  27419. * @param amountForward defines the distance on the forward axis
  27420. * @returns the new displacement vector
  27421. */
  27422. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  27423. /**
  27424. * Perform relative rotation change from the point of view of behind the front of the mesh.
  27425. * Supports definition of mesh facing forward or backward
  27426. * @param flipBack defines the flip
  27427. * @param twirlClockwise defines the twirl
  27428. * @param tiltRight defines the tilt
  27429. * @returns the current mesh
  27430. */
  27431. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  27432. /**
  27433. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  27434. * Supports definition of mesh facing forward or backward.
  27435. * @param flipBack defines the flip
  27436. * @param twirlClockwise defines the twirl
  27437. * @param tiltRight defines the tilt
  27438. * @returns the new rotation vector
  27439. */
  27440. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  27441. /**
  27442. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  27443. * This means the mesh underlying bounding box and sphere are recomputed.
  27444. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  27445. * @returns the current mesh
  27446. */
  27447. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  27448. /** @hidden */
  27449. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  27450. /** @hidden */
  27451. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  27452. /** @hidden */
  27453. _updateBoundingInfo(): AbstractMesh;
  27454. /** @hidden */
  27455. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  27456. /** @hidden */
  27457. protected _afterComputeWorldMatrix(): void;
  27458. /** @hidden */
  27459. readonly _effectiveMesh: AbstractMesh;
  27460. /**
  27461. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  27462. * A mesh is in the frustum if its bounding box intersects the frustum
  27463. * @param frustumPlanes defines the frustum to test
  27464. * @returns true if the mesh is in the frustum planes
  27465. */
  27466. isInFrustum(frustumPlanes: Plane[]): boolean;
  27467. /**
  27468. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  27469. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  27470. * @param frustumPlanes defines the frustum to test
  27471. * @returns true if the mesh is completely in the frustum planes
  27472. */
  27473. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  27474. /**
  27475. * True if the mesh intersects another mesh or a SolidParticle object
  27476. * @param mesh defines a target mesh or SolidParticle to test
  27477. * @param precise Unless the parameter `precise` is set to `true` the intersection is computed according to Axis Aligned Bounding Boxes (AABB), else according to OBB (Oriented BBoxes)
  27478. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  27479. * @returns true if there is an intersection
  27480. */
  27481. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  27482. /**
  27483. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  27484. * @param point defines the point to test
  27485. * @returns true if there is an intersection
  27486. */
  27487. intersectsPoint(point: Vector3): boolean;
  27488. /**
  27489. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  27490. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27491. */
  27492. checkCollisions: boolean;
  27493. /**
  27494. * Gets Collider object used to compute collisions (not physics)
  27495. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27496. */
  27497. readonly collider: Nullable<Collider>;
  27498. /**
  27499. * Move the mesh using collision engine
  27500. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27501. * @param displacement defines the requested displacement vector
  27502. * @returns the current mesh
  27503. */
  27504. moveWithCollisions(displacement: Vector3): AbstractMesh;
  27505. private _onCollisionPositionChange;
  27506. /** @hidden */
  27507. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  27508. /** @hidden */
  27509. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  27510. /** @hidden */
  27511. _checkCollision(collider: Collider): AbstractMesh;
  27512. /** @hidden */
  27513. _generatePointsArray(): boolean;
  27514. /**
  27515. * Checks if the passed Ray intersects with the mesh
  27516. * @param ray defines the ray to use
  27517. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  27518. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  27519. * @returns the picking info
  27520. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  27521. */
  27522. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  27523. /**
  27524. * Clones the current mesh
  27525. * @param name defines the mesh name
  27526. * @param newParent defines the new mesh parent
  27527. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  27528. * @returns the new mesh
  27529. */
  27530. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  27531. /**
  27532. * Disposes all the submeshes of the current meshnp
  27533. * @returns the current mesh
  27534. */
  27535. releaseSubMeshes(): AbstractMesh;
  27536. /**
  27537. * Releases resources associated with this abstract mesh.
  27538. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  27539. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  27540. */
  27541. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  27542. /**
  27543. * Adds the passed mesh as a child to the current mesh
  27544. * @param mesh defines the child mesh
  27545. * @returns the current mesh
  27546. */
  27547. addChild(mesh: AbstractMesh): AbstractMesh;
  27548. /**
  27549. * Removes the passed mesh from the current mesh children list
  27550. * @param mesh defines the child mesh
  27551. * @returns the current mesh
  27552. */
  27553. removeChild(mesh: AbstractMesh): AbstractMesh;
  27554. /** @hidden */
  27555. private _initFacetData;
  27556. /**
  27557. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  27558. * This method can be called within the render loop.
  27559. * You don't need to call this method by yourself in the render loop when you update/morph a mesh with the methods CreateXXX() as they automatically manage this computation
  27560. * @returns the current mesh
  27561. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27562. */
  27563. updateFacetData(): AbstractMesh;
  27564. /**
  27565. * Returns the facetLocalNormals array.
  27566. * The normals are expressed in the mesh local spac
  27567. * @returns an array of Vector3
  27568. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27569. */
  27570. getFacetLocalNormals(): Vector3[];
  27571. /**
  27572. * Returns the facetLocalPositions array.
  27573. * The facet positions are expressed in the mesh local space
  27574. * @returns an array of Vector3
  27575. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27576. */
  27577. getFacetLocalPositions(): Vector3[];
  27578. /**
  27579. * Returns the facetLocalPartioning array
  27580. * @returns an array of array of numbers
  27581. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27582. */
  27583. getFacetLocalPartitioning(): number[][];
  27584. /**
  27585. * Returns the i-th facet position in the world system.
  27586. * This method allocates a new Vector3 per call
  27587. * @param i defines the facet index
  27588. * @returns a new Vector3
  27589. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27590. */
  27591. getFacetPosition(i: number): Vector3;
  27592. /**
  27593. * Sets the reference Vector3 with the i-th facet position in the world system
  27594. * @param i defines the facet index
  27595. * @param ref defines the target vector
  27596. * @returns the current mesh
  27597. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27598. */
  27599. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  27600. /**
  27601. * Returns the i-th facet normal in the world system.
  27602. * This method allocates a new Vector3 per call
  27603. * @param i defines the facet index
  27604. * @returns a new Vector3
  27605. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27606. */
  27607. getFacetNormal(i: number): Vector3;
  27608. /**
  27609. * Sets the reference Vector3 with the i-th facet normal in the world system
  27610. * @param i defines the facet index
  27611. * @param ref defines the target vector
  27612. * @returns the current mesh
  27613. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27614. */
  27615. getFacetNormalToRef(i: number, ref: Vector3): this;
  27616. /**
  27617. * Returns the facets (in an array) in the same partitioning block than the one the passed coordinates are located (expressed in the mesh local system)
  27618. * @param x defines x coordinate
  27619. * @param y defines y coordinate
  27620. * @param z defines z coordinate
  27621. * @returns the array of facet indexes
  27622. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27623. */
  27624. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  27625. /**
  27626. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  27627. * @param projected sets as the (x,y,z) world projection on the facet
  27628. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  27629. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  27630. * @param x defines x coordinate
  27631. * @param y defines y coordinate
  27632. * @param z defines z coordinate
  27633. * @returns the face index if found (or null instead)
  27634. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27635. */
  27636. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27637. /**
  27638. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  27639. * @param projected sets as the (x,y,z) local projection on the facet
  27640. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  27641. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  27642. * @param x defines x coordinate
  27643. * @param y defines y coordinate
  27644. * @param z defines z coordinate
  27645. * @returns the face index if found (or null instead)
  27646. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27647. */
  27648. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27649. /**
  27650. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  27651. * @returns the parameters
  27652. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27653. */
  27654. getFacetDataParameters(): any;
  27655. /**
  27656. * Disables the feature FacetData and frees the related memory
  27657. * @returns the current mesh
  27658. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27659. */
  27660. disableFacetData(): AbstractMesh;
  27661. /**
  27662. * Updates the AbstractMesh indices array
  27663. * @param indices defines the data source
  27664. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  27665. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  27666. * @returns the current mesh
  27667. */
  27668. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  27669. /**
  27670. * Creates new normals data for the mesh
  27671. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  27672. * @returns the current mesh
  27673. */
  27674. createNormals(updatable: boolean): AbstractMesh;
  27675. /**
  27676. * Align the mesh with a normal
  27677. * @param normal defines the normal to use
  27678. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  27679. * @returns the current mesh
  27680. */
  27681. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  27682. /** @hidden */
  27683. _checkOcclusionQuery(): boolean;
  27684. /**
  27685. * Disables the mesh edge rendering mode
  27686. * @returns the currentAbstractMesh
  27687. */
  27688. disableEdgesRendering(): AbstractMesh;
  27689. /**
  27690. * Enables the edge rendering mode on the mesh.
  27691. * This mode makes the mesh edges visible
  27692. * @param epsilon defines the maximal distance between two angles to detect a face
  27693. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  27694. * @returns the currentAbstractMesh
  27695. * @see https://www.babylonjs-playground.com/#19O9TU#0
  27696. */
  27697. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  27698. }
  27699. }
  27700. declare module "babylonjs/Actions/actionEvent" {
  27701. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27702. import { Nullable } from "babylonjs/types";
  27703. import { Sprite } from "babylonjs/Sprites/sprite";
  27704. import { Scene } from "babylonjs/scene";
  27705. import { Vector2 } from "babylonjs/Maths/math.vector";
  27706. /**
  27707. * Interface used to define ActionEvent
  27708. */
  27709. export interface IActionEvent {
  27710. /** The mesh or sprite that triggered the action */
  27711. source: any;
  27712. /** The X mouse cursor position at the time of the event */
  27713. pointerX: number;
  27714. /** The Y mouse cursor position at the time of the event */
  27715. pointerY: number;
  27716. /** The mesh that is currently pointed at (can be null) */
  27717. meshUnderPointer: Nullable<AbstractMesh>;
  27718. /** the original (browser) event that triggered the ActionEvent */
  27719. sourceEvent?: any;
  27720. /** additional data for the event */
  27721. additionalData?: any;
  27722. }
  27723. /**
  27724. * ActionEvent is the event being sent when an action is triggered.
  27725. */
  27726. export class ActionEvent implements IActionEvent {
  27727. /** The mesh or sprite that triggered the action */
  27728. source: any;
  27729. /** The X mouse cursor position at the time of the event */
  27730. pointerX: number;
  27731. /** The Y mouse cursor position at the time of the event */
  27732. pointerY: number;
  27733. /** The mesh that is currently pointed at (can be null) */
  27734. meshUnderPointer: Nullable<AbstractMesh>;
  27735. /** the original (browser) event that triggered the ActionEvent */
  27736. sourceEvent?: any;
  27737. /** additional data for the event */
  27738. additionalData?: any;
  27739. /**
  27740. * Creates a new ActionEvent
  27741. * @param source The mesh or sprite that triggered the action
  27742. * @param pointerX The X mouse cursor position at the time of the event
  27743. * @param pointerY The Y mouse cursor position at the time of the event
  27744. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  27745. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  27746. * @param additionalData additional data for the event
  27747. */
  27748. constructor(
  27749. /** The mesh or sprite that triggered the action */
  27750. source: any,
  27751. /** The X mouse cursor position at the time of the event */
  27752. pointerX: number,
  27753. /** The Y mouse cursor position at the time of the event */
  27754. pointerY: number,
  27755. /** The mesh that is currently pointed at (can be null) */
  27756. meshUnderPointer: Nullable<AbstractMesh>,
  27757. /** the original (browser) event that triggered the ActionEvent */
  27758. sourceEvent?: any,
  27759. /** additional data for the event */
  27760. additionalData?: any);
  27761. /**
  27762. * Helper function to auto-create an ActionEvent from a source mesh.
  27763. * @param source The source mesh that triggered the event
  27764. * @param evt The original (browser) event
  27765. * @param additionalData additional data for the event
  27766. * @returns the new ActionEvent
  27767. */
  27768. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  27769. /**
  27770. * Helper function to auto-create an ActionEvent from a source sprite
  27771. * @param source The source sprite that triggered the event
  27772. * @param scene Scene associated with the sprite
  27773. * @param evt The original (browser) event
  27774. * @param additionalData additional data for the event
  27775. * @returns the new ActionEvent
  27776. */
  27777. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  27778. /**
  27779. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  27780. * @param scene the scene where the event occurred
  27781. * @param evt The original (browser) event
  27782. * @returns the new ActionEvent
  27783. */
  27784. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  27785. /**
  27786. * Helper function to auto-create an ActionEvent from a primitive
  27787. * @param prim defines the target primitive
  27788. * @param pointerPos defines the pointer position
  27789. * @param evt The original (browser) event
  27790. * @param additionalData additional data for the event
  27791. * @returns the new ActionEvent
  27792. */
  27793. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  27794. }
  27795. }
  27796. declare module "babylonjs/Actions/abstractActionManager" {
  27797. import { IDisposable } from "babylonjs/scene";
  27798. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  27799. import { IAction } from "babylonjs/Actions/action";
  27800. import { Nullable } from "babylonjs/types";
  27801. /**
  27802. * Abstract class used to decouple action Manager from scene and meshes.
  27803. * Do not instantiate.
  27804. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  27805. */
  27806. export abstract class AbstractActionManager implements IDisposable {
  27807. /** Gets the list of active triggers */
  27808. static Triggers: {
  27809. [key: string]: number;
  27810. };
  27811. /** Gets the cursor to use when hovering items */
  27812. hoverCursor: string;
  27813. /** Gets the list of actions */
  27814. actions: IAction[];
  27815. /**
  27816. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  27817. */
  27818. isRecursive: boolean;
  27819. /**
  27820. * Releases all associated resources
  27821. */
  27822. abstract dispose(): void;
  27823. /**
  27824. * Does this action manager has pointer triggers
  27825. */
  27826. abstract readonly hasPointerTriggers: boolean;
  27827. /**
  27828. * Does this action manager has pick triggers
  27829. */
  27830. abstract readonly hasPickTriggers: boolean;
  27831. /**
  27832. * Process a specific trigger
  27833. * @param trigger defines the trigger to process
  27834. * @param evt defines the event details to be processed
  27835. */
  27836. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  27837. /**
  27838. * Does this action manager handles actions of any of the given triggers
  27839. * @param triggers defines the triggers to be tested
  27840. * @return a boolean indicating whether one (or more) of the triggers is handled
  27841. */
  27842. abstract hasSpecificTriggers(triggers: number[]): boolean;
  27843. /**
  27844. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  27845. * speed.
  27846. * @param triggerA defines the trigger to be tested
  27847. * @param triggerB defines the trigger to be tested
  27848. * @return a boolean indicating whether one (or more) of the triggers is handled
  27849. */
  27850. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  27851. /**
  27852. * Does this action manager handles actions of a given trigger
  27853. * @param trigger defines the trigger to be tested
  27854. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  27855. * @return whether the trigger is handled
  27856. */
  27857. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  27858. /**
  27859. * Serialize this manager to a JSON object
  27860. * @param name defines the property name to store this manager
  27861. * @returns a JSON representation of this manager
  27862. */
  27863. abstract serialize(name: string): any;
  27864. /**
  27865. * Registers an action to this action manager
  27866. * @param action defines the action to be registered
  27867. * @return the action amended (prepared) after registration
  27868. */
  27869. abstract registerAction(action: IAction): Nullable<IAction>;
  27870. /**
  27871. * Unregisters an action to this action manager
  27872. * @param action defines the action to be unregistered
  27873. * @return a boolean indicating whether the action has been unregistered
  27874. */
  27875. abstract unregisterAction(action: IAction): Boolean;
  27876. /**
  27877. * Does exist one action manager with at least one trigger
  27878. **/
  27879. static readonly HasTriggers: boolean;
  27880. /**
  27881. * Does exist one action manager with at least one pick trigger
  27882. **/
  27883. static readonly HasPickTriggers: boolean;
  27884. /**
  27885. * Does exist one action manager that handles actions of a given trigger
  27886. * @param trigger defines the trigger to be tested
  27887. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  27888. **/
  27889. static HasSpecificTrigger(trigger: number): boolean;
  27890. }
  27891. }
  27892. declare module "babylonjs/node" {
  27893. import { Scene } from "babylonjs/scene";
  27894. import { Nullable } from "babylonjs/types";
  27895. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  27896. import { Engine } from "babylonjs/Engines/engine";
  27897. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  27898. import { Observable } from "babylonjs/Misc/observable";
  27899. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  27900. import { IInspectable } from "babylonjs/Misc/iInspectable";
  27901. import { Animatable } from "babylonjs/Animations/animatable";
  27902. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27903. import { Animation } from "babylonjs/Animations/animation";
  27904. import { AnimationRange } from "babylonjs/Animations/animationRange";
  27905. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27906. /**
  27907. * Defines how a node can be built from a string name.
  27908. */
  27909. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  27910. /**
  27911. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  27912. */
  27913. export class Node implements IBehaviorAware<Node> {
  27914. /** @hidden */
  27915. static _AnimationRangeFactory: (name: string, from: number, to: number) => import("babylonjs/Animations/animationRange").AnimationRange;
  27916. private static _NodeConstructors;
  27917. /**
  27918. * Add a new node constructor
  27919. * @param type defines the type name of the node to construct
  27920. * @param constructorFunc defines the constructor function
  27921. */
  27922. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  27923. /**
  27924. * Returns a node constructor based on type name
  27925. * @param type defines the type name
  27926. * @param name defines the new node name
  27927. * @param scene defines the hosting scene
  27928. * @param options defines optional options to transmit to constructors
  27929. * @returns the new constructor or null
  27930. */
  27931. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  27932. /**
  27933. * Gets or sets the name of the node
  27934. */
  27935. name: string;
  27936. /**
  27937. * Gets or sets the id of the node
  27938. */
  27939. id: string;
  27940. /**
  27941. * Gets or sets the unique id of the node
  27942. */
  27943. uniqueId: number;
  27944. /**
  27945. * Gets or sets a string used to store user defined state for the node
  27946. */
  27947. state: string;
  27948. /**
  27949. * Gets or sets an object used to store user defined information for the node
  27950. */
  27951. metadata: any;
  27952. /**
  27953. * For internal use only. Please do not use.
  27954. */
  27955. reservedDataStore: any;
  27956. /**
  27957. * List of inspectable custom properties (used by the Inspector)
  27958. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  27959. */
  27960. inspectableCustomProperties: IInspectable[];
  27961. private _doNotSerialize;
  27962. /**
  27963. * Gets or sets a boolean used to define if the node must be serialized
  27964. */
  27965. doNotSerialize: boolean;
  27966. /** @hidden */
  27967. _isDisposed: boolean;
  27968. /**
  27969. * Gets a list of Animations associated with the node
  27970. */
  27971. animations: import("babylonjs/Animations/animation").Animation[];
  27972. protected _ranges: {
  27973. [name: string]: Nullable<AnimationRange>;
  27974. };
  27975. /**
  27976. * Callback raised when the node is ready to be used
  27977. */
  27978. onReady: Nullable<(node: Node) => void>;
  27979. private _isEnabled;
  27980. private _isParentEnabled;
  27981. private _isReady;
  27982. /** @hidden */
  27983. _currentRenderId: number;
  27984. private _parentUpdateId;
  27985. /** @hidden */
  27986. _childUpdateId: number;
  27987. /** @hidden */
  27988. _waitingParentId: Nullable<string>;
  27989. /** @hidden */
  27990. _scene: Scene;
  27991. /** @hidden */
  27992. _cache: any;
  27993. private _parentNode;
  27994. private _children;
  27995. /** @hidden */
  27996. _worldMatrix: Matrix;
  27997. /** @hidden */
  27998. _worldMatrixDeterminant: number;
  27999. /** @hidden */
  28000. _worldMatrixDeterminantIsDirty: boolean;
  28001. /** @hidden */
  28002. private _sceneRootNodesIndex;
  28003. /**
  28004. * Gets a boolean indicating if the node has been disposed
  28005. * @returns true if the node was disposed
  28006. */
  28007. isDisposed(): boolean;
  28008. /**
  28009. * Gets or sets the parent of the node (without keeping the current position in the scene)
  28010. * @see https://doc.babylonjs.com/how_to/parenting
  28011. */
  28012. parent: Nullable<Node>;
  28013. /** @hidden */
  28014. _addToSceneRootNodes(): void;
  28015. /** @hidden */
  28016. _removeFromSceneRootNodes(): void;
  28017. private _animationPropertiesOverride;
  28018. /**
  28019. * Gets or sets the animation properties override
  28020. */
  28021. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  28022. /**
  28023. * Gets a string idenfifying the name of the class
  28024. * @returns "Node" string
  28025. */
  28026. getClassName(): string;
  28027. /** @hidden */
  28028. readonly _isNode: boolean;
  28029. /**
  28030. * An event triggered when the mesh is disposed
  28031. */
  28032. onDisposeObservable: Observable<Node>;
  28033. private _onDisposeObserver;
  28034. /**
  28035. * Sets a callback that will be raised when the node will be disposed
  28036. */
  28037. onDispose: () => void;
  28038. /**
  28039. * Creates a new Node
  28040. * @param name the name and id to be given to this node
  28041. * @param scene the scene this node will be added to
  28042. */
  28043. constructor(name: string, scene?: Nullable<Scene>);
  28044. /**
  28045. * Gets the scene of the node
  28046. * @returns a scene
  28047. */
  28048. getScene(): Scene;
  28049. /**
  28050. * Gets the engine of the node
  28051. * @returns a Engine
  28052. */
  28053. getEngine(): Engine;
  28054. private _behaviors;
  28055. /**
  28056. * Attach a behavior to the node
  28057. * @see http://doc.babylonjs.com/features/behaviour
  28058. * @param behavior defines the behavior to attach
  28059. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  28060. * @returns the current Node
  28061. */
  28062. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  28063. /**
  28064. * Remove an attached behavior
  28065. * @see http://doc.babylonjs.com/features/behaviour
  28066. * @param behavior defines the behavior to attach
  28067. * @returns the current Node
  28068. */
  28069. removeBehavior(behavior: Behavior<Node>): Node;
  28070. /**
  28071. * Gets the list of attached behaviors
  28072. * @see http://doc.babylonjs.com/features/behaviour
  28073. */
  28074. readonly behaviors: Behavior<Node>[];
  28075. /**
  28076. * Gets an attached behavior by name
  28077. * @param name defines the name of the behavior to look for
  28078. * @see http://doc.babylonjs.com/features/behaviour
  28079. * @returns null if behavior was not found else the requested behavior
  28080. */
  28081. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  28082. /**
  28083. * Returns the latest update of the World matrix
  28084. * @returns a Matrix
  28085. */
  28086. getWorldMatrix(): Matrix;
  28087. /** @hidden */
  28088. _getWorldMatrixDeterminant(): number;
  28089. /**
  28090. * Returns directly the latest state of the mesh World matrix.
  28091. * A Matrix is returned.
  28092. */
  28093. readonly worldMatrixFromCache: Matrix;
  28094. /** @hidden */
  28095. _initCache(): void;
  28096. /** @hidden */
  28097. updateCache(force?: boolean): void;
  28098. /** @hidden */
  28099. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  28100. /** @hidden */
  28101. _updateCache(ignoreParentClass?: boolean): void;
  28102. /** @hidden */
  28103. _isSynchronized(): boolean;
  28104. /** @hidden */
  28105. _markSyncedWithParent(): void;
  28106. /** @hidden */
  28107. isSynchronizedWithParent(): boolean;
  28108. /** @hidden */
  28109. isSynchronized(): boolean;
  28110. /**
  28111. * Is this node ready to be used/rendered
  28112. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  28113. * @return true if the node is ready
  28114. */
  28115. isReady(completeCheck?: boolean): boolean;
  28116. /**
  28117. * Is this node enabled?
  28118. * If the node has a parent, all ancestors will be checked and false will be returned if any are false (not enabled), otherwise will return true
  28119. * @param checkAncestors indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
  28120. * @return whether this node (and its parent) is enabled
  28121. */
  28122. isEnabled(checkAncestors?: boolean): boolean;
  28123. /** @hidden */
  28124. protected _syncParentEnabledState(): void;
  28125. /**
  28126. * Set the enabled state of this node
  28127. * @param value defines the new enabled state
  28128. */
  28129. setEnabled(value: boolean): void;
  28130. /**
  28131. * Is this node a descendant of the given node?
  28132. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  28133. * @param ancestor defines the parent node to inspect
  28134. * @returns a boolean indicating if this node is a descendant of the given node
  28135. */
  28136. isDescendantOf(ancestor: Node): boolean;
  28137. /** @hidden */
  28138. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  28139. /**
  28140. * Will return all nodes that have this node as ascendant
  28141. * @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
  28142. * @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
  28143. * @return all children nodes of all types
  28144. */
  28145. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  28146. /**
  28147. * Get all child-meshes of this node
  28148. * @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 (Default: false)
  28149. * @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
  28150. * @returns an array of AbstractMesh
  28151. */
  28152. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  28153. /**
  28154. * Get all direct children of this node
  28155. * @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
  28156. * @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 (Default: true)
  28157. * @returns an array of Node
  28158. */
  28159. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  28160. /** @hidden */
  28161. _setReady(state: boolean): void;
  28162. /**
  28163. * Get an animation by name
  28164. * @param name defines the name of the animation to look for
  28165. * @returns null if not found else the requested animation
  28166. */
  28167. getAnimationByName(name: string): Nullable<Animation>;
  28168. /**
  28169. * Creates an animation range for this node
  28170. * @param name defines the name of the range
  28171. * @param from defines the starting key
  28172. * @param to defines the end key
  28173. */
  28174. createAnimationRange(name: string, from: number, to: number): void;
  28175. /**
  28176. * Delete a specific animation range
  28177. * @param name defines the name of the range to delete
  28178. * @param deleteFrames defines if animation frames from the range must be deleted as well
  28179. */
  28180. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  28181. /**
  28182. * Get an animation range by name
  28183. * @param name defines the name of the animation range to look for
  28184. * @returns null if not found else the requested animation range
  28185. */
  28186. getAnimationRange(name: string): Nullable<AnimationRange>;
  28187. /**
  28188. * Gets the list of all animation ranges defined on this node
  28189. * @returns an array
  28190. */
  28191. getAnimationRanges(): Nullable<AnimationRange>[];
  28192. /**
  28193. * Will start the animation sequence
  28194. * @param name defines the range frames for animation sequence
  28195. * @param loop defines if the animation should loop (false by default)
  28196. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  28197. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  28198. * @returns the object created for this animation. If range does not exist, it will return null
  28199. */
  28200. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  28201. /**
  28202. * Serialize animation ranges into a JSON compatible object
  28203. * @returns serialization object
  28204. */
  28205. serializeAnimationRanges(): any;
  28206. /**
  28207. * Computes the world matrix of the node
  28208. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  28209. * @returns the world matrix
  28210. */
  28211. computeWorldMatrix(force?: boolean): Matrix;
  28212. /**
  28213. * Releases resources associated with this node.
  28214. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  28215. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  28216. */
  28217. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  28218. /**
  28219. * Parse animation range data from a serialization object and store them into a given node
  28220. * @param node defines where to store the animation ranges
  28221. * @param parsedNode defines the serialization object to read data from
  28222. * @param scene defines the hosting scene
  28223. */
  28224. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  28225. /**
  28226. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  28227. * @param includeDescendants Include bounding info from descendants as well (true by default)
  28228. * @param predicate defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
  28229. * @returns the new bounding vectors
  28230. */
  28231. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  28232. min: Vector3;
  28233. max: Vector3;
  28234. };
  28235. }
  28236. }
  28237. declare module "babylonjs/Animations/animation" {
  28238. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  28239. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  28240. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  28241. import { Nullable } from "babylonjs/types";
  28242. import { Scene } from "babylonjs/scene";
  28243. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  28244. import { AnimationRange } from "babylonjs/Animations/animationRange";
  28245. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  28246. import { Node } from "babylonjs/node";
  28247. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28248. import { Size } from "babylonjs/Maths/math.size";
  28249. import { Animatable } from "babylonjs/Animations/animatable";
  28250. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  28251. /**
  28252. * @hidden
  28253. */
  28254. export class _IAnimationState {
  28255. key: number;
  28256. repeatCount: number;
  28257. workValue?: any;
  28258. loopMode?: number;
  28259. offsetValue?: any;
  28260. highLimitValue?: any;
  28261. }
  28262. /**
  28263. * Class used to store any kind of animation
  28264. */
  28265. export class Animation {
  28266. /**Name of the animation */
  28267. name: string;
  28268. /**Property to animate */
  28269. targetProperty: string;
  28270. /**The frames per second of the animation */
  28271. framePerSecond: number;
  28272. /**The data type of the animation */
  28273. dataType: number;
  28274. /**The loop mode of the animation */
  28275. loopMode?: number | undefined;
  28276. /**Specifies if blending should be enabled */
  28277. enableBlending?: boolean | undefined;
  28278. /**
  28279. * Use matrix interpolation instead of using direct key value when animating matrices
  28280. */
  28281. static AllowMatricesInterpolation: boolean;
  28282. /**
  28283. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  28284. */
  28285. static AllowMatrixDecomposeForInterpolation: boolean;
  28286. /**
  28287. * Stores the key frames of the animation
  28288. */
  28289. private _keys;
  28290. /**
  28291. * Stores the easing function of the animation
  28292. */
  28293. private _easingFunction;
  28294. /**
  28295. * @hidden Internal use only
  28296. */
  28297. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  28298. /**
  28299. * The set of event that will be linked to this animation
  28300. */
  28301. private _events;
  28302. /**
  28303. * Stores an array of target property paths
  28304. */
  28305. targetPropertyPath: string[];
  28306. /**
  28307. * Stores the blending speed of the animation
  28308. */
  28309. blendingSpeed: number;
  28310. /**
  28311. * Stores the animation ranges for the animation
  28312. */
  28313. private _ranges;
  28314. /**
  28315. * @hidden Internal use
  28316. */
  28317. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  28318. /**
  28319. * Sets up an animation
  28320. * @param property The property to animate
  28321. * @param animationType The animation type to apply
  28322. * @param framePerSecond The frames per second of the animation
  28323. * @param easingFunction The easing function used in the animation
  28324. * @returns The created animation
  28325. */
  28326. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  28327. /**
  28328. * Create and start an animation on a node
  28329. * @param name defines the name of the global animation that will be run on all nodes
  28330. * @param node defines the root node where the animation will take place
  28331. * @param targetProperty defines property to animate
  28332. * @param framePerSecond defines the number of frame per second yo use
  28333. * @param totalFrame defines the number of frames in total
  28334. * @param from defines the initial value
  28335. * @param to defines the final value
  28336. * @param loopMode defines which loop mode you want to use (off by default)
  28337. * @param easingFunction defines the easing function to use (linear by default)
  28338. * @param onAnimationEnd defines the callback to call when animation end
  28339. * @returns the animatable created for this animation
  28340. */
  28341. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  28342. /**
  28343. * Create and start an animation on a node and its descendants
  28344. * @param name defines the name of the global animation that will be run on all nodes
  28345. * @param node defines the root node where the animation will take place
  28346. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used
  28347. * @param targetProperty defines property to animate
  28348. * @param framePerSecond defines the number of frame per second to use
  28349. * @param totalFrame defines the number of frames in total
  28350. * @param from defines the initial value
  28351. * @param to defines the final value
  28352. * @param loopMode defines which loop mode you want to use (off by default)
  28353. * @param easingFunction defines the easing function to use (linear by default)
  28354. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  28355. * @returns the list of animatables created for all nodes
  28356. * @example https://www.babylonjs-playground.com/#MH0VLI
  28357. */
  28358. static CreateAndStartHierarchyAnimation(name: string, node: Node, directDescendantsOnly: boolean, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable[]>;
  28359. /**
  28360. * Creates a new animation, merges it with the existing animations and starts it
  28361. * @param name Name of the animation
  28362. * @param node Node which contains the scene that begins the animations
  28363. * @param targetProperty Specifies which property to animate
  28364. * @param framePerSecond The frames per second of the animation
  28365. * @param totalFrame The total number of frames
  28366. * @param from The frame at the beginning of the animation
  28367. * @param to The frame at the end of the animation
  28368. * @param loopMode Specifies the loop mode of the animation
  28369. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  28370. * @param onAnimationEnd Callback to run once the animation is complete
  28371. * @returns Nullable animation
  28372. */
  28373. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  28374. /**
  28375. * Transition property of an host to the target Value
  28376. * @param property The property to transition
  28377. * @param targetValue The target Value of the property
  28378. * @param host The object where the property to animate belongs
  28379. * @param scene Scene used to run the animation
  28380. * @param frameRate Framerate (in frame/s) to use
  28381. * @param transition The transition type we want to use
  28382. * @param duration The duration of the animation, in milliseconds
  28383. * @param onAnimationEnd Callback trigger at the end of the animation
  28384. * @returns Nullable animation
  28385. */
  28386. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  28387. /**
  28388. * Return the array of runtime animations currently using this animation
  28389. */
  28390. readonly runtimeAnimations: RuntimeAnimation[];
  28391. /**
  28392. * Specifies if any of the runtime animations are currently running
  28393. */
  28394. readonly hasRunningRuntimeAnimations: boolean;
  28395. /**
  28396. * Initializes the animation
  28397. * @param name Name of the animation
  28398. * @param targetProperty Property to animate
  28399. * @param framePerSecond The frames per second of the animation
  28400. * @param dataType The data type of the animation
  28401. * @param loopMode The loop mode of the animation
  28402. * @param enableBlending Specifies if blending should be enabled
  28403. */
  28404. constructor(
  28405. /**Name of the animation */
  28406. name: string,
  28407. /**Property to animate */
  28408. targetProperty: string,
  28409. /**The frames per second of the animation */
  28410. framePerSecond: number,
  28411. /**The data type of the animation */
  28412. dataType: number,
  28413. /**The loop mode of the animation */
  28414. loopMode?: number | undefined,
  28415. /**Specifies if blending should be enabled */
  28416. enableBlending?: boolean | undefined);
  28417. /**
  28418. * Converts the animation to a string
  28419. * @param fullDetails support for multiple levels of logging within scene loading
  28420. * @returns String form of the animation
  28421. */
  28422. toString(fullDetails?: boolean): string;
  28423. /**
  28424. * Add an event to this animation
  28425. * @param event Event to add
  28426. */
  28427. addEvent(event: AnimationEvent): void;
  28428. /**
  28429. * Remove all events found at the given frame
  28430. * @param frame The frame to remove events from
  28431. */
  28432. removeEvents(frame: number): void;
  28433. /**
  28434. * Retrieves all the events from the animation
  28435. * @returns Events from the animation
  28436. */
  28437. getEvents(): AnimationEvent[];
  28438. /**
  28439. * Creates an animation range
  28440. * @param name Name of the animation range
  28441. * @param from Starting frame of the animation range
  28442. * @param to Ending frame of the animation
  28443. */
  28444. createRange(name: string, from: number, to: number): void;
  28445. /**
  28446. * Deletes an animation range by name
  28447. * @param name Name of the animation range to delete
  28448. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  28449. */
  28450. deleteRange(name: string, deleteFrames?: boolean): void;
  28451. /**
  28452. * Gets the animation range by name, or null if not defined
  28453. * @param name Name of the animation range
  28454. * @returns Nullable animation range
  28455. */
  28456. getRange(name: string): Nullable<AnimationRange>;
  28457. /**
  28458. * Gets the key frames from the animation
  28459. * @returns The key frames of the animation
  28460. */
  28461. getKeys(): Array<IAnimationKey>;
  28462. /**
  28463. * Gets the highest frame rate of the animation
  28464. * @returns Highest frame rate of the animation
  28465. */
  28466. getHighestFrame(): number;
  28467. /**
  28468. * Gets the easing function of the animation
  28469. * @returns Easing function of the animation
  28470. */
  28471. getEasingFunction(): IEasingFunction;
  28472. /**
  28473. * Sets the easing function of the animation
  28474. * @param easingFunction A custom mathematical formula for animation
  28475. */
  28476. setEasingFunction(easingFunction: EasingFunction): void;
  28477. /**
  28478. * Interpolates a scalar linearly
  28479. * @param startValue Start value of the animation curve
  28480. * @param endValue End value of the animation curve
  28481. * @param gradient Scalar amount to interpolate
  28482. * @returns Interpolated scalar value
  28483. */
  28484. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  28485. /**
  28486. * Interpolates a scalar cubically
  28487. * @param startValue Start value of the animation curve
  28488. * @param outTangent End tangent of the animation
  28489. * @param endValue End value of the animation curve
  28490. * @param inTangent Start tangent of the animation curve
  28491. * @param gradient Scalar amount to interpolate
  28492. * @returns Interpolated scalar value
  28493. */
  28494. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  28495. /**
  28496. * Interpolates a quaternion using a spherical linear interpolation
  28497. * @param startValue Start value of the animation curve
  28498. * @param endValue End value of the animation curve
  28499. * @param gradient Scalar amount to interpolate
  28500. * @returns Interpolated quaternion value
  28501. */
  28502. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  28503. /**
  28504. * Interpolates a quaternion cubically
  28505. * @param startValue Start value of the animation curve
  28506. * @param outTangent End tangent of the animation curve
  28507. * @param endValue End value of the animation curve
  28508. * @param inTangent Start tangent of the animation curve
  28509. * @param gradient Scalar amount to interpolate
  28510. * @returns Interpolated quaternion value
  28511. */
  28512. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  28513. /**
  28514. * Interpolates a Vector3 linearl
  28515. * @param startValue Start value of the animation curve
  28516. * @param endValue End value of the animation curve
  28517. * @param gradient Scalar amount to interpolate
  28518. * @returns Interpolated scalar value
  28519. */
  28520. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  28521. /**
  28522. * Interpolates a Vector3 cubically
  28523. * @param startValue Start value of the animation curve
  28524. * @param outTangent End tangent of the animation
  28525. * @param endValue End value of the animation curve
  28526. * @param inTangent Start tangent of the animation curve
  28527. * @param gradient Scalar amount to interpolate
  28528. * @returns InterpolatedVector3 value
  28529. */
  28530. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  28531. /**
  28532. * Interpolates a Vector2 linearly
  28533. * @param startValue Start value of the animation curve
  28534. * @param endValue End value of the animation curve
  28535. * @param gradient Scalar amount to interpolate
  28536. * @returns Interpolated Vector2 value
  28537. */
  28538. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  28539. /**
  28540. * Interpolates a Vector2 cubically
  28541. * @param startValue Start value of the animation curve
  28542. * @param outTangent End tangent of the animation
  28543. * @param endValue End value of the animation curve
  28544. * @param inTangent Start tangent of the animation curve
  28545. * @param gradient Scalar amount to interpolate
  28546. * @returns Interpolated Vector2 value
  28547. */
  28548. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  28549. /**
  28550. * Interpolates a size linearly
  28551. * @param startValue Start value of the animation curve
  28552. * @param endValue End value of the animation curve
  28553. * @param gradient Scalar amount to interpolate
  28554. * @returns Interpolated Size value
  28555. */
  28556. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  28557. /**
  28558. * Interpolates a Color3 linearly
  28559. * @param startValue Start value of the animation curve
  28560. * @param endValue End value of the animation curve
  28561. * @param gradient Scalar amount to interpolate
  28562. * @returns Interpolated Color3 value
  28563. */
  28564. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  28565. /**
  28566. * Interpolates a Color4 linearly
  28567. * @param startValue Start value of the animation curve
  28568. * @param endValue End value of the animation curve
  28569. * @param gradient Scalar amount to interpolate
  28570. * @returns Interpolated Color3 value
  28571. */
  28572. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  28573. /**
  28574. * @hidden Internal use only
  28575. */
  28576. _getKeyValue(value: any): any;
  28577. /**
  28578. * @hidden Internal use only
  28579. */
  28580. _interpolate(currentFrame: number, state: _IAnimationState): any;
  28581. /**
  28582. * Defines the function to use to interpolate matrices
  28583. * @param startValue defines the start matrix
  28584. * @param endValue defines the end matrix
  28585. * @param gradient defines the gradient between both matrices
  28586. * @param result defines an optional target matrix where to store the interpolation
  28587. * @returns the interpolated matrix
  28588. */
  28589. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  28590. /**
  28591. * Makes a copy of the animation
  28592. * @returns Cloned animation
  28593. */
  28594. clone(): Animation;
  28595. /**
  28596. * Sets the key frames of the animation
  28597. * @param values The animation key frames to set
  28598. */
  28599. setKeys(values: Array<IAnimationKey>): void;
  28600. /**
  28601. * Serializes the animation to an object
  28602. * @returns Serialized object
  28603. */
  28604. serialize(): any;
  28605. /**
  28606. * Float animation type
  28607. */
  28608. static readonly ANIMATIONTYPE_FLOAT: number;
  28609. /**
  28610. * Vector3 animation type
  28611. */
  28612. static readonly ANIMATIONTYPE_VECTOR3: number;
  28613. /**
  28614. * Quaternion animation type
  28615. */
  28616. static readonly ANIMATIONTYPE_QUATERNION: number;
  28617. /**
  28618. * Matrix animation type
  28619. */
  28620. static readonly ANIMATIONTYPE_MATRIX: number;
  28621. /**
  28622. * Color3 animation type
  28623. */
  28624. static readonly ANIMATIONTYPE_COLOR3: number;
  28625. /**
  28626. * Color3 animation type
  28627. */
  28628. static readonly ANIMATIONTYPE_COLOR4: number;
  28629. /**
  28630. * Vector2 animation type
  28631. */
  28632. static readonly ANIMATIONTYPE_VECTOR2: number;
  28633. /**
  28634. * Size animation type
  28635. */
  28636. static readonly ANIMATIONTYPE_SIZE: number;
  28637. /**
  28638. * Relative Loop Mode
  28639. */
  28640. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  28641. /**
  28642. * Cycle Loop Mode
  28643. */
  28644. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  28645. /**
  28646. * Constant Loop Mode
  28647. */
  28648. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  28649. /** @hidden */
  28650. static _UniversalLerp(left: any, right: any, amount: number): any;
  28651. /**
  28652. * Parses an animation object and creates an animation
  28653. * @param parsedAnimation Parsed animation object
  28654. * @returns Animation object
  28655. */
  28656. static Parse(parsedAnimation: any): Animation;
  28657. /**
  28658. * Appends the serialized animations from the source animations
  28659. * @param source Source containing the animations
  28660. * @param destination Target to store the animations
  28661. */
  28662. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28663. }
  28664. }
  28665. declare module "babylonjs/Animations/animatable.interface" {
  28666. import { Nullable } from "babylonjs/types";
  28667. import { Animation } from "babylonjs/Animations/animation";
  28668. /**
  28669. * Interface containing an array of animations
  28670. */
  28671. export interface IAnimatable {
  28672. /**
  28673. * Array of animations
  28674. */
  28675. animations: Nullable<Array<Animation>>;
  28676. }
  28677. }
  28678. declare module "babylonjs/Materials/fresnelParameters" {
  28679. import { Color3 } from "babylonjs/Maths/math.color";
  28680. /**
  28681. * This represents all the required information to add a fresnel effect on a material:
  28682. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  28683. */
  28684. export class FresnelParameters {
  28685. private _isEnabled;
  28686. /**
  28687. * Define if the fresnel effect is enable or not.
  28688. */
  28689. isEnabled: boolean;
  28690. /**
  28691. * Define the color used on edges (grazing angle)
  28692. */
  28693. leftColor: Color3;
  28694. /**
  28695. * Define the color used on center
  28696. */
  28697. rightColor: Color3;
  28698. /**
  28699. * Define bias applied to computed fresnel term
  28700. */
  28701. bias: number;
  28702. /**
  28703. * Defined the power exponent applied to fresnel term
  28704. */
  28705. power: number;
  28706. /**
  28707. * Clones the current fresnel and its valuues
  28708. * @returns a clone fresnel configuration
  28709. */
  28710. clone(): FresnelParameters;
  28711. /**
  28712. * Serializes the current fresnel parameters to a JSON representation.
  28713. * @return the JSON serialization
  28714. */
  28715. serialize(): any;
  28716. /**
  28717. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  28718. * @param parsedFresnelParameters Define the JSON representation
  28719. * @returns the parsed parameters
  28720. */
  28721. static Parse(parsedFresnelParameters: any): FresnelParameters;
  28722. }
  28723. }
  28724. declare module "babylonjs/Misc/decorators" {
  28725. import { Nullable } from "babylonjs/types";
  28726. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28727. import { Scene } from "babylonjs/scene";
  28728. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  28729. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28730. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28731. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28732. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28733. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28734. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28735. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28736. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28737. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28738. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28739. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28740. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28741. /**
  28742. * Decorator used to define property that can be serialized as reference to a camera
  28743. * @param sourceName defines the name of the property to decorate
  28744. */
  28745. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28746. /**
  28747. * Class used to help serialization objects
  28748. */
  28749. export class SerializationHelper {
  28750. /** @hidden */
  28751. static _ImageProcessingConfigurationParser: (sourceProperty: any) => import("babylonjs/Materials/imageProcessingConfiguration").ImageProcessingConfiguration;
  28752. /** @hidden */
  28753. static _FresnelParametersParser: (sourceProperty: any) => import("babylonjs/Materials/fresnelParameters").FresnelParameters;
  28754. /** @hidden */
  28755. static _ColorCurvesParser: (sourceProperty: any) => import("babylonjs/Materials/colorCurves").ColorCurves;
  28756. /** @hidden */
  28757. static _TextureParser: (sourceProperty: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => Nullable<import("babylonjs/Materials/Textures/baseTexture").BaseTexture>;
  28758. /**
  28759. * Appends the serialized animations from the source animations
  28760. * @param source Source containing the animations
  28761. * @param destination Target to store the animations
  28762. */
  28763. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28764. /**
  28765. * Static function used to serialized a specific entity
  28766. * @param entity defines the entity to serialize
  28767. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  28768. * @returns a JSON compatible object representing the serialization of the entity
  28769. */
  28770. static Serialize<T>(entity: T, serializationObject?: any): any;
  28771. /**
  28772. * Creates a new entity from a serialization data object
  28773. * @param creationFunction defines a function used to instanciated the new entity
  28774. * @param source defines the source serialization data
  28775. * @param scene defines the hosting scene
  28776. * @param rootUrl defines the root url for resources
  28777. * @returns a new entity
  28778. */
  28779. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  28780. /**
  28781. * Clones an object
  28782. * @param creationFunction defines the function used to instanciate the new object
  28783. * @param source defines the source object
  28784. * @returns the cloned object
  28785. */
  28786. static Clone<T>(creationFunction: () => T, source: T): T;
  28787. /**
  28788. * Instanciates a new object based on a source one (some data will be shared between both object)
  28789. * @param creationFunction defines the function used to instanciate the new object
  28790. * @param source defines the source object
  28791. * @returns the new object
  28792. */
  28793. static Instanciate<T>(creationFunction: () => T, source: T): T;
  28794. }
  28795. }
  28796. declare module "babylonjs/Misc/guid" {
  28797. /**
  28798. * Class used to manipulate GUIDs
  28799. */
  28800. export class GUID {
  28801. /**
  28802. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  28803. * Be aware Math.random() could cause collisions, but:
  28804. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  28805. * @returns a pseudo random id
  28806. */
  28807. static RandomId(): string;
  28808. }
  28809. }
  28810. declare module "babylonjs/Materials/Textures/baseTexture" {
  28811. import { Observable } from "babylonjs/Misc/observable";
  28812. import { Nullable } from "babylonjs/types";
  28813. import { Scene } from "babylonjs/scene";
  28814. import { Matrix } from "babylonjs/Maths/math.vector";
  28815. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28816. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28817. import { ISize } from "babylonjs/Maths/math.size";
  28818. /**
  28819. * Base class of all the textures in babylon.
  28820. * It groups all the common properties the materials, post process, lights... might need
  28821. * in order to make a correct use of the texture.
  28822. */
  28823. export class BaseTexture implements IAnimatable {
  28824. /**
  28825. * Default anisotropic filtering level for the application.
  28826. * It is set to 4 as a good tradeoff between perf and quality.
  28827. */
  28828. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  28829. /**
  28830. * Gets or sets the unique id of the texture
  28831. */
  28832. uniqueId: number;
  28833. /**
  28834. * Define the name of the texture.
  28835. */
  28836. name: string;
  28837. /**
  28838. * Gets or sets an object used to store user defined information.
  28839. */
  28840. metadata: any;
  28841. /**
  28842. * For internal use only. Please do not use.
  28843. */
  28844. reservedDataStore: any;
  28845. private _hasAlpha;
  28846. /**
  28847. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  28848. */
  28849. hasAlpha: boolean;
  28850. /**
  28851. * Defines if the alpha value should be determined via the rgb values.
  28852. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  28853. */
  28854. getAlphaFromRGB: boolean;
  28855. /**
  28856. * Intensity or strength of the texture.
  28857. * It is commonly used by materials to fine tune the intensity of the texture
  28858. */
  28859. level: number;
  28860. /**
  28861. * Define the UV chanel to use starting from 0 and defaulting to 0.
  28862. * This is part of the texture as textures usually maps to one uv set.
  28863. */
  28864. coordinatesIndex: number;
  28865. private _coordinatesMode;
  28866. /**
  28867. * How a texture is mapped.
  28868. *
  28869. * | Value | Type | Description |
  28870. * | ----- | ----------------------------------- | ----------- |
  28871. * | 0 | EXPLICIT_MODE | |
  28872. * | 1 | SPHERICAL_MODE | |
  28873. * | 2 | PLANAR_MODE | |
  28874. * | 3 | CUBIC_MODE | |
  28875. * | 4 | PROJECTION_MODE | |
  28876. * | 5 | SKYBOX_MODE | |
  28877. * | 6 | INVCUBIC_MODE | |
  28878. * | 7 | EQUIRECTANGULAR_MODE | |
  28879. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  28880. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  28881. */
  28882. coordinatesMode: number;
  28883. /**
  28884. * | Value | Type | Description |
  28885. * | ----- | ------------------ | ----------- |
  28886. * | 0 | CLAMP_ADDRESSMODE | |
  28887. * | 1 | WRAP_ADDRESSMODE | |
  28888. * | 2 | MIRROR_ADDRESSMODE | |
  28889. */
  28890. wrapU: number;
  28891. /**
  28892. * | Value | Type | Description |
  28893. * | ----- | ------------------ | ----------- |
  28894. * | 0 | CLAMP_ADDRESSMODE | |
  28895. * | 1 | WRAP_ADDRESSMODE | |
  28896. * | 2 | MIRROR_ADDRESSMODE | |
  28897. */
  28898. wrapV: number;
  28899. /**
  28900. * | Value | Type | Description |
  28901. * | ----- | ------------------ | ----------- |
  28902. * | 0 | CLAMP_ADDRESSMODE | |
  28903. * | 1 | WRAP_ADDRESSMODE | |
  28904. * | 2 | MIRROR_ADDRESSMODE | |
  28905. */
  28906. wrapR: number;
  28907. /**
  28908. * With compliant hardware and browser (supporting anisotropic filtering)
  28909. * this defines the level of anisotropic filtering in the texture.
  28910. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  28911. */
  28912. anisotropicFilteringLevel: number;
  28913. /**
  28914. * Define if the texture is a cube texture or if false a 2d texture.
  28915. */
  28916. isCube: boolean;
  28917. /**
  28918. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  28919. */
  28920. is3D: boolean;
  28921. /**
  28922. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  28923. */
  28924. is2DArray: boolean;
  28925. /**
  28926. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  28927. * HDR texture are usually stored in linear space.
  28928. * This only impacts the PBR and Background materials
  28929. */
  28930. gammaSpace: boolean;
  28931. /**
  28932. * Gets or sets whether or not the texture contains RGBD data.
  28933. */
  28934. isRGBD: boolean;
  28935. /**
  28936. * Is Z inverted in the texture (useful in a cube texture).
  28937. */
  28938. invertZ: boolean;
  28939. /**
  28940. * Are mip maps generated for this texture or not.
  28941. */
  28942. readonly noMipmap: boolean;
  28943. /**
  28944. * @hidden
  28945. */
  28946. lodLevelInAlpha: boolean;
  28947. /**
  28948. * With prefiltered texture, defined the offset used during the prefiltering steps.
  28949. */
  28950. lodGenerationOffset: number;
  28951. /**
  28952. * With prefiltered texture, defined the scale used during the prefiltering steps.
  28953. */
  28954. lodGenerationScale: number;
  28955. /**
  28956. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  28957. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  28958. * average roughness values.
  28959. */
  28960. linearSpecularLOD: boolean;
  28961. /**
  28962. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  28963. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  28964. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  28965. */
  28966. irradianceTexture: Nullable<BaseTexture>;
  28967. /**
  28968. * Define if the texture is a render target.
  28969. */
  28970. isRenderTarget: boolean;
  28971. /**
  28972. * Define the unique id of the texture in the scene.
  28973. */
  28974. readonly uid: string;
  28975. /**
  28976. * Return a string representation of the texture.
  28977. * @returns the texture as a string
  28978. */
  28979. toString(): string;
  28980. /**
  28981. * Get the class name of the texture.
  28982. * @returns "BaseTexture"
  28983. */
  28984. getClassName(): string;
  28985. /**
  28986. * Define the list of animation attached to the texture.
  28987. */
  28988. animations: import("babylonjs/Animations/animation").Animation[];
  28989. /**
  28990. * An event triggered when the texture is disposed.
  28991. */
  28992. onDisposeObservable: Observable<BaseTexture>;
  28993. private _onDisposeObserver;
  28994. /**
  28995. * Callback triggered when the texture has been disposed.
  28996. * Kept for back compatibility, you can use the onDisposeObservable instead.
  28997. */
  28998. onDispose: () => void;
  28999. /**
  29000. * Define the current state of the loading sequence when in delayed load mode.
  29001. */
  29002. delayLoadState: number;
  29003. private _scene;
  29004. /** @hidden */
  29005. _texture: Nullable<InternalTexture>;
  29006. private _uid;
  29007. /**
  29008. * Define if the texture is preventinga material to render or not.
  29009. * If not and the texture is not ready, the engine will use a default black texture instead.
  29010. */
  29011. readonly isBlocking: boolean;
  29012. /**
  29013. * Instantiates a new BaseTexture.
  29014. * Base class of all the textures in babylon.
  29015. * It groups all the common properties the materials, post process, lights... might need
  29016. * in order to make a correct use of the texture.
  29017. * @param scene Define the scene the texture blongs to
  29018. */
  29019. constructor(scene: Nullable<Scene>);
  29020. /**
  29021. * Get the scene the texture belongs to.
  29022. * @returns the scene or null if undefined
  29023. */
  29024. getScene(): Nullable<Scene>;
  29025. /**
  29026. * Get the texture transform matrix used to offset tile the texture for istance.
  29027. * @returns the transformation matrix
  29028. */
  29029. getTextureMatrix(): Matrix;
  29030. /**
  29031. * Get the texture reflection matrix used to rotate/transform the reflection.
  29032. * @returns the reflection matrix
  29033. */
  29034. getReflectionTextureMatrix(): Matrix;
  29035. /**
  29036. * Get the underlying lower level texture from Babylon.
  29037. * @returns the insternal texture
  29038. */
  29039. getInternalTexture(): Nullable<InternalTexture>;
  29040. /**
  29041. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  29042. * @returns true if ready or not blocking
  29043. */
  29044. isReadyOrNotBlocking(): boolean;
  29045. /**
  29046. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  29047. * @returns true if fully ready
  29048. */
  29049. isReady(): boolean;
  29050. private _cachedSize;
  29051. /**
  29052. * Get the size of the texture.
  29053. * @returns the texture size.
  29054. */
  29055. getSize(): ISize;
  29056. /**
  29057. * Get the base size of the texture.
  29058. * It can be different from the size if the texture has been resized for POT for instance
  29059. * @returns the base size
  29060. */
  29061. getBaseSize(): ISize;
  29062. /**
  29063. * Update the sampling mode of the texture.
  29064. * Default is Trilinear mode.
  29065. *
  29066. * | Value | Type | Description |
  29067. * | ----- | ------------------ | ----------- |
  29068. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  29069. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  29070. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  29071. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  29072. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  29073. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  29074. * | 7 | NEAREST_LINEAR | |
  29075. * | 8 | NEAREST_NEAREST | |
  29076. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  29077. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  29078. * | 11 | LINEAR_LINEAR | |
  29079. * | 12 | LINEAR_NEAREST | |
  29080. *
  29081. * > _mag_: magnification filter (close to the viewer)
  29082. * > _min_: minification filter (far from the viewer)
  29083. * > _mip_: filter used between mip map levels
  29084. *@param samplingMode Define the new sampling mode of the texture
  29085. */
  29086. updateSamplingMode(samplingMode: number): void;
  29087. /**
  29088. * Scales the texture if is `canRescale()`
  29089. * @param ratio the resize factor we want to use to rescale
  29090. */
  29091. scale(ratio: number): void;
  29092. /**
  29093. * Get if the texture can rescale.
  29094. */
  29095. readonly canRescale: boolean;
  29096. /** @hidden */
  29097. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  29098. /** @hidden */
  29099. _rebuild(): void;
  29100. /**
  29101. * Triggers the load sequence in delayed load mode.
  29102. */
  29103. delayLoad(): void;
  29104. /**
  29105. * Clones the texture.
  29106. * @returns the cloned texture
  29107. */
  29108. clone(): Nullable<BaseTexture>;
  29109. /**
  29110. * Get the texture underlying type (INT, FLOAT...)
  29111. */
  29112. readonly textureType: number;
  29113. /**
  29114. * Get the texture underlying format (RGB, RGBA...)
  29115. */
  29116. readonly textureFormat: number;
  29117. /**
  29118. * Indicates that textures need to be re-calculated for all materials
  29119. */
  29120. protected _markAllSubMeshesAsTexturesDirty(): void;
  29121. /**
  29122. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  29123. * This will returns an RGBA array buffer containing either in values (0-255) or
  29124. * float values (0-1) depending of the underlying buffer type.
  29125. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  29126. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  29127. * @param buffer defines a user defined buffer to fill with data (can be null)
  29128. * @returns The Array buffer containing the pixels data.
  29129. */
  29130. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  29131. /**
  29132. * Release and destroy the underlying lower level texture aka internalTexture.
  29133. */
  29134. releaseInternalTexture(): void;
  29135. /** @hidden */
  29136. readonly _lodTextureHigh: Nullable<BaseTexture>;
  29137. /** @hidden */
  29138. readonly _lodTextureMid: Nullable<BaseTexture>;
  29139. /** @hidden */
  29140. readonly _lodTextureLow: Nullable<BaseTexture>;
  29141. /**
  29142. * Dispose the texture and release its associated resources.
  29143. */
  29144. dispose(): void;
  29145. /**
  29146. * Serialize the texture into a JSON representation that can be parsed later on.
  29147. * @returns the JSON representation of the texture
  29148. */
  29149. serialize(): any;
  29150. /**
  29151. * Helper function to be called back once a list of texture contains only ready textures.
  29152. * @param textures Define the list of textures to wait for
  29153. * @param callback Define the callback triggered once the entire list will be ready
  29154. */
  29155. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  29156. }
  29157. }
  29158. declare module "babylonjs/Materials/effect" {
  29159. import { Observable } from "babylonjs/Misc/observable";
  29160. import { Nullable } from "babylonjs/types";
  29161. import { IDisposable } from "babylonjs/scene";
  29162. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  29163. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  29164. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  29165. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  29166. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  29167. import { Engine } from "babylonjs/Engines/engine";
  29168. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  29169. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  29170. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  29171. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  29172. /**
  29173. * Options to be used when creating an effect.
  29174. */
  29175. export interface IEffectCreationOptions {
  29176. /**
  29177. * Atrributes that will be used in the shader.
  29178. */
  29179. attributes: string[];
  29180. /**
  29181. * Uniform varible names that will be set in the shader.
  29182. */
  29183. uniformsNames: string[];
  29184. /**
  29185. * Uniform buffer varible names that will be set in the shader.
  29186. */
  29187. uniformBuffersNames: string[];
  29188. /**
  29189. * Sampler texture variable names that will be set in the shader.
  29190. */
  29191. samplers: string[];
  29192. /**
  29193. * Define statements that will be set in the shader.
  29194. */
  29195. defines: any;
  29196. /**
  29197. * Possible fallbacks for this effect to improve performance when needed.
  29198. */
  29199. fallbacks: Nullable<IEffectFallbacks>;
  29200. /**
  29201. * Callback that will be called when the shader is compiled.
  29202. */
  29203. onCompiled: Nullable<(effect: Effect) => void>;
  29204. /**
  29205. * Callback that will be called if an error occurs during shader compilation.
  29206. */
  29207. onError: Nullable<(effect: Effect, errors: string) => void>;
  29208. /**
  29209. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29210. */
  29211. indexParameters?: any;
  29212. /**
  29213. * Max number of lights that can be used in the shader.
  29214. */
  29215. maxSimultaneousLights?: number;
  29216. /**
  29217. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  29218. */
  29219. transformFeedbackVaryings?: Nullable<string[]>;
  29220. }
  29221. /**
  29222. * Effect containing vertex and fragment shader that can be executed on an object.
  29223. */
  29224. export class Effect implements IDisposable {
  29225. /**
  29226. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  29227. */
  29228. static ShadersRepository: string;
  29229. /**
  29230. * Name of the effect.
  29231. */
  29232. name: any;
  29233. /**
  29234. * String container all the define statements that should be set on the shader.
  29235. */
  29236. defines: string;
  29237. /**
  29238. * Callback that will be called when the shader is compiled.
  29239. */
  29240. onCompiled: Nullable<(effect: Effect) => void>;
  29241. /**
  29242. * Callback that will be called if an error occurs during shader compilation.
  29243. */
  29244. onError: Nullable<(effect: Effect, errors: string) => void>;
  29245. /**
  29246. * Callback that will be called when effect is bound.
  29247. */
  29248. onBind: Nullable<(effect: Effect) => void>;
  29249. /**
  29250. * Unique ID of the effect.
  29251. */
  29252. uniqueId: number;
  29253. /**
  29254. * Observable that will be called when the shader is compiled.
  29255. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  29256. */
  29257. onCompileObservable: Observable<Effect>;
  29258. /**
  29259. * Observable that will be called if an error occurs during shader compilation.
  29260. */
  29261. onErrorObservable: Observable<Effect>;
  29262. /** @hidden */
  29263. _onBindObservable: Nullable<Observable<Effect>>;
  29264. /**
  29265. * Observable that will be called when effect is bound.
  29266. */
  29267. readonly onBindObservable: Observable<Effect>;
  29268. /** @hidden */
  29269. _bonesComputationForcedToCPU: boolean;
  29270. private static _uniqueIdSeed;
  29271. private _engine;
  29272. private _uniformBuffersNames;
  29273. private _uniformsNames;
  29274. private _samplerList;
  29275. private _samplers;
  29276. private _isReady;
  29277. private _compilationError;
  29278. private _allFallbacksProcessed;
  29279. private _attributesNames;
  29280. private _attributes;
  29281. private _uniforms;
  29282. /**
  29283. * Key for the effect.
  29284. * @hidden
  29285. */
  29286. _key: string;
  29287. private _indexParameters;
  29288. private _fallbacks;
  29289. private _vertexSourceCode;
  29290. private _fragmentSourceCode;
  29291. private _vertexSourceCodeOverride;
  29292. private _fragmentSourceCodeOverride;
  29293. private _transformFeedbackVaryings;
  29294. /**
  29295. * Compiled shader to webGL program.
  29296. * @hidden
  29297. */
  29298. _pipelineContext: Nullable<IPipelineContext>;
  29299. private _valueCache;
  29300. private static _baseCache;
  29301. /**
  29302. * Instantiates an effect.
  29303. * An effect can be used to create/manage/execute vertex and fragment shaders.
  29304. * @param baseName Name of the effect.
  29305. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  29306. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  29307. * @param samplers List of sampler variables that will be passed to the shader.
  29308. * @param engine Engine to be used to render the effect
  29309. * @param defines Define statements to be added to the shader.
  29310. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  29311. * @param onCompiled Callback that will be called when the shader is compiled.
  29312. * @param onError Callback that will be called if an error occurs during shader compilation.
  29313. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29314. */
  29315. constructor(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: Nullable<string[]>, engine?: ThinEngine, defines?: Nullable<string>, fallbacks?: Nullable<IEffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  29316. private _useFinalCode;
  29317. /**
  29318. * Unique key for this effect
  29319. */
  29320. readonly key: string;
  29321. /**
  29322. * If the effect has been compiled and prepared.
  29323. * @returns if the effect is compiled and prepared.
  29324. */
  29325. isReady(): boolean;
  29326. private _isReadyInternal;
  29327. /**
  29328. * The engine the effect was initialized with.
  29329. * @returns the engine.
  29330. */
  29331. getEngine(): Engine;
  29332. /**
  29333. * The pipeline context for this effect
  29334. * @returns the associated pipeline context
  29335. */
  29336. getPipelineContext(): Nullable<IPipelineContext>;
  29337. /**
  29338. * The set of names of attribute variables for the shader.
  29339. * @returns An array of attribute names.
  29340. */
  29341. getAttributesNames(): string[];
  29342. /**
  29343. * Returns the attribute at the given index.
  29344. * @param index The index of the attribute.
  29345. * @returns The location of the attribute.
  29346. */
  29347. getAttributeLocation(index: number): number;
  29348. /**
  29349. * Returns the attribute based on the name of the variable.
  29350. * @param name of the attribute to look up.
  29351. * @returns the attribute location.
  29352. */
  29353. getAttributeLocationByName(name: string): number;
  29354. /**
  29355. * The number of attributes.
  29356. * @returns the numnber of attributes.
  29357. */
  29358. getAttributesCount(): number;
  29359. /**
  29360. * Gets the index of a uniform variable.
  29361. * @param uniformName of the uniform to look up.
  29362. * @returns the index.
  29363. */
  29364. getUniformIndex(uniformName: string): number;
  29365. /**
  29366. * Returns the attribute based on the name of the variable.
  29367. * @param uniformName of the uniform to look up.
  29368. * @returns the location of the uniform.
  29369. */
  29370. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  29371. /**
  29372. * Returns an array of sampler variable names
  29373. * @returns The array of sampler variable neames.
  29374. */
  29375. getSamplers(): string[];
  29376. /**
  29377. * The error from the last compilation.
  29378. * @returns the error string.
  29379. */
  29380. getCompilationError(): string;
  29381. /**
  29382. * Gets a boolean indicating that all fallbacks were used during compilation
  29383. * @returns true if all fallbacks were used
  29384. */
  29385. allFallbacksProcessed(): boolean;
  29386. /**
  29387. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  29388. * @param func The callback to be used.
  29389. */
  29390. executeWhenCompiled(func: (effect: Effect) => void): void;
  29391. private _checkIsReady;
  29392. private _loadShader;
  29393. /**
  29394. * Recompiles the webGL program
  29395. * @param vertexSourceCode The source code for the vertex shader.
  29396. * @param fragmentSourceCode The source code for the fragment shader.
  29397. * @param onCompiled Callback called when completed.
  29398. * @param onError Callback called on error.
  29399. * @hidden
  29400. */
  29401. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  29402. /**
  29403. * Prepares the effect
  29404. * @hidden
  29405. */
  29406. _prepareEffect(): void;
  29407. private _processCompilationErrors;
  29408. /**
  29409. * Checks if the effect is supported. (Must be called after compilation)
  29410. */
  29411. readonly isSupported: boolean;
  29412. /**
  29413. * Binds a texture to the engine to be used as output of the shader.
  29414. * @param channel Name of the output variable.
  29415. * @param texture Texture to bind.
  29416. * @hidden
  29417. */
  29418. _bindTexture(channel: string, texture: InternalTexture): void;
  29419. /**
  29420. * Sets a texture on the engine to be used in the shader.
  29421. * @param channel Name of the sampler variable.
  29422. * @param texture Texture to set.
  29423. */
  29424. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  29425. /**
  29426. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  29427. * @param channel Name of the sampler variable.
  29428. * @param texture Texture to set.
  29429. */
  29430. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  29431. /**
  29432. * Sets an array of textures on the engine to be used in the shader.
  29433. * @param channel Name of the variable.
  29434. * @param textures Textures to set.
  29435. */
  29436. setTextureArray(channel: string, textures: BaseTexture[]): void;
  29437. /**
  29438. * Sets a texture to be the input of the specified post process. (To use the output, pass in the next post process in the pipeline)
  29439. * @param channel Name of the sampler variable.
  29440. * @param postProcess Post process to get the input texture from.
  29441. */
  29442. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  29443. /**
  29444. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  29445. * Sets the input texture of the passed in post process to be input of this effect. (To use the output of the passed in post process use setTextureFromPostProcessOutput)
  29446. * @param channel Name of the sampler variable.
  29447. * @param postProcess Post process to get the output texture from.
  29448. */
  29449. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  29450. /** @hidden */
  29451. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  29452. /** @hidden */
  29453. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  29454. /** @hidden */
  29455. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  29456. /** @hidden */
  29457. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  29458. /**
  29459. * Binds a buffer to a uniform.
  29460. * @param buffer Buffer to bind.
  29461. * @param name Name of the uniform variable to bind to.
  29462. */
  29463. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  29464. /**
  29465. * Binds block to a uniform.
  29466. * @param blockName Name of the block to bind.
  29467. * @param index Index to bind.
  29468. */
  29469. bindUniformBlock(blockName: string, index: number): void;
  29470. /**
  29471. * Sets an interger value on a uniform variable.
  29472. * @param uniformName Name of the variable.
  29473. * @param value Value to be set.
  29474. * @returns this effect.
  29475. */
  29476. setInt(uniformName: string, value: number): Effect;
  29477. /**
  29478. * Sets an int array on a uniform variable.
  29479. * @param uniformName Name of the variable.
  29480. * @param array array to be set.
  29481. * @returns this effect.
  29482. */
  29483. setIntArray(uniformName: string, array: Int32Array): Effect;
  29484. /**
  29485. * Sets an int array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  29486. * @param uniformName Name of the variable.
  29487. * @param array array to be set.
  29488. * @returns this effect.
  29489. */
  29490. setIntArray2(uniformName: string, array: Int32Array): Effect;
  29491. /**
  29492. * Sets an int array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  29493. * @param uniformName Name of the variable.
  29494. * @param array array to be set.
  29495. * @returns this effect.
  29496. */
  29497. setIntArray3(uniformName: string, array: Int32Array): Effect;
  29498. /**
  29499. * Sets an int array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  29500. * @param uniformName Name of the variable.
  29501. * @param array array to be set.
  29502. * @returns this effect.
  29503. */
  29504. setIntArray4(uniformName: string, array: Int32Array): Effect;
  29505. /**
  29506. * Sets an float array on a uniform variable.
  29507. * @param uniformName Name of the variable.
  29508. * @param array array to be set.
  29509. * @returns this effect.
  29510. */
  29511. setFloatArray(uniformName: string, array: Float32Array): Effect;
  29512. /**
  29513. * Sets an float array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  29514. * @param uniformName Name of the variable.
  29515. * @param array array to be set.
  29516. * @returns this effect.
  29517. */
  29518. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  29519. /**
  29520. * Sets an float array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  29521. * @param uniformName Name of the variable.
  29522. * @param array array to be set.
  29523. * @returns this effect.
  29524. */
  29525. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  29526. /**
  29527. * Sets an float array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  29528. * @param uniformName Name of the variable.
  29529. * @param array array to be set.
  29530. * @returns this effect.
  29531. */
  29532. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  29533. /**
  29534. * Sets an array on a uniform variable.
  29535. * @param uniformName Name of the variable.
  29536. * @param array array to be set.
  29537. * @returns this effect.
  29538. */
  29539. setArray(uniformName: string, array: number[]): Effect;
  29540. /**
  29541. * Sets an array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  29542. * @param uniformName Name of the variable.
  29543. * @param array array to be set.
  29544. * @returns this effect.
  29545. */
  29546. setArray2(uniformName: string, array: number[]): Effect;
  29547. /**
  29548. * Sets an array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  29549. * @param uniformName Name of the variable.
  29550. * @param array array to be set.
  29551. * @returns this effect.
  29552. */
  29553. setArray3(uniformName: string, array: number[]): Effect;
  29554. /**
  29555. * Sets an array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  29556. * @param uniformName Name of the variable.
  29557. * @param array array to be set.
  29558. * @returns this effect.
  29559. */
  29560. setArray4(uniformName: string, array: number[]): Effect;
  29561. /**
  29562. * Sets matrices on a uniform variable.
  29563. * @param uniformName Name of the variable.
  29564. * @param matrices matrices to be set.
  29565. * @returns this effect.
  29566. */
  29567. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  29568. /**
  29569. * Sets matrix on a uniform variable.
  29570. * @param uniformName Name of the variable.
  29571. * @param matrix matrix to be set.
  29572. * @returns this effect.
  29573. */
  29574. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  29575. /**
  29576. * Sets a 3x3 matrix on a uniform variable. (Speicified as [1,2,3,4,5,6,7,8,9] will result in [1,2,3][4,5,6][7,8,9] matrix)
  29577. * @param uniformName Name of the variable.
  29578. * @param matrix matrix to be set.
  29579. * @returns this effect.
  29580. */
  29581. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  29582. /**
  29583. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  29584. * @param uniformName Name of the variable.
  29585. * @param matrix matrix to be set.
  29586. * @returns this effect.
  29587. */
  29588. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  29589. /**
  29590. * Sets a float on a uniform variable.
  29591. * @param uniformName Name of the variable.
  29592. * @param value value to be set.
  29593. * @returns this effect.
  29594. */
  29595. setFloat(uniformName: string, value: number): Effect;
  29596. /**
  29597. * Sets a boolean on a uniform variable.
  29598. * @param uniformName Name of the variable.
  29599. * @param bool value to be set.
  29600. * @returns this effect.
  29601. */
  29602. setBool(uniformName: string, bool: boolean): Effect;
  29603. /**
  29604. * Sets a Vector2 on a uniform variable.
  29605. * @param uniformName Name of the variable.
  29606. * @param vector2 vector2 to be set.
  29607. * @returns this effect.
  29608. */
  29609. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  29610. /**
  29611. * Sets a float2 on a uniform variable.
  29612. * @param uniformName Name of the variable.
  29613. * @param x First float in float2.
  29614. * @param y Second float in float2.
  29615. * @returns this effect.
  29616. */
  29617. setFloat2(uniformName: string, x: number, y: number): Effect;
  29618. /**
  29619. * Sets a Vector3 on a uniform variable.
  29620. * @param uniformName Name of the variable.
  29621. * @param vector3 Value to be set.
  29622. * @returns this effect.
  29623. */
  29624. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  29625. /**
  29626. * Sets a float3 on a uniform variable.
  29627. * @param uniformName Name of the variable.
  29628. * @param x First float in float3.
  29629. * @param y Second float in float3.
  29630. * @param z Third float in float3.
  29631. * @returns this effect.
  29632. */
  29633. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  29634. /**
  29635. * Sets a Vector4 on a uniform variable.
  29636. * @param uniformName Name of the variable.
  29637. * @param vector4 Value to be set.
  29638. * @returns this effect.
  29639. */
  29640. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  29641. /**
  29642. * Sets a float4 on a uniform variable.
  29643. * @param uniformName Name of the variable.
  29644. * @param x First float in float4.
  29645. * @param y Second float in float4.
  29646. * @param z Third float in float4.
  29647. * @param w Fourth float in float4.
  29648. * @returns this effect.
  29649. */
  29650. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  29651. /**
  29652. * Sets a Color3 on a uniform variable.
  29653. * @param uniformName Name of the variable.
  29654. * @param color3 Value to be set.
  29655. * @returns this effect.
  29656. */
  29657. setColor3(uniformName: string, color3: IColor3Like): Effect;
  29658. /**
  29659. * Sets a Color4 on a uniform variable.
  29660. * @param uniformName Name of the variable.
  29661. * @param color3 Value to be set.
  29662. * @param alpha Alpha value to be set.
  29663. * @returns this effect.
  29664. */
  29665. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  29666. /**
  29667. * Sets a Color4 on a uniform variable
  29668. * @param uniformName defines the name of the variable
  29669. * @param color4 defines the value to be set
  29670. * @returns this effect.
  29671. */
  29672. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  29673. /** Release all associated resources */
  29674. dispose(): void;
  29675. /**
  29676. * This function will add a new shader to the shader store
  29677. * @param name the name of the shader
  29678. * @param pixelShader optional pixel shader content
  29679. * @param vertexShader optional vertex shader content
  29680. */
  29681. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  29682. /**
  29683. * Store of each shader (The can be looked up using effect.key)
  29684. */
  29685. static ShadersStore: {
  29686. [key: string]: string;
  29687. };
  29688. /**
  29689. * Store of each included file for a shader (The can be looked up using effect.key)
  29690. */
  29691. static IncludesShadersStore: {
  29692. [key: string]: string;
  29693. };
  29694. /**
  29695. * Resets the cache of effects.
  29696. */
  29697. static ResetCache(): void;
  29698. }
  29699. }
  29700. declare module "babylonjs/Engines/engineCapabilities" {
  29701. /**
  29702. * Interface used to describe the capabilities of the engine relatively to the current browser
  29703. */
  29704. export interface EngineCapabilities {
  29705. /** Maximum textures units per fragment shader */
  29706. maxTexturesImageUnits: number;
  29707. /** Maximum texture units per vertex shader */
  29708. maxVertexTextureImageUnits: number;
  29709. /** Maximum textures units in the entire pipeline */
  29710. maxCombinedTexturesImageUnits: number;
  29711. /** Maximum texture size */
  29712. maxTextureSize: number;
  29713. /** Maximum cube texture size */
  29714. maxCubemapTextureSize: number;
  29715. /** Maximum render texture size */
  29716. maxRenderTextureSize: number;
  29717. /** Maximum number of vertex attributes */
  29718. maxVertexAttribs: number;
  29719. /** Maximum number of varyings */
  29720. maxVaryingVectors: number;
  29721. /** Maximum number of uniforms per vertex shader */
  29722. maxVertexUniformVectors: number;
  29723. /** Maximum number of uniforms per fragment shader */
  29724. maxFragmentUniformVectors: number;
  29725. /** Defines if standard derivates (dx/dy) are supported */
  29726. standardDerivatives: boolean;
  29727. /** Defines if s3tc texture compression is supported */
  29728. s3tc?: WEBGL_compressed_texture_s3tc;
  29729. /** Defines if pvrtc texture compression is supported */
  29730. pvrtc: any;
  29731. /** Defines if etc1 texture compression is supported */
  29732. etc1: any;
  29733. /** Defines if etc2 texture compression is supported */
  29734. etc2: any;
  29735. /** Defines if astc texture compression is supported */
  29736. astc: any;
  29737. /** Defines if float textures are supported */
  29738. textureFloat: boolean;
  29739. /** Defines if vertex array objects are supported */
  29740. vertexArrayObject: boolean;
  29741. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  29742. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  29743. /** Gets the maximum level of anisotropy supported */
  29744. maxAnisotropy: number;
  29745. /** Defines if instancing is supported */
  29746. instancedArrays: boolean;
  29747. /** Defines if 32 bits indices are supported */
  29748. uintIndices: boolean;
  29749. /** Defines if high precision shaders are supported */
  29750. highPrecisionShaderSupported: boolean;
  29751. /** Defines if depth reading in the fragment shader is supported */
  29752. fragmentDepthSupported: boolean;
  29753. /** Defines if float texture linear filtering is supported*/
  29754. textureFloatLinearFiltering: boolean;
  29755. /** Defines if rendering to float textures is supported */
  29756. textureFloatRender: boolean;
  29757. /** Defines if half float textures are supported*/
  29758. textureHalfFloat: boolean;
  29759. /** Defines if half float texture linear filtering is supported*/
  29760. textureHalfFloatLinearFiltering: boolean;
  29761. /** Defines if rendering to half float textures is supported */
  29762. textureHalfFloatRender: boolean;
  29763. /** Defines if textureLOD shader command is supported */
  29764. textureLOD: boolean;
  29765. /** Defines if draw buffers extension is supported */
  29766. drawBuffersExtension: boolean;
  29767. /** Defines if depth textures are supported */
  29768. depthTextureExtension: boolean;
  29769. /** Defines if float color buffer are supported */
  29770. colorBufferFloat: boolean;
  29771. /** Gets disjoint timer query extension (null if not supported) */
  29772. timerQuery?: EXT_disjoint_timer_query;
  29773. /** Defines if timestamp can be used with timer query */
  29774. canUseTimestampForTimerQuery: boolean;
  29775. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  29776. multiview?: any;
  29777. /** Function used to let the system compiles shaders in background */
  29778. parallelShaderCompile?: {
  29779. COMPLETION_STATUS_KHR: number;
  29780. };
  29781. /** Max number of texture samples for MSAA */
  29782. maxMSAASamples: number;
  29783. /** Defines if the blend min max extension is supported */
  29784. blendMinMax: boolean;
  29785. }
  29786. }
  29787. declare module "babylonjs/States/depthCullingState" {
  29788. import { Nullable } from "babylonjs/types";
  29789. /**
  29790. * @hidden
  29791. **/
  29792. export class DepthCullingState {
  29793. private _isDepthTestDirty;
  29794. private _isDepthMaskDirty;
  29795. private _isDepthFuncDirty;
  29796. private _isCullFaceDirty;
  29797. private _isCullDirty;
  29798. private _isZOffsetDirty;
  29799. private _isFrontFaceDirty;
  29800. private _depthTest;
  29801. private _depthMask;
  29802. private _depthFunc;
  29803. private _cull;
  29804. private _cullFace;
  29805. private _zOffset;
  29806. private _frontFace;
  29807. /**
  29808. * Initializes the state.
  29809. */
  29810. constructor();
  29811. readonly isDirty: boolean;
  29812. zOffset: number;
  29813. cullFace: Nullable<number>;
  29814. cull: Nullable<boolean>;
  29815. depthFunc: Nullable<number>;
  29816. depthMask: boolean;
  29817. depthTest: boolean;
  29818. frontFace: Nullable<number>;
  29819. reset(): void;
  29820. apply(gl: WebGLRenderingContext): void;
  29821. }
  29822. }
  29823. declare module "babylonjs/States/stencilState" {
  29824. /**
  29825. * @hidden
  29826. **/
  29827. export class StencilState {
  29828. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  29829. static readonly ALWAYS: number;
  29830. /** Passed to stencilOperation to specify that stencil value must be kept */
  29831. static readonly KEEP: number;
  29832. /** Passed to stencilOperation to specify that stencil value must be replaced */
  29833. static readonly REPLACE: number;
  29834. private _isStencilTestDirty;
  29835. private _isStencilMaskDirty;
  29836. private _isStencilFuncDirty;
  29837. private _isStencilOpDirty;
  29838. private _stencilTest;
  29839. private _stencilMask;
  29840. private _stencilFunc;
  29841. private _stencilFuncRef;
  29842. private _stencilFuncMask;
  29843. private _stencilOpStencilFail;
  29844. private _stencilOpDepthFail;
  29845. private _stencilOpStencilDepthPass;
  29846. readonly isDirty: boolean;
  29847. stencilFunc: number;
  29848. stencilFuncRef: number;
  29849. stencilFuncMask: number;
  29850. stencilOpStencilFail: number;
  29851. stencilOpDepthFail: number;
  29852. stencilOpStencilDepthPass: number;
  29853. stencilMask: number;
  29854. stencilTest: boolean;
  29855. constructor();
  29856. reset(): void;
  29857. apply(gl: WebGLRenderingContext): void;
  29858. }
  29859. }
  29860. declare module "babylonjs/States/alphaCullingState" {
  29861. /**
  29862. * @hidden
  29863. **/
  29864. export class AlphaState {
  29865. private _isAlphaBlendDirty;
  29866. private _isBlendFunctionParametersDirty;
  29867. private _isBlendEquationParametersDirty;
  29868. private _isBlendConstantsDirty;
  29869. private _alphaBlend;
  29870. private _blendFunctionParameters;
  29871. private _blendEquationParameters;
  29872. private _blendConstants;
  29873. /**
  29874. * Initializes the state.
  29875. */
  29876. constructor();
  29877. readonly isDirty: boolean;
  29878. alphaBlend: boolean;
  29879. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  29880. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  29881. setAlphaEquationParameters(rgb: number, alpha: number): void;
  29882. reset(): void;
  29883. apply(gl: WebGLRenderingContext): void;
  29884. }
  29885. }
  29886. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  29887. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  29888. /** @hidden */
  29889. export class WebGL2ShaderProcessor implements IShaderProcessor {
  29890. attributeProcessor(attribute: string): string;
  29891. varyingProcessor(varying: string, isFragment: boolean): string;
  29892. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  29893. }
  29894. }
  29895. declare module "babylonjs/Engines/instancingAttributeInfo" {
  29896. /**
  29897. * Interface for attribute information associated with buffer instanciation
  29898. */
  29899. export interface InstancingAttributeInfo {
  29900. /**
  29901. * Index/offset of the attribute in the vertex shader
  29902. */
  29903. index: number;
  29904. /**
  29905. * size of the attribute, 1, 2, 3 or 4
  29906. */
  29907. attributeSize: number;
  29908. /**
  29909. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  29910. * default is FLOAT
  29911. */
  29912. attributeType: number;
  29913. /**
  29914. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  29915. */
  29916. normalized: boolean;
  29917. /**
  29918. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  29919. */
  29920. offset: number;
  29921. /**
  29922. * Name of the GLSL attribute, for debugging purpose only
  29923. */
  29924. attributeName: string;
  29925. }
  29926. }
  29927. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  29928. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  29929. import { Nullable } from "babylonjs/types";
  29930. module "babylonjs/Engines/thinEngine" {
  29931. interface ThinEngine {
  29932. /**
  29933. * Update a video texture
  29934. * @param texture defines the texture to update
  29935. * @param video defines the video element to use
  29936. * @param invertY defines if data must be stored with Y axis inverted
  29937. */
  29938. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  29939. }
  29940. }
  29941. }
  29942. declare module "babylonjs/Materials/Textures/videoTexture" {
  29943. import { Observable } from "babylonjs/Misc/observable";
  29944. import { Nullable } from "babylonjs/types";
  29945. import { Scene } from "babylonjs/scene";
  29946. import { Texture } from "babylonjs/Materials/Textures/texture";
  29947. import "babylonjs/Engines/Extensions/engine.videoTexture";
  29948. /**
  29949. * Settings for finer control over video usage
  29950. */
  29951. export interface VideoTextureSettings {
  29952. /**
  29953. * Applies `autoplay` to video, if specified
  29954. */
  29955. autoPlay?: boolean;
  29956. /**
  29957. * Applies `loop` to video, if specified
  29958. */
  29959. loop?: boolean;
  29960. /**
  29961. * Automatically updates internal texture from video at every frame in the render loop
  29962. */
  29963. autoUpdateTexture: boolean;
  29964. /**
  29965. * Image src displayed during the video loading or until the user interacts with the video.
  29966. */
  29967. poster?: string;
  29968. }
  29969. /**
  29970. * If you want to display a video in your scene, this is the special texture for that.
  29971. * This special texture works similar to other textures, with the exception of a few parameters.
  29972. * @see https://doc.babylonjs.com/how_to/video_texture
  29973. */
  29974. export class VideoTexture extends Texture {
  29975. /**
  29976. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  29977. */
  29978. readonly autoUpdateTexture: boolean;
  29979. /**
  29980. * The video instance used by the texture internally
  29981. */
  29982. readonly video: HTMLVideoElement;
  29983. private _onUserActionRequestedObservable;
  29984. /**
  29985. * Event triggerd when a dom action is required by the user to play the video.
  29986. * This happens due to recent changes in browser policies preventing video to auto start.
  29987. */
  29988. readonly onUserActionRequestedObservable: Observable<Texture>;
  29989. private _generateMipMaps;
  29990. private _engine;
  29991. private _stillImageCaptured;
  29992. private _displayingPosterTexture;
  29993. private _settings;
  29994. private _createInternalTextureOnEvent;
  29995. private _frameId;
  29996. /**
  29997. * Creates a video texture.
  29998. * If you want to display a video in your scene, this is the special texture for that.
  29999. * This special texture works similar to other textures, with the exception of a few parameters.
  30000. * @see https://doc.babylonjs.com/how_to/video_texture
  30001. * @param name optional name, will detect from video source, if not defined
  30002. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  30003. * @param scene is obviously the current scene.
  30004. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  30005. * @param invertY is false by default but can be used to invert video on Y axis
  30006. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  30007. * @param settings allows finer control over video usage
  30008. */
  30009. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  30010. private _getName;
  30011. private _getVideo;
  30012. private _createInternalTexture;
  30013. private reset;
  30014. /**
  30015. * @hidden Internal method to initiate `update`.
  30016. */
  30017. _rebuild(): void;
  30018. /**
  30019. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  30020. */
  30021. update(): void;
  30022. /**
  30023. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  30024. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  30025. */
  30026. updateTexture(isVisible: boolean): void;
  30027. protected _updateInternalTexture: () => void;
  30028. /**
  30029. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  30030. * @param url New url.
  30031. */
  30032. updateURL(url: string): void;
  30033. /**
  30034. * Dispose the texture and release its associated resources.
  30035. */
  30036. dispose(): void;
  30037. /**
  30038. * Creates a video texture straight from a stream.
  30039. * @param scene Define the scene the texture should be created in
  30040. * @param stream Define the stream the texture should be created from
  30041. * @returns The created video texture as a promise
  30042. */
  30043. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  30044. /**
  30045. * Creates a video texture straight from your WebCam video feed.
  30046. * @param scene Define the scene the texture should be created in
  30047. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  30048. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  30049. * @returns The created video texture as a promise
  30050. */
  30051. static CreateFromWebCamAsync(scene: Scene, constraints: {
  30052. minWidth: number;
  30053. maxWidth: number;
  30054. minHeight: number;
  30055. maxHeight: number;
  30056. deviceId: string;
  30057. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  30058. /**
  30059. * Creates a video texture straight from your WebCam video feed.
  30060. * @param scene Define the scene the texture should be created in
  30061. * @param onReady Define a callback to triggered once the texture will be ready
  30062. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  30063. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  30064. */
  30065. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  30066. minWidth: number;
  30067. maxWidth: number;
  30068. minHeight: number;
  30069. maxHeight: number;
  30070. deviceId: string;
  30071. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  30072. }
  30073. }
  30074. declare module "babylonjs/Engines/thinEngine" {
  30075. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  30076. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  30077. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  30078. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  30079. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  30080. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  30081. import { Observable } from "babylonjs/Misc/observable";
  30082. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  30083. import { StencilState } from "babylonjs/States/stencilState";
  30084. import { AlphaState } from "babylonjs/States/alphaCullingState";
  30085. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  30086. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  30087. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  30088. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  30089. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  30090. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  30091. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  30092. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  30093. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  30094. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  30095. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  30096. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  30097. /**
  30098. * Defines the interface used by objects working like Scene
  30099. * @hidden
  30100. */
  30101. interface ISceneLike {
  30102. _addPendingData(data: any): void;
  30103. _removePendingData(data: any): void;
  30104. offlineProvider: IOfflineProvider;
  30105. }
  30106. /** Interface defining initialization parameters for Engine class */
  30107. export interface EngineOptions extends WebGLContextAttributes {
  30108. /**
  30109. * Defines if the engine should no exceed a specified device ratio
  30110. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  30111. */
  30112. limitDeviceRatio?: number;
  30113. /**
  30114. * Defines if webvr should be enabled automatically
  30115. * @see http://doc.babylonjs.com/how_to/webvr_camera
  30116. */
  30117. autoEnableWebVR?: boolean;
  30118. /**
  30119. * Defines if webgl2 should be turned off even if supported
  30120. * @see http://doc.babylonjs.com/features/webgl2
  30121. */
  30122. disableWebGL2Support?: boolean;
  30123. /**
  30124. * Defines if webaudio should be initialized as well
  30125. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  30126. */
  30127. audioEngine?: boolean;
  30128. /**
  30129. * Defines if animations should run using a deterministic lock step
  30130. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  30131. */
  30132. deterministicLockstep?: boolean;
  30133. /** Defines the maximum steps to use with deterministic lock step mode */
  30134. lockstepMaxSteps?: number;
  30135. /**
  30136. * Defines that engine should ignore context lost events
  30137. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  30138. */
  30139. doNotHandleContextLost?: boolean;
  30140. /**
  30141. * Defines that engine should ignore modifying touch action attribute and style
  30142. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  30143. */
  30144. doNotHandleTouchAction?: boolean;
  30145. /**
  30146. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  30147. */
  30148. useHighPrecisionFloats?: boolean;
  30149. }
  30150. /**
  30151. * The base engine class (root of all engines)
  30152. */
  30153. export class ThinEngine {
  30154. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  30155. static ExceptionList: ({
  30156. key: string;
  30157. capture: string;
  30158. captureConstraint: number;
  30159. targets: string[];
  30160. } | {
  30161. key: string;
  30162. capture: null;
  30163. captureConstraint: null;
  30164. targets: string[];
  30165. })[];
  30166. /** @hidden */
  30167. static _TextureLoaders: IInternalTextureLoader[];
  30168. /**
  30169. * Returns the current npm package of the sdk
  30170. */
  30171. static readonly NpmPackage: string;
  30172. /**
  30173. * Returns the current version of the framework
  30174. */
  30175. static readonly Version: string;
  30176. /**
  30177. * Returns a string describing the current engine
  30178. */
  30179. readonly description: string;
  30180. /**
  30181. * Gets or sets the epsilon value used by collision engine
  30182. */
  30183. static CollisionsEpsilon: number;
  30184. /**
  30185. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  30186. */
  30187. static ShadersRepository: string;
  30188. /** @hidden */
  30189. _shaderProcessor: IShaderProcessor;
  30190. /**
  30191. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  30192. */
  30193. forcePOTTextures: boolean;
  30194. /**
  30195. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  30196. */
  30197. isFullscreen: boolean;
  30198. /**
  30199. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  30200. */
  30201. cullBackFaces: boolean;
  30202. /**
  30203. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  30204. */
  30205. renderEvenInBackground: boolean;
  30206. /**
  30207. * Gets or sets a boolean indicating that cache can be kept between frames
  30208. */
  30209. preventCacheWipeBetweenFrames: boolean;
  30210. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  30211. validateShaderPrograms: boolean;
  30212. /**
  30213. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  30214. */
  30215. disableUniformBuffers: boolean;
  30216. /** @hidden */
  30217. _uniformBuffers: UniformBuffer[];
  30218. /**
  30219. * Gets a boolean indicating that the engine supports uniform buffers
  30220. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  30221. */
  30222. readonly supportsUniformBuffers: boolean;
  30223. /** @hidden */
  30224. _gl: WebGLRenderingContext;
  30225. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  30226. protected _windowIsBackground: boolean;
  30227. protected _webGLVersion: number;
  30228. protected _creationOptions: EngineOptions;
  30229. protected _highPrecisionShadersAllowed: boolean;
  30230. /** @hidden */
  30231. readonly _shouldUseHighPrecisionShader: boolean;
  30232. /**
  30233. * Gets a boolean indicating that only power of 2 textures are supported
  30234. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  30235. */
  30236. readonly needPOTTextures: boolean;
  30237. /** @hidden */
  30238. _badOS: boolean;
  30239. /** @hidden */
  30240. _badDesktopOS: boolean;
  30241. private _hardwareScalingLevel;
  30242. /** @hidden */
  30243. _caps: EngineCapabilities;
  30244. private _isStencilEnable;
  30245. protected _colorWrite: boolean;
  30246. private _glVersion;
  30247. private _glRenderer;
  30248. private _glVendor;
  30249. /** @hidden */
  30250. _videoTextureSupported: boolean;
  30251. protected _renderingQueueLaunched: boolean;
  30252. protected _activeRenderLoops: (() => void)[];
  30253. /**
  30254. * Observable signaled when a context lost event is raised
  30255. */
  30256. onContextLostObservable: Observable<ThinEngine>;
  30257. /**
  30258. * Observable signaled when a context restored event is raised
  30259. */
  30260. onContextRestoredObservable: Observable<ThinEngine>;
  30261. private _onContextLost;
  30262. private _onContextRestored;
  30263. protected _contextWasLost: boolean;
  30264. /** @hidden */
  30265. _doNotHandleContextLost: boolean;
  30266. /**
  30267. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  30268. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  30269. */
  30270. doNotHandleContextLost: boolean;
  30271. /**
  30272. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  30273. */
  30274. disableVertexArrayObjects: boolean;
  30275. /** @hidden */
  30276. protected _depthCullingState: DepthCullingState;
  30277. /** @hidden */
  30278. protected _stencilState: StencilState;
  30279. /** @hidden */
  30280. protected _alphaState: AlphaState;
  30281. /** @hidden */
  30282. _internalTexturesCache: InternalTexture[];
  30283. /** @hidden */
  30284. protected _activeChannel: number;
  30285. private _currentTextureChannel;
  30286. /** @hidden */
  30287. protected _boundTexturesCache: {
  30288. [key: string]: Nullable<InternalTexture>;
  30289. };
  30290. /** @hidden */
  30291. protected _currentEffect: Nullable<Effect>;
  30292. /** @hidden */
  30293. protected _currentProgram: Nullable<WebGLProgram>;
  30294. private _compiledEffects;
  30295. private _vertexAttribArraysEnabled;
  30296. /** @hidden */
  30297. protected _cachedViewport: Nullable<IViewportLike>;
  30298. private _cachedVertexArrayObject;
  30299. /** @hidden */
  30300. protected _cachedVertexBuffers: any;
  30301. /** @hidden */
  30302. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  30303. /** @hidden */
  30304. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  30305. /** @hidden */
  30306. _currentRenderTarget: Nullable<InternalTexture>;
  30307. private _uintIndicesCurrentlySet;
  30308. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  30309. /** @hidden */
  30310. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  30311. private _currentBufferPointers;
  30312. private _currentInstanceLocations;
  30313. private _currentInstanceBuffers;
  30314. private _textureUnits;
  30315. /** @hidden */
  30316. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  30317. /** @hidden */
  30318. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  30319. /** @hidden */
  30320. _boundRenderFunction: any;
  30321. private _vaoRecordInProgress;
  30322. private _mustWipeVertexAttributes;
  30323. private _emptyTexture;
  30324. private _emptyCubeTexture;
  30325. private _emptyTexture3D;
  30326. private _emptyTexture2DArray;
  30327. /** @hidden */
  30328. _frameHandler: number;
  30329. private _nextFreeTextureSlots;
  30330. private _maxSimultaneousTextures;
  30331. private _activeRequests;
  30332. protected _texturesSupported: string[];
  30333. /** @hidden */
  30334. _textureFormatInUse: Nullable<string>;
  30335. protected readonly _supportsHardwareTextureRescaling: boolean;
  30336. /**
  30337. * Gets the list of texture formats supported
  30338. */
  30339. readonly texturesSupported: Array<string>;
  30340. /**
  30341. * Gets the list of texture formats in use
  30342. */
  30343. readonly textureFormatInUse: Nullable<string>;
  30344. /**
  30345. * Gets the current viewport
  30346. */
  30347. readonly currentViewport: Nullable<IViewportLike>;
  30348. /**
  30349. * Gets the default empty texture
  30350. */
  30351. readonly emptyTexture: InternalTexture;
  30352. /**
  30353. * Gets the default empty 3D texture
  30354. */
  30355. readonly emptyTexture3D: InternalTexture;
  30356. /**
  30357. * Gets the default empty 2D array texture
  30358. */
  30359. readonly emptyTexture2DArray: InternalTexture;
  30360. /**
  30361. * Gets the default empty cube texture
  30362. */
  30363. readonly emptyCubeTexture: InternalTexture;
  30364. /**
  30365. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  30366. */
  30367. readonly premultipliedAlpha: boolean;
  30368. /**
  30369. * Observable event triggered before each texture is initialized
  30370. */
  30371. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  30372. /**
  30373. * Creates a new engine
  30374. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  30375. * @param antialias defines enable antialiasing (default: false)
  30376. * @param options defines further options to be sent to the getContext() function
  30377. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  30378. */
  30379. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  30380. private _rebuildInternalTextures;
  30381. private _rebuildEffects;
  30382. /**
  30383. * Gets a boolean indicating if all created effects are ready
  30384. * @returns true if all effects are ready
  30385. */
  30386. areAllEffectsReady(): boolean;
  30387. protected _rebuildBuffers(): void;
  30388. private _initGLContext;
  30389. /**
  30390. * Gets version of the current webGL context
  30391. */
  30392. readonly webGLVersion: number;
  30393. /**
  30394. * Gets a string idenfifying the name of the class
  30395. * @returns "Engine" string
  30396. */
  30397. getClassName(): string;
  30398. /**
  30399. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  30400. */
  30401. readonly isStencilEnable: boolean;
  30402. /** @hidden */
  30403. _prepareWorkingCanvas(): void;
  30404. /**
  30405. * Reset the texture cache to empty state
  30406. */
  30407. resetTextureCache(): void;
  30408. /**
  30409. * Gets an object containing information about the current webGL context
  30410. * @returns an object containing the vender, the renderer and the version of the current webGL context
  30411. */
  30412. getGlInfo(): {
  30413. vendor: string;
  30414. renderer: string;
  30415. version: string;
  30416. };
  30417. /**
  30418. * Defines the hardware scaling level.
  30419. * By default the hardware scaling level is computed from the window device ratio.
  30420. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  30421. * @param level defines the level to use
  30422. */
  30423. setHardwareScalingLevel(level: number): void;
  30424. /**
  30425. * Gets the current hardware scaling level.
  30426. * By default the hardware scaling level is computed from the window device ratio.
  30427. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  30428. * @returns a number indicating the current hardware scaling level
  30429. */
  30430. getHardwareScalingLevel(): number;
  30431. /**
  30432. * Gets the list of loaded textures
  30433. * @returns an array containing all loaded textures
  30434. */
  30435. getLoadedTexturesCache(): InternalTexture[];
  30436. /**
  30437. * Gets the object containing all engine capabilities
  30438. * @returns the EngineCapabilities object
  30439. */
  30440. getCaps(): EngineCapabilities;
  30441. /**
  30442. * stop executing a render loop function and remove it from the execution array
  30443. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  30444. */
  30445. stopRenderLoop(renderFunction?: () => void): void;
  30446. /** @hidden */
  30447. _renderLoop(): void;
  30448. /**
  30449. * Gets the HTML canvas attached with the current webGL context
  30450. * @returns a HTML canvas
  30451. */
  30452. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  30453. /**
  30454. * Gets host window
  30455. * @returns the host window object
  30456. */
  30457. getHostWindow(): Nullable<Window>;
  30458. /**
  30459. * Gets the current render width
  30460. * @param useScreen defines if screen size must be used (or the current render target if any)
  30461. * @returns a number defining the current render width
  30462. */
  30463. getRenderWidth(useScreen?: boolean): number;
  30464. /**
  30465. * Gets the current render height
  30466. * @param useScreen defines if screen size must be used (or the current render target if any)
  30467. * @returns a number defining the current render height
  30468. */
  30469. getRenderHeight(useScreen?: boolean): number;
  30470. /**
  30471. * Can be used to override the current requestAnimationFrame requester.
  30472. * @hidden
  30473. */
  30474. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  30475. /**
  30476. * Register and execute a render loop. The engine can have more than one render function
  30477. * @param renderFunction defines the function to continuously execute
  30478. */
  30479. runRenderLoop(renderFunction: () => void): void;
  30480. /**
  30481. * Clear the current render buffer or the current render target (if any is set up)
  30482. * @param color defines the color to use
  30483. * @param backBuffer defines if the back buffer must be cleared
  30484. * @param depth defines if the depth buffer must be cleared
  30485. * @param stencil defines if the stencil buffer must be cleared
  30486. */
  30487. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  30488. private _viewportCached;
  30489. /** @hidden */
  30490. _viewport(x: number, y: number, width: number, height: number): void;
  30491. /**
  30492. * Set the WebGL's viewport
  30493. * @param viewport defines the viewport element to be used
  30494. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  30495. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  30496. */
  30497. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  30498. /**
  30499. * Begin a new frame
  30500. */
  30501. beginFrame(): void;
  30502. /**
  30503. * Enf the current frame
  30504. */
  30505. endFrame(): void;
  30506. /**
  30507. * Resize the view according to the canvas' size
  30508. */
  30509. resize(): void;
  30510. /**
  30511. * Force a specific size of the canvas
  30512. * @param width defines the new canvas' width
  30513. * @param height defines the new canvas' height
  30514. */
  30515. setSize(width: number, height: number): void;
  30516. /**
  30517. * Binds the frame buffer to the specified texture.
  30518. * @param texture The texture to render to or null for the default canvas
  30519. * @param faceIndex The face of the texture to render to in case of cube texture
  30520. * @param requiredWidth The width of the target to render to
  30521. * @param requiredHeight The height of the target to render to
  30522. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  30523. * @param depthStencilTexture The depth stencil texture to use to render
  30524. * @param lodLevel defines le lod level to bind to the frame buffer
  30525. */
  30526. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  30527. /** @hidden */
  30528. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  30529. /**
  30530. * Unbind the current render target texture from the webGL context
  30531. * @param texture defines the render target texture to unbind
  30532. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  30533. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  30534. */
  30535. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  30536. /**
  30537. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  30538. */
  30539. flushFramebuffer(): void;
  30540. /**
  30541. * Unbind the current render target and bind the default framebuffer
  30542. */
  30543. restoreDefaultFramebuffer(): void;
  30544. /** @hidden */
  30545. protected _resetVertexBufferBinding(): void;
  30546. /**
  30547. * Creates a vertex buffer
  30548. * @param data the data for the vertex buffer
  30549. * @returns the new WebGL static buffer
  30550. */
  30551. createVertexBuffer(data: DataArray): DataBuffer;
  30552. private _createVertexBuffer;
  30553. /**
  30554. * Creates a dynamic vertex buffer
  30555. * @param data the data for the dynamic vertex buffer
  30556. * @returns the new WebGL dynamic buffer
  30557. */
  30558. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  30559. protected _resetIndexBufferBinding(): void;
  30560. /**
  30561. * Creates a new index buffer
  30562. * @param indices defines the content of the index buffer
  30563. * @param updatable defines if the index buffer must be updatable
  30564. * @returns a new webGL buffer
  30565. */
  30566. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  30567. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  30568. /**
  30569. * Bind a webGL buffer to the webGL context
  30570. * @param buffer defines the buffer to bind
  30571. */
  30572. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  30573. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  30574. private bindBuffer;
  30575. /**
  30576. * update the bound buffer with the given data
  30577. * @param data defines the data to update
  30578. */
  30579. updateArrayBuffer(data: Float32Array): void;
  30580. private _vertexAttribPointer;
  30581. private _bindIndexBufferWithCache;
  30582. private _bindVertexBuffersAttributes;
  30583. /**
  30584. * Records a vertex array object
  30585. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  30586. * @param vertexBuffers defines the list of vertex buffers to store
  30587. * @param indexBuffer defines the index buffer to store
  30588. * @param effect defines the effect to store
  30589. * @returns the new vertex array object
  30590. */
  30591. recordVertexArrayObject(vertexBuffers: {
  30592. [key: string]: VertexBuffer;
  30593. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  30594. /**
  30595. * Bind a specific vertex array object
  30596. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  30597. * @param vertexArrayObject defines the vertex array object to bind
  30598. * @param indexBuffer defines the index buffer to bind
  30599. */
  30600. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  30601. /**
  30602. * Bind webGl buffers directly to the webGL context
  30603. * @param vertexBuffer defines the vertex buffer to bind
  30604. * @param indexBuffer defines the index buffer to bind
  30605. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  30606. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  30607. * @param effect defines the effect associated with the vertex buffer
  30608. */
  30609. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  30610. private _unbindVertexArrayObject;
  30611. /**
  30612. * Bind a list of vertex buffers to the webGL context
  30613. * @param vertexBuffers defines the list of vertex buffers to bind
  30614. * @param indexBuffer defines the index buffer to bind
  30615. * @param effect defines the effect associated with the vertex buffers
  30616. */
  30617. bindBuffers(vertexBuffers: {
  30618. [key: string]: Nullable<VertexBuffer>;
  30619. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  30620. /**
  30621. * Unbind all instance attributes
  30622. */
  30623. unbindInstanceAttributes(): void;
  30624. /**
  30625. * Release and free the memory of a vertex array object
  30626. * @param vao defines the vertex array object to delete
  30627. */
  30628. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  30629. /** @hidden */
  30630. _releaseBuffer(buffer: DataBuffer): boolean;
  30631. protected _deleteBuffer(buffer: DataBuffer): void;
  30632. /**
  30633. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  30634. * @param instancesBuffer defines the webGL buffer to update and bind
  30635. * @param data defines the data to store in the buffer
  30636. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  30637. */
  30638. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  30639. /**
  30640. * Apply all cached states (depth, culling, stencil and alpha)
  30641. */
  30642. applyStates(): void;
  30643. /**
  30644. * Send a draw order
  30645. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  30646. * @param indexStart defines the starting index
  30647. * @param indexCount defines the number of index to draw
  30648. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30649. */
  30650. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  30651. /**
  30652. * Draw a list of points
  30653. * @param verticesStart defines the index of first vertex to draw
  30654. * @param verticesCount defines the count of vertices to draw
  30655. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30656. */
  30657. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30658. /**
  30659. * Draw a list of unindexed primitives
  30660. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  30661. * @param verticesStart defines the index of first vertex to draw
  30662. * @param verticesCount defines the count of vertices to draw
  30663. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30664. */
  30665. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30666. /**
  30667. * Draw a list of indexed primitives
  30668. * @param fillMode defines the primitive to use
  30669. * @param indexStart defines the starting index
  30670. * @param indexCount defines the number of index to draw
  30671. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30672. */
  30673. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  30674. /**
  30675. * Draw a list of unindexed primitives
  30676. * @param fillMode defines the primitive to use
  30677. * @param verticesStart defines the index of first vertex to draw
  30678. * @param verticesCount defines the count of vertices to draw
  30679. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30680. */
  30681. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30682. private _drawMode;
  30683. /** @hidden */
  30684. protected _reportDrawCall(): void;
  30685. /** @hidden */
  30686. _releaseEffect(effect: Effect): void;
  30687. /** @hidden */
  30688. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  30689. /**
  30690. * Create a new effect (used to store vertex/fragment shaders)
  30691. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  30692. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  30693. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  30694. * @param samplers defines an array of string used to represent textures
  30695. * @param defines defines the string containing the defines to use to compile the shaders
  30696. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  30697. * @param onCompiled defines a function to call when the effect creation is successful
  30698. * @param onError defines a function to call when the effect creation has failed
  30699. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  30700. * @returns the new Effect
  30701. */
  30702. createEffect(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: string[], defines?: string, fallbacks?: IEffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  30703. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  30704. private _compileShader;
  30705. private _compileRawShader;
  30706. /**
  30707. * Directly creates a webGL program
  30708. * @param pipelineContext defines the pipeline context to attach to
  30709. * @param vertexCode defines the vertex shader code to use
  30710. * @param fragmentCode defines the fragment shader code to use
  30711. * @param context defines the webGL context to use (if not set, the current one will be used)
  30712. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  30713. * @returns the new webGL program
  30714. */
  30715. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30716. /**
  30717. * Creates a webGL program
  30718. * @param pipelineContext defines the pipeline context to attach to
  30719. * @param vertexCode defines the vertex shader code to use
  30720. * @param fragmentCode defines the fragment shader code to use
  30721. * @param defines defines the string containing the defines to use to compile the shaders
  30722. * @param context defines the webGL context to use (if not set, the current one will be used)
  30723. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  30724. * @returns the new webGL program
  30725. */
  30726. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30727. /**
  30728. * Creates a new pipeline context
  30729. * @returns the new pipeline
  30730. */
  30731. createPipelineContext(): IPipelineContext;
  30732. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30733. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  30734. /** @hidden */
  30735. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  30736. /** @hidden */
  30737. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  30738. /** @hidden */
  30739. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  30740. /**
  30741. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  30742. * @param pipelineContext defines the pipeline context to use
  30743. * @param uniformsNames defines the list of uniform names
  30744. * @returns an array of webGL uniform locations
  30745. */
  30746. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  30747. /**
  30748. * Gets the lsit of active attributes for a given webGL program
  30749. * @param pipelineContext defines the pipeline context to use
  30750. * @param attributesNames defines the list of attribute names to get
  30751. * @returns an array of indices indicating the offset of each attribute
  30752. */
  30753. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  30754. /**
  30755. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  30756. * @param effect defines the effect to activate
  30757. */
  30758. enableEffect(effect: Nullable<Effect>): void;
  30759. /**
  30760. * Set the value of an uniform to a number (int)
  30761. * @param uniform defines the webGL uniform location where to store the value
  30762. * @param value defines the int number to store
  30763. */
  30764. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  30765. /**
  30766. * Set the value of an uniform to an array of int32
  30767. * @param uniform defines the webGL uniform location where to store the value
  30768. * @param array defines the array of int32 to store
  30769. */
  30770. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30771. /**
  30772. * Set the value of an uniform to an array of int32 (stored as vec2)
  30773. * @param uniform defines the webGL uniform location where to store the value
  30774. * @param array defines the array of int32 to store
  30775. */
  30776. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30777. /**
  30778. * Set the value of an uniform to an array of int32 (stored as vec3)
  30779. * @param uniform defines the webGL uniform location where to store the value
  30780. * @param array defines the array of int32 to store
  30781. */
  30782. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30783. /**
  30784. * Set the value of an uniform to an array of int32 (stored as vec4)
  30785. * @param uniform defines the webGL uniform location where to store the value
  30786. * @param array defines the array of int32 to store
  30787. */
  30788. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30789. /**
  30790. * Set the value of an uniform to an array of number
  30791. * @param uniform defines the webGL uniform location where to store the value
  30792. * @param array defines the array of number to store
  30793. */
  30794. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30795. /**
  30796. * Set the value of an uniform to an array of number (stored as vec2)
  30797. * @param uniform defines the webGL uniform location where to store the value
  30798. * @param array defines the array of number to store
  30799. */
  30800. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30801. /**
  30802. * Set the value of an uniform to an array of number (stored as vec3)
  30803. * @param uniform defines the webGL uniform location where to store the value
  30804. * @param array defines the array of number to store
  30805. */
  30806. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30807. /**
  30808. * Set the value of an uniform to an array of number (stored as vec4)
  30809. * @param uniform defines the webGL uniform location where to store the value
  30810. * @param array defines the array of number to store
  30811. */
  30812. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30813. /**
  30814. * Set the value of an uniform to an array of float32 (stored as matrices)
  30815. * @param uniform defines the webGL uniform location where to store the value
  30816. * @param matrices defines the array of float32 to store
  30817. */
  30818. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  30819. /**
  30820. * Set the value of an uniform to a matrix (3x3)
  30821. * @param uniform defines the webGL uniform location where to store the value
  30822. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  30823. */
  30824. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  30825. /**
  30826. * Set the value of an uniform to a matrix (2x2)
  30827. * @param uniform defines the webGL uniform location where to store the value
  30828. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  30829. */
  30830. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  30831. /**
  30832. * Set the value of an uniform to a number (float)
  30833. * @param uniform defines the webGL uniform location where to store the value
  30834. * @param value defines the float number to store
  30835. */
  30836. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  30837. /**
  30838. * Set the value of an uniform to a vec2
  30839. * @param uniform defines the webGL uniform location where to store the value
  30840. * @param x defines the 1st component of the value
  30841. * @param y defines the 2nd component of the value
  30842. */
  30843. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  30844. /**
  30845. * Set the value of an uniform to a vec3
  30846. * @param uniform defines the webGL uniform location where to store the value
  30847. * @param x defines the 1st component of the value
  30848. * @param y defines the 2nd component of the value
  30849. * @param z defines the 3rd component of the value
  30850. */
  30851. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  30852. /**
  30853. * Set the value of an uniform to a vec4
  30854. * @param uniform defines the webGL uniform location where to store the value
  30855. * @param x defines the 1st component of the value
  30856. * @param y defines the 2nd component of the value
  30857. * @param z defines the 3rd component of the value
  30858. * @param w defines the 4th component of the value
  30859. */
  30860. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  30861. /**
  30862. * Gets the depth culling state manager
  30863. */
  30864. readonly depthCullingState: DepthCullingState;
  30865. /**
  30866. * Gets the alpha state manager
  30867. */
  30868. readonly alphaState: AlphaState;
  30869. /**
  30870. * Gets the stencil state manager
  30871. */
  30872. readonly stencilState: StencilState;
  30873. /**
  30874. * Clears the list of texture accessible through engine.
  30875. * This can help preventing texture load conflict due to name collision.
  30876. */
  30877. clearInternalTexturesCache(): void;
  30878. /**
  30879. * Force the entire cache to be cleared
  30880. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  30881. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  30882. */
  30883. wipeCaches(bruteForce?: boolean): void;
  30884. /** @hidden */
  30885. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  30886. min: number;
  30887. mag: number;
  30888. };
  30889. /** @hidden */
  30890. _createTexture(): WebGLTexture;
  30891. /**
  30892. * Usually called from Texture.ts.
  30893. * Passed information to create a WebGLTexture
  30894. * @param urlArg defines a value which contains one of the following:
  30895. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  30896. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  30897. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  30898. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  30899. * @param invertY when true, image is flipped when loaded. You probably want true. Certain compressed textures may invert this if their default is inverted (eg. ktx)
  30900. * @param scene needed for loading to the correct scene
  30901. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  30902. * @param onLoad optional callback to be called upon successful completion
  30903. * @param onError optional callback to be called upon failure
  30904. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), HTMLImageElement (image format), or a Blob
  30905. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  30906. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  30907. * @param forcedExtension defines the extension to use to pick the right loader
  30908. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  30909. * @param mimeType defines an optional mime type
  30910. * @returns a InternalTexture for assignment back into BABYLON.Texture
  30911. */
  30912. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, excludeLoaders?: Array<IInternalTextureLoader>, mimeType?: string): InternalTexture;
  30913. /**
  30914. * @hidden
  30915. */
  30916. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  30917. /**
  30918. * Creates a raw texture
  30919. * @param data defines the data to store in the texture
  30920. * @param width defines the width of the texture
  30921. * @param height defines the height of the texture
  30922. * @param format defines the format of the data
  30923. * @param generateMipMaps defines if the engine should generate the mip levels
  30924. * @param invertY defines if data must be stored with Y axis inverted
  30925. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  30926. * @param compression defines the compression used (null by default)
  30927. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  30928. * @returns the raw texture inside an InternalTexture
  30929. */
  30930. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, type?: number): InternalTexture;
  30931. /**
  30932. * Creates a new raw cube texture
  30933. * @param data defines the array of data to use to create each face
  30934. * @param size defines the size of the textures
  30935. * @param format defines the format of the data
  30936. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  30937. * @param generateMipMaps defines if the engine should generate the mip levels
  30938. * @param invertY defines if data must be stored with Y axis inverted
  30939. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  30940. * @param compression defines the compression used (null by default)
  30941. * @returns the cube texture as an InternalTexture
  30942. */
  30943. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>): InternalTexture;
  30944. /**
  30945. * Creates a new raw 3D texture
  30946. * @param data defines the data used to create the texture
  30947. * @param width defines the width of the texture
  30948. * @param height defines the height of the texture
  30949. * @param depth defines the depth of the texture
  30950. * @param format defines the format of the texture
  30951. * @param generateMipMaps defines if the engine must generate mip levels
  30952. * @param invertY defines if data must be stored with Y axis inverted
  30953. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  30954. * @param compression defines the compressed used (can be null)
  30955. * @param textureType defines the compressed used (can be null)
  30956. * @returns a new raw 3D texture (stored in an InternalTexture)
  30957. */
  30958. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  30959. /**
  30960. * Creates a new raw 2D array texture
  30961. * @param data defines the data used to create the texture
  30962. * @param width defines the width of the texture
  30963. * @param height defines the height of the texture
  30964. * @param depth defines the number of layers of the texture
  30965. * @param format defines the format of the texture
  30966. * @param generateMipMaps defines if the engine must generate mip levels
  30967. * @param invertY defines if data must be stored with Y axis inverted
  30968. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  30969. * @param compression defines the compressed used (can be null)
  30970. * @param textureType defines the compressed used (can be null)
  30971. * @returns a new raw 2D array texture (stored in an InternalTexture)
  30972. */
  30973. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  30974. private _unpackFlipYCached;
  30975. /**
  30976. * In case you are sharing the context with other applications, it might
  30977. * be interested to not cache the unpack flip y state to ensure a consistent
  30978. * value would be set.
  30979. */
  30980. enableUnpackFlipYCached: boolean;
  30981. /** @hidden */
  30982. _unpackFlipY(value: boolean): void;
  30983. /** @hidden */
  30984. _getUnpackAlignement(): number;
  30985. /**
  30986. * Update the sampling mode of a given texture
  30987. * @param samplingMode defines the required sampling mode
  30988. * @param texture defines the texture to update
  30989. */
  30990. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  30991. /** @hidden */
  30992. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  30993. width: number;
  30994. height: number;
  30995. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  30996. /** @hidden */
  30997. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  30998. /** @hidden */
  30999. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  31000. /** @hidden */
  31001. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  31002. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  31003. private _prepareWebGLTexture;
  31004. /** @hidden */
  31005. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  31006. /** @hidden */
  31007. _releaseFramebufferObjects(texture: InternalTexture): void;
  31008. /** @hidden */
  31009. _releaseTexture(texture: InternalTexture): void;
  31010. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  31011. protected _setProgram(program: WebGLProgram): void;
  31012. protected _boundUniforms: {
  31013. [key: number]: WebGLUniformLocation;
  31014. };
  31015. /**
  31016. * Binds an effect to the webGL context
  31017. * @param effect defines the effect to bind
  31018. */
  31019. bindSamplers(effect: Effect): void;
  31020. private _activateCurrentTexture;
  31021. /** @hidden */
  31022. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  31023. /** @hidden */
  31024. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  31025. /**
  31026. * Unbind all textures from the webGL context
  31027. */
  31028. unbindAllTextures(): void;
  31029. /**
  31030. * Sets a texture to the according uniform.
  31031. * @param channel The texture channel
  31032. * @param uniform The uniform to set
  31033. * @param texture The texture to apply
  31034. */
  31035. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  31036. private _bindSamplerUniformToChannel;
  31037. private _getTextureWrapMode;
  31038. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  31039. /**
  31040. * Sets an array of texture to the webGL context
  31041. * @param channel defines the channel where the texture array must be set
  31042. * @param uniform defines the associated uniform location
  31043. * @param textures defines the array of textures to bind
  31044. */
  31045. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  31046. /** @hidden */
  31047. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  31048. private _setTextureParameterFloat;
  31049. private _setTextureParameterInteger;
  31050. /**
  31051. * Unbind all vertex attributes from the webGL context
  31052. */
  31053. unbindAllAttributes(): void;
  31054. /**
  31055. * Force the engine to release all cached effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled
  31056. */
  31057. releaseEffects(): void;
  31058. /**
  31059. * Dispose and release all associated resources
  31060. */
  31061. dispose(): void;
  31062. /**
  31063. * Attach a new callback raised when context lost event is fired
  31064. * @param callback defines the callback to call
  31065. */
  31066. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  31067. /**
  31068. * Attach a new callback raised when context restored event is fired
  31069. * @param callback defines the callback to call
  31070. */
  31071. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  31072. /**
  31073. * Get the current error code of the webGL context
  31074. * @returns the error code
  31075. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  31076. */
  31077. getError(): number;
  31078. private _canRenderToFloatFramebuffer;
  31079. private _canRenderToHalfFloatFramebuffer;
  31080. private _canRenderToFramebuffer;
  31081. /** @hidden */
  31082. _getWebGLTextureType(type: number): number;
  31083. /** @hidden */
  31084. _getInternalFormat(format: number): number;
  31085. /** @hidden */
  31086. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  31087. /** @hidden */
  31088. _getRGBAMultiSampleBufferFormat(type: number): number;
  31089. /** @hidden */
  31090. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest;
  31091. /**
  31092. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  31093. * @returns true if the engine can be created
  31094. * @ignorenaming
  31095. */
  31096. static isSupported(): boolean;
  31097. /**
  31098. * Find the next highest power of two.
  31099. * @param x Number to start search from.
  31100. * @return Next highest power of two.
  31101. */
  31102. static CeilingPOT(x: number): number;
  31103. /**
  31104. * Find the next lowest power of two.
  31105. * @param x Number to start search from.
  31106. * @return Next lowest power of two.
  31107. */
  31108. static FloorPOT(x: number): number;
  31109. /**
  31110. * Find the nearest power of two.
  31111. * @param x Number to start search from.
  31112. * @return Next nearest power of two.
  31113. */
  31114. static NearestPOT(x: number): number;
  31115. /**
  31116. * Get the closest exponent of two
  31117. * @param value defines the value to approximate
  31118. * @param max defines the maximum value to return
  31119. * @param mode defines how to define the closest value
  31120. * @returns closest exponent of two of the given value
  31121. */
  31122. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  31123. /**
  31124. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  31125. * @param func - the function to be called
  31126. * @param requester - the object that will request the next frame. Falls back to window.
  31127. * @returns frame number
  31128. */
  31129. static QueueNewFrame(func: () => void, requester?: any): number;
  31130. }
  31131. }
  31132. declare module "babylonjs/Maths/sphericalPolynomial" {
  31133. import { Vector3 } from "babylonjs/Maths/math.vector";
  31134. import { Color3 } from "babylonjs/Maths/math.color";
  31135. /**
  31136. * Class representing spherical harmonics coefficients to the 3rd degree
  31137. */
  31138. export class SphericalHarmonics {
  31139. /**
  31140. * Defines whether or not the harmonics have been prescaled for rendering.
  31141. */
  31142. preScaled: boolean;
  31143. /**
  31144. * The l0,0 coefficients of the spherical harmonics
  31145. */
  31146. l00: Vector3;
  31147. /**
  31148. * The l1,-1 coefficients of the spherical harmonics
  31149. */
  31150. l1_1: Vector3;
  31151. /**
  31152. * The l1,0 coefficients of the spherical harmonics
  31153. */
  31154. l10: Vector3;
  31155. /**
  31156. * The l1,1 coefficients of the spherical harmonics
  31157. */
  31158. l11: Vector3;
  31159. /**
  31160. * The l2,-2 coefficients of the spherical harmonics
  31161. */
  31162. l2_2: Vector3;
  31163. /**
  31164. * The l2,-1 coefficients of the spherical harmonics
  31165. */
  31166. l2_1: Vector3;
  31167. /**
  31168. * The l2,0 coefficients of the spherical harmonics
  31169. */
  31170. l20: Vector3;
  31171. /**
  31172. * The l2,1 coefficients of the spherical harmonics
  31173. */
  31174. l21: Vector3;
  31175. /**
  31176. * The l2,2 coefficients of the spherical harmonics
  31177. */
  31178. l22: Vector3;
  31179. /**
  31180. * Adds a light to the spherical harmonics
  31181. * @param direction the direction of the light
  31182. * @param color the color of the light
  31183. * @param deltaSolidAngle the delta solid angle of the light
  31184. */
  31185. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  31186. /**
  31187. * Scales the spherical harmonics by the given amount
  31188. * @param scale the amount to scale
  31189. */
  31190. scaleInPlace(scale: number): void;
  31191. /**
  31192. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  31193. *
  31194. * ```
  31195. * E_lm = A_l * L_lm
  31196. * ```
  31197. *
  31198. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  31199. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  31200. * the scaling factors are given in equation 9.
  31201. */
  31202. convertIncidentRadianceToIrradiance(): void;
  31203. /**
  31204. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  31205. *
  31206. * ```
  31207. * L = (1/pi) * E * rho
  31208. * ```
  31209. *
  31210. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  31211. */
  31212. convertIrradianceToLambertianRadiance(): void;
  31213. /**
  31214. * Integrates the reconstruction coefficients directly in to the SH preventing further
  31215. * required operations at run time.
  31216. *
  31217. * This is simply done by scaling back the SH with Ylm constants parameter.
  31218. * The trigonometric part being applied by the shader at run time.
  31219. */
  31220. preScaleForRendering(): void;
  31221. /**
  31222. * Constructs a spherical harmonics from an array.
  31223. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  31224. * @returns the spherical harmonics
  31225. */
  31226. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  31227. /**
  31228. * Gets the spherical harmonics from polynomial
  31229. * @param polynomial the spherical polynomial
  31230. * @returns the spherical harmonics
  31231. */
  31232. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  31233. }
  31234. /**
  31235. * Class representing spherical polynomial coefficients to the 3rd degree
  31236. */
  31237. export class SphericalPolynomial {
  31238. private _harmonics;
  31239. /**
  31240. * The spherical harmonics used to create the polynomials.
  31241. */
  31242. readonly preScaledHarmonics: SphericalHarmonics;
  31243. /**
  31244. * The x coefficients of the spherical polynomial
  31245. */
  31246. x: Vector3;
  31247. /**
  31248. * The y coefficients of the spherical polynomial
  31249. */
  31250. y: Vector3;
  31251. /**
  31252. * The z coefficients of the spherical polynomial
  31253. */
  31254. z: Vector3;
  31255. /**
  31256. * The xx coefficients of the spherical polynomial
  31257. */
  31258. xx: Vector3;
  31259. /**
  31260. * The yy coefficients of the spherical polynomial
  31261. */
  31262. yy: Vector3;
  31263. /**
  31264. * The zz coefficients of the spherical polynomial
  31265. */
  31266. zz: Vector3;
  31267. /**
  31268. * The xy coefficients of the spherical polynomial
  31269. */
  31270. xy: Vector3;
  31271. /**
  31272. * The yz coefficients of the spherical polynomial
  31273. */
  31274. yz: Vector3;
  31275. /**
  31276. * The zx coefficients of the spherical polynomial
  31277. */
  31278. zx: Vector3;
  31279. /**
  31280. * Adds an ambient color to the spherical polynomial
  31281. * @param color the color to add
  31282. */
  31283. addAmbient(color: Color3): void;
  31284. /**
  31285. * Scales the spherical polynomial by the given amount
  31286. * @param scale the amount to scale
  31287. */
  31288. scaleInPlace(scale: number): void;
  31289. /**
  31290. * Gets the spherical polynomial from harmonics
  31291. * @param harmonics the spherical harmonics
  31292. * @returns the spherical polynomial
  31293. */
  31294. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  31295. /**
  31296. * Constructs a spherical polynomial from an array.
  31297. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  31298. * @returns the spherical polynomial
  31299. */
  31300. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  31301. }
  31302. }
  31303. declare module "babylonjs/Materials/Textures/internalTexture" {
  31304. import { Observable } from "babylonjs/Misc/observable";
  31305. import { Nullable, int } from "babylonjs/types";
  31306. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  31307. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31308. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  31309. /**
  31310. * Defines the source of the internal texture
  31311. */
  31312. export enum InternalTextureSource {
  31313. /**
  31314. * The source of the texture data is unknown
  31315. */
  31316. Unknown = 0,
  31317. /**
  31318. * Texture data comes from an URL
  31319. */
  31320. Url = 1,
  31321. /**
  31322. * Texture data is only used for temporary storage
  31323. */
  31324. Temp = 2,
  31325. /**
  31326. * Texture data comes from raw data (ArrayBuffer)
  31327. */
  31328. Raw = 3,
  31329. /**
  31330. * Texture content is dynamic (video or dynamic texture)
  31331. */
  31332. Dynamic = 4,
  31333. /**
  31334. * Texture content is generated by rendering to it
  31335. */
  31336. RenderTarget = 5,
  31337. /**
  31338. * Texture content is part of a multi render target process
  31339. */
  31340. MultiRenderTarget = 6,
  31341. /**
  31342. * Texture data comes from a cube data file
  31343. */
  31344. Cube = 7,
  31345. /**
  31346. * Texture data comes from a raw cube data
  31347. */
  31348. CubeRaw = 8,
  31349. /**
  31350. * Texture data come from a prefiltered cube data file
  31351. */
  31352. CubePrefiltered = 9,
  31353. /**
  31354. * Texture content is raw 3D data
  31355. */
  31356. Raw3D = 10,
  31357. /**
  31358. * Texture content is raw 2D array data
  31359. */
  31360. Raw2DArray = 11,
  31361. /**
  31362. * Texture content is a depth texture
  31363. */
  31364. Depth = 12,
  31365. /**
  31366. * Texture data comes from a raw cube data encoded with RGBD
  31367. */
  31368. CubeRawRGBD = 13
  31369. }
  31370. /**
  31371. * Class used to store data associated with WebGL texture data for the engine
  31372. * This class should not be used directly
  31373. */
  31374. export class InternalTexture {
  31375. /** @hidden */
  31376. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<import("babylonjs/Maths/sphericalPolynomial").SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  31377. /**
  31378. * Defines if the texture is ready
  31379. */
  31380. isReady: boolean;
  31381. /**
  31382. * Defines if the texture is a cube texture
  31383. */
  31384. isCube: boolean;
  31385. /**
  31386. * Defines if the texture contains 3D data
  31387. */
  31388. is3D: boolean;
  31389. /**
  31390. * Defines if the texture contains 2D array data
  31391. */
  31392. is2DArray: boolean;
  31393. /**
  31394. * Defines if the texture contains multiview data
  31395. */
  31396. isMultiview: boolean;
  31397. /**
  31398. * Gets the URL used to load this texture
  31399. */
  31400. url: string;
  31401. /**
  31402. * Gets the sampling mode of the texture
  31403. */
  31404. samplingMode: number;
  31405. /**
  31406. * Gets a boolean indicating if the texture needs mipmaps generation
  31407. */
  31408. generateMipMaps: boolean;
  31409. /**
  31410. * Gets the number of samples used by the texture (WebGL2+ only)
  31411. */
  31412. samples: number;
  31413. /**
  31414. * Gets the type of the texture (int, float...)
  31415. */
  31416. type: number;
  31417. /**
  31418. * Gets the format of the texture (RGB, RGBA...)
  31419. */
  31420. format: number;
  31421. /**
  31422. * Observable called when the texture is loaded
  31423. */
  31424. onLoadedObservable: Observable<InternalTexture>;
  31425. /**
  31426. * Gets the width of the texture
  31427. */
  31428. width: number;
  31429. /**
  31430. * Gets the height of the texture
  31431. */
  31432. height: number;
  31433. /**
  31434. * Gets the depth of the texture
  31435. */
  31436. depth: number;
  31437. /**
  31438. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  31439. */
  31440. baseWidth: number;
  31441. /**
  31442. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  31443. */
  31444. baseHeight: number;
  31445. /**
  31446. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  31447. */
  31448. baseDepth: number;
  31449. /**
  31450. * Gets a boolean indicating if the texture is inverted on Y axis
  31451. */
  31452. invertY: boolean;
  31453. /** @hidden */
  31454. _invertVScale: boolean;
  31455. /** @hidden */
  31456. _associatedChannel: number;
  31457. /** @hidden */
  31458. _source: InternalTextureSource;
  31459. /** @hidden */
  31460. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  31461. /** @hidden */
  31462. _bufferView: Nullable<ArrayBufferView>;
  31463. /** @hidden */
  31464. _bufferViewArray: Nullable<ArrayBufferView[]>;
  31465. /** @hidden */
  31466. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  31467. /** @hidden */
  31468. _size: number;
  31469. /** @hidden */
  31470. _extension: string;
  31471. /** @hidden */
  31472. _files: Nullable<string[]>;
  31473. /** @hidden */
  31474. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  31475. /** @hidden */
  31476. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  31477. /** @hidden */
  31478. _framebuffer: Nullable<WebGLFramebuffer>;
  31479. /** @hidden */
  31480. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  31481. /** @hidden */
  31482. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  31483. /** @hidden */
  31484. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  31485. /** @hidden */
  31486. _attachments: Nullable<number[]>;
  31487. /** @hidden */
  31488. _cachedCoordinatesMode: Nullable<number>;
  31489. /** @hidden */
  31490. _cachedWrapU: Nullable<number>;
  31491. /** @hidden */
  31492. _cachedWrapV: Nullable<number>;
  31493. /** @hidden */
  31494. _cachedWrapR: Nullable<number>;
  31495. /** @hidden */
  31496. _cachedAnisotropicFilteringLevel: Nullable<number>;
  31497. /** @hidden */
  31498. _isDisabled: boolean;
  31499. /** @hidden */
  31500. _compression: Nullable<string>;
  31501. /** @hidden */
  31502. _generateStencilBuffer: boolean;
  31503. /** @hidden */
  31504. _generateDepthBuffer: boolean;
  31505. /** @hidden */
  31506. _comparisonFunction: number;
  31507. /** @hidden */
  31508. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  31509. /** @hidden */
  31510. _lodGenerationScale: number;
  31511. /** @hidden */
  31512. _lodGenerationOffset: number;
  31513. /** @hidden */
  31514. _colorTextureArray: Nullable<WebGLTexture>;
  31515. /** @hidden */
  31516. _depthStencilTextureArray: Nullable<WebGLTexture>;
  31517. /** @hidden */
  31518. _lodTextureHigh: Nullable<BaseTexture>;
  31519. /** @hidden */
  31520. _lodTextureMid: Nullable<BaseTexture>;
  31521. /** @hidden */
  31522. _lodTextureLow: Nullable<BaseTexture>;
  31523. /** @hidden */
  31524. _isRGBD: boolean;
  31525. /** @hidden */
  31526. _linearSpecularLOD: boolean;
  31527. /** @hidden */
  31528. _irradianceTexture: Nullable<BaseTexture>;
  31529. /** @hidden */
  31530. _webGLTexture: Nullable<WebGLTexture>;
  31531. /** @hidden */
  31532. _references: number;
  31533. private _engine;
  31534. /**
  31535. * Gets the Engine the texture belongs to.
  31536. * @returns The babylon engine
  31537. */
  31538. getEngine(): ThinEngine;
  31539. /**
  31540. * Gets the data source type of the texture
  31541. */
  31542. readonly source: InternalTextureSource;
  31543. /**
  31544. * Creates a new InternalTexture
  31545. * @param engine defines the engine to use
  31546. * @param source defines the type of data that will be used
  31547. * @param delayAllocation if the texture allocation should be delayed (default: false)
  31548. */
  31549. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  31550. /**
  31551. * Increments the number of references (ie. the number of Texture that point to it)
  31552. */
  31553. incrementReferences(): void;
  31554. /**
  31555. * Change the size of the texture (not the size of the content)
  31556. * @param width defines the new width
  31557. * @param height defines the new height
  31558. * @param depth defines the new depth (1 by default)
  31559. */
  31560. updateSize(width: int, height: int, depth?: int): void;
  31561. /** @hidden */
  31562. _rebuild(): void;
  31563. /** @hidden */
  31564. _swapAndDie(target: InternalTexture): void;
  31565. /**
  31566. * Dispose the current allocated resources
  31567. */
  31568. dispose(): void;
  31569. }
  31570. }
  31571. declare module "babylonjs/Audio/analyser" {
  31572. import { Scene } from "babylonjs/scene";
  31573. /**
  31574. * Class used to work with sound analyzer using fast fourier transform (FFT)
  31575. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31576. */
  31577. export class Analyser {
  31578. /**
  31579. * Gets or sets the smoothing
  31580. * @ignorenaming
  31581. */
  31582. SMOOTHING: number;
  31583. /**
  31584. * Gets or sets the FFT table size
  31585. * @ignorenaming
  31586. */
  31587. FFT_SIZE: number;
  31588. /**
  31589. * Gets or sets the bar graph amplitude
  31590. * @ignorenaming
  31591. */
  31592. BARGRAPHAMPLITUDE: number;
  31593. /**
  31594. * Gets or sets the position of the debug canvas
  31595. * @ignorenaming
  31596. */
  31597. DEBUGCANVASPOS: {
  31598. x: number;
  31599. y: number;
  31600. };
  31601. /**
  31602. * Gets or sets the debug canvas size
  31603. * @ignorenaming
  31604. */
  31605. DEBUGCANVASSIZE: {
  31606. width: number;
  31607. height: number;
  31608. };
  31609. private _byteFreqs;
  31610. private _byteTime;
  31611. private _floatFreqs;
  31612. private _webAudioAnalyser;
  31613. private _debugCanvas;
  31614. private _debugCanvasContext;
  31615. private _scene;
  31616. private _registerFunc;
  31617. private _audioEngine;
  31618. /**
  31619. * Creates a new analyser
  31620. * @param scene defines hosting scene
  31621. */
  31622. constructor(scene: Scene);
  31623. /**
  31624. * Get the number of data values you will have to play with for the visualization
  31625. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  31626. * @returns a number
  31627. */
  31628. getFrequencyBinCount(): number;
  31629. /**
  31630. * Gets the current frequency data as a byte array
  31631. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  31632. * @returns a Uint8Array
  31633. */
  31634. getByteFrequencyData(): Uint8Array;
  31635. /**
  31636. * Gets the current waveform as a byte array
  31637. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  31638. * @returns a Uint8Array
  31639. */
  31640. getByteTimeDomainData(): Uint8Array;
  31641. /**
  31642. * Gets the current frequency data as a float array
  31643. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  31644. * @returns a Float32Array
  31645. */
  31646. getFloatFrequencyData(): Float32Array;
  31647. /**
  31648. * Renders the debug canvas
  31649. */
  31650. drawDebugCanvas(): void;
  31651. /**
  31652. * Stops rendering the debug canvas and removes it
  31653. */
  31654. stopDebugCanvas(): void;
  31655. /**
  31656. * Connects two audio nodes
  31657. * @param inputAudioNode defines first node to connect
  31658. * @param outputAudioNode defines second node to connect
  31659. */
  31660. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  31661. /**
  31662. * Releases all associated resources
  31663. */
  31664. dispose(): void;
  31665. }
  31666. }
  31667. declare module "babylonjs/Audio/audioEngine" {
  31668. import { IDisposable } from "babylonjs/scene";
  31669. import { Analyser } from "babylonjs/Audio/analyser";
  31670. import { Nullable } from "babylonjs/types";
  31671. import { Observable } from "babylonjs/Misc/observable";
  31672. /**
  31673. * This represents an audio engine and it is responsible
  31674. * to play, synchronize and analyse sounds throughout the application.
  31675. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31676. */
  31677. export interface IAudioEngine extends IDisposable {
  31678. /**
  31679. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  31680. */
  31681. readonly canUseWebAudio: boolean;
  31682. /**
  31683. * Gets the current AudioContext if available.
  31684. */
  31685. readonly audioContext: Nullable<AudioContext>;
  31686. /**
  31687. * The master gain node defines the global audio volume of your audio engine.
  31688. */
  31689. readonly masterGain: GainNode;
  31690. /**
  31691. * Gets whether or not mp3 are supported by your browser.
  31692. */
  31693. readonly isMP3supported: boolean;
  31694. /**
  31695. * Gets whether or not ogg are supported by your browser.
  31696. */
  31697. readonly isOGGsupported: boolean;
  31698. /**
  31699. * Defines if Babylon should emit a warning if WebAudio is not supported.
  31700. * @ignoreNaming
  31701. */
  31702. WarnedWebAudioUnsupported: boolean;
  31703. /**
  31704. * Defines if the audio engine relies on a custom unlocked button.
  31705. * In this case, the embedded button will not be displayed.
  31706. */
  31707. useCustomUnlockedButton: boolean;
  31708. /**
  31709. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  31710. */
  31711. readonly unlocked: boolean;
  31712. /**
  31713. * Event raised when audio has been unlocked on the browser.
  31714. */
  31715. onAudioUnlockedObservable: Observable<AudioEngine>;
  31716. /**
  31717. * Event raised when audio has been locked on the browser.
  31718. */
  31719. onAudioLockedObservable: Observable<AudioEngine>;
  31720. /**
  31721. * Flags the audio engine in Locked state.
  31722. * This happens due to new browser policies preventing audio to autoplay.
  31723. */
  31724. lock(): void;
  31725. /**
  31726. * Unlocks the audio engine once a user action has been done on the dom.
  31727. * This is helpful to resume play once browser policies have been satisfied.
  31728. */
  31729. unlock(): void;
  31730. }
  31731. /**
  31732. * This represents the default audio engine used in babylon.
  31733. * It is responsible to play, synchronize and analyse sounds throughout the application.
  31734. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31735. */
  31736. export class AudioEngine implements IAudioEngine {
  31737. private _audioContext;
  31738. private _audioContextInitialized;
  31739. private _muteButton;
  31740. private _hostElement;
  31741. /**
  31742. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  31743. */
  31744. canUseWebAudio: boolean;
  31745. /**
  31746. * The master gain node defines the global audio volume of your audio engine.
  31747. */
  31748. masterGain: GainNode;
  31749. /**
  31750. * Defines if Babylon should emit a warning if WebAudio is not supported.
  31751. * @ignoreNaming
  31752. */
  31753. WarnedWebAudioUnsupported: boolean;
  31754. /**
  31755. * Gets whether or not mp3 are supported by your browser.
  31756. */
  31757. isMP3supported: boolean;
  31758. /**
  31759. * Gets whether or not ogg are supported by your browser.
  31760. */
  31761. isOGGsupported: boolean;
  31762. /**
  31763. * Gets whether audio has been unlocked on the device.
  31764. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  31765. * a user interaction has happened.
  31766. */
  31767. unlocked: boolean;
  31768. /**
  31769. * Defines if the audio engine relies on a custom unlocked button.
  31770. * In this case, the embedded button will not be displayed.
  31771. */
  31772. useCustomUnlockedButton: boolean;
  31773. /**
  31774. * Event raised when audio has been unlocked on the browser.
  31775. */
  31776. onAudioUnlockedObservable: Observable<AudioEngine>;
  31777. /**
  31778. * Event raised when audio has been locked on the browser.
  31779. */
  31780. onAudioLockedObservable: Observable<AudioEngine>;
  31781. /**
  31782. * Gets the current AudioContext if available.
  31783. */
  31784. readonly audioContext: Nullable<AudioContext>;
  31785. private _connectedAnalyser;
  31786. /**
  31787. * Instantiates a new audio engine.
  31788. *
  31789. * There should be only one per page as some browsers restrict the number
  31790. * of audio contexts you can create.
  31791. * @param hostElement defines the host element where to display the mute icon if necessary
  31792. */
  31793. constructor(hostElement?: Nullable<HTMLElement>);
  31794. /**
  31795. * Flags the audio engine in Locked state.
  31796. * This happens due to new browser policies preventing audio to autoplay.
  31797. */
  31798. lock(): void;
  31799. /**
  31800. * Unlocks the audio engine once a user action has been done on the dom.
  31801. * This is helpful to resume play once browser policies have been satisfied.
  31802. */
  31803. unlock(): void;
  31804. private _resumeAudioContext;
  31805. private _initializeAudioContext;
  31806. private _tryToRun;
  31807. private _triggerRunningState;
  31808. private _triggerSuspendedState;
  31809. private _displayMuteButton;
  31810. private _moveButtonToTopLeft;
  31811. private _onResize;
  31812. private _hideMuteButton;
  31813. /**
  31814. * Destroy and release the resources associated with the audio ccontext.
  31815. */
  31816. dispose(): void;
  31817. /**
  31818. * Gets the global volume sets on the master gain.
  31819. * @returns the global volume if set or -1 otherwise
  31820. */
  31821. getGlobalVolume(): number;
  31822. /**
  31823. * Sets the global volume of your experience (sets on the master gain).
  31824. * @param newVolume Defines the new global volume of the application
  31825. */
  31826. setGlobalVolume(newVolume: number): void;
  31827. /**
  31828. * Connect the audio engine to an audio analyser allowing some amazing
  31829. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  31830. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  31831. * @param analyser The analyser to connect to the engine
  31832. */
  31833. connectToAnalyser(analyser: Analyser): void;
  31834. }
  31835. }
  31836. declare module "babylonjs/Loading/loadingScreen" {
  31837. /**
  31838. * Interface used to present a loading screen while loading a scene
  31839. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  31840. */
  31841. export interface ILoadingScreen {
  31842. /**
  31843. * Function called to display the loading screen
  31844. */
  31845. displayLoadingUI: () => void;
  31846. /**
  31847. * Function called to hide the loading screen
  31848. */
  31849. hideLoadingUI: () => void;
  31850. /**
  31851. * Gets or sets the color to use for the background
  31852. */
  31853. loadingUIBackgroundColor: string;
  31854. /**
  31855. * Gets or sets the text to display while loading
  31856. */
  31857. loadingUIText: string;
  31858. }
  31859. /**
  31860. * Class used for the default loading screen
  31861. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  31862. */
  31863. export class DefaultLoadingScreen implements ILoadingScreen {
  31864. private _renderingCanvas;
  31865. private _loadingText;
  31866. private _loadingDivBackgroundColor;
  31867. private _loadingDiv;
  31868. private _loadingTextDiv;
  31869. /** Gets or sets the logo url to use for the default loading screen */
  31870. static DefaultLogoUrl: string;
  31871. /** Gets or sets the spinner url to use for the default loading screen */
  31872. static DefaultSpinnerUrl: string;
  31873. /**
  31874. * Creates a new default loading screen
  31875. * @param _renderingCanvas defines the canvas used to render the scene
  31876. * @param _loadingText defines the default text to display
  31877. * @param _loadingDivBackgroundColor defines the default background color
  31878. */
  31879. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  31880. /**
  31881. * Function called to display the loading screen
  31882. */
  31883. displayLoadingUI(): void;
  31884. /**
  31885. * Function called to hide the loading screen
  31886. */
  31887. hideLoadingUI(): void;
  31888. /**
  31889. * Gets or sets the text to display while loading
  31890. */
  31891. loadingUIText: string;
  31892. /**
  31893. * Gets or sets the color to use for the background
  31894. */
  31895. loadingUIBackgroundColor: string;
  31896. private _resizeLoadingUI;
  31897. }
  31898. }
  31899. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  31900. /**
  31901. * Interface for any object that can request an animation frame
  31902. */
  31903. export interface ICustomAnimationFrameRequester {
  31904. /**
  31905. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  31906. */
  31907. renderFunction?: Function;
  31908. /**
  31909. * Called to request the next frame to render to
  31910. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  31911. */
  31912. requestAnimationFrame: Function;
  31913. /**
  31914. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  31915. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  31916. */
  31917. requestID?: number;
  31918. }
  31919. }
  31920. declare module "babylonjs/Misc/performanceMonitor" {
  31921. /**
  31922. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  31923. */
  31924. export class PerformanceMonitor {
  31925. private _enabled;
  31926. private _rollingFrameTime;
  31927. private _lastFrameTimeMs;
  31928. /**
  31929. * constructor
  31930. * @param frameSampleSize The number of samples required to saturate the sliding window
  31931. */
  31932. constructor(frameSampleSize?: number);
  31933. /**
  31934. * Samples current frame
  31935. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  31936. */
  31937. sampleFrame(timeMs?: number): void;
  31938. /**
  31939. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  31940. */
  31941. readonly averageFrameTime: number;
  31942. /**
  31943. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  31944. */
  31945. readonly averageFrameTimeVariance: number;
  31946. /**
  31947. * Returns the frame time of the most recent frame
  31948. */
  31949. readonly instantaneousFrameTime: number;
  31950. /**
  31951. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  31952. */
  31953. readonly averageFPS: number;
  31954. /**
  31955. * Returns the average framerate in frames per second using the most recent frame time
  31956. */
  31957. readonly instantaneousFPS: number;
  31958. /**
  31959. * Returns true if enough samples have been taken to completely fill the sliding window
  31960. */
  31961. readonly isSaturated: boolean;
  31962. /**
  31963. * Enables contributions to the sliding window sample set
  31964. */
  31965. enable(): void;
  31966. /**
  31967. * Disables contributions to the sliding window sample set
  31968. * Samples will not be interpolated over the disabled period
  31969. */
  31970. disable(): void;
  31971. /**
  31972. * Returns true if sampling is enabled
  31973. */
  31974. readonly isEnabled: boolean;
  31975. /**
  31976. * Resets performance monitor
  31977. */
  31978. reset(): void;
  31979. }
  31980. /**
  31981. * RollingAverage
  31982. *
  31983. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  31984. */
  31985. export class RollingAverage {
  31986. /**
  31987. * Current average
  31988. */
  31989. average: number;
  31990. /**
  31991. * Current variance
  31992. */
  31993. variance: number;
  31994. protected _samples: Array<number>;
  31995. protected _sampleCount: number;
  31996. protected _pos: number;
  31997. protected _m2: number;
  31998. /**
  31999. * constructor
  32000. * @param length The number of samples required to saturate the sliding window
  32001. */
  32002. constructor(length: number);
  32003. /**
  32004. * Adds a sample to the sample set
  32005. * @param v The sample value
  32006. */
  32007. add(v: number): void;
  32008. /**
  32009. * Returns previously added values or null if outside of history or outside the sliding window domain
  32010. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  32011. * @return Value previously recorded with add() or null if outside of range
  32012. */
  32013. history(i: number): number;
  32014. /**
  32015. * Returns true if enough samples have been taken to completely fill the sliding window
  32016. * @return true if sample-set saturated
  32017. */
  32018. isSaturated(): boolean;
  32019. /**
  32020. * Resets the rolling average (equivalent to 0 samples taken so far)
  32021. */
  32022. reset(): void;
  32023. /**
  32024. * Wraps a value around the sample range boundaries
  32025. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  32026. * @return Wrapped position in sample range
  32027. */
  32028. protected _wrapPosition(i: number): number;
  32029. }
  32030. }
  32031. declare module "babylonjs/Misc/perfCounter" {
  32032. /**
  32033. * This class is used to track a performance counter which is number based.
  32034. * The user has access to many properties which give statistics of different nature.
  32035. *
  32036. * The implementer can track two kinds of Performance Counter: time and count.
  32037. * For time you can optionally call fetchNewFrame() to notify the start of a new frame to monitor, then call beginMonitoring() to start and endMonitoring() to record the lapsed time. endMonitoring takes a newFrame parameter for you to specify if the monitored time should be set for a new frame or accumulated to the current frame being monitored.
  32038. * For count you first have to call fetchNewFrame() to notify the start of a new frame to monitor, then call addCount() how many time required to increment the count value you monitor.
  32039. */
  32040. export class PerfCounter {
  32041. /**
  32042. * Gets or sets a global boolean to turn on and off all the counters
  32043. */
  32044. static Enabled: boolean;
  32045. /**
  32046. * Returns the smallest value ever
  32047. */
  32048. readonly min: number;
  32049. /**
  32050. * Returns the biggest value ever
  32051. */
  32052. readonly max: number;
  32053. /**
  32054. * Returns the average value since the performance counter is running
  32055. */
  32056. readonly average: number;
  32057. /**
  32058. * Returns the average value of the last second the counter was monitored
  32059. */
  32060. readonly lastSecAverage: number;
  32061. /**
  32062. * Returns the current value
  32063. */
  32064. readonly current: number;
  32065. /**
  32066. * Gets the accumulated total
  32067. */
  32068. readonly total: number;
  32069. /**
  32070. * Gets the total value count
  32071. */
  32072. readonly count: number;
  32073. /**
  32074. * Creates a new counter
  32075. */
  32076. constructor();
  32077. /**
  32078. * Call this method to start monitoring a new frame.
  32079. * This scenario is typically used when you accumulate monitoring time many times for a single frame, you call this method at the start of the frame, then beginMonitoring to start recording and endMonitoring(false) to accumulated the recorded time to the PerfCounter or addCount() to accumulate a monitored count.
  32080. */
  32081. fetchNewFrame(): void;
  32082. /**
  32083. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  32084. * @param newCount the count value to add to the monitored count
  32085. * @param fetchResult true when it's the last time in the frame you add to the counter and you wish to update the statistics properties (min/max/average), false if you only want to update statistics.
  32086. */
  32087. addCount(newCount: number, fetchResult: boolean): void;
  32088. /**
  32089. * Start monitoring this performance counter
  32090. */
  32091. beginMonitoring(): void;
  32092. /**
  32093. * Compute the time lapsed since the previous beginMonitoring() call.
  32094. * @param newFrame true by default to fetch the result and monitor a new frame, if false the time monitored will be added to the current frame counter
  32095. */
  32096. endMonitoring(newFrame?: boolean): void;
  32097. private _fetchResult;
  32098. private _startMonitoringTime;
  32099. private _min;
  32100. private _max;
  32101. private _average;
  32102. private _current;
  32103. private _totalValueCount;
  32104. private _totalAccumulated;
  32105. private _lastSecAverage;
  32106. private _lastSecAccumulated;
  32107. private _lastSecTime;
  32108. private _lastSecValueCount;
  32109. }
  32110. }
  32111. declare module "babylonjs/Engines/engine" {
  32112. import { Observable } from "babylonjs/Misc/observable";
  32113. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  32114. import { Scene } from "babylonjs/scene";
  32115. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  32116. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  32117. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  32118. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  32119. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  32120. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  32121. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  32122. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  32123. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  32124. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  32125. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  32126. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  32127. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  32128. import { Material } from "babylonjs/Materials/material";
  32129. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  32130. /**
  32131. * Defines the interface used by display changed events
  32132. */
  32133. export interface IDisplayChangedEventArgs {
  32134. /** Gets the vrDisplay object (if any) */
  32135. vrDisplay: Nullable<any>;
  32136. /** Gets a boolean indicating if webVR is supported */
  32137. vrSupported: boolean;
  32138. }
  32139. /**
  32140. * Defines the interface used by objects containing a viewport (like a camera)
  32141. */
  32142. interface IViewportOwnerLike {
  32143. /**
  32144. * Gets or sets the viewport
  32145. */
  32146. viewport: IViewportLike;
  32147. }
  32148. /**
  32149. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  32150. */
  32151. export class Engine extends ThinEngine {
  32152. /** Defines that alpha blending is disabled */
  32153. static readonly ALPHA_DISABLE: number;
  32154. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  32155. static readonly ALPHA_ADD: number;
  32156. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  32157. static readonly ALPHA_COMBINE: number;
  32158. /** Defines that alpha blending to DEST - SRC * DEST */
  32159. static readonly ALPHA_SUBTRACT: number;
  32160. /** Defines that alpha blending to SRC * DEST */
  32161. static readonly ALPHA_MULTIPLY: number;
  32162. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  32163. static readonly ALPHA_MAXIMIZED: number;
  32164. /** Defines that alpha blending to SRC + DEST */
  32165. static readonly ALPHA_ONEONE: number;
  32166. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  32167. static readonly ALPHA_PREMULTIPLIED: number;
  32168. /**
  32169. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  32170. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  32171. */
  32172. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  32173. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  32174. static readonly ALPHA_INTERPOLATE: number;
  32175. /**
  32176. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  32177. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  32178. */
  32179. static readonly ALPHA_SCREENMODE: number;
  32180. /** Defines that the ressource is not delayed*/
  32181. static readonly DELAYLOADSTATE_NONE: number;
  32182. /** Defines that the ressource was successfully delay loaded */
  32183. static readonly DELAYLOADSTATE_LOADED: number;
  32184. /** Defines that the ressource is currently delay loading */
  32185. static readonly DELAYLOADSTATE_LOADING: number;
  32186. /** Defines that the ressource is delayed and has not started loading */
  32187. static readonly DELAYLOADSTATE_NOTLOADED: number;
  32188. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  32189. static readonly NEVER: number;
  32190. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  32191. static readonly ALWAYS: number;
  32192. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  32193. static readonly LESS: number;
  32194. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  32195. static readonly EQUAL: number;
  32196. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  32197. static readonly LEQUAL: number;
  32198. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  32199. static readonly GREATER: number;
  32200. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  32201. static readonly GEQUAL: number;
  32202. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  32203. static readonly NOTEQUAL: number;
  32204. /** Passed to stencilOperation to specify that stencil value must be kept */
  32205. static readonly KEEP: number;
  32206. /** Passed to stencilOperation to specify that stencil value must be replaced */
  32207. static readonly REPLACE: number;
  32208. /** Passed to stencilOperation to specify that stencil value must be incremented */
  32209. static readonly INCR: number;
  32210. /** Passed to stencilOperation to specify that stencil value must be decremented */
  32211. static readonly DECR: number;
  32212. /** Passed to stencilOperation to specify that stencil value must be inverted */
  32213. static readonly INVERT: number;
  32214. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  32215. static readonly INCR_WRAP: number;
  32216. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  32217. static readonly DECR_WRAP: number;
  32218. /** Texture is not repeating outside of 0..1 UVs */
  32219. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  32220. /** Texture is repeating outside of 0..1 UVs */
  32221. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  32222. /** Texture is repeating and mirrored */
  32223. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  32224. /** ALPHA */
  32225. static readonly TEXTUREFORMAT_ALPHA: number;
  32226. /** LUMINANCE */
  32227. static readonly TEXTUREFORMAT_LUMINANCE: number;
  32228. /** LUMINANCE_ALPHA */
  32229. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  32230. /** RGB */
  32231. static readonly TEXTUREFORMAT_RGB: number;
  32232. /** RGBA */
  32233. static readonly TEXTUREFORMAT_RGBA: number;
  32234. /** RED */
  32235. static readonly TEXTUREFORMAT_RED: number;
  32236. /** RED (2nd reference) */
  32237. static readonly TEXTUREFORMAT_R: number;
  32238. /** RG */
  32239. static readonly TEXTUREFORMAT_RG: number;
  32240. /** RED_INTEGER */
  32241. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  32242. /** RED_INTEGER (2nd reference) */
  32243. static readonly TEXTUREFORMAT_R_INTEGER: number;
  32244. /** RG_INTEGER */
  32245. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  32246. /** RGB_INTEGER */
  32247. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  32248. /** RGBA_INTEGER */
  32249. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  32250. /** UNSIGNED_BYTE */
  32251. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  32252. /** UNSIGNED_BYTE (2nd reference) */
  32253. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  32254. /** FLOAT */
  32255. static readonly TEXTURETYPE_FLOAT: number;
  32256. /** HALF_FLOAT */
  32257. static readonly TEXTURETYPE_HALF_FLOAT: number;
  32258. /** BYTE */
  32259. static readonly TEXTURETYPE_BYTE: number;
  32260. /** SHORT */
  32261. static readonly TEXTURETYPE_SHORT: number;
  32262. /** UNSIGNED_SHORT */
  32263. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  32264. /** INT */
  32265. static readonly TEXTURETYPE_INT: number;
  32266. /** UNSIGNED_INT */
  32267. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  32268. /** UNSIGNED_SHORT_4_4_4_4 */
  32269. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  32270. /** UNSIGNED_SHORT_5_5_5_1 */
  32271. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  32272. /** UNSIGNED_SHORT_5_6_5 */
  32273. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  32274. /** UNSIGNED_INT_2_10_10_10_REV */
  32275. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  32276. /** UNSIGNED_INT_24_8 */
  32277. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  32278. /** UNSIGNED_INT_10F_11F_11F_REV */
  32279. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  32280. /** UNSIGNED_INT_5_9_9_9_REV */
  32281. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  32282. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  32283. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  32284. /** nearest is mag = nearest and min = nearest and mip = linear */
  32285. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  32286. /** Bilinear is mag = linear and min = linear and mip = nearest */
  32287. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  32288. /** Trilinear is mag = linear and min = linear and mip = linear */
  32289. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  32290. /** nearest is mag = nearest and min = nearest and mip = linear */
  32291. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  32292. /** Bilinear is mag = linear and min = linear and mip = nearest */
  32293. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  32294. /** Trilinear is mag = linear and min = linear and mip = linear */
  32295. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  32296. /** mag = nearest and min = nearest and mip = nearest */
  32297. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  32298. /** mag = nearest and min = linear and mip = nearest */
  32299. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  32300. /** mag = nearest and min = linear and mip = linear */
  32301. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  32302. /** mag = nearest and min = linear and mip = none */
  32303. static readonly TEXTURE_NEAREST_LINEAR: number;
  32304. /** mag = nearest and min = nearest and mip = none */
  32305. static readonly TEXTURE_NEAREST_NEAREST: number;
  32306. /** mag = linear and min = nearest and mip = nearest */
  32307. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  32308. /** mag = linear and min = nearest and mip = linear */
  32309. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  32310. /** mag = linear and min = linear and mip = none */
  32311. static readonly TEXTURE_LINEAR_LINEAR: number;
  32312. /** mag = linear and min = nearest and mip = none */
  32313. static readonly TEXTURE_LINEAR_NEAREST: number;
  32314. /** Explicit coordinates mode */
  32315. static readonly TEXTURE_EXPLICIT_MODE: number;
  32316. /** Spherical coordinates mode */
  32317. static readonly TEXTURE_SPHERICAL_MODE: number;
  32318. /** Planar coordinates mode */
  32319. static readonly TEXTURE_PLANAR_MODE: number;
  32320. /** Cubic coordinates mode */
  32321. static readonly TEXTURE_CUBIC_MODE: number;
  32322. /** Projection coordinates mode */
  32323. static readonly TEXTURE_PROJECTION_MODE: number;
  32324. /** Skybox coordinates mode */
  32325. static readonly TEXTURE_SKYBOX_MODE: number;
  32326. /** Inverse Cubic coordinates mode */
  32327. static readonly TEXTURE_INVCUBIC_MODE: number;
  32328. /** Equirectangular coordinates mode */
  32329. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  32330. /** Equirectangular Fixed coordinates mode */
  32331. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  32332. /** Equirectangular Fixed Mirrored coordinates mode */
  32333. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  32334. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  32335. static readonly SCALEMODE_FLOOR: number;
  32336. /** Defines that texture rescaling will look for the nearest power of 2 size */
  32337. static readonly SCALEMODE_NEAREST: number;
  32338. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  32339. static readonly SCALEMODE_CEILING: number;
  32340. /**
  32341. * Returns the current npm package of the sdk
  32342. */
  32343. static readonly NpmPackage: string;
  32344. /**
  32345. * Returns the current version of the framework
  32346. */
  32347. static readonly Version: string;
  32348. /** Gets the list of created engines */
  32349. static readonly Instances: Engine[];
  32350. /**
  32351. * Gets the latest created engine
  32352. */
  32353. static readonly LastCreatedEngine: Nullable<Engine>;
  32354. /**
  32355. * Gets the latest created scene
  32356. */
  32357. static readonly LastCreatedScene: Nullable<Scene>;
  32358. /**
  32359. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  32360. * @param flag defines which part of the materials must be marked as dirty
  32361. * @param predicate defines a predicate used to filter which materials should be affected
  32362. */
  32363. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  32364. /**
  32365. * Method called to create the default loading screen.
  32366. * This can be overriden in your own app.
  32367. * @param canvas The rendering canvas element
  32368. * @returns The loading screen
  32369. */
  32370. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  32371. /**
  32372. * Method called to create the default rescale post process on each engine.
  32373. */
  32374. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  32375. /**
  32376. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  32377. **/
  32378. enableOfflineSupport: boolean;
  32379. /**
  32380. * Gets or sets a boolean to enable/disable checking manifest if IndexedDB support is enabled (js will always consider the database is up to date)
  32381. **/
  32382. disableManifestCheck: boolean;
  32383. /**
  32384. * Gets the list of created scenes
  32385. */
  32386. scenes: Scene[];
  32387. /**
  32388. * Event raised when a new scene is created
  32389. */
  32390. onNewSceneAddedObservable: Observable<Scene>;
  32391. /**
  32392. * Gets the list of created postprocesses
  32393. */
  32394. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  32395. /**
  32396. * Gets a boolean indicating if the pointer is currently locked
  32397. */
  32398. isPointerLock: boolean;
  32399. /**
  32400. * Observable event triggered each time the rendering canvas is resized
  32401. */
  32402. onResizeObservable: Observable<Engine>;
  32403. /**
  32404. * Observable event triggered each time the canvas loses focus
  32405. */
  32406. onCanvasBlurObservable: Observable<Engine>;
  32407. /**
  32408. * Observable event triggered each time the canvas gains focus
  32409. */
  32410. onCanvasFocusObservable: Observable<Engine>;
  32411. /**
  32412. * Observable event triggered each time the canvas receives pointerout event
  32413. */
  32414. onCanvasPointerOutObservable: Observable<PointerEvent>;
  32415. /**
  32416. * Observable raised when the engine begins a new frame
  32417. */
  32418. onBeginFrameObservable: Observable<Engine>;
  32419. /**
  32420. * If set, will be used to request the next animation frame for the render loop
  32421. */
  32422. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  32423. /**
  32424. * Observable raised when the engine ends the current frame
  32425. */
  32426. onEndFrameObservable: Observable<Engine>;
  32427. /**
  32428. * Observable raised when the engine is about to compile a shader
  32429. */
  32430. onBeforeShaderCompilationObservable: Observable<Engine>;
  32431. /**
  32432. * Observable raised when the engine has jsut compiled a shader
  32433. */
  32434. onAfterShaderCompilationObservable: Observable<Engine>;
  32435. /**
  32436. * Gets the audio engine
  32437. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  32438. * @ignorenaming
  32439. */
  32440. static audioEngine: IAudioEngine;
  32441. /**
  32442. * Default AudioEngine factory responsible of creating the Audio Engine.
  32443. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  32444. */
  32445. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  32446. /**
  32447. * Default offline support factory responsible of creating a tool used to store data locally.
  32448. * By default, this will create a Database object if the workload has been embedded.
  32449. */
  32450. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  32451. private _loadingScreen;
  32452. private _pointerLockRequested;
  32453. private _dummyFramebuffer;
  32454. private _rescalePostProcess;
  32455. /** @hidden */
  32456. protected _alphaMode: number;
  32457. /** @hidden */
  32458. protected _alphaEquation: number;
  32459. private _deterministicLockstep;
  32460. private _lockstepMaxSteps;
  32461. protected readonly _supportsHardwareTextureRescaling: boolean;
  32462. private _fps;
  32463. private _deltaTime;
  32464. /** @hidden */
  32465. _drawCalls: PerfCounter;
  32466. /**
  32467. * Turn this value on if you want to pause FPS computation when in background
  32468. */
  32469. disablePerformanceMonitorInBackground: boolean;
  32470. private _performanceMonitor;
  32471. /**
  32472. * Gets the performance monitor attached to this engine
  32473. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  32474. */
  32475. readonly performanceMonitor: PerformanceMonitor;
  32476. private _onFocus;
  32477. private _onBlur;
  32478. private _onCanvasPointerOut;
  32479. private _onCanvasBlur;
  32480. private _onCanvasFocus;
  32481. private _onFullscreenChange;
  32482. private _onPointerLockChange;
  32483. /**
  32484. * Gets the HTML element used to attach event listeners
  32485. * @returns a HTML element
  32486. */
  32487. getInputElement(): Nullable<HTMLElement>;
  32488. /**
  32489. * Creates a new engine
  32490. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  32491. * @param antialias defines enable antialiasing (default: false)
  32492. * @param options defines further options to be sent to the getContext() function
  32493. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  32494. */
  32495. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  32496. /**
  32497. * Gets current aspect ratio
  32498. * @param viewportOwner defines the camera to use to get the aspect ratio
  32499. * @param useScreen defines if screen size must be used (or the current render target if any)
  32500. * @returns a number defining the aspect ratio
  32501. */
  32502. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  32503. /**
  32504. * Gets current screen aspect ratio
  32505. * @returns a number defining the aspect ratio
  32506. */
  32507. getScreenAspectRatio(): number;
  32508. /**
  32509. * Gets host document
  32510. * @returns the host document object
  32511. */
  32512. getHostDocument(): Document;
  32513. /**
  32514. * Gets the client rect of the HTML canvas attached with the current webGL context
  32515. * @returns a client rectanglee
  32516. */
  32517. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  32518. /**
  32519. * Gets the client rect of the HTML element used for events
  32520. * @returns a client rectanglee
  32521. */
  32522. getInputElementClientRect(): Nullable<ClientRect>;
  32523. /**
  32524. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  32525. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  32526. * @returns true if engine is in deterministic lock step mode
  32527. */
  32528. isDeterministicLockStep(): boolean;
  32529. /**
  32530. * Gets the max steps when engine is running in deterministic lock step
  32531. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  32532. * @returns the max steps
  32533. */
  32534. getLockstepMaxSteps(): number;
  32535. /**
  32536. * Force the mipmap generation for the given render target texture
  32537. * @param texture defines the render target texture to use
  32538. */
  32539. generateMipMapsForCubemap(texture: InternalTexture): void;
  32540. /** States */
  32541. /**
  32542. * Set various states to the webGL context
  32543. * @param culling defines backface culling state
  32544. * @param zOffset defines the value to apply to zOffset (0 by default)
  32545. * @param force defines if states must be applied even if cache is up to date
  32546. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  32547. */
  32548. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  32549. /**
  32550. * Set the z offset to apply to current rendering
  32551. * @param value defines the offset to apply
  32552. */
  32553. setZOffset(value: number): void;
  32554. /**
  32555. * Gets the current value of the zOffset
  32556. * @returns the current zOffset state
  32557. */
  32558. getZOffset(): number;
  32559. /**
  32560. * Enable or disable depth buffering
  32561. * @param enable defines the state to set
  32562. */
  32563. setDepthBuffer(enable: boolean): void;
  32564. /**
  32565. * Gets a boolean indicating if depth writing is enabled
  32566. * @returns the current depth writing state
  32567. */
  32568. getDepthWrite(): boolean;
  32569. /**
  32570. * Enable or disable depth writing
  32571. * @param enable defines the state to set
  32572. */
  32573. setDepthWrite(enable: boolean): void;
  32574. /**
  32575. * Enable or disable color writing
  32576. * @param enable defines the state to set
  32577. */
  32578. setColorWrite(enable: boolean): void;
  32579. /**
  32580. * Gets a boolean indicating if color writing is enabled
  32581. * @returns the current color writing state
  32582. */
  32583. getColorWrite(): boolean;
  32584. /**
  32585. * Sets alpha constants used by some alpha blending modes
  32586. * @param r defines the red component
  32587. * @param g defines the green component
  32588. * @param b defines the blue component
  32589. * @param a defines the alpha component
  32590. */
  32591. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  32592. /**
  32593. * Sets the current alpha mode
  32594. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  32595. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  32596. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32597. */
  32598. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  32599. /**
  32600. * Gets the current alpha mode
  32601. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32602. * @returns the current alpha mode
  32603. */
  32604. getAlphaMode(): number;
  32605. /**
  32606. * Sets the current alpha equation
  32607. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  32608. */
  32609. setAlphaEquation(equation: number): void;
  32610. /**
  32611. * Gets the current alpha equation.
  32612. * @returns the current alpha equation
  32613. */
  32614. getAlphaEquation(): number;
  32615. /**
  32616. * Gets a boolean indicating if stencil buffer is enabled
  32617. * @returns the current stencil buffer state
  32618. */
  32619. getStencilBuffer(): boolean;
  32620. /**
  32621. * Enable or disable the stencil buffer
  32622. * @param enable defines if the stencil buffer must be enabled or disabled
  32623. */
  32624. setStencilBuffer(enable: boolean): void;
  32625. /**
  32626. * Gets the current stencil mask
  32627. * @returns a number defining the new stencil mask to use
  32628. */
  32629. getStencilMask(): number;
  32630. /**
  32631. * Sets the current stencil mask
  32632. * @param mask defines the new stencil mask to use
  32633. */
  32634. setStencilMask(mask: number): void;
  32635. /**
  32636. * Gets the current stencil function
  32637. * @returns a number defining the stencil function to use
  32638. */
  32639. getStencilFunction(): number;
  32640. /**
  32641. * Gets the current stencil reference value
  32642. * @returns a number defining the stencil reference value to use
  32643. */
  32644. getStencilFunctionReference(): number;
  32645. /**
  32646. * Gets the current stencil mask
  32647. * @returns a number defining the stencil mask to use
  32648. */
  32649. getStencilFunctionMask(): number;
  32650. /**
  32651. * Sets the current stencil function
  32652. * @param stencilFunc defines the new stencil function to use
  32653. */
  32654. setStencilFunction(stencilFunc: number): void;
  32655. /**
  32656. * Sets the current stencil reference
  32657. * @param reference defines the new stencil reference to use
  32658. */
  32659. setStencilFunctionReference(reference: number): void;
  32660. /**
  32661. * Sets the current stencil mask
  32662. * @param mask defines the new stencil mask to use
  32663. */
  32664. setStencilFunctionMask(mask: number): void;
  32665. /**
  32666. * Gets the current stencil operation when stencil fails
  32667. * @returns a number defining stencil operation to use when stencil fails
  32668. */
  32669. getStencilOperationFail(): number;
  32670. /**
  32671. * Gets the current stencil operation when depth fails
  32672. * @returns a number defining stencil operation to use when depth fails
  32673. */
  32674. getStencilOperationDepthFail(): number;
  32675. /**
  32676. * Gets the current stencil operation when stencil passes
  32677. * @returns a number defining stencil operation to use when stencil passes
  32678. */
  32679. getStencilOperationPass(): number;
  32680. /**
  32681. * Sets the stencil operation to use when stencil fails
  32682. * @param operation defines the stencil operation to use when stencil fails
  32683. */
  32684. setStencilOperationFail(operation: number): void;
  32685. /**
  32686. * Sets the stencil operation to use when depth fails
  32687. * @param operation defines the stencil operation to use when depth fails
  32688. */
  32689. setStencilOperationDepthFail(operation: number): void;
  32690. /**
  32691. * Sets the stencil operation to use when stencil passes
  32692. * @param operation defines the stencil operation to use when stencil passes
  32693. */
  32694. setStencilOperationPass(operation: number): void;
  32695. /**
  32696. * Sets a boolean indicating if the dithering state is enabled or disabled
  32697. * @param value defines the dithering state
  32698. */
  32699. setDitheringState(value: boolean): void;
  32700. /**
  32701. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  32702. * @param value defines the rasterizer state
  32703. */
  32704. setRasterizerState(value: boolean): void;
  32705. /**
  32706. * Gets the current depth function
  32707. * @returns a number defining the depth function
  32708. */
  32709. getDepthFunction(): Nullable<number>;
  32710. /**
  32711. * Sets the current depth function
  32712. * @param depthFunc defines the function to use
  32713. */
  32714. setDepthFunction(depthFunc: number): void;
  32715. /**
  32716. * Sets the current depth function to GREATER
  32717. */
  32718. setDepthFunctionToGreater(): void;
  32719. /**
  32720. * Sets the current depth function to GEQUAL
  32721. */
  32722. setDepthFunctionToGreaterOrEqual(): void;
  32723. /**
  32724. * Sets the current depth function to LESS
  32725. */
  32726. setDepthFunctionToLess(): void;
  32727. /**
  32728. * Sets the current depth function to LEQUAL
  32729. */
  32730. setDepthFunctionToLessOrEqual(): void;
  32731. private _cachedStencilBuffer;
  32732. private _cachedStencilFunction;
  32733. private _cachedStencilMask;
  32734. private _cachedStencilOperationPass;
  32735. private _cachedStencilOperationFail;
  32736. private _cachedStencilOperationDepthFail;
  32737. private _cachedStencilReference;
  32738. /**
  32739. * Caches the the state of the stencil buffer
  32740. */
  32741. cacheStencilState(): void;
  32742. /**
  32743. * Restores the state of the stencil buffer
  32744. */
  32745. restoreStencilState(): void;
  32746. /**
  32747. * Directly set the WebGL Viewport
  32748. * @param x defines the x coordinate of the viewport (in screen space)
  32749. * @param y defines the y coordinate of the viewport (in screen space)
  32750. * @param width defines the width of the viewport (in screen space)
  32751. * @param height defines the height of the viewport (in screen space)
  32752. * @return the current viewport Object (if any) that is being replaced by this call. You can restore this viewport later on to go back to the original state
  32753. */
  32754. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  32755. /**
  32756. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  32757. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  32758. * @param y defines the y-coordinate of the corner of the clear rectangle
  32759. * @param width defines the width of the clear rectangle
  32760. * @param height defines the height of the clear rectangle
  32761. * @param clearColor defines the clear color
  32762. */
  32763. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  32764. /**
  32765. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  32766. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  32767. * @param y defines the y-coordinate of the corner of the clear rectangle
  32768. * @param width defines the width of the clear rectangle
  32769. * @param height defines the height of the clear rectangle
  32770. */
  32771. enableScissor(x: number, y: number, width: number, height: number): void;
  32772. /**
  32773. * Disable previously set scissor test rectangle
  32774. */
  32775. disableScissor(): void;
  32776. protected _reportDrawCall(): void;
  32777. /**
  32778. * Initializes a webVR display and starts listening to display change events
  32779. * The onVRDisplayChangedObservable will be notified upon these changes
  32780. * @returns The onVRDisplayChangedObservable
  32781. */
  32782. initWebVR(): Observable<IDisplayChangedEventArgs>;
  32783. /** @hidden */
  32784. _prepareVRComponent(): void;
  32785. /** @hidden */
  32786. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  32787. /** @hidden */
  32788. _submitVRFrame(): void;
  32789. /**
  32790. * Call this function to leave webVR mode
  32791. * Will do nothing if webVR is not supported or if there is no webVR device
  32792. * @see http://doc.babylonjs.com/how_to/webvr_camera
  32793. */
  32794. disableVR(): void;
  32795. /**
  32796. * Gets a boolean indicating that the system is in VR mode and is presenting
  32797. * @returns true if VR mode is engaged
  32798. */
  32799. isVRPresenting(): boolean;
  32800. /** @hidden */
  32801. _requestVRFrame(): void;
  32802. /** @hidden */
  32803. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  32804. /**
  32805. * Gets the source code of the vertex shader associated with a specific webGL program
  32806. * @param program defines the program to use
  32807. * @returns a string containing the source code of the vertex shader associated with the program
  32808. */
  32809. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  32810. /**
  32811. * Gets the source code of the fragment shader associated with a specific webGL program
  32812. * @param program defines the program to use
  32813. * @returns a string containing the source code of the fragment shader associated with the program
  32814. */
  32815. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  32816. /**
  32817. * Reads pixels from the current frame buffer. Please note that this function can be slow
  32818. * @param x defines the x coordinate of the rectangle where pixels must be read
  32819. * @param y defines the y coordinate of the rectangle where pixels must be read
  32820. * @param width defines the width of the rectangle where pixels must be read
  32821. * @param height defines the height of the rectangle where pixels must be read
  32822. * @returns a Uint8Array containing RGBA colors
  32823. */
  32824. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  32825. /**
  32826. * Sets a depth stencil texture from a render target to the according uniform.
  32827. * @param channel The texture channel
  32828. * @param uniform The uniform to set
  32829. * @param texture The render target texture containing the depth stencil texture to apply
  32830. */
  32831. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  32832. /**
  32833. * Sets a texture to the webGL context from a postprocess
  32834. * @param channel defines the channel to use
  32835. * @param postProcess defines the source postprocess
  32836. */
  32837. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  32838. /**
  32839. * Binds the output of the passed in post process to the texture channel specified
  32840. * @param channel The channel the texture should be bound to
  32841. * @param postProcess The post process which's output should be bound
  32842. */
  32843. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  32844. /** @hidden */
  32845. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  32846. protected _rebuildBuffers(): void;
  32847. /** @hidden */
  32848. _renderFrame(): void;
  32849. _renderLoop(): void;
  32850. /** @hidden */
  32851. _renderViews(): boolean;
  32852. /**
  32853. * Toggle full screen mode
  32854. * @param requestPointerLock defines if a pointer lock should be requested from the user
  32855. */
  32856. switchFullscreen(requestPointerLock: boolean): void;
  32857. /**
  32858. * Enters full screen mode
  32859. * @param requestPointerLock defines if a pointer lock should be requested from the user
  32860. */
  32861. enterFullscreen(requestPointerLock: boolean): void;
  32862. /**
  32863. * Exits full screen mode
  32864. */
  32865. exitFullscreen(): void;
  32866. /**
  32867. * Enters Pointerlock mode
  32868. */
  32869. enterPointerlock(): void;
  32870. /**
  32871. * Exits Pointerlock mode
  32872. */
  32873. exitPointerlock(): void;
  32874. /**
  32875. * Begin a new frame
  32876. */
  32877. beginFrame(): void;
  32878. /**
  32879. * Enf the current frame
  32880. */
  32881. endFrame(): void;
  32882. resize(): void;
  32883. /**
  32884. * Set the compressed texture format to use, based on the formats you have, and the formats
  32885. * supported by the hardware / browser.
  32886. *
  32887. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  32888. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  32889. * to API arguments needed to compressed textures. This puts the burden on the container
  32890. * generator to house the arcane code for determining these for current & future formats.
  32891. *
  32892. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  32893. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  32894. *
  32895. * Note: The result of this call is not taken into account when a texture is base64.
  32896. *
  32897. * @param formatsAvailable defines the list of those format families you have created
  32898. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  32899. *
  32900. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  32901. * @returns The extension selected.
  32902. */
  32903. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  32904. /**
  32905. * Force a specific size of the canvas
  32906. * @param width defines the new canvas' width
  32907. * @param height defines the new canvas' height
  32908. */
  32909. setSize(width: number, height: number): void;
  32910. /**
  32911. * Updates a dynamic vertex buffer.
  32912. * @param vertexBuffer the vertex buffer to update
  32913. * @param data the data used to update the vertex buffer
  32914. * @param byteOffset the byte offset of the data
  32915. * @param byteLength the byte length of the data
  32916. */
  32917. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  32918. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  32919. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  32920. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  32921. _releaseTexture(texture: InternalTexture): void;
  32922. /**
  32923. * @hidden
  32924. * Rescales a texture
  32925. * @param source input texutre
  32926. * @param destination destination texture
  32927. * @param scene scene to use to render the resize
  32928. * @param internalFormat format to use when resizing
  32929. * @param onComplete callback to be called when resize has completed
  32930. */
  32931. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  32932. /**
  32933. * Gets the current framerate
  32934. * @returns a number representing the framerate
  32935. */
  32936. getFps(): number;
  32937. /**
  32938. * Gets the time spent between current and previous frame
  32939. * @returns a number representing the delta time in ms
  32940. */
  32941. getDeltaTime(): number;
  32942. private _measureFps;
  32943. /** @hidden */
  32944. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  32945. /**
  32946. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  32947. * @param renderTarget The render target to set the frame buffer for
  32948. */
  32949. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  32950. /**
  32951. * Update a dynamic index buffer
  32952. * @param indexBuffer defines the target index buffer
  32953. * @param indices defines the data to update
  32954. * @param offset defines the offset in the target index buffer where update should start
  32955. */
  32956. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  32957. /**
  32958. * Updates the sample count of a render target texture
  32959. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  32960. * @param texture defines the texture to update
  32961. * @param samples defines the sample count to set
  32962. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  32963. */
  32964. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  32965. /**
  32966. * Updates a depth texture Comparison Mode and Function.
  32967. * If the comparison Function is equal to 0, the mode will be set to none.
  32968. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  32969. * @param texture The texture to set the comparison function for
  32970. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  32971. */
  32972. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  32973. /**
  32974. * Creates a webGL buffer to use with instanciation
  32975. * @param capacity defines the size of the buffer
  32976. * @returns the webGL buffer
  32977. */
  32978. createInstancesBuffer(capacity: number): DataBuffer;
  32979. /**
  32980. * Delete a webGL buffer used with instanciation
  32981. * @param buffer defines the webGL buffer to delete
  32982. */
  32983. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  32984. /** @hidden */
  32985. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  32986. dispose(): void;
  32987. private _disableTouchAction;
  32988. /**
  32989. * Display the loading screen
  32990. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32991. */
  32992. displayLoadingUI(): void;
  32993. /**
  32994. * Hide the loading screen
  32995. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  32996. */
  32997. hideLoadingUI(): void;
  32998. /**
  32999. * Gets the current loading screen object
  33000. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33001. */
  33002. /**
  33003. * Sets the current loading screen object
  33004. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33005. */
  33006. loadingScreen: ILoadingScreen;
  33007. /**
  33008. * Sets the current loading screen text
  33009. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33010. */
  33011. loadingUIText: string;
  33012. /**
  33013. * Sets the current loading screen background color
  33014. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33015. */
  33016. loadingUIBackgroundColor: string;
  33017. /** Pointerlock and fullscreen */
  33018. /**
  33019. * Ask the browser to promote the current element to pointerlock mode
  33020. * @param element defines the DOM element to promote
  33021. */
  33022. static _RequestPointerlock(element: HTMLElement): void;
  33023. /**
  33024. * Asks the browser to exit pointerlock mode
  33025. */
  33026. static _ExitPointerlock(): void;
  33027. /**
  33028. * Ask the browser to promote the current element to fullscreen rendering mode
  33029. * @param element defines the DOM element to promote
  33030. */
  33031. static _RequestFullscreen(element: HTMLElement): void;
  33032. /**
  33033. * Asks the browser to exit fullscreen mode
  33034. */
  33035. static _ExitFullscreen(): void;
  33036. }
  33037. }
  33038. declare module "babylonjs/Engines/engineStore" {
  33039. import { Nullable } from "babylonjs/types";
  33040. import { Engine } from "babylonjs/Engines/engine";
  33041. import { Scene } from "babylonjs/scene";
  33042. /**
  33043. * The engine store class is responsible to hold all the instances of Engine and Scene created
  33044. * during the life time of the application.
  33045. */
  33046. export class EngineStore {
  33047. /** Gets the list of created engines */
  33048. static Instances: import("babylonjs/Engines/engine").Engine[];
  33049. /** @hidden */
  33050. static _LastCreatedScene: Nullable<Scene>;
  33051. /**
  33052. * Gets the latest created engine
  33053. */
  33054. static readonly LastCreatedEngine: Nullable<Engine>;
  33055. /**
  33056. * Gets the latest created scene
  33057. */
  33058. static readonly LastCreatedScene: Nullable<Scene>;
  33059. /**
  33060. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  33061. * @ignorenaming
  33062. */
  33063. static UseFallbackTexture: boolean;
  33064. /**
  33065. * Texture content used if a texture cannot loaded
  33066. * @ignorenaming
  33067. */
  33068. static FallbackTexture: string;
  33069. }
  33070. }
  33071. declare module "babylonjs/Misc/promise" {
  33072. /**
  33073. * Helper class that provides a small promise polyfill
  33074. */
  33075. export class PromisePolyfill {
  33076. /**
  33077. * Static function used to check if the polyfill is required
  33078. * If this is the case then the function will inject the polyfill to window.Promise
  33079. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  33080. */
  33081. static Apply(force?: boolean): void;
  33082. }
  33083. }
  33084. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  33085. /**
  33086. * Interface for screenshot methods with describe argument called `size` as object with options
  33087. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  33088. */
  33089. export interface IScreenshotSize {
  33090. /**
  33091. * number in pixels for canvas height
  33092. */
  33093. height?: number;
  33094. /**
  33095. * multiplier allowing render at a higher or lower resolution
  33096. * If value is defined then height and width will be ignored and taken from camera
  33097. */
  33098. precision?: number;
  33099. /**
  33100. * number in pixels for canvas width
  33101. */
  33102. width?: number;
  33103. }
  33104. }
  33105. declare module "babylonjs/Misc/tools" {
  33106. import { Nullable, float } from "babylonjs/types";
  33107. import { DomManagement } from "babylonjs/Misc/domManagement";
  33108. import { WebRequest } from "babylonjs/Misc/webRequest";
  33109. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  33110. import { ReadFileError } from "babylonjs/Misc/fileTools";
  33111. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  33112. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  33113. import { Camera } from "babylonjs/Cameras/camera";
  33114. import { Engine } from "babylonjs/Engines/engine";
  33115. interface IColor4Like {
  33116. r: float;
  33117. g: float;
  33118. b: float;
  33119. a: float;
  33120. }
  33121. /**
  33122. * Class containing a set of static utilities functions
  33123. */
  33124. export class Tools {
  33125. /**
  33126. * Gets or sets the base URL to use to load assets
  33127. */
  33128. static BaseUrl: string;
  33129. /**
  33130. * Enable/Disable Custom HTTP Request Headers globally.
  33131. * default = false
  33132. * @see CustomRequestHeaders
  33133. */
  33134. static UseCustomRequestHeaders: boolean;
  33135. /**
  33136. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  33137. * i.e. when loading files, where the server/service expects an Authorization header
  33138. */
  33139. static CustomRequestHeaders: {
  33140. [key: string]: string;
  33141. };
  33142. /**
  33143. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  33144. */
  33145. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  33146. /**
  33147. * Default behaviour for cors in the application.
  33148. * It can be a string if the expected behavior is identical in the entire app.
  33149. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  33150. */
  33151. static CorsBehavior: string | ((url: string | string[]) => string);
  33152. /**
  33153. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  33154. * @ignorenaming
  33155. */
  33156. static UseFallbackTexture: boolean;
  33157. /**
  33158. * Use this object to register external classes like custom textures or material
  33159. * to allow the laoders to instantiate them
  33160. */
  33161. static RegisteredExternalClasses: {
  33162. [key: string]: Object;
  33163. };
  33164. /**
  33165. * Texture content used if a texture cannot loaded
  33166. * @ignorenaming
  33167. */
  33168. static fallbackTexture: string;
  33169. /**
  33170. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  33171. * @param u defines the coordinate on X axis
  33172. * @param v defines the coordinate on Y axis
  33173. * @param width defines the width of the source data
  33174. * @param height defines the height of the source data
  33175. * @param pixels defines the source byte array
  33176. * @param color defines the output color
  33177. */
  33178. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  33179. /**
  33180. * Interpolates between a and b via alpha
  33181. * @param a The lower value (returned when alpha = 0)
  33182. * @param b The upper value (returned when alpha = 1)
  33183. * @param alpha The interpolation-factor
  33184. * @return The mixed value
  33185. */
  33186. static Mix(a: number, b: number, alpha: number): number;
  33187. /**
  33188. * Tries to instantiate a new object from a given class name
  33189. * @param className defines the class name to instantiate
  33190. * @returns the new object or null if the system was not able to do the instantiation
  33191. */
  33192. static Instantiate(className: string): any;
  33193. /**
  33194. * Provides a slice function that will work even on IE
  33195. * @param data defines the array to slice
  33196. * @param start defines the start of the data (optional)
  33197. * @param end defines the end of the data (optional)
  33198. * @returns the new sliced array
  33199. */
  33200. static Slice<T>(data: T, start?: number, end?: number): T;
  33201. /**
  33202. * Polyfill for setImmediate
  33203. * @param action defines the action to execute after the current execution block
  33204. */
  33205. static SetImmediate(action: () => void): void;
  33206. /**
  33207. * Function indicating if a number is an exponent of 2
  33208. * @param value defines the value to test
  33209. * @returns true if the value is an exponent of 2
  33210. */
  33211. static IsExponentOfTwo(value: number): boolean;
  33212. private static _tmpFloatArray;
  33213. /**
  33214. * Returns the nearest 32-bit single precision float representation of a Number
  33215. * @param value A Number. If the parameter is of a different type, it will get converted
  33216. * to a number or to NaN if it cannot be converted
  33217. * @returns number
  33218. */
  33219. static FloatRound(value: number): number;
  33220. /**
  33221. * Extracts the filename from a path
  33222. * @param path defines the path to use
  33223. * @returns the filename
  33224. */
  33225. static GetFilename(path: string): string;
  33226. /**
  33227. * Extracts the "folder" part of a path (everything before the filename).
  33228. * @param uri The URI to extract the info from
  33229. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  33230. * @returns The "folder" part of the path
  33231. */
  33232. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  33233. /**
  33234. * Extracts text content from a DOM element hierarchy
  33235. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  33236. */
  33237. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  33238. /**
  33239. * Convert an angle in radians to degrees
  33240. * @param angle defines the angle to convert
  33241. * @returns the angle in degrees
  33242. */
  33243. static ToDegrees(angle: number): number;
  33244. /**
  33245. * Convert an angle in degrees to radians
  33246. * @param angle defines the angle to convert
  33247. * @returns the angle in radians
  33248. */
  33249. static ToRadians(angle: number): number;
  33250. /**
  33251. * Returns an array if obj is not an array
  33252. * @param obj defines the object to evaluate as an array
  33253. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  33254. * @returns either obj directly if obj is an array or a new array containing obj
  33255. */
  33256. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  33257. /**
  33258. * Gets the pointer prefix to use
  33259. * @returns "pointer" if touch is enabled. Else returns "mouse"
  33260. */
  33261. static GetPointerPrefix(): string;
  33262. /**
  33263. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  33264. * @param url define the url we are trying
  33265. * @param element define the dom element where to configure the cors policy
  33266. */
  33267. static SetCorsBehavior(url: string | string[], element: {
  33268. crossOrigin: string | null;
  33269. }): void;
  33270. /**
  33271. * Removes unwanted characters from an url
  33272. * @param url defines the url to clean
  33273. * @returns the cleaned url
  33274. */
  33275. static CleanUrl(url: string): string;
  33276. /**
  33277. * Gets or sets a function used to pre-process url before using them to load assets
  33278. */
  33279. static PreprocessUrl: (url: string) => string;
  33280. /**
  33281. * Loads an image as an HTMLImageElement.
  33282. * @param input url string, ArrayBuffer, or Blob to load
  33283. * @param onLoad callback called when the image successfully loads
  33284. * @param onError callback called when the image fails to load
  33285. * @param offlineProvider offline provider for caching
  33286. * @param mimeType optional mime type
  33287. * @returns the HTMLImageElement of the loaded image
  33288. */
  33289. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  33290. /**
  33291. * Loads a file from a url
  33292. * @param url url string, ArrayBuffer, or Blob to load
  33293. * @param onSuccess callback called when the file successfully loads
  33294. * @param onProgress callback called while file is loading (if the server supports this mode)
  33295. * @param offlineProvider defines the offline provider for caching
  33296. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  33297. * @param onError callback called when the file fails to load
  33298. * @returns a file request object
  33299. */
  33300. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: any) => void): IFileRequest;
  33301. /**
  33302. * Loads a file from a url
  33303. * @param url the file url to load
  33304. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  33305. */
  33306. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  33307. /**
  33308. * Load a script (identified by an url). When the url returns, the
  33309. * content of this file is added into a new script element, attached to the DOM (body element)
  33310. * @param scriptUrl defines the url of the script to laod
  33311. * @param onSuccess defines the callback called when the script is loaded
  33312. * @param onError defines the callback to call if an error occurs
  33313. * @param scriptId defines the id of the script element
  33314. */
  33315. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  33316. /**
  33317. * Load an asynchronous script (identified by an url). When the url returns, the
  33318. * content of this file is added into a new script element, attached to the DOM (body element)
  33319. * @param scriptUrl defines the url of the script to laod
  33320. * @param scriptId defines the id of the script element
  33321. * @returns a promise request object
  33322. */
  33323. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  33324. /**
  33325. * Loads a file from a blob
  33326. * @param fileToLoad defines the blob to use
  33327. * @param callback defines the callback to call when data is loaded
  33328. * @param progressCallback defines the callback to call during loading process
  33329. * @returns a file request object
  33330. */
  33331. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  33332. /**
  33333. * Reads a file from a File object
  33334. * @param file defines the file to load
  33335. * @param onSuccess defines the callback to call when data is loaded
  33336. * @param onProgress defines the callback to call during loading process
  33337. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  33338. * @param onError defines the callback to call when an error occurs
  33339. * @returns a file request object
  33340. */
  33341. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  33342. /**
  33343. * Creates a data url from a given string content
  33344. * @param content defines the content to convert
  33345. * @returns the new data url link
  33346. */
  33347. static FileAsURL(content: string): string;
  33348. /**
  33349. * Format the given number to a specific decimal format
  33350. * @param value defines the number to format
  33351. * @param decimals defines the number of decimals to use
  33352. * @returns the formatted string
  33353. */
  33354. static Format(value: number, decimals?: number): string;
  33355. /**
  33356. * Tries to copy an object by duplicating every property
  33357. * @param source defines the source object
  33358. * @param destination defines the target object
  33359. * @param doNotCopyList defines a list of properties to avoid
  33360. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  33361. */
  33362. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  33363. /**
  33364. * Gets a boolean indicating if the given object has no own property
  33365. * @param obj defines the object to test
  33366. * @returns true if object has no own property
  33367. */
  33368. static IsEmpty(obj: any): boolean;
  33369. /**
  33370. * Function used to register events at window level
  33371. * @param windowElement defines the Window object to use
  33372. * @param events defines the events to register
  33373. */
  33374. static RegisterTopRootEvents(windowElement: Window, events: {
  33375. name: string;
  33376. handler: Nullable<(e: FocusEvent) => any>;
  33377. }[]): void;
  33378. /**
  33379. * Function used to unregister events from window level
  33380. * @param windowElement defines the Window object to use
  33381. * @param events defines the events to unregister
  33382. */
  33383. static UnregisterTopRootEvents(windowElement: Window, events: {
  33384. name: string;
  33385. handler: Nullable<(e: FocusEvent) => any>;
  33386. }[]): void;
  33387. /**
  33388. * @ignore
  33389. */
  33390. static _ScreenshotCanvas: HTMLCanvasElement;
  33391. /**
  33392. * Dumps the current bound framebuffer
  33393. * @param width defines the rendering width
  33394. * @param height defines the rendering height
  33395. * @param engine defines the hosting engine
  33396. * @param successCallback defines the callback triggered once the data are available
  33397. * @param mimeType defines the mime type of the result
  33398. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  33399. */
  33400. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  33401. /**
  33402. * Converts the canvas data to blob.
  33403. * This acts as a polyfill for browsers not supporting the to blob function.
  33404. * @param canvas Defines the canvas to extract the data from
  33405. * @param successCallback Defines the callback triggered once the data are available
  33406. * @param mimeType Defines the mime type of the result
  33407. */
  33408. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  33409. /**
  33410. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  33411. * @param successCallback defines the callback triggered once the data are available
  33412. * @param mimeType defines the mime type of the result
  33413. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  33414. */
  33415. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  33416. /**
  33417. * Downloads a blob in the browser
  33418. * @param blob defines the blob to download
  33419. * @param fileName defines the name of the downloaded file
  33420. */
  33421. static Download(blob: Blob, fileName: string): void;
  33422. /**
  33423. * Captures a screenshot of the current rendering
  33424. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33425. * @param engine defines the rendering engine
  33426. * @param camera defines the source camera
  33427. * @param size This parameter can be set to a single number or to an object with the
  33428. * following (optional) properties: precision, width, height. If a single number is passed,
  33429. * it will be used for both width and height. If an object is passed, the screenshot size
  33430. * will be derived from the parameters. The precision property is a multiplier allowing
  33431. * rendering at a higher or lower resolution
  33432. * @param successCallback defines the callback receives a single parameter which contains the
  33433. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  33434. * src parameter of an <img> to display it
  33435. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  33436. * Check your browser for supported MIME types
  33437. */
  33438. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  33439. /**
  33440. * Captures a screenshot of the current rendering
  33441. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33442. * @param engine defines the rendering engine
  33443. * @param camera defines the source camera
  33444. * @param size This parameter can be set to a single number or to an object with the
  33445. * following (optional) properties: precision, width, height. If a single number is passed,
  33446. * it will be used for both width and height. If an object is passed, the screenshot size
  33447. * will be derived from the parameters. The precision property is a multiplier allowing
  33448. * rendering at a higher or lower resolution
  33449. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  33450. * Check your browser for supported MIME types
  33451. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  33452. * to the src parameter of an <img> to display it
  33453. */
  33454. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  33455. /**
  33456. * Generates an image screenshot from the specified camera.
  33457. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33458. * @param engine The engine to use for rendering
  33459. * @param camera The camera to use for rendering
  33460. * @param size This parameter can be set to a single number or to an object with the
  33461. * following (optional) properties: precision, width, height. If a single number is passed,
  33462. * it will be used for both width and height. If an object is passed, the screenshot size
  33463. * will be derived from the parameters. The precision property is a multiplier allowing
  33464. * rendering at a higher or lower resolution
  33465. * @param successCallback The callback receives a single parameter which contains the
  33466. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  33467. * src parameter of an <img> to display it
  33468. * @param mimeType The MIME type of the screenshot image (default: image/png).
  33469. * Check your browser for supported MIME types
  33470. * @param samples Texture samples (default: 1)
  33471. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  33472. * @param fileName A name for for the downloaded file.
  33473. */
  33474. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  33475. /**
  33476. * Generates an image screenshot from the specified camera.
  33477. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33478. * @param engine The engine to use for rendering
  33479. * @param camera The camera to use for rendering
  33480. * @param size This parameter can be set to a single number or to an object with the
  33481. * following (optional) properties: precision, width, height. If a single number is passed,
  33482. * it will be used for both width and height. If an object is passed, the screenshot size
  33483. * will be derived from the parameters. The precision property is a multiplier allowing
  33484. * rendering at a higher or lower resolution
  33485. * @param mimeType The MIME type of the screenshot image (default: image/png).
  33486. * Check your browser for supported MIME types
  33487. * @param samples Texture samples (default: 1)
  33488. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  33489. * @param fileName A name for for the downloaded file.
  33490. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  33491. * to the src parameter of an <img> to display it
  33492. */
  33493. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  33494. /**
  33495. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  33496. * Be aware Math.random() could cause collisions, but:
  33497. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  33498. * @returns a pseudo random id
  33499. */
  33500. static RandomId(): string;
  33501. /**
  33502. * Test if the given uri is a base64 string
  33503. * @param uri The uri to test
  33504. * @return True if the uri is a base64 string or false otherwise
  33505. */
  33506. static IsBase64(uri: string): boolean;
  33507. /**
  33508. * Decode the given base64 uri.
  33509. * @param uri The uri to decode
  33510. * @return The decoded base64 data.
  33511. */
  33512. static DecodeBase64(uri: string): ArrayBuffer;
  33513. /**
  33514. * Gets the absolute url.
  33515. * @param url the input url
  33516. * @return the absolute url
  33517. */
  33518. static GetAbsoluteUrl(url: string): string;
  33519. /**
  33520. * No log
  33521. */
  33522. static readonly NoneLogLevel: number;
  33523. /**
  33524. * Only message logs
  33525. */
  33526. static readonly MessageLogLevel: number;
  33527. /**
  33528. * Only warning logs
  33529. */
  33530. static readonly WarningLogLevel: number;
  33531. /**
  33532. * Only error logs
  33533. */
  33534. static readonly ErrorLogLevel: number;
  33535. /**
  33536. * All logs
  33537. */
  33538. static readonly AllLogLevel: number;
  33539. /**
  33540. * Gets a value indicating the number of loading errors
  33541. * @ignorenaming
  33542. */
  33543. static readonly errorsCount: number;
  33544. /**
  33545. * Callback called when a new log is added
  33546. */
  33547. static OnNewCacheEntry: (entry: string) => void;
  33548. /**
  33549. * Log a message to the console
  33550. * @param message defines the message to log
  33551. */
  33552. static Log(message: string): void;
  33553. /**
  33554. * Write a warning message to the console
  33555. * @param message defines the message to log
  33556. */
  33557. static Warn(message: string): void;
  33558. /**
  33559. * Write an error message to the console
  33560. * @param message defines the message to log
  33561. */
  33562. static Error(message: string): void;
  33563. /**
  33564. * Gets current log cache (list of logs)
  33565. */
  33566. static readonly LogCache: string;
  33567. /**
  33568. * Clears the log cache
  33569. */
  33570. static ClearLogCache(): void;
  33571. /**
  33572. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  33573. */
  33574. static LogLevels: number;
  33575. /**
  33576. * Checks if the window object exists
  33577. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  33578. */
  33579. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  33580. /**
  33581. * No performance log
  33582. */
  33583. static readonly PerformanceNoneLogLevel: number;
  33584. /**
  33585. * Use user marks to log performance
  33586. */
  33587. static readonly PerformanceUserMarkLogLevel: number;
  33588. /**
  33589. * Log performance to the console
  33590. */
  33591. static readonly PerformanceConsoleLogLevel: number;
  33592. private static _performance;
  33593. /**
  33594. * Sets the current performance log level
  33595. */
  33596. static PerformanceLogLevel: number;
  33597. private static _StartPerformanceCounterDisabled;
  33598. private static _EndPerformanceCounterDisabled;
  33599. private static _StartUserMark;
  33600. private static _EndUserMark;
  33601. private static _StartPerformanceConsole;
  33602. private static _EndPerformanceConsole;
  33603. /**
  33604. * Starts a performance counter
  33605. */
  33606. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33607. /**
  33608. * Ends a specific performance coutner
  33609. */
  33610. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33611. /**
  33612. * Gets either window.performance.now() if supported or Date.now() else
  33613. */
  33614. static readonly Now: number;
  33615. /**
  33616. * This method will return the name of the class used to create the instance of the given object.
  33617. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  33618. * @param object the object to get the class name from
  33619. * @param isType defines if the object is actually a type
  33620. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  33621. */
  33622. static GetClassName(object: any, isType?: boolean): string;
  33623. /**
  33624. * Gets the first element of an array satisfying a given predicate
  33625. * @param array defines the array to browse
  33626. * @param predicate defines the predicate to use
  33627. * @returns null if not found or the element
  33628. */
  33629. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  33630. /**
  33631. * This method will return the name of the full name of the class, including its owning module (if any).
  33632. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator or implementing a method getClassName():string (in which case the module won't be specified).
  33633. * @param object the object to get the class name from
  33634. * @param isType defines if the object is actually a type
  33635. * @return a string that can have two forms: "moduleName.className" if module was specified when the class' Name was registered or "className" if there was not module specified.
  33636. * @ignorenaming
  33637. */
  33638. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  33639. /**
  33640. * Returns a promise that resolves after the given amount of time.
  33641. * @param delay Number of milliseconds to delay
  33642. * @returns Promise that resolves after the given amount of time
  33643. */
  33644. static DelayAsync(delay: number): Promise<void>;
  33645. }
  33646. /**
  33647. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  33648. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  33649. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  33650. * @param name The name of the class, case should be preserved
  33651. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  33652. */
  33653. export function className(name: string, module?: string): (target: Object) => void;
  33654. /**
  33655. * An implementation of a loop for asynchronous functions.
  33656. */
  33657. export class AsyncLoop {
  33658. /**
  33659. * Defines the number of iterations for the loop
  33660. */
  33661. iterations: number;
  33662. /**
  33663. * Defines the current index of the loop.
  33664. */
  33665. index: number;
  33666. private _done;
  33667. private _fn;
  33668. private _successCallback;
  33669. /**
  33670. * Constructor.
  33671. * @param iterations the number of iterations.
  33672. * @param func the function to run each iteration
  33673. * @param successCallback the callback that will be called upon succesful execution
  33674. * @param offset starting offset.
  33675. */
  33676. constructor(
  33677. /**
  33678. * Defines the number of iterations for the loop
  33679. */
  33680. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  33681. /**
  33682. * Execute the next iteration. Must be called after the last iteration was finished.
  33683. */
  33684. executeNext(): void;
  33685. /**
  33686. * Break the loop and run the success callback.
  33687. */
  33688. breakLoop(): void;
  33689. /**
  33690. * Create and run an async loop.
  33691. * @param iterations the number of iterations.
  33692. * @param fn the function to run each iteration
  33693. * @param successCallback the callback that will be called upon succesful execution
  33694. * @param offset starting offset.
  33695. * @returns the created async loop object
  33696. */
  33697. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  33698. /**
  33699. * A for-loop that will run a given number of iterations synchronous and the rest async.
  33700. * @param iterations total number of iterations
  33701. * @param syncedIterations number of synchronous iterations in each async iteration.
  33702. * @param fn the function to call each iteration.
  33703. * @param callback a success call back that will be called when iterating stops.
  33704. * @param breakFunction a break condition (optional)
  33705. * @param timeout timeout settings for the setTimeout function. default - 0.
  33706. * @returns the created async loop object
  33707. */
  33708. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  33709. }
  33710. }
  33711. declare module "babylonjs/Misc/stringDictionary" {
  33712. import { Nullable } from "babylonjs/types";
  33713. /**
  33714. * This class implement a typical dictionary using a string as key and the generic type T as value.
  33715. * The underlying implementation relies on an associative array to ensure the best performances.
  33716. * The value can be anything including 'null' but except 'undefined'
  33717. */
  33718. export class StringDictionary<T> {
  33719. /**
  33720. * This will clear this dictionary and copy the content from the 'source' one.
  33721. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  33722. * @param source the dictionary to take the content from and copy to this dictionary
  33723. */
  33724. copyFrom(source: StringDictionary<T>): void;
  33725. /**
  33726. * Get a value based from its key
  33727. * @param key the given key to get the matching value from
  33728. * @return the value if found, otherwise undefined is returned
  33729. */
  33730. get(key: string): T | undefined;
  33731. /**
  33732. * Get a value from its key or add it if it doesn't exist.
  33733. * This method will ensure you that a given key/data will be present in the dictionary.
  33734. * @param key the given key to get the matching value from
  33735. * @param factory the factory that will create the value if the key is not present in the dictionary.
  33736. * The factory will only be invoked if there's no data for the given key.
  33737. * @return the value corresponding to the key.
  33738. */
  33739. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  33740. /**
  33741. * Get a value from its key if present in the dictionary otherwise add it
  33742. * @param key the key to get the value from
  33743. * @param val if there's no such key/value pair in the dictionary add it with this value
  33744. * @return the value corresponding to the key
  33745. */
  33746. getOrAdd(key: string, val: T): T;
  33747. /**
  33748. * Check if there's a given key in the dictionary
  33749. * @param key the key to check for
  33750. * @return true if the key is present, false otherwise
  33751. */
  33752. contains(key: string): boolean;
  33753. /**
  33754. * Add a new key and its corresponding value
  33755. * @param key the key to add
  33756. * @param value the value corresponding to the key
  33757. * @return true if the operation completed successfully, false if we couldn't insert the key/value because there was already this key in the dictionary
  33758. */
  33759. add(key: string, value: T): boolean;
  33760. /**
  33761. * Update a specific value associated to a key
  33762. * @param key defines the key to use
  33763. * @param value defines the value to store
  33764. * @returns true if the value was updated (or false if the key was not found)
  33765. */
  33766. set(key: string, value: T): boolean;
  33767. /**
  33768. * Get the element of the given key and remove it from the dictionary
  33769. * @param key defines the key to search
  33770. * @returns the value associated with the key or null if not found
  33771. */
  33772. getAndRemove(key: string): Nullable<T>;
  33773. /**
  33774. * Remove a key/value from the dictionary.
  33775. * @param key the key to remove
  33776. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  33777. */
  33778. remove(key: string): boolean;
  33779. /**
  33780. * Clear the whole content of the dictionary
  33781. */
  33782. clear(): void;
  33783. /**
  33784. * Gets the current count
  33785. */
  33786. readonly count: number;
  33787. /**
  33788. * Execute a callback on each key/val of the dictionary.
  33789. * Note that you can remove any element in this dictionary in the callback implementation
  33790. * @param callback the callback to execute on a given key/value pair
  33791. */
  33792. forEach(callback: (key: string, val: T) => void): void;
  33793. /**
  33794. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  33795. * If the callback returns null or undefined the method will iterate to the next key/value pair
  33796. * Note that you can remove any element in this dictionary in the callback implementation
  33797. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  33798. * @returns the first item
  33799. */
  33800. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  33801. private _count;
  33802. private _data;
  33803. }
  33804. }
  33805. declare module "babylonjs/Collisions/collisionCoordinator" {
  33806. import { Nullable } from "babylonjs/types";
  33807. import { Scene } from "babylonjs/scene";
  33808. import { Vector3 } from "babylonjs/Maths/math.vector";
  33809. import { Collider } from "babylonjs/Collisions/collider";
  33810. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33811. /** @hidden */
  33812. export interface ICollisionCoordinator {
  33813. createCollider(): Collider;
  33814. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33815. init(scene: Scene): void;
  33816. }
  33817. /** @hidden */
  33818. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  33819. private _scene;
  33820. private _scaledPosition;
  33821. private _scaledVelocity;
  33822. private _finalPosition;
  33823. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33824. createCollider(): Collider;
  33825. init(scene: Scene): void;
  33826. private _collideWithWorld;
  33827. }
  33828. }
  33829. declare module "babylonjs/Inputs/scene.inputManager" {
  33830. import { Nullable } from "babylonjs/types";
  33831. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33832. import { Vector2 } from "babylonjs/Maths/math.vector";
  33833. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33834. import { Scene } from "babylonjs/scene";
  33835. /**
  33836. * Class used to manage all inputs for the scene.
  33837. */
  33838. export class InputManager {
  33839. /** The distance in pixel that you have to move to prevent some events */
  33840. static DragMovementThreshold: number;
  33841. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  33842. static LongPressDelay: number;
  33843. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  33844. static DoubleClickDelay: number;
  33845. /** If you need to check double click without raising a single click at first click, enable this flag */
  33846. static ExclusiveDoubleClickMode: boolean;
  33847. private _wheelEventName;
  33848. private _onPointerMove;
  33849. private _onPointerDown;
  33850. private _onPointerUp;
  33851. private _initClickEvent;
  33852. private _initActionManager;
  33853. private _delayedSimpleClick;
  33854. private _delayedSimpleClickTimeout;
  33855. private _previousDelayedSimpleClickTimeout;
  33856. private _meshPickProceed;
  33857. private _previousButtonPressed;
  33858. private _currentPickResult;
  33859. private _previousPickResult;
  33860. private _totalPointersPressed;
  33861. private _doubleClickOccured;
  33862. private _pointerOverMesh;
  33863. private _pickedDownMesh;
  33864. private _pickedUpMesh;
  33865. private _pointerX;
  33866. private _pointerY;
  33867. private _unTranslatedPointerX;
  33868. private _unTranslatedPointerY;
  33869. private _startingPointerPosition;
  33870. private _previousStartingPointerPosition;
  33871. private _startingPointerTime;
  33872. private _previousStartingPointerTime;
  33873. private _pointerCaptures;
  33874. private _onKeyDown;
  33875. private _onKeyUp;
  33876. private _onCanvasFocusObserver;
  33877. private _onCanvasBlurObserver;
  33878. private _scene;
  33879. /**
  33880. * Creates a new InputManager
  33881. * @param scene defines the hosting scene
  33882. */
  33883. constructor(scene: Scene);
  33884. /**
  33885. * Gets the mesh that is currently under the pointer
  33886. */
  33887. readonly meshUnderPointer: Nullable<AbstractMesh>;
  33888. /**
  33889. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  33890. */
  33891. readonly unTranslatedPointer: Vector2;
  33892. /**
  33893. * Gets or sets the current on-screen X position of the pointer
  33894. */
  33895. pointerX: number;
  33896. /**
  33897. * Gets or sets the current on-screen Y position of the pointer
  33898. */
  33899. pointerY: number;
  33900. private _updatePointerPosition;
  33901. private _processPointerMove;
  33902. private _setRayOnPointerInfo;
  33903. private _checkPrePointerObservable;
  33904. /**
  33905. * Use this method to simulate a pointer move on a mesh
  33906. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33907. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33908. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33909. */
  33910. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  33911. /**
  33912. * Use this method to simulate a pointer down on a mesh
  33913. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33914. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33915. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33916. */
  33917. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  33918. private _processPointerDown;
  33919. /** @hidden */
  33920. _isPointerSwiping(): boolean;
  33921. /**
  33922. * Use this method to simulate a pointer up on a mesh
  33923. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  33924. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  33925. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  33926. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  33927. */
  33928. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  33929. private _processPointerUp;
  33930. /**
  33931. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  33932. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  33933. * @returns true if the pointer was captured
  33934. */
  33935. isPointerCaptured(pointerId?: number): boolean;
  33936. /**
  33937. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  33938. * @param attachUp defines if you want to attach events to pointerup
  33939. * @param attachDown defines if you want to attach events to pointerdown
  33940. * @param attachMove defines if you want to attach events to pointermove
  33941. */
  33942. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  33943. /**
  33944. * Detaches all event handlers
  33945. */
  33946. detachControl(): void;
  33947. /**
  33948. * Force the value of meshUnderPointer
  33949. * @param mesh defines the mesh to use
  33950. */
  33951. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  33952. /**
  33953. * Gets the mesh under the pointer
  33954. * @returns a Mesh or null if no mesh is under the pointer
  33955. */
  33956. getPointerOverMesh(): Nullable<AbstractMesh>;
  33957. }
  33958. }
  33959. declare module "babylonjs/Misc/uniqueIdGenerator" {
  33960. /**
  33961. * Helper class used to generate session unique ID
  33962. */
  33963. export class UniqueIdGenerator {
  33964. private static _UniqueIdCounter;
  33965. /**
  33966. * Gets an unique (relatively to the current scene) Id
  33967. */
  33968. static readonly UniqueId: number;
  33969. }
  33970. }
  33971. declare module "babylonjs/Animations/animationGroup" {
  33972. import { Animatable } from "babylonjs/Animations/animatable";
  33973. import { Animation } from "babylonjs/Animations/animation";
  33974. import { Scene, IDisposable } from "babylonjs/scene";
  33975. import { Observable } from "babylonjs/Misc/observable";
  33976. import { Nullable } from "babylonjs/types";
  33977. import "babylonjs/Animations/animatable";
  33978. /**
  33979. * This class defines the direct association between an animation and a target
  33980. */
  33981. export class TargetedAnimation {
  33982. /**
  33983. * Animation to perform
  33984. */
  33985. animation: Animation;
  33986. /**
  33987. * Target to animate
  33988. */
  33989. target: any;
  33990. /**
  33991. * Serialize the object
  33992. * @returns the JSON object representing the current entity
  33993. */
  33994. serialize(): any;
  33995. }
  33996. /**
  33997. * Use this class to create coordinated animations on multiple targets
  33998. */
  33999. export class AnimationGroup implements IDisposable {
  34000. /** The name of the animation group */
  34001. name: string;
  34002. private _scene;
  34003. private _targetedAnimations;
  34004. private _animatables;
  34005. private _from;
  34006. private _to;
  34007. private _isStarted;
  34008. private _isPaused;
  34009. private _speedRatio;
  34010. private _loopAnimation;
  34011. /**
  34012. * Gets or sets the unique id of the node
  34013. */
  34014. uniqueId: number;
  34015. /**
  34016. * This observable will notify when one animation have ended
  34017. */
  34018. onAnimationEndObservable: Observable<TargetedAnimation>;
  34019. /**
  34020. * Observer raised when one animation loops
  34021. */
  34022. onAnimationLoopObservable: Observable<TargetedAnimation>;
  34023. /**
  34024. * Observer raised when all animations have looped
  34025. */
  34026. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  34027. /**
  34028. * This observable will notify when all animations have ended.
  34029. */
  34030. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  34031. /**
  34032. * This observable will notify when all animations have paused.
  34033. */
  34034. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  34035. /**
  34036. * This observable will notify when all animations are playing.
  34037. */
  34038. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  34039. /**
  34040. * Gets the first frame
  34041. */
  34042. readonly from: number;
  34043. /**
  34044. * Gets the last frame
  34045. */
  34046. readonly to: number;
  34047. /**
  34048. * Define if the animations are started
  34049. */
  34050. readonly isStarted: boolean;
  34051. /**
  34052. * Gets a value indicating that the current group is playing
  34053. */
  34054. readonly isPlaying: boolean;
  34055. /**
  34056. * Gets or sets the speed ratio to use for all animations
  34057. */
  34058. /**
  34059. * Gets or sets the speed ratio to use for all animations
  34060. */
  34061. speedRatio: number;
  34062. /**
  34063. * Gets or sets if all animations should loop or not
  34064. */
  34065. loopAnimation: boolean;
  34066. /**
  34067. * Gets the targeted animations for this animation group
  34068. */
  34069. readonly targetedAnimations: Array<TargetedAnimation>;
  34070. /**
  34071. * returning the list of animatables controlled by this animation group.
  34072. */
  34073. readonly animatables: Array<Animatable>;
  34074. /**
  34075. * Instantiates a new Animation Group.
  34076. * This helps managing several animations at once.
  34077. * @see http://doc.babylonjs.com/how_to/group
  34078. * @param name Defines the name of the group
  34079. * @param scene Defines the scene the group belongs to
  34080. */
  34081. constructor(
  34082. /** The name of the animation group */
  34083. name: string, scene?: Nullable<Scene>);
  34084. /**
  34085. * Add an animation (with its target) in the group
  34086. * @param animation defines the animation we want to add
  34087. * @param target defines the target of the animation
  34088. * @returns the TargetedAnimation object
  34089. */
  34090. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  34091. /**
  34092. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  34093. * It can add constant keys at begin or end
  34094. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  34095. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  34096. * @returns the animation group
  34097. */
  34098. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  34099. private _animationLoopCount;
  34100. private _animationLoopFlags;
  34101. private _processLoop;
  34102. /**
  34103. * Start all animations on given targets
  34104. * @param loop defines if animations must loop
  34105. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  34106. * @param from defines the from key (optional)
  34107. * @param to defines the to key (optional)
  34108. * @returns the current animation group
  34109. */
  34110. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  34111. /**
  34112. * Pause all animations
  34113. * @returns the animation group
  34114. */
  34115. pause(): AnimationGroup;
  34116. /**
  34117. * Play all animations to initial state
  34118. * This function will start() the animations if they were not started or will restart() them if they were paused
  34119. * @param loop defines if animations must loop
  34120. * @returns the animation group
  34121. */
  34122. play(loop?: boolean): AnimationGroup;
  34123. /**
  34124. * Reset all animations to initial state
  34125. * @returns the animation group
  34126. */
  34127. reset(): AnimationGroup;
  34128. /**
  34129. * Restart animations from key 0
  34130. * @returns the animation group
  34131. */
  34132. restart(): AnimationGroup;
  34133. /**
  34134. * Stop all animations
  34135. * @returns the animation group
  34136. */
  34137. stop(): AnimationGroup;
  34138. /**
  34139. * Set animation weight for all animatables
  34140. * @param weight defines the weight to use
  34141. * @return the animationGroup
  34142. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  34143. */
  34144. setWeightForAllAnimatables(weight: number): AnimationGroup;
  34145. /**
  34146. * Synchronize and normalize all animatables with a source animatable
  34147. * @param root defines the root animatable to synchronize with
  34148. * @return the animationGroup
  34149. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  34150. */
  34151. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  34152. /**
  34153. * Goes to a specific frame in this animation group
  34154. * @param frame the frame number to go to
  34155. * @return the animationGroup
  34156. */
  34157. goToFrame(frame: number): AnimationGroup;
  34158. /**
  34159. * Dispose all associated resources
  34160. */
  34161. dispose(): void;
  34162. private _checkAnimationGroupEnded;
  34163. /**
  34164. * Clone the current animation group and returns a copy
  34165. * @param newName defines the name of the new group
  34166. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  34167. * @returns the new aniamtion group
  34168. */
  34169. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  34170. /**
  34171. * Serializes the animationGroup to an object
  34172. * @returns Serialized object
  34173. */
  34174. serialize(): any;
  34175. /**
  34176. * Returns a new AnimationGroup object parsed from the source provided.
  34177. * @param parsedAnimationGroup defines the source
  34178. * @param scene defines the scene that will receive the animationGroup
  34179. * @returns a new AnimationGroup
  34180. */
  34181. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  34182. /**
  34183. * Returns the string "AnimationGroup"
  34184. * @returns "AnimationGroup"
  34185. */
  34186. getClassName(): string;
  34187. /**
  34188. * Creates a detailled string about the object
  34189. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  34190. * @returns a string representing the object
  34191. */
  34192. toString(fullDetails?: boolean): string;
  34193. }
  34194. }
  34195. declare module "babylonjs/scene" {
  34196. import { Nullable } from "babylonjs/types";
  34197. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34198. import { Observable } from "babylonjs/Misc/observable";
  34199. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  34200. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  34201. import { Geometry } from "babylonjs/Meshes/geometry";
  34202. import { TransformNode } from "babylonjs/Meshes/transformNode";
  34203. import { SubMesh } from "babylonjs/Meshes/subMesh";
  34204. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34205. import { Mesh } from "babylonjs/Meshes/mesh";
  34206. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  34207. import { Bone } from "babylonjs/Bones/bone";
  34208. import { Skeleton } from "babylonjs/Bones/skeleton";
  34209. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  34210. import { Camera } from "babylonjs/Cameras/camera";
  34211. import { AbstractScene } from "babylonjs/abstractScene";
  34212. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34213. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  34214. import { Material } from "babylonjs/Materials/material";
  34215. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34216. import { Effect } from "babylonjs/Materials/effect";
  34217. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  34218. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  34219. import { Light } from "babylonjs/Lights/light";
  34220. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  34221. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  34222. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  34223. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  34224. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  34225. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  34226. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  34227. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  34228. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  34229. import { Engine } from "babylonjs/Engines/engine";
  34230. import { Node } from "babylonjs/node";
  34231. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  34232. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34233. import { WebRequest } from "babylonjs/Misc/webRequest";
  34234. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  34235. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  34236. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  34237. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  34238. import { Plane } from "babylonjs/Maths/math.plane";
  34239. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  34240. import { Ray } from "babylonjs/Culling/ray";
  34241. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  34242. import { Animation } from "babylonjs/Animations/animation";
  34243. import { Animatable } from "babylonjs/Animations/animatable";
  34244. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  34245. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34246. import { Collider } from "babylonjs/Collisions/collider";
  34247. /**
  34248. * Define an interface for all classes that will hold resources
  34249. */
  34250. export interface IDisposable {
  34251. /**
  34252. * Releases all held resources
  34253. */
  34254. dispose(): void;
  34255. }
  34256. /** Interface defining initialization parameters for Scene class */
  34257. export interface SceneOptions {
  34258. /**
  34259. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  34260. * It will improve performance when the number of geometries becomes important.
  34261. */
  34262. useGeometryUniqueIdsMap?: boolean;
  34263. /**
  34264. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  34265. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  34266. */
  34267. useMaterialMeshMap?: boolean;
  34268. /**
  34269. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  34270. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  34271. */
  34272. useClonedMeshhMap?: boolean;
  34273. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  34274. virtual?: boolean;
  34275. }
  34276. /**
  34277. * Represents a scene to be rendered by the engine.
  34278. * @see http://doc.babylonjs.com/features/scene
  34279. */
  34280. export class Scene extends AbstractScene implements IAnimatable {
  34281. /** The fog is deactivated */
  34282. static readonly FOGMODE_NONE: number;
  34283. /** The fog density is following an exponential function */
  34284. static readonly FOGMODE_EXP: number;
  34285. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  34286. static readonly FOGMODE_EXP2: number;
  34287. /** The fog density is following a linear function. */
  34288. static readonly FOGMODE_LINEAR: number;
  34289. /**
  34290. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  34291. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34292. */
  34293. static MinDeltaTime: number;
  34294. /**
  34295. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  34296. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34297. */
  34298. static MaxDeltaTime: number;
  34299. /**
  34300. * Factory used to create the default material.
  34301. * @param name The name of the material to create
  34302. * @param scene The scene to create the material for
  34303. * @returns The default material
  34304. */
  34305. static DefaultMaterialFactory(scene: Scene): Material;
  34306. /**
  34307. * Factory used to create the a collision coordinator.
  34308. * @returns The collision coordinator
  34309. */
  34310. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  34311. /** @hidden */
  34312. _inputManager: InputManager;
  34313. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  34314. cameraToUseForPointers: Nullable<Camera>;
  34315. /** @hidden */
  34316. readonly _isScene: boolean;
  34317. /**
  34318. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  34319. */
  34320. autoClear: boolean;
  34321. /**
  34322. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  34323. */
  34324. autoClearDepthAndStencil: boolean;
  34325. /**
  34326. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  34327. */
  34328. clearColor: Color4;
  34329. /**
  34330. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  34331. */
  34332. ambientColor: Color3;
  34333. /**
  34334. * This is use to store the default BRDF lookup for PBR materials in your scene.
  34335. * It should only be one of the following (if not the default embedded one):
  34336. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  34337. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  34338. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  34339. * The material properties need to be setup according to the type of texture in use.
  34340. */
  34341. environmentBRDFTexture: BaseTexture;
  34342. /** @hidden */
  34343. protected _environmentTexture: Nullable<BaseTexture>;
  34344. /**
  34345. * Texture used in all pbr material as the reflection texture.
  34346. * As in the majority of the scene they are the same (exception for multi room and so on),
  34347. * this is easier to reference from here than from all the materials.
  34348. */
  34349. /**
  34350. * Texture used in all pbr material as the reflection texture.
  34351. * As in the majority of the scene they are the same (exception for multi room and so on),
  34352. * this is easier to set here than in all the materials.
  34353. */
  34354. environmentTexture: Nullable<BaseTexture>;
  34355. /** @hidden */
  34356. protected _environmentIntensity: number;
  34357. /**
  34358. * Intensity of the environment in all pbr material.
  34359. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  34360. * As in the majority of the scene they are the same (exception for multi room and so on),
  34361. * this is easier to reference from here than from all the materials.
  34362. */
  34363. /**
  34364. * Intensity of the environment in all pbr material.
  34365. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  34366. * As in the majority of the scene they are the same (exception for multi room and so on),
  34367. * this is easier to set here than in all the materials.
  34368. */
  34369. environmentIntensity: number;
  34370. /** @hidden */
  34371. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  34372. /**
  34373. * Default image processing configuration used either in the rendering
  34374. * Forward main pass or through the imageProcessingPostProcess if present.
  34375. * As in the majority of the scene they are the same (exception for multi camera),
  34376. * this is easier to reference from here than from all the materials and post process.
  34377. *
  34378. * No setter as we it is a shared configuration, you can set the values instead.
  34379. */
  34380. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  34381. private _forceWireframe;
  34382. /**
  34383. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  34384. */
  34385. forceWireframe: boolean;
  34386. private _forcePointsCloud;
  34387. /**
  34388. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  34389. */
  34390. forcePointsCloud: boolean;
  34391. /**
  34392. * Gets or sets the active clipplane 1
  34393. */
  34394. clipPlane: Nullable<Plane>;
  34395. /**
  34396. * Gets or sets the active clipplane 2
  34397. */
  34398. clipPlane2: Nullable<Plane>;
  34399. /**
  34400. * Gets or sets the active clipplane 3
  34401. */
  34402. clipPlane3: Nullable<Plane>;
  34403. /**
  34404. * Gets or sets the active clipplane 4
  34405. */
  34406. clipPlane4: Nullable<Plane>;
  34407. /**
  34408. * Gets or sets a boolean indicating if animations are enabled
  34409. */
  34410. animationsEnabled: boolean;
  34411. private _animationPropertiesOverride;
  34412. /**
  34413. * Gets or sets the animation properties override
  34414. */
  34415. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  34416. /**
  34417. * Gets or sets a boolean indicating if a constant deltatime has to be used
  34418. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  34419. */
  34420. useConstantAnimationDeltaTime: boolean;
  34421. /**
  34422. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  34423. * Please note that it requires to run a ray cast through the scene on every frame
  34424. */
  34425. constantlyUpdateMeshUnderPointer: boolean;
  34426. /**
  34427. * Defines the HTML cursor to use when hovering over interactive elements
  34428. */
  34429. hoverCursor: string;
  34430. /**
  34431. * Defines the HTML default cursor to use (empty by default)
  34432. */
  34433. defaultCursor: string;
  34434. /**
  34435. * Defines wether cursors are handled by the scene.
  34436. */
  34437. doNotHandleCursors: boolean;
  34438. /**
  34439. * This is used to call preventDefault() on pointer down
  34440. * in order to block unwanted artifacts like system double clicks
  34441. */
  34442. preventDefaultOnPointerDown: boolean;
  34443. /**
  34444. * This is used to call preventDefault() on pointer up
  34445. * in order to block unwanted artifacts like system double clicks
  34446. */
  34447. preventDefaultOnPointerUp: boolean;
  34448. /**
  34449. * Gets or sets user defined metadata
  34450. */
  34451. metadata: any;
  34452. /**
  34453. * For internal use only. Please do not use.
  34454. */
  34455. reservedDataStore: any;
  34456. /**
  34457. * Gets the name of the plugin used to load this scene (null by default)
  34458. */
  34459. loadingPluginName: string;
  34460. /**
  34461. * Use this array to add regular expressions used to disable offline support for specific urls
  34462. */
  34463. disableOfflineSupportExceptionRules: RegExp[];
  34464. /**
  34465. * An event triggered when the scene is disposed.
  34466. */
  34467. onDisposeObservable: Observable<Scene>;
  34468. private _onDisposeObserver;
  34469. /** Sets a function to be executed when this scene is disposed. */
  34470. onDispose: () => void;
  34471. /**
  34472. * An event triggered before rendering the scene (right after animations and physics)
  34473. */
  34474. onBeforeRenderObservable: Observable<Scene>;
  34475. private _onBeforeRenderObserver;
  34476. /** Sets a function to be executed before rendering this scene */
  34477. beforeRender: Nullable<() => void>;
  34478. /**
  34479. * An event triggered after rendering the scene
  34480. */
  34481. onAfterRenderObservable: Observable<Scene>;
  34482. /**
  34483. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  34484. */
  34485. onAfterRenderCameraObservable: Observable<Camera>;
  34486. private _onAfterRenderObserver;
  34487. /** Sets a function to be executed after rendering this scene */
  34488. afterRender: Nullable<() => void>;
  34489. /**
  34490. * An event triggered before animating the scene
  34491. */
  34492. onBeforeAnimationsObservable: Observable<Scene>;
  34493. /**
  34494. * An event triggered after animations processing
  34495. */
  34496. onAfterAnimationsObservable: Observable<Scene>;
  34497. /**
  34498. * An event triggered before draw calls are ready to be sent
  34499. */
  34500. onBeforeDrawPhaseObservable: Observable<Scene>;
  34501. /**
  34502. * An event triggered after draw calls have been sent
  34503. */
  34504. onAfterDrawPhaseObservable: Observable<Scene>;
  34505. /**
  34506. * An event triggered when the scene is ready
  34507. */
  34508. onReadyObservable: Observable<Scene>;
  34509. /**
  34510. * An event triggered before rendering a camera
  34511. */
  34512. onBeforeCameraRenderObservable: Observable<Camera>;
  34513. private _onBeforeCameraRenderObserver;
  34514. /** Sets a function to be executed before rendering a camera*/
  34515. beforeCameraRender: () => void;
  34516. /**
  34517. * An event triggered after rendering a camera
  34518. */
  34519. onAfterCameraRenderObservable: Observable<Camera>;
  34520. private _onAfterCameraRenderObserver;
  34521. /** Sets a function to be executed after rendering a camera*/
  34522. afterCameraRender: () => void;
  34523. /**
  34524. * An event triggered when active meshes evaluation is about to start
  34525. */
  34526. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  34527. /**
  34528. * An event triggered when active meshes evaluation is done
  34529. */
  34530. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  34531. /**
  34532. * An event triggered when particles rendering is about to start
  34533. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  34534. */
  34535. onBeforeParticlesRenderingObservable: Observable<Scene>;
  34536. /**
  34537. * An event triggered when particles rendering is done
  34538. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  34539. */
  34540. onAfterParticlesRenderingObservable: Observable<Scene>;
  34541. /**
  34542. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  34543. */
  34544. onDataLoadedObservable: Observable<Scene>;
  34545. /**
  34546. * An event triggered when a camera is created
  34547. */
  34548. onNewCameraAddedObservable: Observable<Camera>;
  34549. /**
  34550. * An event triggered when a camera is removed
  34551. */
  34552. onCameraRemovedObservable: Observable<Camera>;
  34553. /**
  34554. * An event triggered when a light is created
  34555. */
  34556. onNewLightAddedObservable: Observable<Light>;
  34557. /**
  34558. * An event triggered when a light is removed
  34559. */
  34560. onLightRemovedObservable: Observable<Light>;
  34561. /**
  34562. * An event triggered when a geometry is created
  34563. */
  34564. onNewGeometryAddedObservable: Observable<Geometry>;
  34565. /**
  34566. * An event triggered when a geometry is removed
  34567. */
  34568. onGeometryRemovedObservable: Observable<Geometry>;
  34569. /**
  34570. * An event triggered when a transform node is created
  34571. */
  34572. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  34573. /**
  34574. * An event triggered when a transform node is removed
  34575. */
  34576. onTransformNodeRemovedObservable: Observable<TransformNode>;
  34577. /**
  34578. * An event triggered when a mesh is created
  34579. */
  34580. onNewMeshAddedObservable: Observable<AbstractMesh>;
  34581. /**
  34582. * An event triggered when a mesh is removed
  34583. */
  34584. onMeshRemovedObservable: Observable<AbstractMesh>;
  34585. /**
  34586. * An event triggered when a skeleton is created
  34587. */
  34588. onNewSkeletonAddedObservable: Observable<Skeleton>;
  34589. /**
  34590. * An event triggered when a skeleton is removed
  34591. */
  34592. onSkeletonRemovedObservable: Observable<Skeleton>;
  34593. /**
  34594. * An event triggered when a material is created
  34595. */
  34596. onNewMaterialAddedObservable: Observable<Material>;
  34597. /**
  34598. * An event triggered when a material is removed
  34599. */
  34600. onMaterialRemovedObservable: Observable<Material>;
  34601. /**
  34602. * An event triggered when a texture is created
  34603. */
  34604. onNewTextureAddedObservable: Observable<BaseTexture>;
  34605. /**
  34606. * An event triggered when a texture is removed
  34607. */
  34608. onTextureRemovedObservable: Observable<BaseTexture>;
  34609. /**
  34610. * An event triggered when render targets are about to be rendered
  34611. * Can happen multiple times per frame.
  34612. */
  34613. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  34614. /**
  34615. * An event triggered when render targets were rendered.
  34616. * Can happen multiple times per frame.
  34617. */
  34618. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  34619. /**
  34620. * An event triggered before calculating deterministic simulation step
  34621. */
  34622. onBeforeStepObservable: Observable<Scene>;
  34623. /**
  34624. * An event triggered after calculating deterministic simulation step
  34625. */
  34626. onAfterStepObservable: Observable<Scene>;
  34627. /**
  34628. * An event triggered when the activeCamera property is updated
  34629. */
  34630. onActiveCameraChanged: Observable<Scene>;
  34631. /**
  34632. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  34633. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34634. * If you wish to register an Observer only for a given set of renderingGroup, use the mask with a combination of the renderingGroup index elevated to the power of two (1 for renderingGroup 0, 2 for renderingrOup1, 4 for 2 and 8 for 3)
  34635. */
  34636. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34637. /**
  34638. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  34639. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34640. * If you wish to register an Observer only for a given set of renderingGroup, use the mask with a combination of the renderingGroup index elevated to the power of two (1 for renderingGroup 0, 2 for renderingrOup1, 4 for 2 and 8 for 3)
  34641. */
  34642. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34643. /**
  34644. * This Observable will when a mesh has been imported into the scene.
  34645. */
  34646. onMeshImportedObservable: Observable<AbstractMesh>;
  34647. /**
  34648. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  34649. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  34650. */
  34651. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  34652. /** @hidden */
  34653. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  34654. /**
  34655. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  34656. */
  34657. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  34658. /**
  34659. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  34660. */
  34661. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  34662. /**
  34663. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  34664. */
  34665. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  34666. /** Callback called when a pointer move is detected */
  34667. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34668. /** Callback called when a pointer down is detected */
  34669. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34670. /** Callback called when a pointer up is detected */
  34671. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  34672. /** Callback called when a pointer pick is detected */
  34673. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  34674. /**
  34675. * This observable event is triggered when any ponter event is triggered. It is registered during Scene.attachControl() and it is called BEFORE the 3D engine process anything (mesh/sprite picking for instance).
  34676. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  34677. */
  34678. onPrePointerObservable: Observable<PointerInfoPre>;
  34679. /**
  34680. * Observable event triggered each time an input event is received from the rendering canvas
  34681. */
  34682. onPointerObservable: Observable<PointerInfo>;
  34683. /**
  34684. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  34685. */
  34686. readonly unTranslatedPointer: Vector2;
  34687. /**
  34688. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  34689. */
  34690. static DragMovementThreshold: number;
  34691. /**
  34692. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  34693. */
  34694. static LongPressDelay: number;
  34695. /**
  34696. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  34697. */
  34698. static DoubleClickDelay: number;
  34699. /** If you need to check double click without raising a single click at first click, enable this flag */
  34700. static ExclusiveDoubleClickMode: boolean;
  34701. /** @hidden */
  34702. _mirroredCameraPosition: Nullable<Vector3>;
  34703. /**
  34704. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  34705. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  34706. */
  34707. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  34708. /**
  34709. * Observable event triggered each time an keyboard event is received from the hosting window
  34710. */
  34711. onKeyboardObservable: Observable<KeyboardInfo>;
  34712. private _useRightHandedSystem;
  34713. /**
  34714. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  34715. */
  34716. useRightHandedSystem: boolean;
  34717. private _timeAccumulator;
  34718. private _currentStepId;
  34719. private _currentInternalStep;
  34720. /**
  34721. * Sets the step Id used by deterministic lock step
  34722. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34723. * @param newStepId defines the step Id
  34724. */
  34725. setStepId(newStepId: number): void;
  34726. /**
  34727. * Gets the step Id used by deterministic lock step
  34728. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34729. * @returns the step Id
  34730. */
  34731. getStepId(): number;
  34732. /**
  34733. * Gets the internal step used by deterministic lock step
  34734. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34735. * @returns the internal step
  34736. */
  34737. getInternalStep(): number;
  34738. private _fogEnabled;
  34739. /**
  34740. * Gets or sets a boolean indicating if fog is enabled on this scene
  34741. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34742. * (Default is true)
  34743. */
  34744. fogEnabled: boolean;
  34745. private _fogMode;
  34746. /**
  34747. * Gets or sets the fog mode to use
  34748. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34749. * | mode | value |
  34750. * | --- | --- |
  34751. * | FOGMODE_NONE | 0 |
  34752. * | FOGMODE_EXP | 1 |
  34753. * | FOGMODE_EXP2 | 2 |
  34754. * | FOGMODE_LINEAR | 3 |
  34755. */
  34756. fogMode: number;
  34757. /**
  34758. * Gets or sets the fog color to use
  34759. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34760. * (Default is Color3(0.2, 0.2, 0.3))
  34761. */
  34762. fogColor: Color3;
  34763. /**
  34764. * Gets or sets the fog density to use
  34765. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34766. * (Default is 0.1)
  34767. */
  34768. fogDensity: number;
  34769. /**
  34770. * Gets or sets the fog start distance to use
  34771. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34772. * (Default is 0)
  34773. */
  34774. fogStart: number;
  34775. /**
  34776. * Gets or sets the fog end distance to use
  34777. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34778. * (Default is 1000)
  34779. */
  34780. fogEnd: number;
  34781. private _shadowsEnabled;
  34782. /**
  34783. * Gets or sets a boolean indicating if shadows are enabled on this scene
  34784. */
  34785. shadowsEnabled: boolean;
  34786. private _lightsEnabled;
  34787. /**
  34788. * Gets or sets a boolean indicating if lights are enabled on this scene
  34789. */
  34790. lightsEnabled: boolean;
  34791. /** All of the active cameras added to this scene. */
  34792. activeCameras: Camera[];
  34793. /** @hidden */
  34794. _activeCamera: Nullable<Camera>;
  34795. /** Gets or sets the current active camera */
  34796. activeCamera: Nullable<Camera>;
  34797. private _defaultMaterial;
  34798. /** The default material used on meshes when no material is affected */
  34799. /** The default material used on meshes when no material is affected */
  34800. defaultMaterial: Material;
  34801. private _texturesEnabled;
  34802. /**
  34803. * Gets or sets a boolean indicating if textures are enabled on this scene
  34804. */
  34805. texturesEnabled: boolean;
  34806. /**
  34807. * Gets or sets a boolean indicating if particles are enabled on this scene
  34808. */
  34809. particlesEnabled: boolean;
  34810. /**
  34811. * Gets or sets a boolean indicating if sprites are enabled on this scene
  34812. */
  34813. spritesEnabled: boolean;
  34814. private _skeletonsEnabled;
  34815. /**
  34816. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  34817. */
  34818. skeletonsEnabled: boolean;
  34819. /**
  34820. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  34821. */
  34822. lensFlaresEnabled: boolean;
  34823. /**
  34824. * Gets or sets a boolean indicating if collisions are enabled on this scene
  34825. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34826. */
  34827. collisionsEnabled: boolean;
  34828. private _collisionCoordinator;
  34829. /** @hidden */
  34830. readonly collisionCoordinator: ICollisionCoordinator;
  34831. /**
  34832. * Defines the gravity applied to this scene (used only for collisions)
  34833. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34834. */
  34835. gravity: Vector3;
  34836. /**
  34837. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  34838. */
  34839. postProcessesEnabled: boolean;
  34840. /**
  34841. * The list of postprocesses added to the scene
  34842. */
  34843. postProcesses: PostProcess[];
  34844. /**
  34845. * Gets the current postprocess manager
  34846. */
  34847. postProcessManager: PostProcessManager;
  34848. /**
  34849. * Gets or sets a boolean indicating if render targets are enabled on this scene
  34850. */
  34851. renderTargetsEnabled: boolean;
  34852. /**
  34853. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  34854. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  34855. */
  34856. dumpNextRenderTargets: boolean;
  34857. /**
  34858. * The list of user defined render targets added to the scene
  34859. */
  34860. customRenderTargets: RenderTargetTexture[];
  34861. /**
  34862. * Defines if texture loading must be delayed
  34863. * If true, textures will only be loaded when they need to be rendered
  34864. */
  34865. useDelayedTextureLoading: boolean;
  34866. /**
  34867. * Gets the list of meshes imported to the scene through SceneLoader
  34868. */
  34869. importedMeshesFiles: String[];
  34870. /**
  34871. * Gets or sets a boolean indicating if probes are enabled on this scene
  34872. */
  34873. probesEnabled: boolean;
  34874. /**
  34875. * Gets or sets the current offline provider to use to store scene data
  34876. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  34877. */
  34878. offlineProvider: IOfflineProvider;
  34879. /**
  34880. * Gets or sets the action manager associated with the scene
  34881. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  34882. */
  34883. actionManager: AbstractActionManager;
  34884. private _meshesForIntersections;
  34885. /**
  34886. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  34887. */
  34888. proceduralTexturesEnabled: boolean;
  34889. private _engine;
  34890. private _totalVertices;
  34891. /** @hidden */
  34892. _activeIndices: PerfCounter;
  34893. /** @hidden */
  34894. _activeParticles: PerfCounter;
  34895. /** @hidden */
  34896. _activeBones: PerfCounter;
  34897. private _animationRatio;
  34898. /** @hidden */
  34899. _animationTimeLast: number;
  34900. /** @hidden */
  34901. _animationTime: number;
  34902. /**
  34903. * Gets or sets a general scale for animation speed
  34904. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  34905. */
  34906. animationTimeScale: number;
  34907. /** @hidden */
  34908. _cachedMaterial: Nullable<Material>;
  34909. /** @hidden */
  34910. _cachedEffect: Nullable<Effect>;
  34911. /** @hidden */
  34912. _cachedVisibility: Nullable<number>;
  34913. private _renderId;
  34914. private _frameId;
  34915. private _executeWhenReadyTimeoutId;
  34916. private _intermediateRendering;
  34917. private _viewUpdateFlag;
  34918. private _projectionUpdateFlag;
  34919. /** @hidden */
  34920. _toBeDisposed: Nullable<IDisposable>[];
  34921. private _activeRequests;
  34922. /** @hidden */
  34923. _pendingData: any[];
  34924. private _isDisposed;
  34925. /**
  34926. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  34927. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  34928. */
  34929. dispatchAllSubMeshesOfActiveMeshes: boolean;
  34930. private _activeMeshes;
  34931. private _processedMaterials;
  34932. private _renderTargets;
  34933. /** @hidden */
  34934. _activeParticleSystems: SmartArray<IParticleSystem>;
  34935. private _activeSkeletons;
  34936. private _softwareSkinnedMeshes;
  34937. private _renderingManager;
  34938. /** @hidden */
  34939. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  34940. private _transformMatrix;
  34941. private _sceneUbo;
  34942. /** @hidden */
  34943. _viewMatrix: Matrix;
  34944. private _projectionMatrix;
  34945. /** @hidden */
  34946. _forcedViewPosition: Nullable<Vector3>;
  34947. /** @hidden */
  34948. _frustumPlanes: Plane[];
  34949. /**
  34950. * Gets the list of frustum planes (built from the active camera)
  34951. */
  34952. readonly frustumPlanes: Plane[];
  34953. /**
  34954. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  34955. * This is useful if there are more lights that the maximum simulteanous authorized
  34956. */
  34957. requireLightSorting: boolean;
  34958. /** @hidden */
  34959. readonly useMaterialMeshMap: boolean;
  34960. /** @hidden */
  34961. readonly useClonedMeshhMap: boolean;
  34962. private _externalData;
  34963. private _uid;
  34964. /**
  34965. * @hidden
  34966. * Backing store of defined scene components.
  34967. */
  34968. _components: ISceneComponent[];
  34969. /**
  34970. * @hidden
  34971. * Backing store of defined scene components.
  34972. */
  34973. _serializableComponents: ISceneSerializableComponent[];
  34974. /**
  34975. * List of components to register on the next registration step.
  34976. */
  34977. private _transientComponents;
  34978. /**
  34979. * Registers the transient components if needed.
  34980. */
  34981. private _registerTransientComponents;
  34982. /**
  34983. * @hidden
  34984. * Add a component to the scene.
  34985. * Note that the ccomponent could be registered on th next frame if this is called after
  34986. * the register component stage.
  34987. * @param component Defines the component to add to the scene
  34988. */
  34989. _addComponent(component: ISceneComponent): void;
  34990. /**
  34991. * @hidden
  34992. * Gets a component from the scene.
  34993. * @param name defines the name of the component to retrieve
  34994. * @returns the component or null if not present
  34995. */
  34996. _getComponent(name: string): Nullable<ISceneComponent>;
  34997. /**
  34998. * @hidden
  34999. * Defines the actions happening before camera updates.
  35000. */
  35001. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  35002. /**
  35003. * @hidden
  35004. * Defines the actions happening before clear the canvas.
  35005. */
  35006. _beforeClearStage: Stage<SimpleStageAction>;
  35007. /**
  35008. * @hidden
  35009. * Defines the actions when collecting render targets for the frame.
  35010. */
  35011. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  35012. /**
  35013. * @hidden
  35014. * Defines the actions happening for one camera in the frame.
  35015. */
  35016. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  35017. /**
  35018. * @hidden
  35019. * Defines the actions happening during the per mesh ready checks.
  35020. */
  35021. _isReadyForMeshStage: Stage<MeshStageAction>;
  35022. /**
  35023. * @hidden
  35024. * Defines the actions happening before evaluate active mesh checks.
  35025. */
  35026. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  35027. /**
  35028. * @hidden
  35029. * Defines the actions happening during the evaluate sub mesh checks.
  35030. */
  35031. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  35032. /**
  35033. * @hidden
  35034. * Defines the actions happening during the active mesh stage.
  35035. */
  35036. _activeMeshStage: Stage<ActiveMeshStageAction>;
  35037. /**
  35038. * @hidden
  35039. * Defines the actions happening during the per camera render target step.
  35040. */
  35041. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  35042. /**
  35043. * @hidden
  35044. * Defines the actions happening just before the active camera is drawing.
  35045. */
  35046. _beforeCameraDrawStage: Stage<CameraStageAction>;
  35047. /**
  35048. * @hidden
  35049. * Defines the actions happening just before a render target is drawing.
  35050. */
  35051. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  35052. /**
  35053. * @hidden
  35054. * Defines the actions happening just before a rendering group is drawing.
  35055. */
  35056. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  35057. /**
  35058. * @hidden
  35059. * Defines the actions happening just before a mesh is drawing.
  35060. */
  35061. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  35062. /**
  35063. * @hidden
  35064. * Defines the actions happening just after a mesh has been drawn.
  35065. */
  35066. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  35067. /**
  35068. * @hidden
  35069. * Defines the actions happening just after a rendering group has been drawn.
  35070. */
  35071. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  35072. /**
  35073. * @hidden
  35074. * Defines the actions happening just after the active camera has been drawn.
  35075. */
  35076. _afterCameraDrawStage: Stage<CameraStageAction>;
  35077. /**
  35078. * @hidden
  35079. * Defines the actions happening just after a render target has been drawn.
  35080. */
  35081. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  35082. /**
  35083. * @hidden
  35084. * Defines the actions happening just after rendering all cameras and computing intersections.
  35085. */
  35086. _afterRenderStage: Stage<SimpleStageAction>;
  35087. /**
  35088. * @hidden
  35089. * Defines the actions happening when a pointer move event happens.
  35090. */
  35091. _pointerMoveStage: Stage<PointerMoveStageAction>;
  35092. /**
  35093. * @hidden
  35094. * Defines the actions happening when a pointer down event happens.
  35095. */
  35096. _pointerDownStage: Stage<PointerUpDownStageAction>;
  35097. /**
  35098. * @hidden
  35099. * Defines the actions happening when a pointer up event happens.
  35100. */
  35101. _pointerUpStage: Stage<PointerUpDownStageAction>;
  35102. /**
  35103. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  35104. */
  35105. private geometriesByUniqueId;
  35106. /**
  35107. * Creates a new Scene
  35108. * @param engine defines the engine to use to render this scene
  35109. * @param options defines the scene options
  35110. */
  35111. constructor(engine: Engine, options?: SceneOptions);
  35112. /**
  35113. * Gets a string idenfifying the name of the class
  35114. * @returns "Scene" string
  35115. */
  35116. getClassName(): string;
  35117. private _defaultMeshCandidates;
  35118. /**
  35119. * @hidden
  35120. */
  35121. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  35122. private _defaultSubMeshCandidates;
  35123. /**
  35124. * @hidden
  35125. */
  35126. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  35127. /**
  35128. * Sets the default candidate providers for the scene.
  35129. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  35130. * and getCollidingSubMeshCandidates to their default function
  35131. */
  35132. setDefaultCandidateProviders(): void;
  35133. /**
  35134. * Gets the mesh that is currently under the pointer
  35135. */
  35136. readonly meshUnderPointer: Nullable<AbstractMesh>;
  35137. /**
  35138. * Gets or sets the current on-screen X position of the pointer
  35139. */
  35140. pointerX: number;
  35141. /**
  35142. * Gets or sets the current on-screen Y position of the pointer
  35143. */
  35144. pointerY: number;
  35145. /**
  35146. * Gets the cached material (ie. the latest rendered one)
  35147. * @returns the cached material
  35148. */
  35149. getCachedMaterial(): Nullable<Material>;
  35150. /**
  35151. * Gets the cached effect (ie. the latest rendered one)
  35152. * @returns the cached effect
  35153. */
  35154. getCachedEffect(): Nullable<Effect>;
  35155. /**
  35156. * Gets the cached visibility state (ie. the latest rendered one)
  35157. * @returns the cached visibility state
  35158. */
  35159. getCachedVisibility(): Nullable<number>;
  35160. /**
  35161. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  35162. * @param material defines the current material
  35163. * @param effect defines the current effect
  35164. * @param visibility defines the current visibility state
  35165. * @returns true if one parameter is not cached
  35166. */
  35167. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  35168. /**
  35169. * Gets the engine associated with the scene
  35170. * @returns an Engine
  35171. */
  35172. getEngine(): Engine;
  35173. /**
  35174. * Gets the total number of vertices rendered per frame
  35175. * @returns the total number of vertices rendered per frame
  35176. */
  35177. getTotalVertices(): number;
  35178. /**
  35179. * Gets the performance counter for total vertices
  35180. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35181. */
  35182. readonly totalVerticesPerfCounter: PerfCounter;
  35183. /**
  35184. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  35185. * @returns the total number of active indices rendered per frame
  35186. */
  35187. getActiveIndices(): number;
  35188. /**
  35189. * Gets the performance counter for active indices
  35190. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35191. */
  35192. readonly totalActiveIndicesPerfCounter: PerfCounter;
  35193. /**
  35194. * Gets the total number of active particles rendered per frame
  35195. * @returns the total number of active particles rendered per frame
  35196. */
  35197. getActiveParticles(): number;
  35198. /**
  35199. * Gets the performance counter for active particles
  35200. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35201. */
  35202. readonly activeParticlesPerfCounter: PerfCounter;
  35203. /**
  35204. * Gets the total number of active bones rendered per frame
  35205. * @returns the total number of active bones rendered per frame
  35206. */
  35207. getActiveBones(): number;
  35208. /**
  35209. * Gets the performance counter for active bones
  35210. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35211. */
  35212. readonly activeBonesPerfCounter: PerfCounter;
  35213. /**
  35214. * Gets the array of active meshes
  35215. * @returns an array of AbstractMesh
  35216. */
  35217. getActiveMeshes(): SmartArray<AbstractMesh>;
  35218. /**
  35219. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  35220. * @returns a number
  35221. */
  35222. getAnimationRatio(): number;
  35223. /**
  35224. * Gets an unique Id for the current render phase
  35225. * @returns a number
  35226. */
  35227. getRenderId(): number;
  35228. /**
  35229. * Gets an unique Id for the current frame
  35230. * @returns a number
  35231. */
  35232. getFrameId(): number;
  35233. /** Call this function if you want to manually increment the render Id*/
  35234. incrementRenderId(): void;
  35235. private _createUbo;
  35236. /**
  35237. * Use this method to simulate a pointer move on a mesh
  35238. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35239. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35240. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35241. * @returns the current scene
  35242. */
  35243. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  35244. /**
  35245. * Use this method to simulate a pointer down on a mesh
  35246. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35247. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35248. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35249. * @returns the current scene
  35250. */
  35251. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  35252. /**
  35253. * Use this method to simulate a pointer up on a mesh
  35254. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35255. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35256. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35257. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  35258. * @returns the current scene
  35259. */
  35260. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  35261. /**
  35262. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  35263. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  35264. * @returns true if the pointer was captured
  35265. */
  35266. isPointerCaptured(pointerId?: number): boolean;
  35267. /**
  35268. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  35269. * @param attachUp defines if you want to attach events to pointerup
  35270. * @param attachDown defines if you want to attach events to pointerdown
  35271. * @param attachMove defines if you want to attach events to pointermove
  35272. */
  35273. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  35274. /** Detaches all event handlers*/
  35275. detachControl(): void;
  35276. /**
  35277. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  35278. * Delay loaded resources are not taking in account
  35279. * @return true if all required resources are ready
  35280. */
  35281. isReady(): boolean;
  35282. /** Resets all cached information relative to material (including effect and visibility) */
  35283. resetCachedMaterial(): void;
  35284. /**
  35285. * Registers a function to be called before every frame render
  35286. * @param func defines the function to register
  35287. */
  35288. registerBeforeRender(func: () => void): void;
  35289. /**
  35290. * Unregisters a function called before every frame render
  35291. * @param func defines the function to unregister
  35292. */
  35293. unregisterBeforeRender(func: () => void): void;
  35294. /**
  35295. * Registers a function to be called after every frame render
  35296. * @param func defines the function to register
  35297. */
  35298. registerAfterRender(func: () => void): void;
  35299. /**
  35300. * Unregisters a function called after every frame render
  35301. * @param func defines the function to unregister
  35302. */
  35303. unregisterAfterRender(func: () => void): void;
  35304. private _executeOnceBeforeRender;
  35305. /**
  35306. * The provided function will run before render once and will be disposed afterwards.
  35307. * A timeout delay can be provided so that the function will be executed in N ms.
  35308. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  35309. * @param func The function to be executed.
  35310. * @param timeout optional delay in ms
  35311. */
  35312. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  35313. /** @hidden */
  35314. _addPendingData(data: any): void;
  35315. /** @hidden */
  35316. _removePendingData(data: any): void;
  35317. /**
  35318. * Returns the number of items waiting to be loaded
  35319. * @returns the number of items waiting to be loaded
  35320. */
  35321. getWaitingItemsCount(): number;
  35322. /**
  35323. * Returns a boolean indicating if the scene is still loading data
  35324. */
  35325. readonly isLoading: boolean;
  35326. /**
  35327. * Registers a function to be executed when the scene is ready
  35328. * @param {Function} func - the function to be executed
  35329. */
  35330. executeWhenReady(func: () => void): void;
  35331. /**
  35332. * Returns a promise that resolves when the scene is ready
  35333. * @returns A promise that resolves when the scene is ready
  35334. */
  35335. whenReadyAsync(): Promise<void>;
  35336. /** @hidden */
  35337. _checkIsReady(): void;
  35338. /**
  35339. * Gets all animatable attached to the scene
  35340. */
  35341. readonly animatables: Animatable[];
  35342. /**
  35343. * Resets the last animation time frame.
  35344. * Useful to override when animations start running when loading a scene for the first time.
  35345. */
  35346. resetLastAnimationTimeFrame(): void;
  35347. /**
  35348. * Gets the current view matrix
  35349. * @returns a Matrix
  35350. */
  35351. getViewMatrix(): Matrix;
  35352. /**
  35353. * Gets the current projection matrix
  35354. * @returns a Matrix
  35355. */
  35356. getProjectionMatrix(): Matrix;
  35357. /**
  35358. * Gets the current transform matrix
  35359. * @returns a Matrix made of View * Projection
  35360. */
  35361. getTransformMatrix(): Matrix;
  35362. /**
  35363. * Sets the current transform matrix
  35364. * @param viewL defines the View matrix to use
  35365. * @param projectionL defines the Projection matrix to use
  35366. * @param viewR defines the right View matrix to use (if provided)
  35367. * @param projectionR defines the right Projection matrix to use (if provided)
  35368. */
  35369. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  35370. /**
  35371. * Gets the uniform buffer used to store scene data
  35372. * @returns a UniformBuffer
  35373. */
  35374. getSceneUniformBuffer(): UniformBuffer;
  35375. /**
  35376. * Gets an unique (relatively to the current scene) Id
  35377. * @returns an unique number for the scene
  35378. */
  35379. getUniqueId(): number;
  35380. /**
  35381. * Add a mesh to the list of scene's meshes
  35382. * @param newMesh defines the mesh to add
  35383. * @param recursive if all child meshes should also be added to the scene
  35384. */
  35385. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  35386. /**
  35387. * Remove a mesh for the list of scene's meshes
  35388. * @param toRemove defines the mesh to remove
  35389. * @param recursive if all child meshes should also be removed from the scene
  35390. * @returns the index where the mesh was in the mesh list
  35391. */
  35392. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  35393. /**
  35394. * Add a transform node to the list of scene's transform nodes
  35395. * @param newTransformNode defines the transform node to add
  35396. */
  35397. addTransformNode(newTransformNode: TransformNode): void;
  35398. /**
  35399. * Remove a transform node for the list of scene's transform nodes
  35400. * @param toRemove defines the transform node to remove
  35401. * @returns the index where the transform node was in the transform node list
  35402. */
  35403. removeTransformNode(toRemove: TransformNode): number;
  35404. /**
  35405. * Remove a skeleton for the list of scene's skeletons
  35406. * @param toRemove defines the skeleton to remove
  35407. * @returns the index where the skeleton was in the skeleton list
  35408. */
  35409. removeSkeleton(toRemove: Skeleton): number;
  35410. /**
  35411. * Remove a morph target for the list of scene's morph targets
  35412. * @param toRemove defines the morph target to remove
  35413. * @returns the index where the morph target was in the morph target list
  35414. */
  35415. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  35416. /**
  35417. * Remove a light for the list of scene's lights
  35418. * @param toRemove defines the light to remove
  35419. * @returns the index where the light was in the light list
  35420. */
  35421. removeLight(toRemove: Light): number;
  35422. /**
  35423. * Remove a camera for the list of scene's cameras
  35424. * @param toRemove defines the camera to remove
  35425. * @returns the index where the camera was in the camera list
  35426. */
  35427. removeCamera(toRemove: Camera): number;
  35428. /**
  35429. * Remove a particle system for the list of scene's particle systems
  35430. * @param toRemove defines the particle system to remove
  35431. * @returns the index where the particle system was in the particle system list
  35432. */
  35433. removeParticleSystem(toRemove: IParticleSystem): number;
  35434. /**
  35435. * Remove a animation for the list of scene's animations
  35436. * @param toRemove defines the animation to remove
  35437. * @returns the index where the animation was in the animation list
  35438. */
  35439. removeAnimation(toRemove: Animation): number;
  35440. /**
  35441. * Will stop the animation of the given target
  35442. * @param target - the target
  35443. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  35444. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  35445. */
  35446. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  35447. /**
  35448. * Removes the given animation group from this scene.
  35449. * @param toRemove The animation group to remove
  35450. * @returns The index of the removed animation group
  35451. */
  35452. removeAnimationGroup(toRemove: AnimationGroup): number;
  35453. /**
  35454. * Removes the given multi-material from this scene.
  35455. * @param toRemove The multi-material to remove
  35456. * @returns The index of the removed multi-material
  35457. */
  35458. removeMultiMaterial(toRemove: MultiMaterial): number;
  35459. /**
  35460. * Removes the given material from this scene.
  35461. * @param toRemove The material to remove
  35462. * @returns The index of the removed material
  35463. */
  35464. removeMaterial(toRemove: Material): number;
  35465. /**
  35466. * Removes the given action manager from this scene.
  35467. * @param toRemove The action manager to remove
  35468. * @returns The index of the removed action manager
  35469. */
  35470. removeActionManager(toRemove: AbstractActionManager): number;
  35471. /**
  35472. * Removes the given texture from this scene.
  35473. * @param toRemove The texture to remove
  35474. * @returns The index of the removed texture
  35475. */
  35476. removeTexture(toRemove: BaseTexture): number;
  35477. /**
  35478. * Adds the given light to this scene
  35479. * @param newLight The light to add
  35480. */
  35481. addLight(newLight: Light): void;
  35482. /**
  35483. * Sorts the list list based on light priorities
  35484. */
  35485. sortLightsByPriority(): void;
  35486. /**
  35487. * Adds the given camera to this scene
  35488. * @param newCamera The camera to add
  35489. */
  35490. addCamera(newCamera: Camera): void;
  35491. /**
  35492. * Adds the given skeleton to this scene
  35493. * @param newSkeleton The skeleton to add
  35494. */
  35495. addSkeleton(newSkeleton: Skeleton): void;
  35496. /**
  35497. * Adds the given particle system to this scene
  35498. * @param newParticleSystem The particle system to add
  35499. */
  35500. addParticleSystem(newParticleSystem: IParticleSystem): void;
  35501. /**
  35502. * Adds the given animation to this scene
  35503. * @param newAnimation The animation to add
  35504. */
  35505. addAnimation(newAnimation: Animation): void;
  35506. /**
  35507. * Adds the given animation group to this scene.
  35508. * @param newAnimationGroup The animation group to add
  35509. */
  35510. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  35511. /**
  35512. * Adds the given multi-material to this scene
  35513. * @param newMultiMaterial The multi-material to add
  35514. */
  35515. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  35516. /**
  35517. * Adds the given material to this scene
  35518. * @param newMaterial The material to add
  35519. */
  35520. addMaterial(newMaterial: Material): void;
  35521. /**
  35522. * Adds the given morph target to this scene
  35523. * @param newMorphTargetManager The morph target to add
  35524. */
  35525. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  35526. /**
  35527. * Adds the given geometry to this scene
  35528. * @param newGeometry The geometry to add
  35529. */
  35530. addGeometry(newGeometry: Geometry): void;
  35531. /**
  35532. * Adds the given action manager to this scene
  35533. * @param newActionManager The action manager to add
  35534. */
  35535. addActionManager(newActionManager: AbstractActionManager): void;
  35536. /**
  35537. * Adds the given texture to this scene.
  35538. * @param newTexture The texture to add
  35539. */
  35540. addTexture(newTexture: BaseTexture): void;
  35541. /**
  35542. * Switch active camera
  35543. * @param newCamera defines the new active camera
  35544. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  35545. */
  35546. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  35547. /**
  35548. * sets the active camera of the scene using its ID
  35549. * @param id defines the camera's ID
  35550. * @return the new active camera or null if none found.
  35551. */
  35552. setActiveCameraByID(id: string): Nullable<Camera>;
  35553. /**
  35554. * sets the active camera of the scene using its name
  35555. * @param name defines the camera's name
  35556. * @returns the new active camera or null if none found.
  35557. */
  35558. setActiveCameraByName(name: string): Nullable<Camera>;
  35559. /**
  35560. * get an animation group using its name
  35561. * @param name defines the material's name
  35562. * @return the animation group or null if none found.
  35563. */
  35564. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  35565. /**
  35566. * Get a material using its unique id
  35567. * @param uniqueId defines the material's unique id
  35568. * @return the material or null if none found.
  35569. */
  35570. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  35571. /**
  35572. * get a material using its id
  35573. * @param id defines the material's ID
  35574. * @return the material or null if none found.
  35575. */
  35576. getMaterialByID(id: string): Nullable<Material>;
  35577. /**
  35578. * Gets a the last added material using a given id
  35579. * @param id defines the material's ID
  35580. * @return the last material with the given id or null if none found.
  35581. */
  35582. getLastMaterialByID(id: string): Nullable<Material>;
  35583. /**
  35584. * Gets a material using its name
  35585. * @param name defines the material's name
  35586. * @return the material or null if none found.
  35587. */
  35588. getMaterialByName(name: string): Nullable<Material>;
  35589. /**
  35590. * Get a texture using its unique id
  35591. * @param uniqueId defines the texture's unique id
  35592. * @return the texture or null if none found.
  35593. */
  35594. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  35595. /**
  35596. * Gets a camera using its id
  35597. * @param id defines the id to look for
  35598. * @returns the camera or null if not found
  35599. */
  35600. getCameraByID(id: string): Nullable<Camera>;
  35601. /**
  35602. * Gets a camera using its unique id
  35603. * @param uniqueId defines the unique id to look for
  35604. * @returns the camera or null if not found
  35605. */
  35606. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  35607. /**
  35608. * Gets a camera using its name
  35609. * @param name defines the camera's name
  35610. * @return the camera or null if none found.
  35611. */
  35612. getCameraByName(name: string): Nullable<Camera>;
  35613. /**
  35614. * Gets a bone using its id
  35615. * @param id defines the bone's id
  35616. * @return the bone or null if not found
  35617. */
  35618. getBoneByID(id: string): Nullable<Bone>;
  35619. /**
  35620. * Gets a bone using its id
  35621. * @param name defines the bone's name
  35622. * @return the bone or null if not found
  35623. */
  35624. getBoneByName(name: string): Nullable<Bone>;
  35625. /**
  35626. * Gets a light node using its name
  35627. * @param name defines the the light's name
  35628. * @return the light or null if none found.
  35629. */
  35630. getLightByName(name: string): Nullable<Light>;
  35631. /**
  35632. * Gets a light node using its id
  35633. * @param id defines the light's id
  35634. * @return the light or null if none found.
  35635. */
  35636. getLightByID(id: string): Nullable<Light>;
  35637. /**
  35638. * Gets a light node using its scene-generated unique ID
  35639. * @param uniqueId defines the light's unique id
  35640. * @return the light or null if none found.
  35641. */
  35642. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  35643. /**
  35644. * Gets a particle system by id
  35645. * @param id defines the particle system id
  35646. * @return the corresponding system or null if none found
  35647. */
  35648. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  35649. /**
  35650. * Gets a geometry using its ID
  35651. * @param id defines the geometry's id
  35652. * @return the geometry or null if none found.
  35653. */
  35654. getGeometryByID(id: string): Nullable<Geometry>;
  35655. private _getGeometryByUniqueID;
  35656. /**
  35657. * Add a new geometry to this scene
  35658. * @param geometry defines the geometry to be added to the scene.
  35659. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  35660. * @return a boolean defining if the geometry was added or not
  35661. */
  35662. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  35663. /**
  35664. * Removes an existing geometry
  35665. * @param geometry defines the geometry to be removed from the scene
  35666. * @return a boolean defining if the geometry was removed or not
  35667. */
  35668. removeGeometry(geometry: Geometry): boolean;
  35669. /**
  35670. * Gets the list of geometries attached to the scene
  35671. * @returns an array of Geometry
  35672. */
  35673. getGeometries(): Geometry[];
  35674. /**
  35675. * Gets the first added mesh found of a given ID
  35676. * @param id defines the id to search for
  35677. * @return the mesh found or null if not found at all
  35678. */
  35679. getMeshByID(id: string): Nullable<AbstractMesh>;
  35680. /**
  35681. * Gets a list of meshes using their id
  35682. * @param id defines the id to search for
  35683. * @returns a list of meshes
  35684. */
  35685. getMeshesByID(id: string): Array<AbstractMesh>;
  35686. /**
  35687. * Gets the first added transform node found of a given ID
  35688. * @param id defines the id to search for
  35689. * @return the found transform node or null if not found at all.
  35690. */
  35691. getTransformNodeByID(id: string): Nullable<TransformNode>;
  35692. /**
  35693. * Gets a transform node with its auto-generated unique id
  35694. * @param uniqueId efines the unique id to search for
  35695. * @return the found transform node or null if not found at all.
  35696. */
  35697. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  35698. /**
  35699. * Gets a list of transform nodes using their id
  35700. * @param id defines the id to search for
  35701. * @returns a list of transform nodes
  35702. */
  35703. getTransformNodesByID(id: string): Array<TransformNode>;
  35704. /**
  35705. * Gets a mesh with its auto-generated unique id
  35706. * @param uniqueId defines the unique id to search for
  35707. * @return the found mesh or null if not found at all.
  35708. */
  35709. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  35710. /**
  35711. * Gets a the last added mesh using a given id
  35712. * @param id defines the id to search for
  35713. * @return the found mesh or null if not found at all.
  35714. */
  35715. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  35716. /**
  35717. * Gets a the last added node (Mesh, Camera, Light) using a given id
  35718. * @param id defines the id to search for
  35719. * @return the found node or null if not found at all
  35720. */
  35721. getLastEntryByID(id: string): Nullable<Node>;
  35722. /**
  35723. * Gets a node (Mesh, Camera, Light) using a given id
  35724. * @param id defines the id to search for
  35725. * @return the found node or null if not found at all
  35726. */
  35727. getNodeByID(id: string): Nullable<Node>;
  35728. /**
  35729. * Gets a node (Mesh, Camera, Light) using a given name
  35730. * @param name defines the name to search for
  35731. * @return the found node or null if not found at all.
  35732. */
  35733. getNodeByName(name: string): Nullable<Node>;
  35734. /**
  35735. * Gets a mesh using a given name
  35736. * @param name defines the name to search for
  35737. * @return the found mesh or null if not found at all.
  35738. */
  35739. getMeshByName(name: string): Nullable<AbstractMesh>;
  35740. /**
  35741. * Gets a transform node using a given name
  35742. * @param name defines the name to search for
  35743. * @return the found transform node or null if not found at all.
  35744. */
  35745. getTransformNodeByName(name: string): Nullable<TransformNode>;
  35746. /**
  35747. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  35748. * @param id defines the id to search for
  35749. * @return the found skeleton or null if not found at all.
  35750. */
  35751. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  35752. /**
  35753. * Gets a skeleton using a given auto generated unique id
  35754. * @param uniqueId defines the unique id to search for
  35755. * @return the found skeleton or null if not found at all.
  35756. */
  35757. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  35758. /**
  35759. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  35760. * @param id defines the id to search for
  35761. * @return the found skeleton or null if not found at all.
  35762. */
  35763. getSkeletonById(id: string): Nullable<Skeleton>;
  35764. /**
  35765. * Gets a skeleton using a given name
  35766. * @param name defines the name to search for
  35767. * @return the found skeleton or null if not found at all.
  35768. */
  35769. getSkeletonByName(name: string): Nullable<Skeleton>;
  35770. /**
  35771. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  35772. * @param id defines the id to search for
  35773. * @return the found morph target manager or null if not found at all.
  35774. */
  35775. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  35776. /**
  35777. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  35778. * @param id defines the id to search for
  35779. * @return the found morph target or null if not found at all.
  35780. */
  35781. getMorphTargetById(id: string): Nullable<MorphTarget>;
  35782. /**
  35783. * Gets a boolean indicating if the given mesh is active
  35784. * @param mesh defines the mesh to look for
  35785. * @returns true if the mesh is in the active list
  35786. */
  35787. isActiveMesh(mesh: AbstractMesh): boolean;
  35788. /**
  35789. * Return a unique id as a string which can serve as an identifier for the scene
  35790. */
  35791. readonly uid: string;
  35792. /**
  35793. * Add an externaly attached data from its key.
  35794. * This method call will fail and return false, if such key already exists.
  35795. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  35796. * @param key the unique key that identifies the data
  35797. * @param data the data object to associate to the key for this Engine instance
  35798. * @return true if no such key were already present and the data was added successfully, false otherwise
  35799. */
  35800. addExternalData<T>(key: string, data: T): boolean;
  35801. /**
  35802. * Get an externaly attached data from its key
  35803. * @param key the unique key that identifies the data
  35804. * @return the associated data, if present (can be null), or undefined if not present
  35805. */
  35806. getExternalData<T>(key: string): Nullable<T>;
  35807. /**
  35808. * Get an externaly attached data from its key, create it using a factory if it's not already present
  35809. * @param key the unique key that identifies the data
  35810. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  35811. * @return the associated data, can be null if the factory returned null.
  35812. */
  35813. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  35814. /**
  35815. * Remove an externaly attached data from the Engine instance
  35816. * @param key the unique key that identifies the data
  35817. * @return true if the data was successfully removed, false if it doesn't exist
  35818. */
  35819. removeExternalData(key: string): boolean;
  35820. private _evaluateSubMesh;
  35821. /**
  35822. * Clear the processed materials smart array preventing retention point in material dispose.
  35823. */
  35824. freeProcessedMaterials(): void;
  35825. private _preventFreeActiveMeshesAndRenderingGroups;
  35826. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  35827. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  35828. * when disposing several meshes in a row or a hierarchy of meshes.
  35829. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  35830. */
  35831. blockfreeActiveMeshesAndRenderingGroups: boolean;
  35832. /**
  35833. * Clear the active meshes smart array preventing retention point in mesh dispose.
  35834. */
  35835. freeActiveMeshes(): void;
  35836. /**
  35837. * Clear the info related to rendering groups preventing retention points during dispose.
  35838. */
  35839. freeRenderingGroups(): void;
  35840. /** @hidden */
  35841. _isInIntermediateRendering(): boolean;
  35842. /**
  35843. * Lambda returning the list of potentially active meshes.
  35844. */
  35845. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  35846. /**
  35847. * Lambda returning the list of potentially active sub meshes.
  35848. */
  35849. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  35850. /**
  35851. * Lambda returning the list of potentially intersecting sub meshes.
  35852. */
  35853. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  35854. /**
  35855. * Lambda returning the list of potentially colliding sub meshes.
  35856. */
  35857. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  35858. private _activeMeshesFrozen;
  35859. /**
  35860. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  35861. * @returns the current scene
  35862. */
  35863. freezeActiveMeshes(): Scene;
  35864. /**
  35865. * Use this function to restart evaluating active meshes on every frame
  35866. * @returns the current scene
  35867. */
  35868. unfreezeActiveMeshes(): Scene;
  35869. private _evaluateActiveMeshes;
  35870. private _activeMesh;
  35871. /**
  35872. * Update the transform matrix to update from the current active camera
  35873. * @param force defines a boolean used to force the update even if cache is up to date
  35874. */
  35875. updateTransformMatrix(force?: boolean): void;
  35876. private _bindFrameBuffer;
  35877. /** @hidden */
  35878. _allowPostProcessClearColor: boolean;
  35879. /** @hidden */
  35880. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  35881. private _processSubCameras;
  35882. private _checkIntersections;
  35883. /** @hidden */
  35884. _advancePhysicsEngineStep(step: number): void;
  35885. /**
  35886. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  35887. */
  35888. getDeterministicFrameTime: () => number;
  35889. /** @hidden */
  35890. _animate(): void;
  35891. /** Execute all animations (for a frame) */
  35892. animate(): void;
  35893. /**
  35894. * Render the scene
  35895. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  35896. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  35897. */
  35898. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  35899. /**
  35900. * Freeze all materials
  35901. * A frozen material will not be updatable but should be faster to render
  35902. */
  35903. freezeMaterials(): void;
  35904. /**
  35905. * Unfreeze all materials
  35906. * A frozen material will not be updatable but should be faster to render
  35907. */
  35908. unfreezeMaterials(): void;
  35909. /**
  35910. * Releases all held ressources
  35911. */
  35912. dispose(): void;
  35913. /**
  35914. * Gets if the scene is already disposed
  35915. */
  35916. readonly isDisposed: boolean;
  35917. /**
  35918. * Call this function to reduce memory footprint of the scene.
  35919. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  35920. */
  35921. clearCachedVertexData(): void;
  35922. /**
  35923. * This function will remove the local cached buffer data from texture.
  35924. * It will save memory but will prevent the texture from being rebuilt
  35925. */
  35926. cleanCachedTextureBuffer(): void;
  35927. /**
  35928. * Get the world extend vectors with an optional filter
  35929. *
  35930. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  35931. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  35932. */
  35933. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  35934. min: Vector3;
  35935. max: Vector3;
  35936. };
  35937. /**
  35938. * Creates a ray that can be used to pick in the scene
  35939. * @param x defines the x coordinate of the origin (on-screen)
  35940. * @param y defines the y coordinate of the origin (on-screen)
  35941. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  35942. * @param camera defines the camera to use for the picking
  35943. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  35944. * @returns a Ray
  35945. */
  35946. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  35947. /**
  35948. * Creates a ray that can be used to pick in the scene
  35949. * @param x defines the x coordinate of the origin (on-screen)
  35950. * @param y defines the y coordinate of the origin (on-screen)
  35951. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  35952. * @param result defines the ray where to store the picking ray
  35953. * @param camera defines the camera to use for the picking
  35954. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  35955. * @returns the current scene
  35956. */
  35957. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  35958. /**
  35959. * Creates a ray that can be used to pick in the scene
  35960. * @param x defines the x coordinate of the origin (on-screen)
  35961. * @param y defines the y coordinate of the origin (on-screen)
  35962. * @param camera defines the camera to use for the picking
  35963. * @returns a Ray
  35964. */
  35965. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  35966. /**
  35967. * Creates a ray that can be used to pick in the scene
  35968. * @param x defines the x coordinate of the origin (on-screen)
  35969. * @param y defines the y coordinate of the origin (on-screen)
  35970. * @param result defines the ray where to store the picking ray
  35971. * @param camera defines the camera to use for the picking
  35972. * @returns the current scene
  35973. */
  35974. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  35975. /** Launch a ray to try to pick a mesh in the scene
  35976. * @param x position on screen
  35977. * @param y position on screen
  35978. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true
  35979. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  35980. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  35981. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35982. * @returns a PickingInfo
  35983. */
  35984. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  35985. /** Use the given ray to pick a mesh in the scene
  35986. * @param ray The ray to use to pick meshes
  35987. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must have isPickable set to true
  35988. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  35989. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  35990. * @returns a PickingInfo
  35991. */
  35992. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  35993. /**
  35994. * Launch a ray to try to pick a mesh in the scene
  35995. * @param x X position on screen
  35996. * @param y Y position on screen
  35997. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true
  35998. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  35999. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  36000. * @returns an array of PickingInfo
  36001. */
  36002. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  36003. /**
  36004. * Launch a ray to try to pick a mesh in the scene
  36005. * @param ray Ray to use
  36006. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true
  36007. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  36008. * @returns an array of PickingInfo
  36009. */
  36010. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  36011. /**
  36012. * Force the value of meshUnderPointer
  36013. * @param mesh defines the mesh to use
  36014. */
  36015. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  36016. /**
  36017. * Gets the mesh under the pointer
  36018. * @returns a Mesh or null if no mesh is under the pointer
  36019. */
  36020. getPointerOverMesh(): Nullable<AbstractMesh>;
  36021. /** @hidden */
  36022. _rebuildGeometries(): void;
  36023. /** @hidden */
  36024. _rebuildTextures(): void;
  36025. private _getByTags;
  36026. /**
  36027. * Get a list of meshes by tags
  36028. * @param tagsQuery defines the tags query to use
  36029. * @param forEach defines a predicate used to filter results
  36030. * @returns an array of Mesh
  36031. */
  36032. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  36033. /**
  36034. * Get a list of cameras by tags
  36035. * @param tagsQuery defines the tags query to use
  36036. * @param forEach defines a predicate used to filter results
  36037. * @returns an array of Camera
  36038. */
  36039. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  36040. /**
  36041. * Get a list of lights by tags
  36042. * @param tagsQuery defines the tags query to use
  36043. * @param forEach defines a predicate used to filter results
  36044. * @returns an array of Light
  36045. */
  36046. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  36047. /**
  36048. * Get a list of materials by tags
  36049. * @param tagsQuery defines the tags query to use
  36050. * @param forEach defines a predicate used to filter results
  36051. * @returns an array of Material
  36052. */
  36053. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  36054. /**
  36055. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  36056. * This allowed control for front to back rendering or reversly depending of the special needs.
  36057. *
  36058. * @param renderingGroupId The rendering group id corresponding to its index
  36059. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  36060. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  36061. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  36062. */
  36063. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  36064. /**
  36065. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  36066. *
  36067. * @param renderingGroupId The rendering group id corresponding to its index
  36068. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  36069. * @param depth Automatically clears depth between groups if true and autoClear is true.
  36070. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  36071. */
  36072. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  36073. /**
  36074. * Gets the current auto clear configuration for one rendering group of the rendering
  36075. * manager.
  36076. * @param index the rendering group index to get the information for
  36077. * @returns The auto clear setup for the requested rendering group
  36078. */
  36079. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  36080. private _blockMaterialDirtyMechanism;
  36081. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  36082. blockMaterialDirtyMechanism: boolean;
  36083. /**
  36084. * Will flag all materials as dirty to trigger new shader compilation
  36085. * @param flag defines the flag used to specify which material part must be marked as dirty
  36086. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  36087. */
  36088. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  36089. /** @hidden */
  36090. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  36091. /** @hidden */
  36092. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  36093. /** @hidden */
  36094. _requestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  36095. /** @hidden */
  36096. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  36097. /** @hidden */
  36098. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  36099. /** @hidden */
  36100. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  36101. }
  36102. }
  36103. declare module "babylonjs/assetContainer" {
  36104. import { AbstractScene } from "babylonjs/abstractScene";
  36105. import { Scene } from "babylonjs/scene";
  36106. import { Mesh } from "babylonjs/Meshes/mesh";
  36107. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36108. import { Skeleton } from "babylonjs/Bones/skeleton";
  36109. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  36110. /**
  36111. * Set of assets to keep when moving a scene into an asset container.
  36112. */
  36113. export class KeepAssets extends AbstractScene {
  36114. }
  36115. /**
  36116. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  36117. */
  36118. export class InstantiatedEntries {
  36119. /**
  36120. * List of new root nodes (eg. nodes with no parent)
  36121. */
  36122. rootNodes: TransformNode[];
  36123. /**
  36124. * List of new skeletons
  36125. */
  36126. skeletons: Skeleton[];
  36127. /**
  36128. * List of new animation groups
  36129. */
  36130. animationGroups: AnimationGroup[];
  36131. }
  36132. /**
  36133. * Container with a set of assets that can be added or removed from a scene.
  36134. */
  36135. export class AssetContainer extends AbstractScene {
  36136. /**
  36137. * The scene the AssetContainer belongs to.
  36138. */
  36139. scene: Scene;
  36140. /**
  36141. * Instantiates an AssetContainer.
  36142. * @param scene The scene the AssetContainer belongs to.
  36143. */
  36144. constructor(scene: Scene);
  36145. /**
  36146. * Instantiate or clone all meshes and add the new ones to the scene.
  36147. * Skeletons and animation groups will all be cloned
  36148. * @param nameFunction defines an optional function used to get new names for clones
  36149. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  36150. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  36151. */
  36152. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  36153. /**
  36154. * Adds all the assets from the container to the scene.
  36155. */
  36156. addAllToScene(): void;
  36157. /**
  36158. * Removes all the assets in the container from the scene
  36159. */
  36160. removeAllFromScene(): void;
  36161. /**
  36162. * Disposes all the assets in the container
  36163. */
  36164. dispose(): void;
  36165. private _moveAssets;
  36166. /**
  36167. * Removes all the assets contained in the scene and adds them to the container.
  36168. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  36169. */
  36170. moveAllFromScene(keepAssets?: KeepAssets): void;
  36171. /**
  36172. * Adds all meshes in the asset container to a root mesh that can be used to position all the contained meshes. The root mesh is then added to the front of the meshes in the assetContainer.
  36173. * @returns the root mesh
  36174. */
  36175. createRootMesh(): Mesh;
  36176. }
  36177. }
  36178. declare module "babylonjs/abstractScene" {
  36179. import { Scene } from "babylonjs/scene";
  36180. import { Nullable } from "babylonjs/types";
  36181. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  36182. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36183. import { Geometry } from "babylonjs/Meshes/geometry";
  36184. import { Skeleton } from "babylonjs/Bones/skeleton";
  36185. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  36186. import { AssetContainer } from "babylonjs/assetContainer";
  36187. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  36188. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  36189. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36190. import { Material } from "babylonjs/Materials/material";
  36191. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  36192. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  36193. import { Camera } from "babylonjs/Cameras/camera";
  36194. import { Light } from "babylonjs/Lights/light";
  36195. import { Node } from "babylonjs/node";
  36196. import { Animation } from "babylonjs/Animations/animation";
  36197. /**
  36198. * Defines how the parser contract is defined.
  36199. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  36200. */
  36201. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  36202. /**
  36203. * Defines how the individual parser contract is defined.
  36204. * These parser can parse an individual asset
  36205. */
  36206. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  36207. /**
  36208. * Base class of the scene acting as a container for the different elements composing a scene.
  36209. * This class is dynamically extended by the different components of the scene increasing
  36210. * flexibility and reducing coupling
  36211. */
  36212. export abstract class AbstractScene {
  36213. /**
  36214. * Stores the list of available parsers in the application.
  36215. */
  36216. private static _BabylonFileParsers;
  36217. /**
  36218. * Stores the list of available individual parsers in the application.
  36219. */
  36220. private static _IndividualBabylonFileParsers;
  36221. /**
  36222. * Adds a parser in the list of available ones
  36223. * @param name Defines the name of the parser
  36224. * @param parser Defines the parser to add
  36225. */
  36226. static AddParser(name: string, parser: BabylonFileParser): void;
  36227. /**
  36228. * Gets a general parser from the list of avaialble ones
  36229. * @param name Defines the name of the parser
  36230. * @returns the requested parser or null
  36231. */
  36232. static GetParser(name: string): Nullable<BabylonFileParser>;
  36233. /**
  36234. * Adds n individual parser in the list of available ones
  36235. * @param name Defines the name of the parser
  36236. * @param parser Defines the parser to add
  36237. */
  36238. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  36239. /**
  36240. * Gets an individual parser from the list of avaialble ones
  36241. * @param name Defines the name of the parser
  36242. * @returns the requested parser or null
  36243. */
  36244. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  36245. /**
  36246. * Parser json data and populate both a scene and its associated container object
  36247. * @param jsonData Defines the data to parse
  36248. * @param scene Defines the scene to parse the data for
  36249. * @param container Defines the container attached to the parsing sequence
  36250. * @param rootUrl Defines the root url of the data
  36251. */
  36252. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  36253. /**
  36254. * Gets the list of root nodes (ie. nodes with no parent)
  36255. */
  36256. rootNodes: Node[];
  36257. /** All of the cameras added to this scene
  36258. * @see http://doc.babylonjs.com/babylon101/cameras
  36259. */
  36260. cameras: Camera[];
  36261. /**
  36262. * All of the lights added to this scene
  36263. * @see http://doc.babylonjs.com/babylon101/lights
  36264. */
  36265. lights: Light[];
  36266. /**
  36267. * All of the (abstract) meshes added to this scene
  36268. */
  36269. meshes: AbstractMesh[];
  36270. /**
  36271. * The list of skeletons added to the scene
  36272. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  36273. */
  36274. skeletons: Skeleton[];
  36275. /**
  36276. * All of the particle systems added to this scene
  36277. * @see http://doc.babylonjs.com/babylon101/particles
  36278. */
  36279. particleSystems: IParticleSystem[];
  36280. /**
  36281. * Gets a list of Animations associated with the scene
  36282. */
  36283. animations: Animation[];
  36284. /**
  36285. * All of the animation groups added to this scene
  36286. * @see http://doc.babylonjs.com/how_to/group
  36287. */
  36288. animationGroups: AnimationGroup[];
  36289. /**
  36290. * All of the multi-materials added to this scene
  36291. * @see http://doc.babylonjs.com/how_to/multi_materials
  36292. */
  36293. multiMaterials: MultiMaterial[];
  36294. /**
  36295. * All of the materials added to this scene
  36296. * In the context of a Scene, it is not supposed to be modified manually.
  36297. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  36298. * Note also that the order of the Material within the array is not significant and might change.
  36299. * @see http://doc.babylonjs.com/babylon101/materials
  36300. */
  36301. materials: Material[];
  36302. /**
  36303. * The list of morph target managers added to the scene
  36304. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  36305. */
  36306. morphTargetManagers: MorphTargetManager[];
  36307. /**
  36308. * The list of geometries used in the scene.
  36309. */
  36310. geometries: Geometry[];
  36311. /**
  36312. * All of the tranform nodes added to this scene
  36313. * In the context of a Scene, it is not supposed to be modified manually.
  36314. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  36315. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  36316. * @see http://doc.babylonjs.com/how_to/transformnode
  36317. */
  36318. transformNodes: TransformNode[];
  36319. /**
  36320. * ActionManagers available on the scene.
  36321. */
  36322. actionManagers: AbstractActionManager[];
  36323. /**
  36324. * Textures to keep.
  36325. */
  36326. textures: BaseTexture[];
  36327. /**
  36328. * Environment texture for the scene
  36329. */
  36330. environmentTexture: Nullable<BaseTexture>;
  36331. }
  36332. }
  36333. declare module "babylonjs/Audio/sound" {
  36334. import { Observable } from "babylonjs/Misc/observable";
  36335. import { Vector3 } from "babylonjs/Maths/math.vector";
  36336. import { Nullable } from "babylonjs/types";
  36337. import { Scene } from "babylonjs/scene";
  36338. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36339. /**
  36340. * Interface used to define options for Sound class
  36341. */
  36342. export interface ISoundOptions {
  36343. /**
  36344. * Does the sound autoplay once loaded.
  36345. */
  36346. autoplay?: boolean;
  36347. /**
  36348. * Does the sound loop after it finishes playing once.
  36349. */
  36350. loop?: boolean;
  36351. /**
  36352. * Sound's volume
  36353. */
  36354. volume?: number;
  36355. /**
  36356. * Is it a spatial sound?
  36357. */
  36358. spatialSound?: boolean;
  36359. /**
  36360. * Maximum distance to hear that sound
  36361. */
  36362. maxDistance?: number;
  36363. /**
  36364. * Uses user defined attenuation function
  36365. */
  36366. useCustomAttenuation?: boolean;
  36367. /**
  36368. * Define the roll off factor of spatial sounds.
  36369. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36370. */
  36371. rolloffFactor?: number;
  36372. /**
  36373. * Define the reference distance the sound should be heard perfectly.
  36374. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36375. */
  36376. refDistance?: number;
  36377. /**
  36378. * Define the distance attenuation model the sound will follow.
  36379. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36380. */
  36381. distanceModel?: string;
  36382. /**
  36383. * Defines the playback speed (1 by default)
  36384. */
  36385. playbackRate?: number;
  36386. /**
  36387. * Defines if the sound is from a streaming source
  36388. */
  36389. streaming?: boolean;
  36390. /**
  36391. * Defines an optional length (in seconds) inside the sound file
  36392. */
  36393. length?: number;
  36394. /**
  36395. * Defines an optional offset (in seconds) inside the sound file
  36396. */
  36397. offset?: number;
  36398. /**
  36399. * If true, URLs will not be required to state the audio file codec to use.
  36400. */
  36401. skipCodecCheck?: boolean;
  36402. }
  36403. /**
  36404. * Defines a sound that can be played in the application.
  36405. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  36406. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36407. */
  36408. export class Sound {
  36409. /**
  36410. * The name of the sound in the scene.
  36411. */
  36412. name: string;
  36413. /**
  36414. * Does the sound autoplay once loaded.
  36415. */
  36416. autoplay: boolean;
  36417. /**
  36418. * Does the sound loop after it finishes playing once.
  36419. */
  36420. loop: boolean;
  36421. /**
  36422. * Does the sound use a custom attenuation curve to simulate the falloff
  36423. * happening when the source gets further away from the camera.
  36424. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  36425. */
  36426. useCustomAttenuation: boolean;
  36427. /**
  36428. * The sound track id this sound belongs to.
  36429. */
  36430. soundTrackId: number;
  36431. /**
  36432. * Is this sound currently played.
  36433. */
  36434. isPlaying: boolean;
  36435. /**
  36436. * Is this sound currently paused.
  36437. */
  36438. isPaused: boolean;
  36439. /**
  36440. * Does this sound enables spatial sound.
  36441. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36442. */
  36443. spatialSound: boolean;
  36444. /**
  36445. * Define the reference distance the sound should be heard perfectly.
  36446. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36447. */
  36448. refDistance: number;
  36449. /**
  36450. * Define the roll off factor of spatial sounds.
  36451. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36452. */
  36453. rolloffFactor: number;
  36454. /**
  36455. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  36456. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36457. */
  36458. maxDistance: number;
  36459. /**
  36460. * Define the distance attenuation model the sound will follow.
  36461. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36462. */
  36463. distanceModel: string;
  36464. /**
  36465. * @hidden
  36466. * Back Compat
  36467. **/
  36468. onended: () => any;
  36469. /**
  36470. * Observable event when the current playing sound finishes.
  36471. */
  36472. onEndedObservable: Observable<Sound>;
  36473. private _panningModel;
  36474. private _playbackRate;
  36475. private _streaming;
  36476. private _startTime;
  36477. private _startOffset;
  36478. private _position;
  36479. /** @hidden */
  36480. _positionInEmitterSpace: boolean;
  36481. private _localDirection;
  36482. private _volume;
  36483. private _isReadyToPlay;
  36484. private _isDirectional;
  36485. private _readyToPlayCallback;
  36486. private _audioBuffer;
  36487. private _soundSource;
  36488. private _streamingSource;
  36489. private _soundPanner;
  36490. private _soundGain;
  36491. private _inputAudioNode;
  36492. private _outputAudioNode;
  36493. private _coneInnerAngle;
  36494. private _coneOuterAngle;
  36495. private _coneOuterGain;
  36496. private _scene;
  36497. private _connectedTransformNode;
  36498. private _customAttenuationFunction;
  36499. private _registerFunc;
  36500. private _isOutputConnected;
  36501. private _htmlAudioElement;
  36502. private _urlType;
  36503. private _length?;
  36504. private _offset?;
  36505. /** @hidden */
  36506. static _SceneComponentInitialization: (scene: Scene) => void;
  36507. /**
  36508. * Create a sound and attach it to a scene
  36509. * @param name Name of your sound
  36510. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  36511. * @param scene defines the scene the sound belongs to
  36512. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  36513. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  36514. */
  36515. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  36516. /**
  36517. * Release the sound and its associated resources
  36518. */
  36519. dispose(): void;
  36520. /**
  36521. * Gets if the sounds is ready to be played or not.
  36522. * @returns true if ready, otherwise false
  36523. */
  36524. isReady(): boolean;
  36525. private _soundLoaded;
  36526. /**
  36527. * Sets the data of the sound from an audiobuffer
  36528. * @param audioBuffer The audioBuffer containing the data
  36529. */
  36530. setAudioBuffer(audioBuffer: AudioBuffer): void;
  36531. /**
  36532. * Updates the current sounds options such as maxdistance, loop...
  36533. * @param options A JSON object containing values named as the object properties
  36534. */
  36535. updateOptions(options: ISoundOptions): void;
  36536. private _createSpatialParameters;
  36537. private _updateSpatialParameters;
  36538. /**
  36539. * Switch the panning model to HRTF:
  36540. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36541. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36542. */
  36543. switchPanningModelToHRTF(): void;
  36544. /**
  36545. * Switch the panning model to Equal Power:
  36546. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36547. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36548. */
  36549. switchPanningModelToEqualPower(): void;
  36550. private _switchPanningModel;
  36551. /**
  36552. * Connect this sound to a sound track audio node like gain...
  36553. * @param soundTrackAudioNode the sound track audio node to connect to
  36554. */
  36555. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  36556. /**
  36557. * Transform this sound into a directional source
  36558. * @param coneInnerAngle Size of the inner cone in degree
  36559. * @param coneOuterAngle Size of the outer cone in degree
  36560. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  36561. */
  36562. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  36563. /**
  36564. * Gets or sets the inner angle for the directional cone.
  36565. */
  36566. /**
  36567. * Gets or sets the inner angle for the directional cone.
  36568. */
  36569. directionalConeInnerAngle: number;
  36570. /**
  36571. * Gets or sets the outer angle for the directional cone.
  36572. */
  36573. /**
  36574. * Gets or sets the outer angle for the directional cone.
  36575. */
  36576. directionalConeOuterAngle: number;
  36577. /**
  36578. * Sets the position of the emitter if spatial sound is enabled
  36579. * @param newPosition Defines the new posisiton
  36580. */
  36581. setPosition(newPosition: Vector3): void;
  36582. /**
  36583. * Sets the local direction of the emitter if spatial sound is enabled
  36584. * @param newLocalDirection Defines the new local direction
  36585. */
  36586. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  36587. private _updateDirection;
  36588. /** @hidden */
  36589. updateDistanceFromListener(): void;
  36590. /**
  36591. * Sets a new custom attenuation function for the sound.
  36592. * @param callback Defines the function used for the attenuation
  36593. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  36594. */
  36595. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  36596. /**
  36597. * Play the sound
  36598. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  36599. * @param offset (optional) Start the sound at a specific time in seconds
  36600. * @param length (optional) Sound duration (in seconds)
  36601. */
  36602. play(time?: number, offset?: number, length?: number): void;
  36603. private _onended;
  36604. /**
  36605. * Stop the sound
  36606. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  36607. */
  36608. stop(time?: number): void;
  36609. /**
  36610. * Put the sound in pause
  36611. */
  36612. pause(): void;
  36613. /**
  36614. * Sets a dedicated volume for this sounds
  36615. * @param newVolume Define the new volume of the sound
  36616. * @param time Define time for gradual change to new volume
  36617. */
  36618. setVolume(newVolume: number, time?: number): void;
  36619. /**
  36620. * Set the sound play back rate
  36621. * @param newPlaybackRate Define the playback rate the sound should be played at
  36622. */
  36623. setPlaybackRate(newPlaybackRate: number): void;
  36624. /**
  36625. * Gets the volume of the sound.
  36626. * @returns the volume of the sound
  36627. */
  36628. getVolume(): number;
  36629. /**
  36630. * Attach the sound to a dedicated mesh
  36631. * @param transformNode The transform node to connect the sound with
  36632. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  36633. */
  36634. attachToMesh(transformNode: TransformNode): void;
  36635. /**
  36636. * Detach the sound from the previously attached mesh
  36637. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  36638. */
  36639. detachFromMesh(): void;
  36640. private _onRegisterAfterWorldMatrixUpdate;
  36641. /**
  36642. * Clone the current sound in the scene.
  36643. * @returns the new sound clone
  36644. */
  36645. clone(): Nullable<Sound>;
  36646. /**
  36647. * Gets the current underlying audio buffer containing the data
  36648. * @returns the audio buffer
  36649. */
  36650. getAudioBuffer(): Nullable<AudioBuffer>;
  36651. /**
  36652. * Serializes the Sound in a JSON representation
  36653. * @returns the JSON representation of the sound
  36654. */
  36655. serialize(): any;
  36656. /**
  36657. * Parse a JSON representation of a sound to innstantiate in a given scene
  36658. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  36659. * @param scene Define the scene the new parsed sound should be created in
  36660. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  36661. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  36662. * @returns the newly parsed sound
  36663. */
  36664. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  36665. }
  36666. }
  36667. declare module "babylonjs/Actions/directAudioActions" {
  36668. import { Action } from "babylonjs/Actions/action";
  36669. import { Condition } from "babylonjs/Actions/condition";
  36670. import { Sound } from "babylonjs/Audio/sound";
  36671. /**
  36672. * This defines an action helpful to play a defined sound on a triggered action.
  36673. */
  36674. export class PlaySoundAction extends Action {
  36675. private _sound;
  36676. /**
  36677. * Instantiate the action
  36678. * @param triggerOptions defines the trigger options
  36679. * @param sound defines the sound to play
  36680. * @param condition defines the trigger related conditions
  36681. */
  36682. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36683. /** @hidden */
  36684. _prepare(): void;
  36685. /**
  36686. * Execute the action and play the sound.
  36687. */
  36688. execute(): void;
  36689. /**
  36690. * Serializes the actions and its related information.
  36691. * @param parent defines the object to serialize in
  36692. * @returns the serialized object
  36693. */
  36694. serialize(parent: any): any;
  36695. }
  36696. /**
  36697. * This defines an action helpful to stop a defined sound on a triggered action.
  36698. */
  36699. export class StopSoundAction extends Action {
  36700. private _sound;
  36701. /**
  36702. * Instantiate the action
  36703. * @param triggerOptions defines the trigger options
  36704. * @param sound defines the sound to stop
  36705. * @param condition defines the trigger related conditions
  36706. */
  36707. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36708. /** @hidden */
  36709. _prepare(): void;
  36710. /**
  36711. * Execute the action and stop the sound.
  36712. */
  36713. execute(): void;
  36714. /**
  36715. * Serializes the actions and its related information.
  36716. * @param parent defines the object to serialize in
  36717. * @returns the serialized object
  36718. */
  36719. serialize(parent: any): any;
  36720. }
  36721. }
  36722. declare module "babylonjs/Actions/interpolateValueAction" {
  36723. import { Action } from "babylonjs/Actions/action";
  36724. import { Condition } from "babylonjs/Actions/condition";
  36725. import { Observable } from "babylonjs/Misc/observable";
  36726. /**
  36727. * This defines an action responsible to change the value of a property
  36728. * by interpolating between its current value and the newly set one once triggered.
  36729. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  36730. */
  36731. export class InterpolateValueAction extends Action {
  36732. /**
  36733. * Defines the path of the property where the value should be interpolated
  36734. */
  36735. propertyPath: string;
  36736. /**
  36737. * Defines the target value at the end of the interpolation.
  36738. */
  36739. value: any;
  36740. /**
  36741. * Defines the time it will take for the property to interpolate to the value.
  36742. */
  36743. duration: number;
  36744. /**
  36745. * Defines if the other scene animations should be stopped when the action has been triggered
  36746. */
  36747. stopOtherAnimations?: boolean;
  36748. /**
  36749. * Defines a callback raised once the interpolation animation has been done.
  36750. */
  36751. onInterpolationDone?: () => void;
  36752. /**
  36753. * Observable triggered once the interpolation animation has been done.
  36754. */
  36755. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  36756. private _target;
  36757. private _effectiveTarget;
  36758. private _property;
  36759. /**
  36760. * Instantiate the action
  36761. * @param triggerOptions defines the trigger options
  36762. * @param target defines the object containing the value to interpolate
  36763. * @param propertyPath defines the path to the property in the target object
  36764. * @param value defines the target value at the end of the interpolation
  36765. * @param duration deines the time it will take for the property to interpolate to the value.
  36766. * @param condition defines the trigger related conditions
  36767. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  36768. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  36769. */
  36770. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  36771. /** @hidden */
  36772. _prepare(): void;
  36773. /**
  36774. * Execute the action starts the value interpolation.
  36775. */
  36776. execute(): void;
  36777. /**
  36778. * Serializes the actions and its related information.
  36779. * @param parent defines the object to serialize in
  36780. * @returns the serialized object
  36781. */
  36782. serialize(parent: any): any;
  36783. }
  36784. }
  36785. declare module "babylonjs/Actions/index" {
  36786. export * from "babylonjs/Actions/abstractActionManager";
  36787. export * from "babylonjs/Actions/action";
  36788. export * from "babylonjs/Actions/actionEvent";
  36789. export * from "babylonjs/Actions/actionManager";
  36790. export * from "babylonjs/Actions/condition";
  36791. export * from "babylonjs/Actions/directActions";
  36792. export * from "babylonjs/Actions/directAudioActions";
  36793. export * from "babylonjs/Actions/interpolateValueAction";
  36794. }
  36795. declare module "babylonjs/Animations/index" {
  36796. export * from "babylonjs/Animations/animatable";
  36797. export * from "babylonjs/Animations/animation";
  36798. export * from "babylonjs/Animations/animationGroup";
  36799. export * from "babylonjs/Animations/animationPropertiesOverride";
  36800. export * from "babylonjs/Animations/easing";
  36801. export * from "babylonjs/Animations/runtimeAnimation";
  36802. export * from "babylonjs/Animations/animationEvent";
  36803. export * from "babylonjs/Animations/animationGroup";
  36804. export * from "babylonjs/Animations/animationKey";
  36805. export * from "babylonjs/Animations/animationRange";
  36806. export * from "babylonjs/Animations/animatable.interface";
  36807. }
  36808. declare module "babylonjs/Audio/soundTrack" {
  36809. import { Sound } from "babylonjs/Audio/sound";
  36810. import { Analyser } from "babylonjs/Audio/analyser";
  36811. import { Scene } from "babylonjs/scene";
  36812. /**
  36813. * Options allowed during the creation of a sound track.
  36814. */
  36815. export interface ISoundTrackOptions {
  36816. /**
  36817. * The volume the sound track should take during creation
  36818. */
  36819. volume?: number;
  36820. /**
  36821. * Define if the sound track is the main sound track of the scene
  36822. */
  36823. mainTrack?: boolean;
  36824. }
  36825. /**
  36826. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  36827. * It will be also used in a future release to apply effects on a specific track.
  36828. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36829. */
  36830. export class SoundTrack {
  36831. /**
  36832. * The unique identifier of the sound track in the scene.
  36833. */
  36834. id: number;
  36835. /**
  36836. * The list of sounds included in the sound track.
  36837. */
  36838. soundCollection: Array<Sound>;
  36839. private _outputAudioNode;
  36840. private _scene;
  36841. private _isMainTrack;
  36842. private _connectedAnalyser;
  36843. private _options;
  36844. private _isInitialized;
  36845. /**
  36846. * Creates a new sound track.
  36847. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36848. * @param scene Define the scene the sound track belongs to
  36849. * @param options
  36850. */
  36851. constructor(scene: Scene, options?: ISoundTrackOptions);
  36852. private _initializeSoundTrackAudioGraph;
  36853. /**
  36854. * Release the sound track and its associated resources
  36855. */
  36856. dispose(): void;
  36857. /**
  36858. * Adds a sound to this sound track
  36859. * @param sound define the cound to add
  36860. * @ignoreNaming
  36861. */
  36862. AddSound(sound: Sound): void;
  36863. /**
  36864. * Removes a sound to this sound track
  36865. * @param sound define the cound to remove
  36866. * @ignoreNaming
  36867. */
  36868. RemoveSound(sound: Sound): void;
  36869. /**
  36870. * Set a global volume for the full sound track.
  36871. * @param newVolume Define the new volume of the sound track
  36872. */
  36873. setVolume(newVolume: number): void;
  36874. /**
  36875. * Switch the panning model to HRTF:
  36876. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36877. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36878. */
  36879. switchPanningModelToHRTF(): void;
  36880. /**
  36881. * Switch the panning model to Equal Power:
  36882. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36883. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36884. */
  36885. switchPanningModelToEqualPower(): void;
  36886. /**
  36887. * Connect the sound track to an audio analyser allowing some amazing
  36888. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  36889. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  36890. * @param analyser The analyser to connect to the engine
  36891. */
  36892. connectToAnalyser(analyser: Analyser): void;
  36893. }
  36894. }
  36895. declare module "babylonjs/Audio/audioSceneComponent" {
  36896. import { Sound } from "babylonjs/Audio/sound";
  36897. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  36898. import { Nullable } from "babylonjs/types";
  36899. import { Vector3 } from "babylonjs/Maths/math.vector";
  36900. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  36901. import { Scene } from "babylonjs/scene";
  36902. import { AbstractScene } from "babylonjs/abstractScene";
  36903. import "babylonjs/Audio/audioEngine";
  36904. module "babylonjs/abstractScene" {
  36905. interface AbstractScene {
  36906. /**
  36907. * The list of sounds used in the scene.
  36908. */
  36909. sounds: Nullable<Array<Sound>>;
  36910. }
  36911. }
  36912. module "babylonjs/scene" {
  36913. interface Scene {
  36914. /**
  36915. * @hidden
  36916. * Backing field
  36917. */
  36918. _mainSoundTrack: SoundTrack;
  36919. /**
  36920. * The main sound track played by the scene.
  36921. * It cotains your primary collection of sounds.
  36922. */
  36923. mainSoundTrack: SoundTrack;
  36924. /**
  36925. * The list of sound tracks added to the scene
  36926. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36927. */
  36928. soundTracks: Nullable<Array<SoundTrack>>;
  36929. /**
  36930. * Gets a sound using a given name
  36931. * @param name defines the name to search for
  36932. * @return the found sound or null if not found at all.
  36933. */
  36934. getSoundByName(name: string): Nullable<Sound>;
  36935. /**
  36936. * Gets or sets if audio support is enabled
  36937. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36938. */
  36939. audioEnabled: boolean;
  36940. /**
  36941. * Gets or sets if audio will be output to headphones
  36942. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36943. */
  36944. headphone: boolean;
  36945. /**
  36946. * Gets or sets custom audio listener position provider
  36947. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36948. */
  36949. audioListenerPositionProvider: Nullable<() => Vector3>;
  36950. /**
  36951. * Gets or sets a refresh rate when using 3D audio positioning
  36952. */
  36953. audioPositioningRefreshRate: number;
  36954. }
  36955. }
  36956. /**
  36957. * Defines the sound scene component responsible to manage any sounds
  36958. * in a given scene.
  36959. */
  36960. export class AudioSceneComponent implements ISceneSerializableComponent {
  36961. /**
  36962. * The component name helpfull to identify the component in the list of scene components.
  36963. */
  36964. readonly name: string;
  36965. /**
  36966. * The scene the component belongs to.
  36967. */
  36968. scene: Scene;
  36969. private _audioEnabled;
  36970. /**
  36971. * Gets whether audio is enabled or not.
  36972. * Please use related enable/disable method to switch state.
  36973. */
  36974. readonly audioEnabled: boolean;
  36975. private _headphone;
  36976. /**
  36977. * Gets whether audio is outputing to headphone or not.
  36978. * Please use the according Switch methods to change output.
  36979. */
  36980. readonly headphone: boolean;
  36981. /**
  36982. * Gets or sets a refresh rate when using 3D audio positioning
  36983. */
  36984. audioPositioningRefreshRate: number;
  36985. private _audioListenerPositionProvider;
  36986. /**
  36987. * Gets the current audio listener position provider
  36988. */
  36989. /**
  36990. * Sets a custom listener position for all sounds in the scene
  36991. * By default, this is the position of the first active camera
  36992. */
  36993. audioListenerPositionProvider: Nullable<() => Vector3>;
  36994. /**
  36995. * Creates a new instance of the component for the given scene
  36996. * @param scene Defines the scene to register the component in
  36997. */
  36998. constructor(scene: Scene);
  36999. /**
  37000. * Registers the component in a given scene
  37001. */
  37002. register(): void;
  37003. /**
  37004. * Rebuilds the elements related to this component in case of
  37005. * context lost for instance.
  37006. */
  37007. rebuild(): void;
  37008. /**
  37009. * Serializes the component data to the specified json object
  37010. * @param serializationObject The object to serialize to
  37011. */
  37012. serialize(serializationObject: any): void;
  37013. /**
  37014. * Adds all the elements from the container to the scene
  37015. * @param container the container holding the elements
  37016. */
  37017. addFromContainer(container: AbstractScene): void;
  37018. /**
  37019. * Removes all the elements in the container from the scene
  37020. * @param container contains the elements to remove
  37021. * @param dispose if the removed element should be disposed (default: false)
  37022. */
  37023. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  37024. /**
  37025. * Disposes the component and the associated ressources.
  37026. */
  37027. dispose(): void;
  37028. /**
  37029. * Disables audio in the associated scene.
  37030. */
  37031. disableAudio(): void;
  37032. /**
  37033. * Enables audio in the associated scene.
  37034. */
  37035. enableAudio(): void;
  37036. /**
  37037. * Switch audio to headphone output.
  37038. */
  37039. switchAudioModeForHeadphones(): void;
  37040. /**
  37041. * Switch audio to normal speakers.
  37042. */
  37043. switchAudioModeForNormalSpeakers(): void;
  37044. private _cachedCameraDirection;
  37045. private _cachedCameraPosition;
  37046. private _lastCheck;
  37047. private _afterRender;
  37048. }
  37049. }
  37050. declare module "babylonjs/Audio/weightedsound" {
  37051. import { Sound } from "babylonjs/Audio/sound";
  37052. /**
  37053. * Wraps one or more Sound objects and selects one with random weight for playback.
  37054. */
  37055. export class WeightedSound {
  37056. /** When true a Sound will be selected and played when the current playing Sound completes. */
  37057. loop: boolean;
  37058. private _coneInnerAngle;
  37059. private _coneOuterAngle;
  37060. private _volume;
  37061. /** A Sound is currently playing. */
  37062. isPlaying: boolean;
  37063. /** A Sound is currently paused. */
  37064. isPaused: boolean;
  37065. private _sounds;
  37066. private _weights;
  37067. private _currentIndex?;
  37068. /**
  37069. * Creates a new WeightedSound from the list of sounds given.
  37070. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  37071. * @param sounds Array of Sounds that will be selected from.
  37072. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  37073. */
  37074. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  37075. /**
  37076. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  37077. */
  37078. /**
  37079. * The size of cone in degress for a directional sound in which there will be no attenuation.
  37080. */
  37081. directionalConeInnerAngle: number;
  37082. /**
  37083. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  37084. * Listener angles between innerAngle and outerAngle will falloff linearly.
  37085. */
  37086. /**
  37087. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  37088. * Listener angles between innerAngle and outerAngle will falloff linearly.
  37089. */
  37090. directionalConeOuterAngle: number;
  37091. /**
  37092. * Playback volume.
  37093. */
  37094. /**
  37095. * Playback volume.
  37096. */
  37097. volume: number;
  37098. private _onended;
  37099. /**
  37100. * Suspend playback
  37101. */
  37102. pause(): void;
  37103. /**
  37104. * Stop playback
  37105. */
  37106. stop(): void;
  37107. /**
  37108. * Start playback.
  37109. * @param startOffset Position the clip head at a specific time in seconds.
  37110. */
  37111. play(startOffset?: number): void;
  37112. }
  37113. }
  37114. declare module "babylonjs/Audio/index" {
  37115. export * from "babylonjs/Audio/analyser";
  37116. export * from "babylonjs/Audio/audioEngine";
  37117. export * from "babylonjs/Audio/audioSceneComponent";
  37118. export * from "babylonjs/Audio/sound";
  37119. export * from "babylonjs/Audio/soundTrack";
  37120. export * from "babylonjs/Audio/weightedsound";
  37121. }
  37122. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  37123. import { Behavior } from "babylonjs/Behaviors/behavior";
  37124. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37125. import { BackEase } from "babylonjs/Animations/easing";
  37126. /**
  37127. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  37128. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37129. */
  37130. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  37131. /**
  37132. * Gets the name of the behavior.
  37133. */
  37134. readonly name: string;
  37135. /**
  37136. * The easing function used by animations
  37137. */
  37138. static EasingFunction: BackEase;
  37139. /**
  37140. * The easing mode used by animations
  37141. */
  37142. static EasingMode: number;
  37143. /**
  37144. * The duration of the animation, in milliseconds
  37145. */
  37146. transitionDuration: number;
  37147. /**
  37148. * Length of the distance animated by the transition when lower radius is reached
  37149. */
  37150. lowerRadiusTransitionRange: number;
  37151. /**
  37152. * Length of the distance animated by the transition when upper radius is reached
  37153. */
  37154. upperRadiusTransitionRange: number;
  37155. private _autoTransitionRange;
  37156. /**
  37157. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  37158. */
  37159. /**
  37160. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  37161. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  37162. */
  37163. autoTransitionRange: boolean;
  37164. private _attachedCamera;
  37165. private _onAfterCheckInputsObserver;
  37166. private _onMeshTargetChangedObserver;
  37167. /**
  37168. * Initializes the behavior.
  37169. */
  37170. init(): void;
  37171. /**
  37172. * Attaches the behavior to its arc rotate camera.
  37173. * @param camera Defines the camera to attach the behavior to
  37174. */
  37175. attach(camera: ArcRotateCamera): void;
  37176. /**
  37177. * Detaches the behavior from its current arc rotate camera.
  37178. */
  37179. detach(): void;
  37180. private _radiusIsAnimating;
  37181. private _radiusBounceTransition;
  37182. private _animatables;
  37183. private _cachedWheelPrecision;
  37184. /**
  37185. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  37186. * @param radiusLimit The limit to check against.
  37187. * @return Bool to indicate if at limit.
  37188. */
  37189. private _isRadiusAtLimit;
  37190. /**
  37191. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  37192. * @param radiusDelta The delta by which to animate to. Can be negative.
  37193. */
  37194. private _applyBoundRadiusAnimation;
  37195. /**
  37196. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  37197. */
  37198. protected _clearAnimationLocks(): void;
  37199. /**
  37200. * Stops and removes all animations that have been applied to the camera
  37201. */
  37202. stopAllAnimations(): void;
  37203. }
  37204. }
  37205. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  37206. import { Behavior } from "babylonjs/Behaviors/behavior";
  37207. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37208. import { ExponentialEase } from "babylonjs/Animations/easing";
  37209. import { Nullable } from "babylonjs/types";
  37210. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37211. import { Vector3 } from "babylonjs/Maths/math.vector";
  37212. /**
  37213. * The framing behavior (FramingBehavior) is designed to automatically position an ArcRotateCamera when its target is set to a mesh. It is also useful if you want to prevent the camera to go under a virtual horizontal plane.
  37214. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37215. */
  37216. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  37217. /**
  37218. * Gets the name of the behavior.
  37219. */
  37220. readonly name: string;
  37221. private _mode;
  37222. private _radiusScale;
  37223. private _positionScale;
  37224. private _defaultElevation;
  37225. private _elevationReturnTime;
  37226. private _elevationReturnWaitTime;
  37227. private _zoomStopsAnimation;
  37228. private _framingTime;
  37229. /**
  37230. * The easing function used by animations
  37231. */
  37232. static EasingFunction: ExponentialEase;
  37233. /**
  37234. * The easing mode used by animations
  37235. */
  37236. static EasingMode: number;
  37237. /**
  37238. * Sets the current mode used by the behavior
  37239. */
  37240. /**
  37241. * Gets current mode used by the behavior.
  37242. */
  37243. mode: number;
  37244. /**
  37245. * Sets the scale applied to the radius (1 by default)
  37246. */
  37247. /**
  37248. * Gets the scale applied to the radius
  37249. */
  37250. radiusScale: number;
  37251. /**
  37252. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  37253. */
  37254. /**
  37255. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  37256. */
  37257. positionScale: number;
  37258. /**
  37259. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  37260. * behaviour is triggered, in radians.
  37261. */
  37262. /**
  37263. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  37264. * behaviour is triggered, in radians.
  37265. */
  37266. defaultElevation: number;
  37267. /**
  37268. * Sets the time (in milliseconds) taken to return to the default beta position.
  37269. * Negative value indicates camera should not return to default.
  37270. */
  37271. /**
  37272. * Gets the time (in milliseconds) taken to return to the default beta position.
  37273. * Negative value indicates camera should not return to default.
  37274. */
  37275. elevationReturnTime: number;
  37276. /**
  37277. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  37278. */
  37279. /**
  37280. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  37281. */
  37282. elevationReturnWaitTime: number;
  37283. /**
  37284. * Sets the flag that indicates if user zooming should stop animation.
  37285. */
  37286. /**
  37287. * Gets the flag that indicates if user zooming should stop animation.
  37288. */
  37289. zoomStopsAnimation: boolean;
  37290. /**
  37291. * Sets the transition time when framing the mesh, in milliseconds
  37292. */
  37293. /**
  37294. * Gets the transition time when framing the mesh, in milliseconds
  37295. */
  37296. framingTime: number;
  37297. /**
  37298. * Define if the behavior should automatically change the configured
  37299. * camera limits and sensibilities.
  37300. */
  37301. autoCorrectCameraLimitsAndSensibility: boolean;
  37302. private _onPrePointerObservableObserver;
  37303. private _onAfterCheckInputsObserver;
  37304. private _onMeshTargetChangedObserver;
  37305. private _attachedCamera;
  37306. private _isPointerDown;
  37307. private _lastInteractionTime;
  37308. /**
  37309. * Initializes the behavior.
  37310. */
  37311. init(): void;
  37312. /**
  37313. * Attaches the behavior to its arc rotate camera.
  37314. * @param camera Defines the camera to attach the behavior to
  37315. */
  37316. attach(camera: ArcRotateCamera): void;
  37317. /**
  37318. * Detaches the behavior from its current arc rotate camera.
  37319. */
  37320. detach(): void;
  37321. private _animatables;
  37322. private _betaIsAnimating;
  37323. private _betaTransition;
  37324. private _radiusTransition;
  37325. private _vectorTransition;
  37326. /**
  37327. * Targets the given mesh and updates zoom level accordingly.
  37328. * @param mesh The mesh to target.
  37329. * @param radius Optional. If a cached radius position already exists, overrides default.
  37330. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37331. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37332. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37333. */
  37334. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37335. /**
  37336. * Targets the given mesh with its children and updates zoom level accordingly.
  37337. * @param mesh The mesh to target.
  37338. * @param radius Optional. If a cached radius position already exists, overrides default.
  37339. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37340. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37341. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37342. */
  37343. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37344. /**
  37345. * Targets the given meshes with their children and updates zoom level accordingly.
  37346. * @param meshes The mesh to target.
  37347. * @param radius Optional. If a cached radius position already exists, overrides default.
  37348. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37349. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37350. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37351. */
  37352. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37353. /**
  37354. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  37355. * @param minimumWorld Determines the smaller position of the bounding box extend
  37356. * @param maximumWorld Determines the bigger position of the bounding box extend
  37357. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37358. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37359. */
  37360. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37361. /**
  37362. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  37363. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  37364. * frustum width.
  37365. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  37366. * to fully enclose the mesh in the viewing frustum.
  37367. */
  37368. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  37369. /**
  37370. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  37371. * is automatically returned to its default position (expected to be above ground plane).
  37372. */
  37373. private _maintainCameraAboveGround;
  37374. /**
  37375. * Returns the frustum slope based on the canvas ratio and camera FOV
  37376. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  37377. */
  37378. private _getFrustumSlope;
  37379. /**
  37380. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  37381. */
  37382. private _clearAnimationLocks;
  37383. /**
  37384. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  37385. */
  37386. private _applyUserInteraction;
  37387. /**
  37388. * Stops and removes all animations that have been applied to the camera
  37389. */
  37390. stopAllAnimations(): void;
  37391. /**
  37392. * Gets a value indicating if the user is moving the camera
  37393. */
  37394. readonly isUserIsMoving: boolean;
  37395. /**
  37396. * The camera can move all the way towards the mesh.
  37397. */
  37398. static IgnoreBoundsSizeMode: number;
  37399. /**
  37400. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  37401. */
  37402. static FitFrustumSidesMode: number;
  37403. }
  37404. }
  37405. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  37406. import { Nullable } from "babylonjs/types";
  37407. import { Camera } from "babylonjs/Cameras/camera";
  37408. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37409. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  37410. /**
  37411. * Base class for Camera Pointer Inputs.
  37412. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  37413. * for example usage.
  37414. */
  37415. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  37416. /**
  37417. * Defines the camera the input is attached to.
  37418. */
  37419. abstract camera: Camera;
  37420. /**
  37421. * Whether keyboard modifier keys are pressed at time of last mouse event.
  37422. */
  37423. protected _altKey: boolean;
  37424. protected _ctrlKey: boolean;
  37425. protected _metaKey: boolean;
  37426. protected _shiftKey: boolean;
  37427. /**
  37428. * Which mouse buttons were pressed at time of last mouse event.
  37429. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  37430. */
  37431. protected _buttonsPressed: number;
  37432. /**
  37433. * Defines the buttons associated with the input to handle camera move.
  37434. */
  37435. buttons: number[];
  37436. /**
  37437. * Attach the input controls to a specific dom element to get the input from.
  37438. * @param element Defines the element the controls should be listened from
  37439. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37440. */
  37441. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37442. /**
  37443. * Detach the current controls from the specified dom element.
  37444. * @param element Defines the element to stop listening the inputs from
  37445. */
  37446. detachControl(element: Nullable<HTMLElement>): void;
  37447. /**
  37448. * Gets the class name of the current input.
  37449. * @returns the class name
  37450. */
  37451. getClassName(): string;
  37452. /**
  37453. * Get the friendly name associated with the input class.
  37454. * @returns the input friendly name
  37455. */
  37456. getSimpleName(): string;
  37457. /**
  37458. * Called on pointer POINTERDOUBLETAP event.
  37459. * Override this method to provide functionality on POINTERDOUBLETAP event.
  37460. */
  37461. protected onDoubleTap(type: string): void;
  37462. /**
  37463. * Called on pointer POINTERMOVE event if only a single touch is active.
  37464. * Override this method to provide functionality.
  37465. */
  37466. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  37467. /**
  37468. * Called on pointer POINTERMOVE event if multiple touches are active.
  37469. * Override this method to provide functionality.
  37470. */
  37471. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  37472. /**
  37473. * Called on JS contextmenu event.
  37474. * Override this method to provide functionality.
  37475. */
  37476. protected onContextMenu(evt: PointerEvent): void;
  37477. /**
  37478. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  37479. * press.
  37480. * Override this method to provide functionality.
  37481. */
  37482. protected onButtonDown(evt: PointerEvent): void;
  37483. /**
  37484. * Called each time a new POINTERUP event occurs. Ie, for each button
  37485. * release.
  37486. * Override this method to provide functionality.
  37487. */
  37488. protected onButtonUp(evt: PointerEvent): void;
  37489. /**
  37490. * Called when window becomes inactive.
  37491. * Override this method to provide functionality.
  37492. */
  37493. protected onLostFocus(): void;
  37494. private _pointerInput;
  37495. private _observer;
  37496. private _onLostFocus;
  37497. private pointA;
  37498. private pointB;
  37499. }
  37500. }
  37501. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  37502. import { Nullable } from "babylonjs/types";
  37503. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37504. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  37505. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  37506. /**
  37507. * Manage the pointers inputs to control an arc rotate camera.
  37508. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37509. */
  37510. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  37511. /**
  37512. * Defines the camera the input is attached to.
  37513. */
  37514. camera: ArcRotateCamera;
  37515. /**
  37516. * Gets the class name of the current input.
  37517. * @returns the class name
  37518. */
  37519. getClassName(): string;
  37520. /**
  37521. * Defines the buttons associated with the input to handle camera move.
  37522. */
  37523. buttons: number[];
  37524. /**
  37525. * Defines the pointer angular sensibility along the X axis or how fast is
  37526. * the camera rotating.
  37527. */
  37528. angularSensibilityX: number;
  37529. /**
  37530. * Defines the pointer angular sensibility along the Y axis or how fast is
  37531. * the camera rotating.
  37532. */
  37533. angularSensibilityY: number;
  37534. /**
  37535. * Defines the pointer pinch precision or how fast is the camera zooming.
  37536. */
  37537. pinchPrecision: number;
  37538. /**
  37539. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  37540. * from 0.
  37541. * It defines the percentage of current camera.radius to use as delta when
  37542. * pinch zoom is used.
  37543. */
  37544. pinchDeltaPercentage: number;
  37545. /**
  37546. * Defines the pointer panning sensibility or how fast is the camera moving.
  37547. */
  37548. panningSensibility: number;
  37549. /**
  37550. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  37551. */
  37552. multiTouchPanning: boolean;
  37553. /**
  37554. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  37555. * zoom (pinch) through multitouch.
  37556. */
  37557. multiTouchPanAndZoom: boolean;
  37558. /**
  37559. * Revers pinch action direction.
  37560. */
  37561. pinchInwards: boolean;
  37562. private _isPanClick;
  37563. private _twoFingerActivityCount;
  37564. private _isPinching;
  37565. /**
  37566. * Called on pointer POINTERMOVE event if only a single touch is active.
  37567. */
  37568. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  37569. /**
  37570. * Called on pointer POINTERDOUBLETAP event.
  37571. */
  37572. protected onDoubleTap(type: string): void;
  37573. /**
  37574. * Called on pointer POINTERMOVE event if multiple touches are active.
  37575. */
  37576. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  37577. /**
  37578. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  37579. * press.
  37580. */
  37581. protected onButtonDown(evt: PointerEvent): void;
  37582. /**
  37583. * Called each time a new POINTERUP event occurs. Ie, for each button
  37584. * release.
  37585. */
  37586. protected onButtonUp(evt: PointerEvent): void;
  37587. /**
  37588. * Called when window becomes inactive.
  37589. */
  37590. protected onLostFocus(): void;
  37591. }
  37592. }
  37593. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  37594. import { Nullable } from "babylonjs/types";
  37595. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37596. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37597. /**
  37598. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  37599. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37600. */
  37601. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  37602. /**
  37603. * Defines the camera the input is attached to.
  37604. */
  37605. camera: ArcRotateCamera;
  37606. /**
  37607. * Defines the list of key codes associated with the up action (increase alpha)
  37608. */
  37609. keysUp: number[];
  37610. /**
  37611. * Defines the list of key codes associated with the down action (decrease alpha)
  37612. */
  37613. keysDown: number[];
  37614. /**
  37615. * Defines the list of key codes associated with the left action (increase beta)
  37616. */
  37617. keysLeft: number[];
  37618. /**
  37619. * Defines the list of key codes associated with the right action (decrease beta)
  37620. */
  37621. keysRight: number[];
  37622. /**
  37623. * Defines the list of key codes associated with the reset action.
  37624. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  37625. */
  37626. keysReset: number[];
  37627. /**
  37628. * Defines the panning sensibility of the inputs.
  37629. * (How fast is the camera paning)
  37630. */
  37631. panningSensibility: number;
  37632. /**
  37633. * Defines the zooming sensibility of the inputs.
  37634. * (How fast is the camera zooming)
  37635. */
  37636. zoomingSensibility: number;
  37637. /**
  37638. * Defines wether maintaining the alt key down switch the movement mode from
  37639. * orientation to zoom.
  37640. */
  37641. useAltToZoom: boolean;
  37642. /**
  37643. * Rotation speed of the camera
  37644. */
  37645. angularSpeed: number;
  37646. private _keys;
  37647. private _ctrlPressed;
  37648. private _altPressed;
  37649. private _onCanvasBlurObserver;
  37650. private _onKeyboardObserver;
  37651. private _engine;
  37652. private _scene;
  37653. /**
  37654. * Attach the input controls to a specific dom element to get the input from.
  37655. * @param element Defines the element the controls should be listened from
  37656. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37657. */
  37658. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37659. /**
  37660. * Detach the current controls from the specified dom element.
  37661. * @param element Defines the element to stop listening the inputs from
  37662. */
  37663. detachControl(element: Nullable<HTMLElement>): void;
  37664. /**
  37665. * Update the current camera state depending on the inputs that have been used this frame.
  37666. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  37667. */
  37668. checkInputs(): void;
  37669. /**
  37670. * Gets the class name of the current intput.
  37671. * @returns the class name
  37672. */
  37673. getClassName(): string;
  37674. /**
  37675. * Get the friendly name associated with the input class.
  37676. * @returns the input friendly name
  37677. */
  37678. getSimpleName(): string;
  37679. }
  37680. }
  37681. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  37682. import { Nullable } from "babylonjs/types";
  37683. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37684. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37685. /**
  37686. * Manage the mouse wheel inputs to control an arc rotate camera.
  37687. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37688. */
  37689. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  37690. /**
  37691. * Defines the camera the input is attached to.
  37692. */
  37693. camera: ArcRotateCamera;
  37694. /**
  37695. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37696. */
  37697. wheelPrecision: number;
  37698. /**
  37699. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  37700. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  37701. */
  37702. wheelDeltaPercentage: number;
  37703. private _wheel;
  37704. private _observer;
  37705. private computeDeltaFromMouseWheelLegacyEvent;
  37706. /**
  37707. * Attach the input controls to a specific dom element to get the input from.
  37708. * @param element Defines the element the controls should be listened from
  37709. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37710. */
  37711. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37712. /**
  37713. * Detach the current controls from the specified dom element.
  37714. * @param element Defines the element to stop listening the inputs from
  37715. */
  37716. detachControl(element: Nullable<HTMLElement>): void;
  37717. /**
  37718. * Gets the class name of the current intput.
  37719. * @returns the class name
  37720. */
  37721. getClassName(): string;
  37722. /**
  37723. * Get the friendly name associated with the input class.
  37724. * @returns the input friendly name
  37725. */
  37726. getSimpleName(): string;
  37727. }
  37728. }
  37729. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  37730. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37731. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  37732. /**
  37733. * Default Inputs manager for the ArcRotateCamera.
  37734. * It groups all the default supported inputs for ease of use.
  37735. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37736. */
  37737. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  37738. /**
  37739. * Instantiates a new ArcRotateCameraInputsManager.
  37740. * @param camera Defines the camera the inputs belong to
  37741. */
  37742. constructor(camera: ArcRotateCamera);
  37743. /**
  37744. * Add mouse wheel input support to the input manager.
  37745. * @returns the current input manager
  37746. */
  37747. addMouseWheel(): ArcRotateCameraInputsManager;
  37748. /**
  37749. * Add pointers input support to the input manager.
  37750. * @returns the current input manager
  37751. */
  37752. addPointers(): ArcRotateCameraInputsManager;
  37753. /**
  37754. * Add keyboard input support to the input manager.
  37755. * @returns the current input manager
  37756. */
  37757. addKeyboard(): ArcRotateCameraInputsManager;
  37758. }
  37759. }
  37760. declare module "babylonjs/Cameras/arcRotateCamera" {
  37761. import { Observable } from "babylonjs/Misc/observable";
  37762. import { Nullable } from "babylonjs/types";
  37763. import { Scene } from "babylonjs/scene";
  37764. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  37765. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37766. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  37767. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  37768. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  37769. import { Camera } from "babylonjs/Cameras/camera";
  37770. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  37771. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  37772. import { Collider } from "babylonjs/Collisions/collider";
  37773. /**
  37774. * This represents an orbital type of camera.
  37775. *
  37776. * This camera always points towards a given target position and can be rotated around that target with the target as the centre of rotation. It can be controlled with cursors and mouse, or with touch events.
  37777. * Think of this camera as one orbiting its target position, or more imaginatively as a spy satellite orbiting the earth. Its position relative to the target (earth) can be set by three parameters, alpha (radians) the longitudinal rotation, beta (radians) the latitudinal rotation and radius the distance from the target position.
  37778. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  37779. */
  37780. export class ArcRotateCamera extends TargetCamera {
  37781. /**
  37782. * Defines the rotation angle of the camera along the longitudinal axis.
  37783. */
  37784. alpha: number;
  37785. /**
  37786. * Defines the rotation angle of the camera along the latitudinal axis.
  37787. */
  37788. beta: number;
  37789. /**
  37790. * Defines the radius of the camera from it s target point.
  37791. */
  37792. radius: number;
  37793. protected _target: Vector3;
  37794. protected _targetHost: Nullable<AbstractMesh>;
  37795. /**
  37796. * Defines the target point of the camera.
  37797. * The camera looks towards it form the radius distance.
  37798. */
  37799. target: Vector3;
  37800. /**
  37801. * Define the current local position of the camera in the scene
  37802. */
  37803. position: Vector3;
  37804. protected _upVector: Vector3;
  37805. protected _upToYMatrix: Matrix;
  37806. protected _YToUpMatrix: Matrix;
  37807. /**
  37808. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  37809. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  37810. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  37811. */
  37812. upVector: Vector3;
  37813. /**
  37814. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  37815. */
  37816. setMatUp(): void;
  37817. /**
  37818. * Current inertia value on the longitudinal axis.
  37819. * The bigger this number the longer it will take for the camera to stop.
  37820. */
  37821. inertialAlphaOffset: number;
  37822. /**
  37823. * Current inertia value on the latitudinal axis.
  37824. * The bigger this number the longer it will take for the camera to stop.
  37825. */
  37826. inertialBetaOffset: number;
  37827. /**
  37828. * Current inertia value on the radius axis.
  37829. * The bigger this number the longer it will take for the camera to stop.
  37830. */
  37831. inertialRadiusOffset: number;
  37832. /**
  37833. * Minimum allowed angle on the longitudinal axis.
  37834. * This can help limiting how the Camera is able to move in the scene.
  37835. */
  37836. lowerAlphaLimit: Nullable<number>;
  37837. /**
  37838. * Maximum allowed angle on the longitudinal axis.
  37839. * This can help limiting how the Camera is able to move in the scene.
  37840. */
  37841. upperAlphaLimit: Nullable<number>;
  37842. /**
  37843. * Minimum allowed angle on the latitudinal axis.
  37844. * This can help limiting how the Camera is able to move in the scene.
  37845. */
  37846. lowerBetaLimit: number;
  37847. /**
  37848. * Maximum allowed angle on the latitudinal axis.
  37849. * This can help limiting how the Camera is able to move in the scene.
  37850. */
  37851. upperBetaLimit: number;
  37852. /**
  37853. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  37854. * This can help limiting how the Camera is able to move in the scene.
  37855. */
  37856. lowerRadiusLimit: Nullable<number>;
  37857. /**
  37858. * Maximum allowed distance of the camera to the target (The camera can not get further).
  37859. * This can help limiting how the Camera is able to move in the scene.
  37860. */
  37861. upperRadiusLimit: Nullable<number>;
  37862. /**
  37863. * Defines the current inertia value used during panning of the camera along the X axis.
  37864. */
  37865. inertialPanningX: number;
  37866. /**
  37867. * Defines the current inertia value used during panning of the camera along the Y axis.
  37868. */
  37869. inertialPanningY: number;
  37870. /**
  37871. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  37872. * Basically if your fingers moves away from more than this distance you will be considered
  37873. * in pinch mode.
  37874. */
  37875. pinchToPanMaxDistance: number;
  37876. /**
  37877. * Defines the maximum distance the camera can pan.
  37878. * This could help keeping the cammera always in your scene.
  37879. */
  37880. panningDistanceLimit: Nullable<number>;
  37881. /**
  37882. * Defines the target of the camera before paning.
  37883. */
  37884. panningOriginTarget: Vector3;
  37885. /**
  37886. * Defines the value of the inertia used during panning.
  37887. * 0 would mean stop inertia and one would mean no decelleration at all.
  37888. */
  37889. panningInertia: number;
  37890. /**
  37891. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  37892. */
  37893. angularSensibilityX: number;
  37894. /**
  37895. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  37896. */
  37897. angularSensibilityY: number;
  37898. /**
  37899. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  37900. */
  37901. pinchPrecision: number;
  37902. /**
  37903. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  37904. * It will be used instead of pinchDeltaPrecision if different from 0.
  37905. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  37906. */
  37907. pinchDeltaPercentage: number;
  37908. /**
  37909. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  37910. */
  37911. panningSensibility: number;
  37912. /**
  37913. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  37914. */
  37915. keysUp: number[];
  37916. /**
  37917. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  37918. */
  37919. keysDown: number[];
  37920. /**
  37921. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  37922. */
  37923. keysLeft: number[];
  37924. /**
  37925. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  37926. */
  37927. keysRight: number[];
  37928. /**
  37929. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37930. */
  37931. wheelPrecision: number;
  37932. /**
  37933. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  37934. * It will be used instead of pinchDeltaPrecision if different from 0.
  37935. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  37936. */
  37937. wheelDeltaPercentage: number;
  37938. /**
  37939. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  37940. */
  37941. zoomOnFactor: number;
  37942. /**
  37943. * Defines a screen offset for the camera position.
  37944. */
  37945. targetScreenOffset: Vector2;
  37946. /**
  37947. * Allows the camera to be completely reversed.
  37948. * If false the camera can not arrive upside down.
  37949. */
  37950. allowUpsideDown: boolean;
  37951. /**
  37952. * Define if double tap/click is used to restore the previously saved state of the camera.
  37953. */
  37954. useInputToRestoreState: boolean;
  37955. /** @hidden */
  37956. _viewMatrix: Matrix;
  37957. /** @hidden */
  37958. _useCtrlForPanning: boolean;
  37959. /** @hidden */
  37960. _panningMouseButton: number;
  37961. /**
  37962. * Defines the input associated to the camera.
  37963. */
  37964. inputs: ArcRotateCameraInputsManager;
  37965. /** @hidden */
  37966. _reset: () => void;
  37967. /**
  37968. * Defines the allowed panning axis.
  37969. */
  37970. panningAxis: Vector3;
  37971. protected _localDirection: Vector3;
  37972. protected _transformedDirection: Vector3;
  37973. private _bouncingBehavior;
  37974. /**
  37975. * Gets the bouncing behavior of the camera if it has been enabled.
  37976. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37977. */
  37978. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  37979. /**
  37980. * Defines if the bouncing behavior of the camera is enabled on the camera.
  37981. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37982. */
  37983. useBouncingBehavior: boolean;
  37984. private _framingBehavior;
  37985. /**
  37986. * Gets the framing behavior of the camera if it has been enabled.
  37987. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37988. */
  37989. readonly framingBehavior: Nullable<FramingBehavior>;
  37990. /**
  37991. * Defines if the framing behavior of the camera is enabled on the camera.
  37992. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37993. */
  37994. useFramingBehavior: boolean;
  37995. private _autoRotationBehavior;
  37996. /**
  37997. * Gets the auto rotation behavior of the camera if it has been enabled.
  37998. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  37999. */
  38000. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  38001. /**
  38002. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  38003. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  38004. */
  38005. useAutoRotationBehavior: boolean;
  38006. /**
  38007. * Observable triggered when the mesh target has been changed on the camera.
  38008. */
  38009. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  38010. /**
  38011. * Event raised when the camera is colliding with a mesh.
  38012. */
  38013. onCollide: (collidedMesh: AbstractMesh) => void;
  38014. /**
  38015. * Defines whether the camera should check collision with the objects oh the scene.
  38016. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  38017. */
  38018. checkCollisions: boolean;
  38019. /**
  38020. * Defines the collision radius of the camera.
  38021. * This simulates a sphere around the camera.
  38022. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  38023. */
  38024. collisionRadius: Vector3;
  38025. protected _collider: Collider;
  38026. protected _previousPosition: Vector3;
  38027. protected _collisionVelocity: Vector3;
  38028. protected _newPosition: Vector3;
  38029. protected _previousAlpha: number;
  38030. protected _previousBeta: number;
  38031. protected _previousRadius: number;
  38032. protected _collisionTriggered: boolean;
  38033. protected _targetBoundingCenter: Nullable<Vector3>;
  38034. private _computationVector;
  38035. /**
  38036. * Instantiates a new ArcRotateCamera in a given scene
  38037. * @param name Defines the name of the camera
  38038. * @param alpha Defines the camera rotation along the logitudinal axis
  38039. * @param beta Defines the camera rotation along the latitudinal axis
  38040. * @param radius Defines the camera distance from its target
  38041. * @param target Defines the camera target
  38042. * @param scene Defines the scene the camera belongs to
  38043. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  38044. */
  38045. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  38046. /** @hidden */
  38047. _initCache(): void;
  38048. /** @hidden */
  38049. _updateCache(ignoreParentClass?: boolean): void;
  38050. protected _getTargetPosition(): Vector3;
  38051. private _storedAlpha;
  38052. private _storedBeta;
  38053. private _storedRadius;
  38054. private _storedTarget;
  38055. private _storedTargetScreenOffset;
  38056. /**
  38057. * Stores the current state of the camera (alpha, beta, radius and target)
  38058. * @returns the camera itself
  38059. */
  38060. storeState(): Camera;
  38061. /**
  38062. * @hidden
  38063. * Restored camera state. You must call storeState() first
  38064. */
  38065. _restoreStateValues(): boolean;
  38066. /** @hidden */
  38067. _isSynchronizedViewMatrix(): boolean;
  38068. /**
  38069. * Attached controls to the current camera.
  38070. * @param element Defines the element the controls should be listened from
  38071. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38072. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  38073. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  38074. */
  38075. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  38076. /**
  38077. * Detach the current controls from the camera.
  38078. * The camera will stop reacting to inputs.
  38079. * @param element Defines the element to stop listening the inputs from
  38080. */
  38081. detachControl(element: HTMLElement): void;
  38082. /** @hidden */
  38083. _checkInputs(): void;
  38084. protected _checkLimits(): void;
  38085. /**
  38086. * Rebuilds angles (alpha, beta) and radius from the give position and target
  38087. */
  38088. rebuildAnglesAndRadius(): void;
  38089. /**
  38090. * Use a position to define the current camera related information like alpha, beta and radius
  38091. * @param position Defines the position to set the camera at
  38092. */
  38093. setPosition(position: Vector3): void;
  38094. /**
  38095. * Defines the target the camera should look at.
  38096. * This will automatically adapt alpha beta and radius to fit within the new target.
  38097. * @param target Defines the new target as a Vector or a mesh
  38098. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  38099. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  38100. */
  38101. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  38102. /** @hidden */
  38103. _getViewMatrix(): Matrix;
  38104. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  38105. /**
  38106. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  38107. * @param meshes Defines the mesh to zoom on
  38108. * @param doNotUpdateMaxZ Defines whether or not maxZ should be updated whilst zooming on the mesh (this can happen if the mesh is big and the maxradius pretty small for instance)
  38109. */
  38110. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  38111. /**
  38112. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  38113. * The target will be changed but the radius
  38114. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  38115. * @param doNotUpdateMaxZ Defines whether or not maxZ should be updated whilst zooming on the mesh (this can happen if the mesh is big and the maxradius pretty small for instance)
  38116. */
  38117. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  38118. min: Vector3;
  38119. max: Vector3;
  38120. distance: number;
  38121. }, doNotUpdateMaxZ?: boolean): void;
  38122. /**
  38123. * @override
  38124. * Override Camera.createRigCamera
  38125. */
  38126. createRigCamera(name: string, cameraIndex: number): Camera;
  38127. /**
  38128. * @hidden
  38129. * @override
  38130. * Override Camera._updateRigCameras
  38131. */
  38132. _updateRigCameras(): void;
  38133. /**
  38134. * Destroy the camera and release the current resources hold by it.
  38135. */
  38136. dispose(): void;
  38137. /**
  38138. * Gets the current object class name.
  38139. * @return the class name
  38140. */
  38141. getClassName(): string;
  38142. }
  38143. }
  38144. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  38145. import { Behavior } from "babylonjs/Behaviors/behavior";
  38146. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38147. /**
  38148. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  38149. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  38150. */
  38151. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  38152. /**
  38153. * Gets the name of the behavior.
  38154. */
  38155. readonly name: string;
  38156. private _zoomStopsAnimation;
  38157. private _idleRotationSpeed;
  38158. private _idleRotationWaitTime;
  38159. private _idleRotationSpinupTime;
  38160. /**
  38161. * Sets the flag that indicates if user zooming should stop animation.
  38162. */
  38163. /**
  38164. * Gets the flag that indicates if user zooming should stop animation.
  38165. */
  38166. zoomStopsAnimation: boolean;
  38167. /**
  38168. * Sets the default speed at which the camera rotates around the model.
  38169. */
  38170. /**
  38171. * Gets the default speed at which the camera rotates around the model.
  38172. */
  38173. idleRotationSpeed: number;
  38174. /**
  38175. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  38176. */
  38177. /**
  38178. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  38179. */
  38180. idleRotationWaitTime: number;
  38181. /**
  38182. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  38183. */
  38184. /**
  38185. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  38186. */
  38187. idleRotationSpinupTime: number;
  38188. /**
  38189. * Gets a value indicating if the camera is currently rotating because of this behavior
  38190. */
  38191. readonly rotationInProgress: boolean;
  38192. private _onPrePointerObservableObserver;
  38193. private _onAfterCheckInputsObserver;
  38194. private _attachedCamera;
  38195. private _isPointerDown;
  38196. private _lastFrameTime;
  38197. private _lastInteractionTime;
  38198. private _cameraRotationSpeed;
  38199. /**
  38200. * Initializes the behavior.
  38201. */
  38202. init(): void;
  38203. /**
  38204. * Attaches the behavior to its arc rotate camera.
  38205. * @param camera Defines the camera to attach the behavior to
  38206. */
  38207. attach(camera: ArcRotateCamera): void;
  38208. /**
  38209. * Detaches the behavior from its current arc rotate camera.
  38210. */
  38211. detach(): void;
  38212. /**
  38213. * Returns true if user is scrolling.
  38214. * @return true if user is scrolling.
  38215. */
  38216. private _userIsZooming;
  38217. private _lastFrameRadius;
  38218. private _shouldAnimationStopForInteraction;
  38219. /**
  38220. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  38221. */
  38222. private _applyUserInteraction;
  38223. private _userIsMoving;
  38224. }
  38225. }
  38226. declare module "babylonjs/Behaviors/Cameras/index" {
  38227. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  38228. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  38229. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  38230. }
  38231. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  38232. import { Mesh } from "babylonjs/Meshes/mesh";
  38233. import { TransformNode } from "babylonjs/Meshes/transformNode";
  38234. import { Behavior } from "babylonjs/Behaviors/behavior";
  38235. /**
  38236. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  38237. */
  38238. export class AttachToBoxBehavior implements Behavior<Mesh> {
  38239. private ui;
  38240. /**
  38241. * The name of the behavior
  38242. */
  38243. name: string;
  38244. /**
  38245. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  38246. */
  38247. distanceAwayFromFace: number;
  38248. /**
  38249. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  38250. */
  38251. distanceAwayFromBottomOfFace: number;
  38252. private _faceVectors;
  38253. private _target;
  38254. private _scene;
  38255. private _onRenderObserver;
  38256. private _tmpMatrix;
  38257. private _tmpVector;
  38258. /**
  38259. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  38260. * @param ui The transform node that should be attched to the mesh
  38261. */
  38262. constructor(ui: TransformNode);
  38263. /**
  38264. * Initializes the behavior
  38265. */
  38266. init(): void;
  38267. private _closestFace;
  38268. private _zeroVector;
  38269. private _lookAtTmpMatrix;
  38270. private _lookAtToRef;
  38271. /**
  38272. * Attaches the AttachToBoxBehavior to the passed in mesh
  38273. * @param target The mesh that the specified node will be attached to
  38274. */
  38275. attach(target: Mesh): void;
  38276. /**
  38277. * Detaches the behavior from the mesh
  38278. */
  38279. detach(): void;
  38280. }
  38281. }
  38282. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  38283. import { Behavior } from "babylonjs/Behaviors/behavior";
  38284. import { Mesh } from "babylonjs/Meshes/mesh";
  38285. /**
  38286. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  38287. */
  38288. export class FadeInOutBehavior implements Behavior<Mesh> {
  38289. /**
  38290. * Time in milliseconds to delay before fading in (Default: 0)
  38291. */
  38292. delay: number;
  38293. /**
  38294. * Time in milliseconds for the mesh to fade in (Default: 300)
  38295. */
  38296. fadeInTime: number;
  38297. private _millisecondsPerFrame;
  38298. private _hovered;
  38299. private _hoverValue;
  38300. private _ownerNode;
  38301. /**
  38302. * Instatiates the FadeInOutBehavior
  38303. */
  38304. constructor();
  38305. /**
  38306. * The name of the behavior
  38307. */
  38308. readonly name: string;
  38309. /**
  38310. * Initializes the behavior
  38311. */
  38312. init(): void;
  38313. /**
  38314. * Attaches the fade behavior on the passed in mesh
  38315. * @param ownerNode The mesh that will be faded in/out once attached
  38316. */
  38317. attach(ownerNode: Mesh): void;
  38318. /**
  38319. * Detaches the behavior from the mesh
  38320. */
  38321. detach(): void;
  38322. /**
  38323. * Triggers the mesh to begin fading in or out
  38324. * @param value if the object should fade in or out (true to fade in)
  38325. */
  38326. fadeIn(value: boolean): void;
  38327. private _update;
  38328. private _setAllVisibility;
  38329. }
  38330. }
  38331. declare module "babylonjs/Misc/pivotTools" {
  38332. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38333. /**
  38334. * Class containing a set of static utilities functions for managing Pivots
  38335. * @hidden
  38336. */
  38337. export class PivotTools {
  38338. private static _PivotCached;
  38339. private static _OldPivotPoint;
  38340. private static _PivotTranslation;
  38341. private static _PivotTmpVector;
  38342. /** @hidden */
  38343. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  38344. /** @hidden */
  38345. static _RestorePivotPoint(mesh: AbstractMesh): void;
  38346. }
  38347. }
  38348. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  38349. import { Scene } from "babylonjs/scene";
  38350. import { Vector4 } from "babylonjs/Maths/math.vector";
  38351. import { Mesh } from "babylonjs/Meshes/mesh";
  38352. import { Nullable } from "babylonjs/types";
  38353. import { Plane } from "babylonjs/Maths/math.plane";
  38354. /**
  38355. * Class containing static functions to help procedurally build meshes
  38356. */
  38357. export class PlaneBuilder {
  38358. /**
  38359. * Creates a plane mesh
  38360. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  38361. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  38362. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  38363. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  38364. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  38365. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  38366. * @param name defines the name of the mesh
  38367. * @param options defines the options used to create the mesh
  38368. * @param scene defines the hosting scene
  38369. * @returns the plane mesh
  38370. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  38371. */
  38372. static CreatePlane(name: string, options: {
  38373. size?: number;
  38374. width?: number;
  38375. height?: number;
  38376. sideOrientation?: number;
  38377. frontUVs?: Vector4;
  38378. backUVs?: Vector4;
  38379. updatable?: boolean;
  38380. sourcePlane?: Plane;
  38381. }, scene?: Nullable<Scene>): Mesh;
  38382. }
  38383. }
  38384. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  38385. import { Behavior } from "babylonjs/Behaviors/behavior";
  38386. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38387. import { Observable } from "babylonjs/Misc/observable";
  38388. import { Vector3 } from "babylonjs/Maths/math.vector";
  38389. import { Ray } from "babylonjs/Culling/ray";
  38390. import "babylonjs/Meshes/Builders/planeBuilder";
  38391. /**
  38392. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  38393. */
  38394. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  38395. private static _AnyMouseID;
  38396. /**
  38397. * Abstract mesh the behavior is set on
  38398. */
  38399. attachedNode: AbstractMesh;
  38400. private _dragPlane;
  38401. private _scene;
  38402. private _pointerObserver;
  38403. private _beforeRenderObserver;
  38404. private static _planeScene;
  38405. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  38406. /**
  38407. * The maximum tolerated angle between the drag plane and dragging pointer rays to trigger pointer events. Set to 0 to allow any angle (default: 0)
  38408. */
  38409. maxDragAngle: number;
  38410. /**
  38411. * @hidden
  38412. */
  38413. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  38414. /**
  38415. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  38416. */
  38417. currentDraggingPointerID: number;
  38418. /**
  38419. * The last position where the pointer hit the drag plane in world space
  38420. */
  38421. lastDragPosition: Vector3;
  38422. /**
  38423. * If the behavior is currently in a dragging state
  38424. */
  38425. dragging: boolean;
  38426. /**
  38427. * The distance towards the target drag position to move each frame. This can be useful to avoid jitter. Set this to 1 for no delay. (Default: 0.2)
  38428. */
  38429. dragDeltaRatio: number;
  38430. /**
  38431. * If the drag plane orientation should be updated during the dragging (Default: true)
  38432. */
  38433. updateDragPlane: boolean;
  38434. private _debugMode;
  38435. private _moving;
  38436. /**
  38437. * Fires each time the attached mesh is dragged with the pointer
  38438. * * delta between last drag position and current drag position in world space
  38439. * * dragDistance along the drag axis
  38440. * * dragPlaneNormal normal of the current drag plane used during the drag
  38441. * * dragPlanePoint in world space where the drag intersects the drag plane
  38442. */
  38443. onDragObservable: Observable<{
  38444. delta: Vector3;
  38445. dragPlanePoint: Vector3;
  38446. dragPlaneNormal: Vector3;
  38447. dragDistance: number;
  38448. pointerId: number;
  38449. }>;
  38450. /**
  38451. * Fires each time a drag begins (eg. mouse down on mesh)
  38452. */
  38453. onDragStartObservable: Observable<{
  38454. dragPlanePoint: Vector3;
  38455. pointerId: number;
  38456. }>;
  38457. /**
  38458. * Fires each time a drag ends (eg. mouse release after drag)
  38459. */
  38460. onDragEndObservable: Observable<{
  38461. dragPlanePoint: Vector3;
  38462. pointerId: number;
  38463. }>;
  38464. /**
  38465. * If the attached mesh should be moved when dragged
  38466. */
  38467. moveAttached: boolean;
  38468. /**
  38469. * If the drag behavior will react to drag events (Default: true)
  38470. */
  38471. enabled: boolean;
  38472. /**
  38473. * If pointer events should start and release the drag (Default: true)
  38474. */
  38475. startAndReleaseDragOnPointerEvents: boolean;
  38476. /**
  38477. * If camera controls should be detached during the drag
  38478. */
  38479. detachCameraControls: boolean;
  38480. /**
  38481. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  38482. */
  38483. useObjectOrienationForDragging: boolean;
  38484. private _options;
  38485. /**
  38486. * Creates a pointer drag behavior that can be attached to a mesh
  38487. * @param options The drag axis or normal of the plane that will be dragged across. If no options are specified the drag plane will always face the ray's origin (eg. camera)
  38488. */
  38489. constructor(options?: {
  38490. dragAxis?: Vector3;
  38491. dragPlaneNormal?: Vector3;
  38492. });
  38493. /**
  38494. * Predicate to determine if it is valid to move the object to a new position when it is moved
  38495. */
  38496. validateDrag: (targetPosition: Vector3) => boolean;
  38497. /**
  38498. * The name of the behavior
  38499. */
  38500. readonly name: string;
  38501. /**
  38502. * Initializes the behavior
  38503. */
  38504. init(): void;
  38505. private _tmpVector;
  38506. private _alternatePickedPoint;
  38507. private _worldDragAxis;
  38508. private _targetPosition;
  38509. private _attachedElement;
  38510. /**
  38511. * Attaches the drag behavior the passed in mesh
  38512. * @param ownerNode The mesh that will be dragged around once attached
  38513. * @param predicate Predicate to use for pick filtering
  38514. */
  38515. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  38516. /**
  38517. * Force relase the drag action by code.
  38518. */
  38519. releaseDrag(): void;
  38520. private _startDragRay;
  38521. private _lastPointerRay;
  38522. /**
  38523. * Simulates the start of a pointer drag event on the behavior
  38524. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  38525. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  38526. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  38527. */
  38528. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  38529. private _startDrag;
  38530. private _dragDelta;
  38531. private _moveDrag;
  38532. private _pickWithRayOnDragPlane;
  38533. private _pointA;
  38534. private _pointB;
  38535. private _pointC;
  38536. private _lineA;
  38537. private _lineB;
  38538. private _localAxis;
  38539. private _lookAt;
  38540. private _updateDragPlanePosition;
  38541. /**
  38542. * Detaches the behavior from the mesh
  38543. */
  38544. detach(): void;
  38545. }
  38546. }
  38547. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  38548. import { Mesh } from "babylonjs/Meshes/mesh";
  38549. import { Behavior } from "babylonjs/Behaviors/behavior";
  38550. /**
  38551. * A behavior that when attached to a mesh will allow the mesh to be scaled
  38552. */
  38553. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  38554. private _dragBehaviorA;
  38555. private _dragBehaviorB;
  38556. private _startDistance;
  38557. private _initialScale;
  38558. private _targetScale;
  38559. private _ownerNode;
  38560. private _sceneRenderObserver;
  38561. /**
  38562. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  38563. */
  38564. constructor();
  38565. /**
  38566. * The name of the behavior
  38567. */
  38568. readonly name: string;
  38569. /**
  38570. * Initializes the behavior
  38571. */
  38572. init(): void;
  38573. private _getCurrentDistance;
  38574. /**
  38575. * Attaches the scale behavior the passed in mesh
  38576. * @param ownerNode The mesh that will be scaled around once attached
  38577. */
  38578. attach(ownerNode: Mesh): void;
  38579. /**
  38580. * Detaches the behavior from the mesh
  38581. */
  38582. detach(): void;
  38583. }
  38584. }
  38585. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  38586. import { Behavior } from "babylonjs/Behaviors/behavior";
  38587. import { Mesh } from "babylonjs/Meshes/mesh";
  38588. import { Observable } from "babylonjs/Misc/observable";
  38589. /**
  38590. * A behavior that when attached to a mesh will allow the mesh to be dragged around based on directions and origin of the pointer's ray
  38591. */
  38592. export class SixDofDragBehavior implements Behavior<Mesh> {
  38593. private static _virtualScene;
  38594. private _ownerNode;
  38595. private _sceneRenderObserver;
  38596. private _scene;
  38597. private _targetPosition;
  38598. private _virtualOriginMesh;
  38599. private _virtualDragMesh;
  38600. private _pointerObserver;
  38601. private _moving;
  38602. private _startingOrientation;
  38603. /**
  38604. * How much faster the object should move when the controller is moving towards it. This is useful to bring objects that are far away from the user to them faster. Set this to 0 to avoid any speed increase. (Default: 3)
  38605. */
  38606. private zDragFactor;
  38607. /**
  38608. * If the object should rotate to face the drag origin
  38609. */
  38610. rotateDraggedObject: boolean;
  38611. /**
  38612. * If the behavior is currently in a dragging state
  38613. */
  38614. dragging: boolean;
  38615. /**
  38616. * The distance towards the target drag position to move each frame. This can be useful to avoid jitter. Set this to 1 for no delay. (Default: 0.2)
  38617. */
  38618. dragDeltaRatio: number;
  38619. /**
  38620. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  38621. */
  38622. currentDraggingPointerID: number;
  38623. /**
  38624. * If camera controls should be detached during the drag
  38625. */
  38626. detachCameraControls: boolean;
  38627. /**
  38628. * Fires each time a drag starts
  38629. */
  38630. onDragStartObservable: Observable<{}>;
  38631. /**
  38632. * Fires each time a drag ends (eg. mouse release after drag)
  38633. */
  38634. onDragEndObservable: Observable<{}>;
  38635. /**
  38636. * Instantiates a behavior that when attached to a mesh will allow the mesh to be dragged around based on directions and origin of the pointer's ray
  38637. */
  38638. constructor();
  38639. /**
  38640. * The name of the behavior
  38641. */
  38642. readonly name: string;
  38643. /**
  38644. * Initializes the behavior
  38645. */
  38646. init(): void;
  38647. /**
  38648. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  38649. */
  38650. private readonly _pointerCamera;
  38651. /**
  38652. * Attaches the scale behavior the passed in mesh
  38653. * @param ownerNode The mesh that will be scaled around once attached
  38654. */
  38655. attach(ownerNode: Mesh): void;
  38656. /**
  38657. * Detaches the behavior from the mesh
  38658. */
  38659. detach(): void;
  38660. }
  38661. }
  38662. declare module "babylonjs/Behaviors/Meshes/index" {
  38663. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  38664. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  38665. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  38666. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  38667. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  38668. }
  38669. declare module "babylonjs/Behaviors/index" {
  38670. export * from "babylonjs/Behaviors/behavior";
  38671. export * from "babylonjs/Behaviors/Cameras/index";
  38672. export * from "babylonjs/Behaviors/Meshes/index";
  38673. }
  38674. declare module "babylonjs/Bones/boneIKController" {
  38675. import { Bone } from "babylonjs/Bones/bone";
  38676. import { Vector3 } from "babylonjs/Maths/math.vector";
  38677. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38678. import { Nullable } from "babylonjs/types";
  38679. /**
  38680. * Class used to apply inverse kinematics to bones
  38681. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  38682. */
  38683. export class BoneIKController {
  38684. private static _tmpVecs;
  38685. private static _tmpQuat;
  38686. private static _tmpMats;
  38687. /**
  38688. * Gets or sets the target mesh
  38689. */
  38690. targetMesh: AbstractMesh;
  38691. /** Gets or sets the mesh used as pole */
  38692. poleTargetMesh: AbstractMesh;
  38693. /**
  38694. * Gets or sets the bone used as pole
  38695. */
  38696. poleTargetBone: Nullable<Bone>;
  38697. /**
  38698. * Gets or sets the target position
  38699. */
  38700. targetPosition: Vector3;
  38701. /**
  38702. * Gets or sets the pole target position
  38703. */
  38704. poleTargetPosition: Vector3;
  38705. /**
  38706. * Gets or sets the pole target local offset
  38707. */
  38708. poleTargetLocalOffset: Vector3;
  38709. /**
  38710. * Gets or sets the pole angle
  38711. */
  38712. poleAngle: number;
  38713. /**
  38714. * Gets or sets the mesh associated with the controller
  38715. */
  38716. mesh: AbstractMesh;
  38717. /**
  38718. * The amount to slerp (spherical linear interpolation) to the target. Set this to a value between 0 and 1 (a value of 1 disables slerp)
  38719. */
  38720. slerpAmount: number;
  38721. private _bone1Quat;
  38722. private _bone1Mat;
  38723. private _bone2Ang;
  38724. private _bone1;
  38725. private _bone2;
  38726. private _bone1Length;
  38727. private _bone2Length;
  38728. private _maxAngle;
  38729. private _maxReach;
  38730. private _rightHandedSystem;
  38731. private _bendAxis;
  38732. private _slerping;
  38733. private _adjustRoll;
  38734. /**
  38735. * Gets or sets maximum allowed angle
  38736. */
  38737. maxAngle: number;
  38738. /**
  38739. * Creates a new BoneIKController
  38740. * @param mesh defines the mesh to control
  38741. * @param bone defines the bone to control
  38742. * @param options defines options to set up the controller
  38743. */
  38744. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  38745. targetMesh?: AbstractMesh;
  38746. poleTargetMesh?: AbstractMesh;
  38747. poleTargetBone?: Bone;
  38748. poleTargetLocalOffset?: Vector3;
  38749. poleAngle?: number;
  38750. bendAxis?: Vector3;
  38751. maxAngle?: number;
  38752. slerpAmount?: number;
  38753. });
  38754. private _setMaxAngle;
  38755. /**
  38756. * Force the controller to update the bones
  38757. */
  38758. update(): void;
  38759. }
  38760. }
  38761. declare module "babylonjs/Bones/boneLookController" {
  38762. import { Vector3 } from "babylonjs/Maths/math.vector";
  38763. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38764. import { Bone } from "babylonjs/Bones/bone";
  38765. import { Space } from "babylonjs/Maths/math.axis";
  38766. /**
  38767. * Class used to make a bone look toward a point in space
  38768. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  38769. */
  38770. export class BoneLookController {
  38771. private static _tmpVecs;
  38772. private static _tmpQuat;
  38773. private static _tmpMats;
  38774. /**
  38775. * The target Vector3 that the bone will look at
  38776. */
  38777. target: Vector3;
  38778. /**
  38779. * The mesh that the bone is attached to
  38780. */
  38781. mesh: AbstractMesh;
  38782. /**
  38783. * The bone that will be looking to the target
  38784. */
  38785. bone: Bone;
  38786. /**
  38787. * The up axis of the coordinate system that is used when the bone is rotated
  38788. */
  38789. upAxis: Vector3;
  38790. /**
  38791. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  38792. */
  38793. upAxisSpace: Space;
  38794. /**
  38795. * Used to make an adjustment to the yaw of the bone
  38796. */
  38797. adjustYaw: number;
  38798. /**
  38799. * Used to make an adjustment to the pitch of the bone
  38800. */
  38801. adjustPitch: number;
  38802. /**
  38803. * Used to make an adjustment to the roll of the bone
  38804. */
  38805. adjustRoll: number;
  38806. /**
  38807. * The amount to slerp (spherical linear interpolation) to the target. Set this to a value between 0 and 1 (a value of 1 disables slerp)
  38808. */
  38809. slerpAmount: number;
  38810. private _minYaw;
  38811. private _maxYaw;
  38812. private _minPitch;
  38813. private _maxPitch;
  38814. private _minYawSin;
  38815. private _minYawCos;
  38816. private _maxYawSin;
  38817. private _maxYawCos;
  38818. private _midYawConstraint;
  38819. private _minPitchTan;
  38820. private _maxPitchTan;
  38821. private _boneQuat;
  38822. private _slerping;
  38823. private _transformYawPitch;
  38824. private _transformYawPitchInv;
  38825. private _firstFrameSkipped;
  38826. private _yawRange;
  38827. private _fowardAxis;
  38828. /**
  38829. * Gets or sets the minimum yaw angle that the bone can look to
  38830. */
  38831. minYaw: number;
  38832. /**
  38833. * Gets or sets the maximum yaw angle that the bone can look to
  38834. */
  38835. maxYaw: number;
  38836. /**
  38837. * Gets or sets the minimum pitch angle that the bone can look to
  38838. */
  38839. minPitch: number;
  38840. /**
  38841. * Gets or sets the maximum pitch angle that the bone can look to
  38842. */
  38843. maxPitch: number;
  38844. /**
  38845. * Create a BoneLookController
  38846. * @param mesh the mesh that the bone belongs to
  38847. * @param bone the bone that will be looking to the target
  38848. * @param target the target Vector3 to look at
  38849. * @param options optional settings:
  38850. * * maxYaw: the maximum angle the bone will yaw to
  38851. * * minYaw: the minimum angle the bone will yaw to
  38852. * * maxPitch: the maximum angle the bone will pitch to
  38853. * * minPitch: the minimum angle the bone will yaw to
  38854. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  38855. * * upAxis: the up axis of the coordinate system
  38856. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  38857. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  38858. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  38859. * * adjustYaw: used to make an adjustment to the yaw of the bone
  38860. * * adjustPitch: used to make an adjustment to the pitch of the bone
  38861. * * adjustRoll: used to make an adjustment to the roll of the bone
  38862. **/
  38863. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  38864. maxYaw?: number;
  38865. minYaw?: number;
  38866. maxPitch?: number;
  38867. minPitch?: number;
  38868. slerpAmount?: number;
  38869. upAxis?: Vector3;
  38870. upAxisSpace?: Space;
  38871. yawAxis?: Vector3;
  38872. pitchAxis?: Vector3;
  38873. adjustYaw?: number;
  38874. adjustPitch?: number;
  38875. adjustRoll?: number;
  38876. });
  38877. /**
  38878. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  38879. */
  38880. update(): void;
  38881. private _getAngleDiff;
  38882. private _getAngleBetween;
  38883. private _isAngleBetween;
  38884. }
  38885. }
  38886. declare module "babylonjs/Bones/index" {
  38887. export * from "babylonjs/Bones/bone";
  38888. export * from "babylonjs/Bones/boneIKController";
  38889. export * from "babylonjs/Bones/boneLookController";
  38890. export * from "babylonjs/Bones/skeleton";
  38891. }
  38892. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  38893. import { Nullable } from "babylonjs/types";
  38894. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38895. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38896. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  38897. /**
  38898. * Manage the gamepad inputs to control an arc rotate camera.
  38899. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38900. */
  38901. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  38902. /**
  38903. * Defines the camera the input is attached to.
  38904. */
  38905. camera: ArcRotateCamera;
  38906. /**
  38907. * Defines the gamepad the input is gathering event from.
  38908. */
  38909. gamepad: Nullable<Gamepad>;
  38910. /**
  38911. * Defines the gamepad rotation sensiblity.
  38912. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  38913. */
  38914. gamepadRotationSensibility: number;
  38915. /**
  38916. * Defines the gamepad move sensiblity.
  38917. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  38918. */
  38919. gamepadMoveSensibility: number;
  38920. private _yAxisScale;
  38921. /**
  38922. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  38923. */
  38924. invertYAxis: boolean;
  38925. private _onGamepadConnectedObserver;
  38926. private _onGamepadDisconnectedObserver;
  38927. /**
  38928. * Attach the input controls to a specific dom element to get the input from.
  38929. * @param element Defines the element the controls should be listened from
  38930. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38931. */
  38932. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38933. /**
  38934. * Detach the current controls from the specified dom element.
  38935. * @param element Defines the element to stop listening the inputs from
  38936. */
  38937. detachControl(element: Nullable<HTMLElement>): void;
  38938. /**
  38939. * Update the current camera state depending on the inputs that have been used this frame.
  38940. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  38941. */
  38942. checkInputs(): void;
  38943. /**
  38944. * Gets the class name of the current intput.
  38945. * @returns the class name
  38946. */
  38947. getClassName(): string;
  38948. /**
  38949. * Get the friendly name associated with the input class.
  38950. * @returns the input friendly name
  38951. */
  38952. getSimpleName(): string;
  38953. }
  38954. }
  38955. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  38956. import { Nullable } from "babylonjs/types";
  38957. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38958. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  38959. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  38960. interface ArcRotateCameraInputsManager {
  38961. /**
  38962. * Add orientation input support to the input manager.
  38963. * @returns the current input manager
  38964. */
  38965. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  38966. }
  38967. }
  38968. /**
  38969. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  38970. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  38971. */
  38972. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  38973. /**
  38974. * Defines the camera the input is attached to.
  38975. */
  38976. camera: ArcRotateCamera;
  38977. /**
  38978. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  38979. */
  38980. alphaCorrection: number;
  38981. /**
  38982. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  38983. */
  38984. gammaCorrection: number;
  38985. private _alpha;
  38986. private _gamma;
  38987. private _dirty;
  38988. private _deviceOrientationHandler;
  38989. /**
  38990. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  38991. */
  38992. constructor();
  38993. /**
  38994. * Attach the input controls to a specific dom element to get the input from.
  38995. * @param element Defines the element the controls should be listened from
  38996. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38997. */
  38998. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  38999. /** @hidden */
  39000. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  39001. /**
  39002. * Update the current camera state depending on the inputs that have been used this frame.
  39003. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39004. */
  39005. checkInputs(): void;
  39006. /**
  39007. * Detach the current controls from the specified dom element.
  39008. * @param element Defines the element to stop listening the inputs from
  39009. */
  39010. detachControl(element: Nullable<HTMLElement>): void;
  39011. /**
  39012. * Gets the class name of the current intput.
  39013. * @returns the class name
  39014. */
  39015. getClassName(): string;
  39016. /**
  39017. * Get the friendly name associated with the input class.
  39018. * @returns the input friendly name
  39019. */
  39020. getSimpleName(): string;
  39021. }
  39022. }
  39023. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  39024. import { Nullable } from "babylonjs/types";
  39025. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39026. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39027. /**
  39028. * Listen to mouse events to control the camera.
  39029. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39030. */
  39031. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  39032. /**
  39033. * Defines the camera the input is attached to.
  39034. */
  39035. camera: FlyCamera;
  39036. /**
  39037. * Defines if touch is enabled. (Default is true.)
  39038. */
  39039. touchEnabled: boolean;
  39040. /**
  39041. * Defines the buttons associated with the input to handle camera rotation.
  39042. */
  39043. buttons: number[];
  39044. /**
  39045. * Assign buttons for Yaw control.
  39046. */
  39047. buttonsYaw: number[];
  39048. /**
  39049. * Assign buttons for Pitch control.
  39050. */
  39051. buttonsPitch: number[];
  39052. /**
  39053. * Assign buttons for Roll control.
  39054. */
  39055. buttonsRoll: number[];
  39056. /**
  39057. * Detect if any button is being pressed while mouse is moved.
  39058. * -1 = Mouse locked.
  39059. * 0 = Left button.
  39060. * 1 = Middle Button.
  39061. * 2 = Right Button.
  39062. */
  39063. activeButton: number;
  39064. /**
  39065. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  39066. * Higher values reduce its sensitivity.
  39067. */
  39068. angularSensibility: number;
  39069. private _mousemoveCallback;
  39070. private _observer;
  39071. private _rollObserver;
  39072. private previousPosition;
  39073. private noPreventDefault;
  39074. private element;
  39075. /**
  39076. * Listen to mouse events to control the camera.
  39077. * @param touchEnabled Define if touch is enabled. (Default is true.)
  39078. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39079. */
  39080. constructor(touchEnabled?: boolean);
  39081. /**
  39082. * Attach the mouse control to the HTML DOM element.
  39083. * @param element Defines the element that listens to the input events.
  39084. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  39085. */
  39086. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39087. /**
  39088. * Detach the current controls from the specified dom element.
  39089. * @param element Defines the element to stop listening the inputs from
  39090. */
  39091. detachControl(element: Nullable<HTMLElement>): void;
  39092. /**
  39093. * Gets the class name of the current input.
  39094. * @returns the class name.
  39095. */
  39096. getClassName(): string;
  39097. /**
  39098. * Get the friendly name associated with the input class.
  39099. * @returns the input's friendly name.
  39100. */
  39101. getSimpleName(): string;
  39102. private _pointerInput;
  39103. private _onMouseMove;
  39104. /**
  39105. * Rotate camera by mouse offset.
  39106. */
  39107. private rotateCamera;
  39108. }
  39109. }
  39110. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  39111. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39112. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  39113. /**
  39114. * Default Inputs manager for the FlyCamera.
  39115. * It groups all the default supported inputs for ease of use.
  39116. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39117. */
  39118. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  39119. /**
  39120. * Instantiates a new FlyCameraInputsManager.
  39121. * @param camera Defines the camera the inputs belong to.
  39122. */
  39123. constructor(camera: FlyCamera);
  39124. /**
  39125. * Add keyboard input support to the input manager.
  39126. * @returns the new FlyCameraKeyboardMoveInput().
  39127. */
  39128. addKeyboard(): FlyCameraInputsManager;
  39129. /**
  39130. * Add mouse input support to the input manager.
  39131. * @param touchEnabled Enable touch screen support.
  39132. * @returns the new FlyCameraMouseInput().
  39133. */
  39134. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  39135. }
  39136. }
  39137. declare module "babylonjs/Cameras/flyCamera" {
  39138. import { Scene } from "babylonjs/scene";
  39139. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  39140. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39141. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  39142. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  39143. /**
  39144. * This is a flying camera, designed for 3D movement and rotation in all directions,
  39145. * such as in a 3D Space Shooter or a Flight Simulator.
  39146. */
  39147. export class FlyCamera extends TargetCamera {
  39148. /**
  39149. * Define the collision ellipsoid of the camera.
  39150. * This is helpful for simulating a camera body, like a player's body.
  39151. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  39152. */
  39153. ellipsoid: Vector3;
  39154. /**
  39155. * Define an offset for the position of the ellipsoid around the camera.
  39156. * This can be helpful if the camera is attached away from the player's body center,
  39157. * such as at its head.
  39158. */
  39159. ellipsoidOffset: Vector3;
  39160. /**
  39161. * Enable or disable collisions of the camera with the rest of the scene objects.
  39162. */
  39163. checkCollisions: boolean;
  39164. /**
  39165. * Enable or disable gravity on the camera.
  39166. */
  39167. applyGravity: boolean;
  39168. /**
  39169. * Define the current direction the camera is moving to.
  39170. */
  39171. cameraDirection: Vector3;
  39172. /**
  39173. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  39174. * This overrides and empties cameraRotation.
  39175. */
  39176. rotationQuaternion: Quaternion;
  39177. /**
  39178. * Track Roll to maintain the wanted Rolling when looking around.
  39179. */
  39180. _trackRoll: number;
  39181. /**
  39182. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  39183. */
  39184. rollCorrect: number;
  39185. /**
  39186. * Mimic a banked turn, Rolling the camera when Yawing.
  39187. * It's recommended to use rollCorrect = 10 for faster banking correction.
  39188. */
  39189. bankedTurn: boolean;
  39190. /**
  39191. * Limit in radians for how much Roll banking will add. (Default: 90°)
  39192. */
  39193. bankedTurnLimit: number;
  39194. /**
  39195. * Value of 0 disables the banked Roll.
  39196. * Value of 1 is equal to the Yaw angle in radians.
  39197. */
  39198. bankedTurnMultiplier: number;
  39199. /**
  39200. * The inputs manager loads all the input sources, such as keyboard and mouse.
  39201. */
  39202. inputs: FlyCameraInputsManager;
  39203. /**
  39204. * Gets the input sensibility for mouse input.
  39205. * Higher values reduce sensitivity.
  39206. */
  39207. /**
  39208. * Sets the input sensibility for a mouse input.
  39209. * Higher values reduce sensitivity.
  39210. */
  39211. angularSensibility: number;
  39212. /**
  39213. * Get the keys for camera movement forward.
  39214. */
  39215. /**
  39216. * Set the keys for camera movement forward.
  39217. */
  39218. keysForward: number[];
  39219. /**
  39220. * Get the keys for camera movement backward.
  39221. */
  39222. keysBackward: number[];
  39223. /**
  39224. * Get the keys for camera movement up.
  39225. */
  39226. /**
  39227. * Set the keys for camera movement up.
  39228. */
  39229. keysUp: number[];
  39230. /**
  39231. * Get the keys for camera movement down.
  39232. */
  39233. /**
  39234. * Set the keys for camera movement down.
  39235. */
  39236. keysDown: number[];
  39237. /**
  39238. * Get the keys for camera movement left.
  39239. */
  39240. /**
  39241. * Set the keys for camera movement left.
  39242. */
  39243. keysLeft: number[];
  39244. /**
  39245. * Set the keys for camera movement right.
  39246. */
  39247. /**
  39248. * Set the keys for camera movement right.
  39249. */
  39250. keysRight: number[];
  39251. /**
  39252. * Event raised when the camera collides with a mesh in the scene.
  39253. */
  39254. onCollide: (collidedMesh: AbstractMesh) => void;
  39255. private _collider;
  39256. private _needMoveForGravity;
  39257. private _oldPosition;
  39258. private _diffPosition;
  39259. private _newPosition;
  39260. /** @hidden */
  39261. _localDirection: Vector3;
  39262. /** @hidden */
  39263. _transformedDirection: Vector3;
  39264. /**
  39265. * Instantiates a FlyCamera.
  39266. * This is a flying camera, designed for 3D movement and rotation in all directions,
  39267. * such as in a 3D Space Shooter or a Flight Simulator.
  39268. * @param name Define the name of the camera in the scene.
  39269. * @param position Define the starting position of the camera in the scene.
  39270. * @param scene Define the scene the camera belongs to.
  39271. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  39272. */
  39273. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  39274. /**
  39275. * Attach a control to the HTML DOM element.
  39276. * @param element Defines the element that listens to the input events.
  39277. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  39278. */
  39279. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39280. /**
  39281. * Detach a control from the HTML DOM element.
  39282. * The camera will stop reacting to that input.
  39283. * @param element Defines the element that listens to the input events.
  39284. */
  39285. detachControl(element: HTMLElement): void;
  39286. private _collisionMask;
  39287. /**
  39288. * Get the mask that the camera ignores in collision events.
  39289. */
  39290. /**
  39291. * Set the mask that the camera ignores in collision events.
  39292. */
  39293. collisionMask: number;
  39294. /** @hidden */
  39295. _collideWithWorld(displacement: Vector3): void;
  39296. /** @hidden */
  39297. private _onCollisionPositionChange;
  39298. /** @hidden */
  39299. _checkInputs(): void;
  39300. /** @hidden */
  39301. _decideIfNeedsToMove(): boolean;
  39302. /** @hidden */
  39303. _updatePosition(): void;
  39304. /**
  39305. * Restore the Roll to its target value at the rate specified.
  39306. * @param rate - Higher means slower restoring.
  39307. * @hidden
  39308. */
  39309. restoreRoll(rate: number): void;
  39310. /**
  39311. * Destroy the camera and release the current resources held by it.
  39312. */
  39313. dispose(): void;
  39314. /**
  39315. * Get the current object class name.
  39316. * @returns the class name.
  39317. */
  39318. getClassName(): string;
  39319. }
  39320. }
  39321. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  39322. import { Nullable } from "babylonjs/types";
  39323. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39324. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39325. /**
  39326. * Listen to keyboard events to control the camera.
  39327. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39328. */
  39329. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  39330. /**
  39331. * Defines the camera the input is attached to.
  39332. */
  39333. camera: FlyCamera;
  39334. /**
  39335. * The list of keyboard keys used to control the forward move of the camera.
  39336. */
  39337. keysForward: number[];
  39338. /**
  39339. * The list of keyboard keys used to control the backward move of the camera.
  39340. */
  39341. keysBackward: number[];
  39342. /**
  39343. * The list of keyboard keys used to control the forward move of the camera.
  39344. */
  39345. keysUp: number[];
  39346. /**
  39347. * The list of keyboard keys used to control the backward move of the camera.
  39348. */
  39349. keysDown: number[];
  39350. /**
  39351. * The list of keyboard keys used to control the right strafe move of the camera.
  39352. */
  39353. keysRight: number[];
  39354. /**
  39355. * The list of keyboard keys used to control the left strafe move of the camera.
  39356. */
  39357. keysLeft: number[];
  39358. private _keys;
  39359. private _onCanvasBlurObserver;
  39360. private _onKeyboardObserver;
  39361. private _engine;
  39362. private _scene;
  39363. /**
  39364. * Attach the input controls to a specific dom element to get the input from.
  39365. * @param element Defines the element the controls should be listened from
  39366. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39367. */
  39368. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39369. /**
  39370. * Detach the current controls from the specified dom element.
  39371. * @param element Defines the element to stop listening the inputs from
  39372. */
  39373. detachControl(element: Nullable<HTMLElement>): void;
  39374. /**
  39375. * Gets the class name of the current intput.
  39376. * @returns the class name
  39377. */
  39378. getClassName(): string;
  39379. /** @hidden */
  39380. _onLostFocus(e: FocusEvent): void;
  39381. /**
  39382. * Get the friendly name associated with the input class.
  39383. * @returns the input friendly name
  39384. */
  39385. getSimpleName(): string;
  39386. /**
  39387. * Update the current camera state depending on the inputs that have been used this frame.
  39388. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39389. */
  39390. checkInputs(): void;
  39391. }
  39392. }
  39393. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  39394. import { Nullable } from "babylonjs/types";
  39395. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39396. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39397. /**
  39398. * Manage the mouse wheel inputs to control a follow camera.
  39399. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39400. */
  39401. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  39402. /**
  39403. * Defines the camera the input is attached to.
  39404. */
  39405. camera: FollowCamera;
  39406. /**
  39407. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  39408. */
  39409. axisControlRadius: boolean;
  39410. /**
  39411. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  39412. */
  39413. axisControlHeight: boolean;
  39414. /**
  39415. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  39416. */
  39417. axisControlRotation: boolean;
  39418. /**
  39419. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  39420. * relation to mouseWheel events.
  39421. */
  39422. wheelPrecision: number;
  39423. /**
  39424. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  39425. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  39426. */
  39427. wheelDeltaPercentage: number;
  39428. private _wheel;
  39429. private _observer;
  39430. /**
  39431. * Attach the input controls to a specific dom element to get the input from.
  39432. * @param element Defines the element the controls should be listened from
  39433. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39434. */
  39435. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39436. /**
  39437. * Detach the current controls from the specified dom element.
  39438. * @param element Defines the element to stop listening the inputs from
  39439. */
  39440. detachControl(element: Nullable<HTMLElement>): void;
  39441. /**
  39442. * Gets the class name of the current intput.
  39443. * @returns the class name
  39444. */
  39445. getClassName(): string;
  39446. /**
  39447. * Get the friendly name associated with the input class.
  39448. * @returns the input friendly name
  39449. */
  39450. getSimpleName(): string;
  39451. }
  39452. }
  39453. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  39454. import { Nullable } from "babylonjs/types";
  39455. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39456. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  39457. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  39458. /**
  39459. * Manage the pointers inputs to control an follow camera.
  39460. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39461. */
  39462. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  39463. /**
  39464. * Defines the camera the input is attached to.
  39465. */
  39466. camera: FollowCamera;
  39467. /**
  39468. * Gets the class name of the current input.
  39469. * @returns the class name
  39470. */
  39471. getClassName(): string;
  39472. /**
  39473. * Defines the pointer angular sensibility along the X axis or how fast is
  39474. * the camera rotating.
  39475. * A negative number will reverse the axis direction.
  39476. */
  39477. angularSensibilityX: number;
  39478. /**
  39479. * Defines the pointer angular sensibility along the Y axis or how fast is
  39480. * the camera rotating.
  39481. * A negative number will reverse the axis direction.
  39482. */
  39483. angularSensibilityY: number;
  39484. /**
  39485. * Defines the pointer pinch precision or how fast is the camera zooming.
  39486. * A negative number will reverse the axis direction.
  39487. */
  39488. pinchPrecision: number;
  39489. /**
  39490. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  39491. * from 0.
  39492. * It defines the percentage of current camera.radius to use as delta when
  39493. * pinch zoom is used.
  39494. */
  39495. pinchDeltaPercentage: number;
  39496. /**
  39497. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  39498. */
  39499. axisXControlRadius: boolean;
  39500. /**
  39501. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  39502. */
  39503. axisXControlHeight: boolean;
  39504. /**
  39505. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  39506. */
  39507. axisXControlRotation: boolean;
  39508. /**
  39509. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  39510. */
  39511. axisYControlRadius: boolean;
  39512. /**
  39513. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  39514. */
  39515. axisYControlHeight: boolean;
  39516. /**
  39517. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  39518. */
  39519. axisYControlRotation: boolean;
  39520. /**
  39521. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  39522. */
  39523. axisPinchControlRadius: boolean;
  39524. /**
  39525. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  39526. */
  39527. axisPinchControlHeight: boolean;
  39528. /**
  39529. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  39530. */
  39531. axisPinchControlRotation: boolean;
  39532. /**
  39533. * Log error messages if basic misconfiguration has occurred.
  39534. */
  39535. warningEnable: boolean;
  39536. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  39537. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  39538. private _warningCounter;
  39539. private _warning;
  39540. }
  39541. }
  39542. declare module "babylonjs/Cameras/followCameraInputsManager" {
  39543. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  39544. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39545. /**
  39546. * Default Inputs manager for the FollowCamera.
  39547. * It groups all the default supported inputs for ease of use.
  39548. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39549. */
  39550. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  39551. /**
  39552. * Instantiates a new FollowCameraInputsManager.
  39553. * @param camera Defines the camera the inputs belong to
  39554. */
  39555. constructor(camera: FollowCamera);
  39556. /**
  39557. * Add keyboard input support to the input manager.
  39558. * @returns the current input manager
  39559. */
  39560. addKeyboard(): FollowCameraInputsManager;
  39561. /**
  39562. * Add mouse wheel input support to the input manager.
  39563. * @returns the current input manager
  39564. */
  39565. addMouseWheel(): FollowCameraInputsManager;
  39566. /**
  39567. * Add pointers input support to the input manager.
  39568. * @returns the current input manager
  39569. */
  39570. addPointers(): FollowCameraInputsManager;
  39571. /**
  39572. * Add orientation input support to the input manager.
  39573. * @returns the current input manager
  39574. */
  39575. addVRDeviceOrientation(): FollowCameraInputsManager;
  39576. }
  39577. }
  39578. declare module "babylonjs/Cameras/followCamera" {
  39579. import { Nullable } from "babylonjs/types";
  39580. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  39581. import { Scene } from "babylonjs/scene";
  39582. import { Vector3 } from "babylonjs/Maths/math.vector";
  39583. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39584. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  39585. /**
  39586. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  39587. * an arc rotate version arcFollowCamera are available.
  39588. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39589. */
  39590. export class FollowCamera extends TargetCamera {
  39591. /**
  39592. * Distance the follow camera should follow an object at
  39593. */
  39594. radius: number;
  39595. /**
  39596. * Minimum allowed distance of the camera to the axis of rotation
  39597. * (The camera can not get closer).
  39598. * This can help limiting how the Camera is able to move in the scene.
  39599. */
  39600. lowerRadiusLimit: Nullable<number>;
  39601. /**
  39602. * Maximum allowed distance of the camera to the axis of rotation
  39603. * (The camera can not get further).
  39604. * This can help limiting how the Camera is able to move in the scene.
  39605. */
  39606. upperRadiusLimit: Nullable<number>;
  39607. /**
  39608. * Define a rotation offset between the camera and the object it follows
  39609. */
  39610. rotationOffset: number;
  39611. /**
  39612. * Minimum allowed angle to camera position relative to target object.
  39613. * This can help limiting how the Camera is able to move in the scene.
  39614. */
  39615. lowerRotationOffsetLimit: Nullable<number>;
  39616. /**
  39617. * Maximum allowed angle to camera position relative to target object.
  39618. * This can help limiting how the Camera is able to move in the scene.
  39619. */
  39620. upperRotationOffsetLimit: Nullable<number>;
  39621. /**
  39622. * Define a height offset between the camera and the object it follows.
  39623. * It can help following an object from the top (like a car chaing a plane)
  39624. */
  39625. heightOffset: number;
  39626. /**
  39627. * Minimum allowed height of camera position relative to target object.
  39628. * This can help limiting how the Camera is able to move in the scene.
  39629. */
  39630. lowerHeightOffsetLimit: Nullable<number>;
  39631. /**
  39632. * Maximum allowed height of camera position relative to target object.
  39633. * This can help limiting how the Camera is able to move in the scene.
  39634. */
  39635. upperHeightOffsetLimit: Nullable<number>;
  39636. /**
  39637. * Define how fast the camera can accelerate to follow it s target.
  39638. */
  39639. cameraAcceleration: number;
  39640. /**
  39641. * Define the speed limit of the camera following an object.
  39642. */
  39643. maxCameraSpeed: number;
  39644. /**
  39645. * Define the target of the camera.
  39646. */
  39647. lockedTarget: Nullable<AbstractMesh>;
  39648. /**
  39649. * Defines the input associated with the camera.
  39650. */
  39651. inputs: FollowCameraInputsManager;
  39652. /**
  39653. * Instantiates the follow camera.
  39654. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39655. * @param name Define the name of the camera in the scene
  39656. * @param position Define the position of the camera
  39657. * @param scene Define the scene the camera belong to
  39658. * @param lockedTarget Define the target of the camera
  39659. */
  39660. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  39661. private _follow;
  39662. /**
  39663. * Attached controls to the current camera.
  39664. * @param element Defines the element the controls should be listened from
  39665. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39666. */
  39667. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39668. /**
  39669. * Detach the current controls from the camera.
  39670. * The camera will stop reacting to inputs.
  39671. * @param element Defines the element to stop listening the inputs from
  39672. */
  39673. detachControl(element: HTMLElement): void;
  39674. /** @hidden */
  39675. _checkInputs(): void;
  39676. private _checkLimits;
  39677. /**
  39678. * Gets the camera class name.
  39679. * @returns the class name
  39680. */
  39681. getClassName(): string;
  39682. }
  39683. /**
  39684. * Arc Rotate version of the follow camera.
  39685. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  39686. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39687. */
  39688. export class ArcFollowCamera extends TargetCamera {
  39689. /** The longitudinal angle of the camera */
  39690. alpha: number;
  39691. /** The latitudinal angle of the camera */
  39692. beta: number;
  39693. /** The radius of the camera from its target */
  39694. radius: number;
  39695. /** Define the camera target (the messh it should follow) */
  39696. target: Nullable<AbstractMesh>;
  39697. private _cartesianCoordinates;
  39698. /**
  39699. * Instantiates a new ArcFollowCamera
  39700. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39701. * @param name Define the name of the camera
  39702. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  39703. * @param beta Define the rotation angle of the camera around the elevation axis
  39704. * @param radius Define the radius of the camera from its target point
  39705. * @param target Define the target of the camera
  39706. * @param scene Define the scene the camera belongs to
  39707. */
  39708. constructor(name: string,
  39709. /** The longitudinal angle of the camera */
  39710. alpha: number,
  39711. /** The latitudinal angle of the camera */
  39712. beta: number,
  39713. /** The radius of the camera from its target */
  39714. radius: number,
  39715. /** Define the camera target (the messh it should follow) */
  39716. target: Nullable<AbstractMesh>, scene: Scene);
  39717. private _follow;
  39718. /** @hidden */
  39719. _checkInputs(): void;
  39720. /**
  39721. * Returns the class name of the object.
  39722. * It is mostly used internally for serialization purposes.
  39723. */
  39724. getClassName(): string;
  39725. }
  39726. }
  39727. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  39728. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39729. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39730. import { Nullable } from "babylonjs/types";
  39731. /**
  39732. * Manage the keyboard inputs to control the movement of a follow camera.
  39733. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39734. */
  39735. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  39736. /**
  39737. * Defines the camera the input is attached to.
  39738. */
  39739. camera: FollowCamera;
  39740. /**
  39741. * Defines the list of key codes associated with the up action (increase heightOffset)
  39742. */
  39743. keysHeightOffsetIncr: number[];
  39744. /**
  39745. * Defines the list of key codes associated with the down action (decrease heightOffset)
  39746. */
  39747. keysHeightOffsetDecr: number[];
  39748. /**
  39749. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  39750. */
  39751. keysHeightOffsetModifierAlt: boolean;
  39752. /**
  39753. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  39754. */
  39755. keysHeightOffsetModifierCtrl: boolean;
  39756. /**
  39757. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  39758. */
  39759. keysHeightOffsetModifierShift: boolean;
  39760. /**
  39761. * Defines the list of key codes associated with the left action (increase rotationOffset)
  39762. */
  39763. keysRotationOffsetIncr: number[];
  39764. /**
  39765. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  39766. */
  39767. keysRotationOffsetDecr: number[];
  39768. /**
  39769. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  39770. */
  39771. keysRotationOffsetModifierAlt: boolean;
  39772. /**
  39773. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  39774. */
  39775. keysRotationOffsetModifierCtrl: boolean;
  39776. /**
  39777. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  39778. */
  39779. keysRotationOffsetModifierShift: boolean;
  39780. /**
  39781. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  39782. */
  39783. keysRadiusIncr: number[];
  39784. /**
  39785. * Defines the list of key codes associated with the zoom-out action (increase radius)
  39786. */
  39787. keysRadiusDecr: number[];
  39788. /**
  39789. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  39790. */
  39791. keysRadiusModifierAlt: boolean;
  39792. /**
  39793. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  39794. */
  39795. keysRadiusModifierCtrl: boolean;
  39796. /**
  39797. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  39798. */
  39799. keysRadiusModifierShift: boolean;
  39800. /**
  39801. * Defines the rate of change of heightOffset.
  39802. */
  39803. heightSensibility: number;
  39804. /**
  39805. * Defines the rate of change of rotationOffset.
  39806. */
  39807. rotationSensibility: number;
  39808. /**
  39809. * Defines the rate of change of radius.
  39810. */
  39811. radiusSensibility: number;
  39812. private _keys;
  39813. private _ctrlPressed;
  39814. private _altPressed;
  39815. private _shiftPressed;
  39816. private _onCanvasBlurObserver;
  39817. private _onKeyboardObserver;
  39818. private _engine;
  39819. private _scene;
  39820. /**
  39821. * Attach the input controls to a specific dom element to get the input from.
  39822. * @param element Defines the element the controls should be listened from
  39823. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39824. */
  39825. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39826. /**
  39827. * Detach the current controls from the specified dom element.
  39828. * @param element Defines the element to stop listening the inputs from
  39829. */
  39830. detachControl(element: Nullable<HTMLElement>): void;
  39831. /**
  39832. * Update the current camera state depending on the inputs that have been used this frame.
  39833. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39834. */
  39835. checkInputs(): void;
  39836. /**
  39837. * Gets the class name of the current input.
  39838. * @returns the class name
  39839. */
  39840. getClassName(): string;
  39841. /**
  39842. * Get the friendly name associated with the input class.
  39843. * @returns the input friendly name
  39844. */
  39845. getSimpleName(): string;
  39846. /**
  39847. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39848. * allow modification of the heightOffset value.
  39849. */
  39850. private _modifierHeightOffset;
  39851. /**
  39852. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39853. * allow modification of the rotationOffset value.
  39854. */
  39855. private _modifierRotationOffset;
  39856. /**
  39857. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39858. * allow modification of the radius value.
  39859. */
  39860. private _modifierRadius;
  39861. }
  39862. }
  39863. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  39864. import { Nullable } from "babylonjs/types";
  39865. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39866. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39867. import { Observable } from "babylonjs/Misc/observable";
  39868. module "babylonjs/Cameras/freeCameraInputsManager" {
  39869. interface FreeCameraInputsManager {
  39870. /**
  39871. * @hidden
  39872. */
  39873. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  39874. /**
  39875. * Add orientation input support to the input manager.
  39876. * @returns the current input manager
  39877. */
  39878. addDeviceOrientation(): FreeCameraInputsManager;
  39879. }
  39880. }
  39881. /**
  39882. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  39883. * Screen rotation is taken into account.
  39884. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39885. */
  39886. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  39887. private _camera;
  39888. private _screenOrientationAngle;
  39889. private _constantTranform;
  39890. private _screenQuaternion;
  39891. private _alpha;
  39892. private _beta;
  39893. private _gamma;
  39894. /**
  39895. * Can be used to detect if a device orientation sensor is availible on a device
  39896. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  39897. * @returns a promise that will resolve on orientation change
  39898. */
  39899. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  39900. /**
  39901. * @hidden
  39902. */
  39903. _onDeviceOrientationChangedObservable: Observable<void>;
  39904. /**
  39905. * Instantiates a new input
  39906. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39907. */
  39908. constructor();
  39909. /**
  39910. * Define the camera controlled by the input.
  39911. */
  39912. camera: FreeCamera;
  39913. /**
  39914. * Attach the input controls to a specific dom element to get the input from.
  39915. * @param element Defines the element the controls should be listened from
  39916. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39917. */
  39918. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39919. private _orientationChanged;
  39920. private _deviceOrientation;
  39921. /**
  39922. * Detach the current controls from the specified dom element.
  39923. * @param element Defines the element to stop listening the inputs from
  39924. */
  39925. detachControl(element: Nullable<HTMLElement>): void;
  39926. /**
  39927. * Update the current camera state depending on the inputs that have been used this frame.
  39928. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39929. */
  39930. checkInputs(): void;
  39931. /**
  39932. * Gets the class name of the current intput.
  39933. * @returns the class name
  39934. */
  39935. getClassName(): string;
  39936. /**
  39937. * Get the friendly name associated with the input class.
  39938. * @returns the input friendly name
  39939. */
  39940. getSimpleName(): string;
  39941. }
  39942. }
  39943. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  39944. import { Nullable } from "babylonjs/types";
  39945. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39946. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39947. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39948. /**
  39949. * Manage the gamepad inputs to control a free camera.
  39950. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39951. */
  39952. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  39953. /**
  39954. * Define the camera the input is attached to.
  39955. */
  39956. camera: FreeCamera;
  39957. /**
  39958. * Define the Gamepad controlling the input
  39959. */
  39960. gamepad: Nullable<Gamepad>;
  39961. /**
  39962. * Defines the gamepad rotation sensiblity.
  39963. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  39964. */
  39965. gamepadAngularSensibility: number;
  39966. /**
  39967. * Defines the gamepad move sensiblity.
  39968. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  39969. */
  39970. gamepadMoveSensibility: number;
  39971. private _yAxisScale;
  39972. /**
  39973. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  39974. */
  39975. invertYAxis: boolean;
  39976. private _onGamepadConnectedObserver;
  39977. private _onGamepadDisconnectedObserver;
  39978. private _cameraTransform;
  39979. private _deltaTransform;
  39980. private _vector3;
  39981. private _vector2;
  39982. /**
  39983. * Attach the input controls to a specific dom element to get the input from.
  39984. * @param element Defines the element the controls should be listened from
  39985. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39986. */
  39987. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39988. /**
  39989. * Detach the current controls from the specified dom element.
  39990. * @param element Defines the element to stop listening the inputs from
  39991. */
  39992. detachControl(element: Nullable<HTMLElement>): void;
  39993. /**
  39994. * Update the current camera state depending on the inputs that have been used this frame.
  39995. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39996. */
  39997. checkInputs(): void;
  39998. /**
  39999. * Gets the class name of the current intput.
  40000. * @returns the class name
  40001. */
  40002. getClassName(): string;
  40003. /**
  40004. * Get the friendly name associated with the input class.
  40005. * @returns the input friendly name
  40006. */
  40007. getSimpleName(): string;
  40008. }
  40009. }
  40010. declare module "babylonjs/Misc/virtualJoystick" {
  40011. import { Nullable } from "babylonjs/types";
  40012. import { Vector3 } from "babylonjs/Maths/math.vector";
  40013. /**
  40014. * Defines the potential axis of a Joystick
  40015. */
  40016. export enum JoystickAxis {
  40017. /** X axis */
  40018. X = 0,
  40019. /** Y axis */
  40020. Y = 1,
  40021. /** Z axis */
  40022. Z = 2
  40023. }
  40024. /**
  40025. * Class used to define virtual joystick (used in touch mode)
  40026. */
  40027. export class VirtualJoystick {
  40028. /**
  40029. * Gets or sets a boolean indicating that left and right values must be inverted
  40030. */
  40031. reverseLeftRight: boolean;
  40032. /**
  40033. * Gets or sets a boolean indicating that up and down values must be inverted
  40034. */
  40035. reverseUpDown: boolean;
  40036. /**
  40037. * Gets the offset value for the position (ie. the change of the position value)
  40038. */
  40039. deltaPosition: Vector3;
  40040. /**
  40041. * Gets a boolean indicating if the virtual joystick was pressed
  40042. */
  40043. pressed: boolean;
  40044. /**
  40045. * Canvas the virtual joystick will render onto, default z-index of this is 5
  40046. */
  40047. static Canvas: Nullable<HTMLCanvasElement>;
  40048. private static _globalJoystickIndex;
  40049. private static vjCanvasContext;
  40050. private static vjCanvasWidth;
  40051. private static vjCanvasHeight;
  40052. private static halfWidth;
  40053. private _action;
  40054. private _axisTargetedByLeftAndRight;
  40055. private _axisTargetedByUpAndDown;
  40056. private _joystickSensibility;
  40057. private _inversedSensibility;
  40058. private _joystickPointerID;
  40059. private _joystickColor;
  40060. private _joystickPointerPos;
  40061. private _joystickPreviousPointerPos;
  40062. private _joystickPointerStartPos;
  40063. private _deltaJoystickVector;
  40064. private _leftJoystick;
  40065. private _touches;
  40066. private _onPointerDownHandlerRef;
  40067. private _onPointerMoveHandlerRef;
  40068. private _onPointerUpHandlerRef;
  40069. private _onResize;
  40070. /**
  40071. * Creates a new virtual joystick
  40072. * @param leftJoystick defines that the joystick is for left hand (false by default)
  40073. */
  40074. constructor(leftJoystick?: boolean);
  40075. /**
  40076. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  40077. * @param newJoystickSensibility defines the new sensibility
  40078. */
  40079. setJoystickSensibility(newJoystickSensibility: number): void;
  40080. private _onPointerDown;
  40081. private _onPointerMove;
  40082. private _onPointerUp;
  40083. /**
  40084. * Change the color of the virtual joystick
  40085. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  40086. */
  40087. setJoystickColor(newColor: string): void;
  40088. /**
  40089. * Defines a callback to call when the joystick is touched
  40090. * @param action defines the callback
  40091. */
  40092. setActionOnTouch(action: () => any): void;
  40093. /**
  40094. * Defines which axis you'd like to control for left & right
  40095. * @param axis defines the axis to use
  40096. */
  40097. setAxisForLeftRight(axis: JoystickAxis): void;
  40098. /**
  40099. * Defines which axis you'd like to control for up & down
  40100. * @param axis defines the axis to use
  40101. */
  40102. setAxisForUpDown(axis: JoystickAxis): void;
  40103. private _drawVirtualJoystick;
  40104. /**
  40105. * Release internal HTML canvas
  40106. */
  40107. releaseCanvas(): void;
  40108. }
  40109. }
  40110. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  40111. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  40112. import { Nullable } from "babylonjs/types";
  40113. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  40114. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40115. module "babylonjs/Cameras/freeCameraInputsManager" {
  40116. interface FreeCameraInputsManager {
  40117. /**
  40118. * Add virtual joystick input support to the input manager.
  40119. * @returns the current input manager
  40120. */
  40121. addVirtualJoystick(): FreeCameraInputsManager;
  40122. }
  40123. }
  40124. /**
  40125. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  40126. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  40127. */
  40128. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  40129. /**
  40130. * Defines the camera the input is attached to.
  40131. */
  40132. camera: FreeCamera;
  40133. private _leftjoystick;
  40134. private _rightjoystick;
  40135. /**
  40136. * Gets the left stick of the virtual joystick.
  40137. * @returns The virtual Joystick
  40138. */
  40139. getLeftJoystick(): VirtualJoystick;
  40140. /**
  40141. * Gets the right stick of the virtual joystick.
  40142. * @returns The virtual Joystick
  40143. */
  40144. getRightJoystick(): VirtualJoystick;
  40145. /**
  40146. * Update the current camera state depending on the inputs that have been used this frame.
  40147. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  40148. */
  40149. checkInputs(): void;
  40150. /**
  40151. * Attach the input controls to a specific dom element to get the input from.
  40152. * @param element Defines the element the controls should be listened from
  40153. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  40154. */
  40155. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  40156. /**
  40157. * Detach the current controls from the specified dom element.
  40158. * @param element Defines the element to stop listening the inputs from
  40159. */
  40160. detachControl(element: Nullable<HTMLElement>): void;
  40161. /**
  40162. * Gets the class name of the current intput.
  40163. * @returns the class name
  40164. */
  40165. getClassName(): string;
  40166. /**
  40167. * Get the friendly name associated with the input class.
  40168. * @returns the input friendly name
  40169. */
  40170. getSimpleName(): string;
  40171. }
  40172. }
  40173. declare module "babylonjs/Cameras/Inputs/index" {
  40174. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  40175. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  40176. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  40177. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  40178. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  40179. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  40180. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  40181. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  40182. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  40183. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  40184. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  40185. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  40186. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  40187. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  40188. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  40189. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  40190. }
  40191. declare module "babylonjs/Cameras/touchCamera" {
  40192. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40193. import { Scene } from "babylonjs/scene";
  40194. import { Vector3 } from "babylonjs/Maths/math.vector";
  40195. /**
  40196. * This represents a FPS type of camera controlled by touch.
  40197. * This is like a universal camera minus the Gamepad controls.
  40198. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40199. */
  40200. export class TouchCamera extends FreeCamera {
  40201. /**
  40202. * Defines the touch sensibility for rotation.
  40203. * The higher the faster.
  40204. */
  40205. touchAngularSensibility: number;
  40206. /**
  40207. * Defines the touch sensibility for move.
  40208. * The higher the faster.
  40209. */
  40210. touchMoveSensibility: number;
  40211. /**
  40212. * Instantiates a new touch camera.
  40213. * This represents a FPS type of camera controlled by touch.
  40214. * This is like a universal camera minus the Gamepad controls.
  40215. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40216. * @param name Define the name of the camera in the scene
  40217. * @param position Define the start position of the camera in the scene
  40218. * @param scene Define the scene the camera belongs to
  40219. */
  40220. constructor(name: string, position: Vector3, scene: Scene);
  40221. /**
  40222. * Gets the current object class name.
  40223. * @return the class name
  40224. */
  40225. getClassName(): string;
  40226. /** @hidden */
  40227. _setupInputs(): void;
  40228. }
  40229. }
  40230. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  40231. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40232. import { Scene } from "babylonjs/scene";
  40233. import { Vector3 } from "babylonjs/Maths/math.vector";
  40234. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  40235. import { Axis } from "babylonjs/Maths/math.axis";
  40236. /**
  40237. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  40238. * being tilted forward or back and left or right.
  40239. */
  40240. export class DeviceOrientationCamera extends FreeCamera {
  40241. private _initialQuaternion;
  40242. private _quaternionCache;
  40243. private _tmpDragQuaternion;
  40244. private _disablePointerInputWhenUsingDeviceOrientation;
  40245. /**
  40246. * Creates a new device orientation camera
  40247. * @param name The name of the camera
  40248. * @param position The start position camera
  40249. * @param scene The scene the camera belongs to
  40250. */
  40251. constructor(name: string, position: Vector3, scene: Scene);
  40252. /**
  40253. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  40254. */
  40255. disablePointerInputWhenUsingDeviceOrientation: boolean;
  40256. private _dragFactor;
  40257. /**
  40258. * Enabled turning on the y axis when the orientation sensor is active
  40259. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  40260. */
  40261. enableHorizontalDragging(dragFactor?: number): void;
  40262. /**
  40263. * Gets the current instance class name ("DeviceOrientationCamera").
  40264. * This helps avoiding instanceof at run time.
  40265. * @returns the class name
  40266. */
  40267. getClassName(): string;
  40268. /**
  40269. * @hidden
  40270. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  40271. */
  40272. _checkInputs(): void;
  40273. /**
  40274. * Reset the camera to its default orientation on the specified axis only.
  40275. * @param axis The axis to reset
  40276. */
  40277. resetToCurrentRotation(axis?: Axis): void;
  40278. }
  40279. }
  40280. declare module "babylonjs/Gamepads/xboxGamepad" {
  40281. import { Observable } from "babylonjs/Misc/observable";
  40282. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40283. /**
  40284. * Defines supported buttons for XBox360 compatible gamepads
  40285. */
  40286. export enum Xbox360Button {
  40287. /** A */
  40288. A = 0,
  40289. /** B */
  40290. B = 1,
  40291. /** X */
  40292. X = 2,
  40293. /** Y */
  40294. Y = 3,
  40295. /** Start */
  40296. Start = 4,
  40297. /** Back */
  40298. Back = 5,
  40299. /** Left button */
  40300. LB = 6,
  40301. /** Right button */
  40302. RB = 7,
  40303. /** Left stick */
  40304. LeftStick = 8,
  40305. /** Right stick */
  40306. RightStick = 9
  40307. }
  40308. /** Defines values for XBox360 DPad */
  40309. export enum Xbox360Dpad {
  40310. /** Up */
  40311. Up = 0,
  40312. /** Down */
  40313. Down = 1,
  40314. /** Left */
  40315. Left = 2,
  40316. /** Right */
  40317. Right = 3
  40318. }
  40319. /**
  40320. * Defines a XBox360 gamepad
  40321. */
  40322. export class Xbox360Pad extends Gamepad {
  40323. private _leftTrigger;
  40324. private _rightTrigger;
  40325. private _onlefttriggerchanged;
  40326. private _onrighttriggerchanged;
  40327. private _onbuttondown;
  40328. private _onbuttonup;
  40329. private _ondpaddown;
  40330. private _ondpadup;
  40331. /** Observable raised when a button is pressed */
  40332. onButtonDownObservable: Observable<Xbox360Button>;
  40333. /** Observable raised when a button is released */
  40334. onButtonUpObservable: Observable<Xbox360Button>;
  40335. /** Observable raised when a pad is pressed */
  40336. onPadDownObservable: Observable<Xbox360Dpad>;
  40337. /** Observable raised when a pad is released */
  40338. onPadUpObservable: Observable<Xbox360Dpad>;
  40339. private _buttonA;
  40340. private _buttonB;
  40341. private _buttonX;
  40342. private _buttonY;
  40343. private _buttonBack;
  40344. private _buttonStart;
  40345. private _buttonLB;
  40346. private _buttonRB;
  40347. private _buttonLeftStick;
  40348. private _buttonRightStick;
  40349. private _dPadUp;
  40350. private _dPadDown;
  40351. private _dPadLeft;
  40352. private _dPadRight;
  40353. private _isXboxOnePad;
  40354. /**
  40355. * Creates a new XBox360 gamepad object
  40356. * @param id defines the id of this gamepad
  40357. * @param index defines its index
  40358. * @param gamepad defines the internal HTML gamepad object
  40359. * @param xboxOne defines if it is a XBox One gamepad
  40360. */
  40361. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  40362. /**
  40363. * Defines the callback to call when left trigger is pressed
  40364. * @param callback defines the callback to use
  40365. */
  40366. onlefttriggerchanged(callback: (value: number) => void): void;
  40367. /**
  40368. * Defines the callback to call when right trigger is pressed
  40369. * @param callback defines the callback to use
  40370. */
  40371. onrighttriggerchanged(callback: (value: number) => void): void;
  40372. /**
  40373. * Gets the left trigger value
  40374. */
  40375. /**
  40376. * Sets the left trigger value
  40377. */
  40378. leftTrigger: number;
  40379. /**
  40380. * Gets the right trigger value
  40381. */
  40382. /**
  40383. * Sets the right trigger value
  40384. */
  40385. rightTrigger: number;
  40386. /**
  40387. * Defines the callback to call when a button is pressed
  40388. * @param callback defines the callback to use
  40389. */
  40390. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  40391. /**
  40392. * Defines the callback to call when a button is released
  40393. * @param callback defines the callback to use
  40394. */
  40395. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  40396. /**
  40397. * Defines the callback to call when a pad is pressed
  40398. * @param callback defines the callback to use
  40399. */
  40400. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  40401. /**
  40402. * Defines the callback to call when a pad is released
  40403. * @param callback defines the callback to use
  40404. */
  40405. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  40406. private _setButtonValue;
  40407. private _setDPadValue;
  40408. /**
  40409. * Gets the value of the `A` button
  40410. */
  40411. /**
  40412. * Sets the value of the `A` button
  40413. */
  40414. buttonA: number;
  40415. /**
  40416. * Gets the value of the `B` button
  40417. */
  40418. /**
  40419. * Sets the value of the `B` button
  40420. */
  40421. buttonB: number;
  40422. /**
  40423. * Gets the value of the `X` button
  40424. */
  40425. /**
  40426. * Sets the value of the `X` button
  40427. */
  40428. buttonX: number;
  40429. /**
  40430. * Gets the value of the `Y` button
  40431. */
  40432. /**
  40433. * Sets the value of the `Y` button
  40434. */
  40435. buttonY: number;
  40436. /**
  40437. * Gets the value of the `Start` button
  40438. */
  40439. /**
  40440. * Sets the value of the `Start` button
  40441. */
  40442. buttonStart: number;
  40443. /**
  40444. * Gets the value of the `Back` button
  40445. */
  40446. /**
  40447. * Sets the value of the `Back` button
  40448. */
  40449. buttonBack: number;
  40450. /**
  40451. * Gets the value of the `Left` button
  40452. */
  40453. /**
  40454. * Sets the value of the `Left` button
  40455. */
  40456. buttonLB: number;
  40457. /**
  40458. * Gets the value of the `Right` button
  40459. */
  40460. /**
  40461. * Sets the value of the `Right` button
  40462. */
  40463. buttonRB: number;
  40464. /**
  40465. * Gets the value of the Left joystick
  40466. */
  40467. /**
  40468. * Sets the value of the Left joystick
  40469. */
  40470. buttonLeftStick: number;
  40471. /**
  40472. * Gets the value of the Right joystick
  40473. */
  40474. /**
  40475. * Sets the value of the Right joystick
  40476. */
  40477. buttonRightStick: number;
  40478. /**
  40479. * Gets the value of D-pad up
  40480. */
  40481. /**
  40482. * Sets the value of D-pad up
  40483. */
  40484. dPadUp: number;
  40485. /**
  40486. * Gets the value of D-pad down
  40487. */
  40488. /**
  40489. * Sets the value of D-pad down
  40490. */
  40491. dPadDown: number;
  40492. /**
  40493. * Gets the value of D-pad left
  40494. */
  40495. /**
  40496. * Sets the value of D-pad left
  40497. */
  40498. dPadLeft: number;
  40499. /**
  40500. * Gets the value of D-pad right
  40501. */
  40502. /**
  40503. * Sets the value of D-pad right
  40504. */
  40505. dPadRight: number;
  40506. /**
  40507. * Force the gamepad to synchronize with device values
  40508. */
  40509. update(): void;
  40510. /**
  40511. * Disposes the gamepad
  40512. */
  40513. dispose(): void;
  40514. }
  40515. }
  40516. declare module "babylonjs/Gamepads/dualShockGamepad" {
  40517. import { Observable } from "babylonjs/Misc/observable";
  40518. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40519. /**
  40520. * Defines supported buttons for DualShock compatible gamepads
  40521. */
  40522. export enum DualShockButton {
  40523. /** Cross */
  40524. Cross = 0,
  40525. /** Circle */
  40526. Circle = 1,
  40527. /** Square */
  40528. Square = 2,
  40529. /** Triangle */
  40530. Triangle = 3,
  40531. /** Options */
  40532. Options = 4,
  40533. /** Share */
  40534. Share = 5,
  40535. /** L1 */
  40536. L1 = 6,
  40537. /** R1 */
  40538. R1 = 7,
  40539. /** Left stick */
  40540. LeftStick = 8,
  40541. /** Right stick */
  40542. RightStick = 9
  40543. }
  40544. /** Defines values for DualShock DPad */
  40545. export enum DualShockDpad {
  40546. /** Up */
  40547. Up = 0,
  40548. /** Down */
  40549. Down = 1,
  40550. /** Left */
  40551. Left = 2,
  40552. /** Right */
  40553. Right = 3
  40554. }
  40555. /**
  40556. * Defines a DualShock gamepad
  40557. */
  40558. export class DualShockPad extends Gamepad {
  40559. private _leftTrigger;
  40560. private _rightTrigger;
  40561. private _onlefttriggerchanged;
  40562. private _onrighttriggerchanged;
  40563. private _onbuttondown;
  40564. private _onbuttonup;
  40565. private _ondpaddown;
  40566. private _ondpadup;
  40567. /** Observable raised when a button is pressed */
  40568. onButtonDownObservable: Observable<DualShockButton>;
  40569. /** Observable raised when a button is released */
  40570. onButtonUpObservable: Observable<DualShockButton>;
  40571. /** Observable raised when a pad is pressed */
  40572. onPadDownObservable: Observable<DualShockDpad>;
  40573. /** Observable raised when a pad is released */
  40574. onPadUpObservable: Observable<DualShockDpad>;
  40575. private _buttonCross;
  40576. private _buttonCircle;
  40577. private _buttonSquare;
  40578. private _buttonTriangle;
  40579. private _buttonShare;
  40580. private _buttonOptions;
  40581. private _buttonL1;
  40582. private _buttonR1;
  40583. private _buttonLeftStick;
  40584. private _buttonRightStick;
  40585. private _dPadUp;
  40586. private _dPadDown;
  40587. private _dPadLeft;
  40588. private _dPadRight;
  40589. /**
  40590. * Creates a new DualShock gamepad object
  40591. * @param id defines the id of this gamepad
  40592. * @param index defines its index
  40593. * @param gamepad defines the internal HTML gamepad object
  40594. */
  40595. constructor(id: string, index: number, gamepad: any);
  40596. /**
  40597. * Defines the callback to call when left trigger is pressed
  40598. * @param callback defines the callback to use
  40599. */
  40600. onlefttriggerchanged(callback: (value: number) => void): void;
  40601. /**
  40602. * Defines the callback to call when right trigger is pressed
  40603. * @param callback defines the callback to use
  40604. */
  40605. onrighttriggerchanged(callback: (value: number) => void): void;
  40606. /**
  40607. * Gets the left trigger value
  40608. */
  40609. /**
  40610. * Sets the left trigger value
  40611. */
  40612. leftTrigger: number;
  40613. /**
  40614. * Gets the right trigger value
  40615. */
  40616. /**
  40617. * Sets the right trigger value
  40618. */
  40619. rightTrigger: number;
  40620. /**
  40621. * Defines the callback to call when a button is pressed
  40622. * @param callback defines the callback to use
  40623. */
  40624. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  40625. /**
  40626. * Defines the callback to call when a button is released
  40627. * @param callback defines the callback to use
  40628. */
  40629. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  40630. /**
  40631. * Defines the callback to call when a pad is pressed
  40632. * @param callback defines the callback to use
  40633. */
  40634. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  40635. /**
  40636. * Defines the callback to call when a pad is released
  40637. * @param callback defines the callback to use
  40638. */
  40639. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  40640. private _setButtonValue;
  40641. private _setDPadValue;
  40642. /**
  40643. * Gets the value of the `Cross` button
  40644. */
  40645. /**
  40646. * Sets the value of the `Cross` button
  40647. */
  40648. buttonCross: number;
  40649. /**
  40650. * Gets the value of the `Circle` button
  40651. */
  40652. /**
  40653. * Sets the value of the `Circle` button
  40654. */
  40655. buttonCircle: number;
  40656. /**
  40657. * Gets the value of the `Square` button
  40658. */
  40659. /**
  40660. * Sets the value of the `Square` button
  40661. */
  40662. buttonSquare: number;
  40663. /**
  40664. * Gets the value of the `Triangle` button
  40665. */
  40666. /**
  40667. * Sets the value of the `Triangle` button
  40668. */
  40669. buttonTriangle: number;
  40670. /**
  40671. * Gets the value of the `Options` button
  40672. */
  40673. /**
  40674. * Sets the value of the `Options` button
  40675. */
  40676. buttonOptions: number;
  40677. /**
  40678. * Gets the value of the `Share` button
  40679. */
  40680. /**
  40681. * Sets the value of the `Share` button
  40682. */
  40683. buttonShare: number;
  40684. /**
  40685. * Gets the value of the `L1` button
  40686. */
  40687. /**
  40688. * Sets the value of the `L1` button
  40689. */
  40690. buttonL1: number;
  40691. /**
  40692. * Gets the value of the `R1` button
  40693. */
  40694. /**
  40695. * Sets the value of the `R1` button
  40696. */
  40697. buttonR1: number;
  40698. /**
  40699. * Gets the value of the Left joystick
  40700. */
  40701. /**
  40702. * Sets the value of the Left joystick
  40703. */
  40704. buttonLeftStick: number;
  40705. /**
  40706. * Gets the value of the Right joystick
  40707. */
  40708. /**
  40709. * Sets the value of the Right joystick
  40710. */
  40711. buttonRightStick: number;
  40712. /**
  40713. * Gets the value of D-pad up
  40714. */
  40715. /**
  40716. * Sets the value of D-pad up
  40717. */
  40718. dPadUp: number;
  40719. /**
  40720. * Gets the value of D-pad down
  40721. */
  40722. /**
  40723. * Sets the value of D-pad down
  40724. */
  40725. dPadDown: number;
  40726. /**
  40727. * Gets the value of D-pad left
  40728. */
  40729. /**
  40730. * Sets the value of D-pad left
  40731. */
  40732. dPadLeft: number;
  40733. /**
  40734. * Gets the value of D-pad right
  40735. */
  40736. /**
  40737. * Sets the value of D-pad right
  40738. */
  40739. dPadRight: number;
  40740. /**
  40741. * Force the gamepad to synchronize with device values
  40742. */
  40743. update(): void;
  40744. /**
  40745. * Disposes the gamepad
  40746. */
  40747. dispose(): void;
  40748. }
  40749. }
  40750. declare module "babylonjs/Gamepads/gamepadManager" {
  40751. import { Observable } from "babylonjs/Misc/observable";
  40752. import { Nullable } from "babylonjs/types";
  40753. import { Scene } from "babylonjs/scene";
  40754. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40755. /**
  40756. * Manager for handling gamepads
  40757. */
  40758. export class GamepadManager {
  40759. private _scene?;
  40760. private _babylonGamepads;
  40761. private _oneGamepadConnected;
  40762. /** @hidden */
  40763. _isMonitoring: boolean;
  40764. private _gamepadEventSupported;
  40765. private _gamepadSupport;
  40766. /**
  40767. * observable to be triggered when the gamepad controller has been connected
  40768. */
  40769. onGamepadConnectedObservable: Observable<Gamepad>;
  40770. /**
  40771. * observable to be triggered when the gamepad controller has been disconnected
  40772. */
  40773. onGamepadDisconnectedObservable: Observable<Gamepad>;
  40774. private _onGamepadConnectedEvent;
  40775. private _onGamepadDisconnectedEvent;
  40776. /**
  40777. * Initializes the gamepad manager
  40778. * @param _scene BabylonJS scene
  40779. */
  40780. constructor(_scene?: Scene | undefined);
  40781. /**
  40782. * The gamepads in the game pad manager
  40783. */
  40784. readonly gamepads: Gamepad[];
  40785. /**
  40786. * Get the gamepad controllers based on type
  40787. * @param type The type of gamepad controller
  40788. * @returns Nullable gamepad
  40789. */
  40790. getGamepadByType(type?: number): Nullable<Gamepad>;
  40791. /**
  40792. * Disposes the gamepad manager
  40793. */
  40794. dispose(): void;
  40795. private _addNewGamepad;
  40796. private _startMonitoringGamepads;
  40797. private _stopMonitoringGamepads;
  40798. /** @hidden */
  40799. _checkGamepadsStatus(): void;
  40800. private _updateGamepadObjects;
  40801. }
  40802. }
  40803. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  40804. import { Nullable } from "babylonjs/types";
  40805. import { Scene } from "babylonjs/scene";
  40806. import { ISceneComponent } from "babylonjs/sceneComponent";
  40807. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  40808. module "babylonjs/scene" {
  40809. interface Scene {
  40810. /** @hidden */
  40811. _gamepadManager: Nullable<GamepadManager>;
  40812. /**
  40813. * Gets the gamepad manager associated with the scene
  40814. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  40815. */
  40816. gamepadManager: GamepadManager;
  40817. }
  40818. }
  40819. module "babylonjs/Cameras/freeCameraInputsManager" {
  40820. /**
  40821. * Interface representing a free camera inputs manager
  40822. */
  40823. interface FreeCameraInputsManager {
  40824. /**
  40825. * Adds gamepad input support to the FreeCameraInputsManager.
  40826. * @returns the FreeCameraInputsManager
  40827. */
  40828. addGamepad(): FreeCameraInputsManager;
  40829. }
  40830. }
  40831. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  40832. /**
  40833. * Interface representing an arc rotate camera inputs manager
  40834. */
  40835. interface ArcRotateCameraInputsManager {
  40836. /**
  40837. * Adds gamepad input support to the ArcRotateCamera InputManager.
  40838. * @returns the camera inputs manager
  40839. */
  40840. addGamepad(): ArcRotateCameraInputsManager;
  40841. }
  40842. }
  40843. /**
  40844. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  40845. */
  40846. export class GamepadSystemSceneComponent implements ISceneComponent {
  40847. /**
  40848. * The component name helpfull to identify the component in the list of scene components.
  40849. */
  40850. readonly name: string;
  40851. /**
  40852. * The scene the component belongs to.
  40853. */
  40854. scene: Scene;
  40855. /**
  40856. * Creates a new instance of the component for the given scene
  40857. * @param scene Defines the scene to register the component in
  40858. */
  40859. constructor(scene: Scene);
  40860. /**
  40861. * Registers the component in a given scene
  40862. */
  40863. register(): void;
  40864. /**
  40865. * Rebuilds the elements related to this component in case of
  40866. * context lost for instance.
  40867. */
  40868. rebuild(): void;
  40869. /**
  40870. * Disposes the component and the associated ressources
  40871. */
  40872. dispose(): void;
  40873. private _beforeCameraUpdate;
  40874. }
  40875. }
  40876. declare module "babylonjs/Cameras/universalCamera" {
  40877. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  40878. import { Scene } from "babylonjs/scene";
  40879. import { Vector3 } from "babylonjs/Maths/math.vector";
  40880. import "babylonjs/Gamepads/gamepadSceneComponent";
  40881. /**
  40882. * The Universal Camera is the one to choose for first person shooter type games, and works with all the keyboard, mouse, touch and gamepads. This replaces the earlier Free Camera,
  40883. * which still works and will still be found in many Playgrounds.
  40884. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40885. */
  40886. export class UniversalCamera extends TouchCamera {
  40887. /**
  40888. * Defines the gamepad rotation sensiblity.
  40889. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  40890. */
  40891. gamepadAngularSensibility: number;
  40892. /**
  40893. * Defines the gamepad move sensiblity.
  40894. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  40895. */
  40896. gamepadMoveSensibility: number;
  40897. /**
  40898. * The Universal Camera is the one to choose for first person shooter type games, and works with all the keyboard, mouse, touch and gamepads. This replaces the earlier Free Camera,
  40899. * which still works and will still be found in many Playgrounds.
  40900. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40901. * @param name Define the name of the camera in the scene
  40902. * @param position Define the start position of the camera in the scene
  40903. * @param scene Define the scene the camera belongs to
  40904. */
  40905. constructor(name: string, position: Vector3, scene: Scene);
  40906. /**
  40907. * Gets the current object class name.
  40908. * @return the class name
  40909. */
  40910. getClassName(): string;
  40911. }
  40912. }
  40913. declare module "babylonjs/Cameras/gamepadCamera" {
  40914. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  40915. import { Scene } from "babylonjs/scene";
  40916. import { Vector3 } from "babylonjs/Maths/math.vector";
  40917. /**
  40918. * This represents a FPS type of camera. This is only here for back compat purpose.
  40919. * Please use the UniversalCamera instead as both are identical.
  40920. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40921. */
  40922. export class GamepadCamera extends UniversalCamera {
  40923. /**
  40924. * Instantiates a new Gamepad Camera
  40925. * This represents a FPS type of camera. This is only here for back compat purpose.
  40926. * Please use the UniversalCamera instead as both are identical.
  40927. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40928. * @param name Define the name of the camera in the scene
  40929. * @param position Define the start position of the camera in the scene
  40930. * @param scene Define the scene the camera belongs to
  40931. */
  40932. constructor(name: string, position: Vector3, scene: Scene);
  40933. /**
  40934. * Gets the current object class name.
  40935. * @return the class name
  40936. */
  40937. getClassName(): string;
  40938. }
  40939. }
  40940. declare module "babylonjs/Shaders/pass.fragment" {
  40941. /** @hidden */
  40942. export var passPixelShader: {
  40943. name: string;
  40944. shader: string;
  40945. };
  40946. }
  40947. declare module "babylonjs/Shaders/passCube.fragment" {
  40948. /** @hidden */
  40949. export var passCubePixelShader: {
  40950. name: string;
  40951. shader: string;
  40952. };
  40953. }
  40954. declare module "babylonjs/PostProcesses/passPostProcess" {
  40955. import { Nullable } from "babylonjs/types";
  40956. import { Camera } from "babylonjs/Cameras/camera";
  40957. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  40958. import { Engine } from "babylonjs/Engines/engine";
  40959. import "babylonjs/Shaders/pass.fragment";
  40960. import "babylonjs/Shaders/passCube.fragment";
  40961. /**
  40962. * PassPostProcess which produces an output the same as it's input
  40963. */
  40964. export class PassPostProcess extends PostProcess {
  40965. /**
  40966. * Creates the PassPostProcess
  40967. * @param name The name of the effect.
  40968. * @param options The required width/height ratio to downsize to before computing the render pass.
  40969. * @param camera The camera to apply the render pass to.
  40970. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40971. * @param engine The engine which the post process will be applied. (default: current engine)
  40972. * @param reusable If the post process can be reused on the same frame. (default: false)
  40973. * @param textureType The type of texture to be used when performing the post processing.
  40974. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  40975. */
  40976. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  40977. }
  40978. /**
  40979. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  40980. */
  40981. export class PassCubePostProcess extends PostProcess {
  40982. private _face;
  40983. /**
  40984. * Gets or sets the cube face to display.
  40985. * * 0 is +X
  40986. * * 1 is -X
  40987. * * 2 is +Y
  40988. * * 3 is -Y
  40989. * * 4 is +Z
  40990. * * 5 is -Z
  40991. */
  40992. face: number;
  40993. /**
  40994. * Creates the PassCubePostProcess
  40995. * @param name The name of the effect.
  40996. * @param options The required width/height ratio to downsize to before computing the render pass.
  40997. * @param camera The camera to apply the render pass to.
  40998. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  40999. * @param engine The engine which the post process will be applied. (default: current engine)
  41000. * @param reusable If the post process can be reused on the same frame. (default: false)
  41001. * @param textureType The type of texture to be used when performing the post processing.
  41002. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  41003. */
  41004. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  41005. }
  41006. }
  41007. declare module "babylonjs/Shaders/anaglyph.fragment" {
  41008. /** @hidden */
  41009. export var anaglyphPixelShader: {
  41010. name: string;
  41011. shader: string;
  41012. };
  41013. }
  41014. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  41015. import { Engine } from "babylonjs/Engines/engine";
  41016. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  41017. import { Camera } from "babylonjs/Cameras/camera";
  41018. import "babylonjs/Shaders/anaglyph.fragment";
  41019. /**
  41020. * Postprocess used to generate anaglyphic rendering
  41021. */
  41022. export class AnaglyphPostProcess extends PostProcess {
  41023. private _passedProcess;
  41024. /**
  41025. * Creates a new AnaglyphPostProcess
  41026. * @param name defines postprocess name
  41027. * @param options defines creation options or target ratio scale
  41028. * @param rigCameras defines cameras using this postprocess
  41029. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  41030. * @param engine defines hosting engine
  41031. * @param reusable defines if the postprocess will be reused multiple times per frame
  41032. */
  41033. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  41034. }
  41035. }
  41036. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  41037. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  41038. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41039. import { Scene } from "babylonjs/scene";
  41040. import { Vector3 } from "babylonjs/Maths/math.vector";
  41041. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41042. /**
  41043. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  41044. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41045. */
  41046. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  41047. /**
  41048. * Creates a new AnaglyphArcRotateCamera
  41049. * @param name defines camera name
  41050. * @param alpha defines alpha angle (in radians)
  41051. * @param beta defines beta angle (in radians)
  41052. * @param radius defines radius
  41053. * @param target defines camera target
  41054. * @param interaxialDistance defines distance between each color axis
  41055. * @param scene defines the hosting scene
  41056. */
  41057. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  41058. /**
  41059. * Gets camera class name
  41060. * @returns AnaglyphArcRotateCamera
  41061. */
  41062. getClassName(): string;
  41063. }
  41064. }
  41065. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  41066. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41067. import { Scene } from "babylonjs/scene";
  41068. import { Vector3 } from "babylonjs/Maths/math.vector";
  41069. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41070. /**
  41071. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  41072. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41073. */
  41074. export class AnaglyphFreeCamera extends FreeCamera {
  41075. /**
  41076. * Creates a new AnaglyphFreeCamera
  41077. * @param name defines camera name
  41078. * @param position defines initial position
  41079. * @param interaxialDistance defines distance between each color axis
  41080. * @param scene defines the hosting scene
  41081. */
  41082. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  41083. /**
  41084. * Gets camera class name
  41085. * @returns AnaglyphFreeCamera
  41086. */
  41087. getClassName(): string;
  41088. }
  41089. }
  41090. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  41091. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  41092. import { Scene } from "babylonjs/scene";
  41093. import { Vector3 } from "babylonjs/Maths/math.vector";
  41094. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41095. /**
  41096. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  41097. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41098. */
  41099. export class AnaglyphGamepadCamera extends GamepadCamera {
  41100. /**
  41101. * Creates a new AnaglyphGamepadCamera
  41102. * @param name defines camera name
  41103. * @param position defines initial position
  41104. * @param interaxialDistance defines distance between each color axis
  41105. * @param scene defines the hosting scene
  41106. */
  41107. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  41108. /**
  41109. * Gets camera class name
  41110. * @returns AnaglyphGamepadCamera
  41111. */
  41112. getClassName(): string;
  41113. }
  41114. }
  41115. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  41116. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  41117. import { Scene } from "babylonjs/scene";
  41118. import { Vector3 } from "babylonjs/Maths/math.vector";
  41119. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41120. /**
  41121. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  41122. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41123. */
  41124. export class AnaglyphUniversalCamera extends UniversalCamera {
  41125. /**
  41126. * Creates a new AnaglyphUniversalCamera
  41127. * @param name defines camera name
  41128. * @param position defines initial position
  41129. * @param interaxialDistance defines distance between each color axis
  41130. * @param scene defines the hosting scene
  41131. */
  41132. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  41133. /**
  41134. * Gets camera class name
  41135. * @returns AnaglyphUniversalCamera
  41136. */
  41137. getClassName(): string;
  41138. }
  41139. }
  41140. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  41141. /** @hidden */
  41142. export var stereoscopicInterlacePixelShader: {
  41143. name: string;
  41144. shader: string;
  41145. };
  41146. }
  41147. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  41148. import { Camera } from "babylonjs/Cameras/camera";
  41149. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  41150. import { Engine } from "babylonjs/Engines/engine";
  41151. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  41152. /**
  41153. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  41154. */
  41155. export class StereoscopicInterlacePostProcess extends PostProcess {
  41156. private _stepSize;
  41157. private _passedProcess;
  41158. /**
  41159. * Initializes a StereoscopicInterlacePostProcess
  41160. * @param name The name of the effect.
  41161. * @param rigCameras The rig cameras to be appled to the post process
  41162. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  41163. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  41164. * @param engine The engine which the post process will be applied. (default: current engine)
  41165. * @param reusable If the post process can be reused on the same frame. (default: false)
  41166. */
  41167. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  41168. }
  41169. }
  41170. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  41171. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  41172. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41173. import { Scene } from "babylonjs/scene";
  41174. import { Vector3 } from "babylonjs/Maths/math.vector";
  41175. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41176. /**
  41177. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  41178. * @see http://doc.babylonjs.com/features/cameras
  41179. */
  41180. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  41181. /**
  41182. * Creates a new StereoscopicArcRotateCamera
  41183. * @param name defines camera name
  41184. * @param alpha defines alpha angle (in radians)
  41185. * @param beta defines beta angle (in radians)
  41186. * @param radius defines radius
  41187. * @param target defines camera target
  41188. * @param interaxialDistance defines distance between each color axis
  41189. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41190. * @param scene defines the hosting scene
  41191. */
  41192. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41193. /**
  41194. * Gets camera class name
  41195. * @returns StereoscopicArcRotateCamera
  41196. */
  41197. getClassName(): string;
  41198. }
  41199. }
  41200. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  41201. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41202. import { Scene } from "babylonjs/scene";
  41203. import { Vector3 } from "babylonjs/Maths/math.vector";
  41204. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41205. /**
  41206. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  41207. * @see http://doc.babylonjs.com/features/cameras
  41208. */
  41209. export class StereoscopicFreeCamera extends FreeCamera {
  41210. /**
  41211. * Creates a new StereoscopicFreeCamera
  41212. * @param name defines camera name
  41213. * @param position defines initial position
  41214. * @param interaxialDistance defines distance between each color axis
  41215. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41216. * @param scene defines the hosting scene
  41217. */
  41218. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41219. /**
  41220. * Gets camera class name
  41221. * @returns StereoscopicFreeCamera
  41222. */
  41223. getClassName(): string;
  41224. }
  41225. }
  41226. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  41227. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  41228. import { Scene } from "babylonjs/scene";
  41229. import { Vector3 } from "babylonjs/Maths/math.vector";
  41230. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41231. /**
  41232. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  41233. * @see http://doc.babylonjs.com/features/cameras
  41234. */
  41235. export class StereoscopicGamepadCamera extends GamepadCamera {
  41236. /**
  41237. * Creates a new StereoscopicGamepadCamera
  41238. * @param name defines camera name
  41239. * @param position defines initial position
  41240. * @param interaxialDistance defines distance between each color axis
  41241. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41242. * @param scene defines the hosting scene
  41243. */
  41244. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41245. /**
  41246. * Gets camera class name
  41247. * @returns StereoscopicGamepadCamera
  41248. */
  41249. getClassName(): string;
  41250. }
  41251. }
  41252. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  41253. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  41254. import { Scene } from "babylonjs/scene";
  41255. import { Vector3 } from "babylonjs/Maths/math.vector";
  41256. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41257. /**
  41258. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  41259. * @see http://doc.babylonjs.com/features/cameras
  41260. */
  41261. export class StereoscopicUniversalCamera extends UniversalCamera {
  41262. /**
  41263. * Creates a new StereoscopicUniversalCamera
  41264. * @param name defines camera name
  41265. * @param position defines initial position
  41266. * @param interaxialDistance defines distance between each color axis
  41267. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41268. * @param scene defines the hosting scene
  41269. */
  41270. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41271. /**
  41272. * Gets camera class name
  41273. * @returns StereoscopicUniversalCamera
  41274. */
  41275. getClassName(): string;
  41276. }
  41277. }
  41278. declare module "babylonjs/Cameras/Stereoscopic/index" {
  41279. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  41280. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  41281. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  41282. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  41283. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  41284. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  41285. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  41286. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  41287. }
  41288. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  41289. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41290. import { Scene } from "babylonjs/scene";
  41291. import { Vector3 } from "babylonjs/Maths/math.vector";
  41292. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  41293. /**
  41294. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  41295. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  41296. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  41297. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  41298. */
  41299. export class VirtualJoysticksCamera extends FreeCamera {
  41300. /**
  41301. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  41302. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  41303. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  41304. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  41305. * @param name Define the name of the camera in the scene
  41306. * @param position Define the start position of the camera in the scene
  41307. * @param scene Define the scene the camera belongs to
  41308. */
  41309. constructor(name: string, position: Vector3, scene: Scene);
  41310. /**
  41311. * Gets the current object class name.
  41312. * @return the class name
  41313. */
  41314. getClassName(): string;
  41315. }
  41316. }
  41317. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  41318. import { Matrix } from "babylonjs/Maths/math.vector";
  41319. /**
  41320. * This represents all the required metrics to create a VR camera.
  41321. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  41322. */
  41323. export class VRCameraMetrics {
  41324. /**
  41325. * Define the horizontal resolution off the screen.
  41326. */
  41327. hResolution: number;
  41328. /**
  41329. * Define the vertical resolution off the screen.
  41330. */
  41331. vResolution: number;
  41332. /**
  41333. * Define the horizontal screen size.
  41334. */
  41335. hScreenSize: number;
  41336. /**
  41337. * Define the vertical screen size.
  41338. */
  41339. vScreenSize: number;
  41340. /**
  41341. * Define the vertical screen center position.
  41342. */
  41343. vScreenCenter: number;
  41344. /**
  41345. * Define the distance of the eyes to the screen.
  41346. */
  41347. eyeToScreenDistance: number;
  41348. /**
  41349. * Define the distance between both lenses
  41350. */
  41351. lensSeparationDistance: number;
  41352. /**
  41353. * Define the distance between both viewer's eyes.
  41354. */
  41355. interpupillaryDistance: number;
  41356. /**
  41357. * Define the distortion factor of the VR postprocess.
  41358. * Please, touch with care.
  41359. */
  41360. distortionK: number[];
  41361. /**
  41362. * Define the chromatic aberration correction factors for the VR post process.
  41363. */
  41364. chromaAbCorrection: number[];
  41365. /**
  41366. * Define the scale factor of the post process.
  41367. * The smaller the better but the slower.
  41368. */
  41369. postProcessScaleFactor: number;
  41370. /**
  41371. * Define an offset for the lens center.
  41372. */
  41373. lensCenterOffset: number;
  41374. /**
  41375. * Define if the current vr camera should compensate the distortion of the lense or not.
  41376. */
  41377. compensateDistortion: boolean;
  41378. /**
  41379. * Defines if multiview should be enabled when rendering (Default: false)
  41380. */
  41381. multiviewEnabled: boolean;
  41382. /**
  41383. * Gets the rendering aspect ratio based on the provided resolutions.
  41384. */
  41385. readonly aspectRatio: number;
  41386. /**
  41387. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  41388. */
  41389. readonly aspectRatioFov: number;
  41390. /**
  41391. * @hidden
  41392. */
  41393. readonly leftHMatrix: Matrix;
  41394. /**
  41395. * @hidden
  41396. */
  41397. readonly rightHMatrix: Matrix;
  41398. /**
  41399. * @hidden
  41400. */
  41401. readonly leftPreViewMatrix: Matrix;
  41402. /**
  41403. * @hidden
  41404. */
  41405. readonly rightPreViewMatrix: Matrix;
  41406. /**
  41407. * Get the default VRMetrics based on the most generic setup.
  41408. * @returns the default vr metrics
  41409. */
  41410. static GetDefault(): VRCameraMetrics;
  41411. }
  41412. }
  41413. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  41414. /** @hidden */
  41415. export var vrDistortionCorrectionPixelShader: {
  41416. name: string;
  41417. shader: string;
  41418. };
  41419. }
  41420. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  41421. import { Camera } from "babylonjs/Cameras/camera";
  41422. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41423. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  41424. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  41425. /**
  41426. * VRDistortionCorrectionPostProcess used for mobile VR
  41427. */
  41428. export class VRDistortionCorrectionPostProcess extends PostProcess {
  41429. private _isRightEye;
  41430. private _distortionFactors;
  41431. private _postProcessScaleFactor;
  41432. private _lensCenterOffset;
  41433. private _scaleIn;
  41434. private _scaleFactor;
  41435. private _lensCenter;
  41436. /**
  41437. * Initializes the VRDistortionCorrectionPostProcess
  41438. * @param name The name of the effect.
  41439. * @param camera The camera to apply the render pass to.
  41440. * @param isRightEye If this is for the right eye distortion
  41441. * @param vrMetrics All the required metrics for the VR camera
  41442. */
  41443. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  41444. }
  41445. }
  41446. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  41447. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  41448. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41449. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41450. import { Scene } from "babylonjs/scene";
  41451. import { Vector3 } from "babylonjs/Maths/math.vector";
  41452. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  41453. import "babylonjs/Cameras/RigModes/vrRigMode";
  41454. /**
  41455. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  41456. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41457. */
  41458. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  41459. /**
  41460. * Creates a new VRDeviceOrientationArcRotateCamera
  41461. * @param name defines camera name
  41462. * @param alpha defines the camera rotation along the logitudinal axis
  41463. * @param beta defines the camera rotation along the latitudinal axis
  41464. * @param radius defines the camera distance from its target
  41465. * @param target defines the camera target
  41466. * @param scene defines the scene the camera belongs to
  41467. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41468. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41469. */
  41470. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41471. /**
  41472. * Gets camera class name
  41473. * @returns VRDeviceOrientationArcRotateCamera
  41474. */
  41475. getClassName(): string;
  41476. }
  41477. }
  41478. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  41479. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  41480. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41481. import { Scene } from "babylonjs/scene";
  41482. import { Vector3 } from "babylonjs/Maths/math.vector";
  41483. import "babylonjs/Cameras/RigModes/vrRigMode";
  41484. /**
  41485. * Camera used to simulate VR rendering (based on FreeCamera)
  41486. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41487. */
  41488. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  41489. /**
  41490. * Creates a new VRDeviceOrientationFreeCamera
  41491. * @param name defines camera name
  41492. * @param position defines the start position of the camera
  41493. * @param scene defines the scene the camera belongs to
  41494. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41495. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41496. */
  41497. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41498. /**
  41499. * Gets camera class name
  41500. * @returns VRDeviceOrientationFreeCamera
  41501. */
  41502. getClassName(): string;
  41503. }
  41504. }
  41505. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  41506. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  41507. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41508. import { Scene } from "babylonjs/scene";
  41509. import { Vector3 } from "babylonjs/Maths/math.vector";
  41510. import "babylonjs/Gamepads/gamepadSceneComponent";
  41511. /**
  41512. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  41513. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41514. */
  41515. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  41516. /**
  41517. * Creates a new VRDeviceOrientationGamepadCamera
  41518. * @param name defines camera name
  41519. * @param position defines the start position of the camera
  41520. * @param scene defines the scene the camera belongs to
  41521. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41522. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41523. */
  41524. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41525. /**
  41526. * Gets camera class name
  41527. * @returns VRDeviceOrientationGamepadCamera
  41528. */
  41529. getClassName(): string;
  41530. }
  41531. }
  41532. declare module "babylonjs/Materials/pushMaterial" {
  41533. import { Nullable } from "babylonjs/types";
  41534. import { Scene } from "babylonjs/scene";
  41535. import { Matrix } from "babylonjs/Maths/math.vector";
  41536. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41537. import { Mesh } from "babylonjs/Meshes/mesh";
  41538. import { Material } from "babylonjs/Materials/material";
  41539. import { Effect } from "babylonjs/Materials/effect";
  41540. /**
  41541. * Base class of materials working in push mode in babylon JS
  41542. * @hidden
  41543. */
  41544. export class PushMaterial extends Material {
  41545. protected _activeEffect: Effect;
  41546. protected _normalMatrix: Matrix;
  41547. /**
  41548. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  41549. * This means that the material can keep using a previous shader while a new one is being compiled.
  41550. * This is mostly used when shader parallel compilation is supported (true by default)
  41551. */
  41552. allowShaderHotSwapping: boolean;
  41553. constructor(name: string, scene: Scene);
  41554. getEffect(): Effect;
  41555. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  41556. /**
  41557. * Binds the given world matrix to the active effect
  41558. *
  41559. * @param world the matrix to bind
  41560. */
  41561. bindOnlyWorldMatrix(world: Matrix): void;
  41562. /**
  41563. * Binds the given normal matrix to the active effect
  41564. *
  41565. * @param normalMatrix the matrix to bind
  41566. */
  41567. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  41568. bind(world: Matrix, mesh?: Mesh): void;
  41569. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  41570. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  41571. }
  41572. }
  41573. declare module "babylonjs/Materials/materialFlags" {
  41574. /**
  41575. * This groups all the flags used to control the materials channel.
  41576. */
  41577. export class MaterialFlags {
  41578. private static _DiffuseTextureEnabled;
  41579. /**
  41580. * Are diffuse textures enabled in the application.
  41581. */
  41582. static DiffuseTextureEnabled: boolean;
  41583. private static _AmbientTextureEnabled;
  41584. /**
  41585. * Are ambient textures enabled in the application.
  41586. */
  41587. static AmbientTextureEnabled: boolean;
  41588. private static _OpacityTextureEnabled;
  41589. /**
  41590. * Are opacity textures enabled in the application.
  41591. */
  41592. static OpacityTextureEnabled: boolean;
  41593. private static _ReflectionTextureEnabled;
  41594. /**
  41595. * Are reflection textures enabled in the application.
  41596. */
  41597. static ReflectionTextureEnabled: boolean;
  41598. private static _EmissiveTextureEnabled;
  41599. /**
  41600. * Are emissive textures enabled in the application.
  41601. */
  41602. static EmissiveTextureEnabled: boolean;
  41603. private static _SpecularTextureEnabled;
  41604. /**
  41605. * Are specular textures enabled in the application.
  41606. */
  41607. static SpecularTextureEnabled: boolean;
  41608. private static _BumpTextureEnabled;
  41609. /**
  41610. * Are bump textures enabled in the application.
  41611. */
  41612. static BumpTextureEnabled: boolean;
  41613. private static _LightmapTextureEnabled;
  41614. /**
  41615. * Are lightmap textures enabled in the application.
  41616. */
  41617. static LightmapTextureEnabled: boolean;
  41618. private static _RefractionTextureEnabled;
  41619. /**
  41620. * Are refraction textures enabled in the application.
  41621. */
  41622. static RefractionTextureEnabled: boolean;
  41623. private static _ColorGradingTextureEnabled;
  41624. /**
  41625. * Are color grading textures enabled in the application.
  41626. */
  41627. static ColorGradingTextureEnabled: boolean;
  41628. private static _FresnelEnabled;
  41629. /**
  41630. * Are fresnels enabled in the application.
  41631. */
  41632. static FresnelEnabled: boolean;
  41633. private static _ClearCoatTextureEnabled;
  41634. /**
  41635. * Are clear coat textures enabled in the application.
  41636. */
  41637. static ClearCoatTextureEnabled: boolean;
  41638. private static _ClearCoatBumpTextureEnabled;
  41639. /**
  41640. * Are clear coat bump textures enabled in the application.
  41641. */
  41642. static ClearCoatBumpTextureEnabled: boolean;
  41643. private static _ClearCoatTintTextureEnabled;
  41644. /**
  41645. * Are clear coat tint textures enabled in the application.
  41646. */
  41647. static ClearCoatTintTextureEnabled: boolean;
  41648. private static _SheenTextureEnabled;
  41649. /**
  41650. * Are sheen textures enabled in the application.
  41651. */
  41652. static SheenTextureEnabled: boolean;
  41653. private static _AnisotropicTextureEnabled;
  41654. /**
  41655. * Are anisotropic textures enabled in the application.
  41656. */
  41657. static AnisotropicTextureEnabled: boolean;
  41658. private static _ThicknessTextureEnabled;
  41659. /**
  41660. * Are thickness textures enabled in the application.
  41661. */
  41662. static ThicknessTextureEnabled: boolean;
  41663. }
  41664. }
  41665. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  41666. /** @hidden */
  41667. export var defaultFragmentDeclaration: {
  41668. name: string;
  41669. shader: string;
  41670. };
  41671. }
  41672. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  41673. /** @hidden */
  41674. export var defaultUboDeclaration: {
  41675. name: string;
  41676. shader: string;
  41677. };
  41678. }
  41679. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  41680. /** @hidden */
  41681. export var lightFragmentDeclaration: {
  41682. name: string;
  41683. shader: string;
  41684. };
  41685. }
  41686. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  41687. /** @hidden */
  41688. export var lightUboDeclaration: {
  41689. name: string;
  41690. shader: string;
  41691. };
  41692. }
  41693. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  41694. /** @hidden */
  41695. export var lightsFragmentFunctions: {
  41696. name: string;
  41697. shader: string;
  41698. };
  41699. }
  41700. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  41701. /** @hidden */
  41702. export var shadowsFragmentFunctions: {
  41703. name: string;
  41704. shader: string;
  41705. };
  41706. }
  41707. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  41708. /** @hidden */
  41709. export var fresnelFunction: {
  41710. name: string;
  41711. shader: string;
  41712. };
  41713. }
  41714. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  41715. /** @hidden */
  41716. export var reflectionFunction: {
  41717. name: string;
  41718. shader: string;
  41719. };
  41720. }
  41721. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  41722. /** @hidden */
  41723. export var bumpFragmentFunctions: {
  41724. name: string;
  41725. shader: string;
  41726. };
  41727. }
  41728. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  41729. /** @hidden */
  41730. export var logDepthDeclaration: {
  41731. name: string;
  41732. shader: string;
  41733. };
  41734. }
  41735. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  41736. /** @hidden */
  41737. export var bumpFragment: {
  41738. name: string;
  41739. shader: string;
  41740. };
  41741. }
  41742. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  41743. /** @hidden */
  41744. export var depthPrePass: {
  41745. name: string;
  41746. shader: string;
  41747. };
  41748. }
  41749. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  41750. /** @hidden */
  41751. export var lightFragment: {
  41752. name: string;
  41753. shader: string;
  41754. };
  41755. }
  41756. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  41757. /** @hidden */
  41758. export var logDepthFragment: {
  41759. name: string;
  41760. shader: string;
  41761. };
  41762. }
  41763. declare module "babylonjs/Shaders/default.fragment" {
  41764. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  41765. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41766. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41767. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41768. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41769. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  41770. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  41771. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  41772. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  41773. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  41774. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  41775. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  41776. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  41777. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41778. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  41779. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  41780. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  41781. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  41782. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  41783. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  41784. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  41785. /** @hidden */
  41786. export var defaultPixelShader: {
  41787. name: string;
  41788. shader: string;
  41789. };
  41790. }
  41791. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  41792. /** @hidden */
  41793. export var defaultVertexDeclaration: {
  41794. name: string;
  41795. shader: string;
  41796. };
  41797. }
  41798. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  41799. /** @hidden */
  41800. export var bumpVertexDeclaration: {
  41801. name: string;
  41802. shader: string;
  41803. };
  41804. }
  41805. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  41806. /** @hidden */
  41807. export var bumpVertex: {
  41808. name: string;
  41809. shader: string;
  41810. };
  41811. }
  41812. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  41813. /** @hidden */
  41814. export var fogVertex: {
  41815. name: string;
  41816. shader: string;
  41817. };
  41818. }
  41819. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  41820. /** @hidden */
  41821. export var shadowsVertex: {
  41822. name: string;
  41823. shader: string;
  41824. };
  41825. }
  41826. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  41827. /** @hidden */
  41828. export var pointCloudVertex: {
  41829. name: string;
  41830. shader: string;
  41831. };
  41832. }
  41833. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  41834. /** @hidden */
  41835. export var logDepthVertex: {
  41836. name: string;
  41837. shader: string;
  41838. };
  41839. }
  41840. declare module "babylonjs/Shaders/default.vertex" {
  41841. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  41842. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41843. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41844. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  41845. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  41846. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  41847. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  41848. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  41849. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41850. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41851. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  41852. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  41853. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41854. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  41855. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  41856. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  41857. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  41858. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  41859. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  41860. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  41861. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  41862. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  41863. /** @hidden */
  41864. export var defaultVertexShader: {
  41865. name: string;
  41866. shader: string;
  41867. };
  41868. }
  41869. declare module "babylonjs/Materials/standardMaterial" {
  41870. import { SmartArray } from "babylonjs/Misc/smartArray";
  41871. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  41872. import { Nullable } from "babylonjs/types";
  41873. import { Scene } from "babylonjs/scene";
  41874. import { Matrix } from "babylonjs/Maths/math.vector";
  41875. import { Color3 } from "babylonjs/Maths/math.color";
  41876. import { SubMesh } from "babylonjs/Meshes/subMesh";
  41877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41878. import { Mesh } from "babylonjs/Meshes/mesh";
  41879. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  41880. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  41881. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  41882. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  41883. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  41884. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  41885. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  41886. import "babylonjs/Shaders/default.fragment";
  41887. import "babylonjs/Shaders/default.vertex";
  41888. /** @hidden */
  41889. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  41890. MAINUV1: boolean;
  41891. MAINUV2: boolean;
  41892. DIFFUSE: boolean;
  41893. DIFFUSEDIRECTUV: number;
  41894. AMBIENT: boolean;
  41895. AMBIENTDIRECTUV: number;
  41896. OPACITY: boolean;
  41897. OPACITYDIRECTUV: number;
  41898. OPACITYRGB: boolean;
  41899. REFLECTION: boolean;
  41900. EMISSIVE: boolean;
  41901. EMISSIVEDIRECTUV: number;
  41902. SPECULAR: boolean;
  41903. SPECULARDIRECTUV: number;
  41904. BUMP: boolean;
  41905. BUMPDIRECTUV: number;
  41906. PARALLAX: boolean;
  41907. PARALLAXOCCLUSION: boolean;
  41908. SPECULAROVERALPHA: boolean;
  41909. CLIPPLANE: boolean;
  41910. CLIPPLANE2: boolean;
  41911. CLIPPLANE3: boolean;
  41912. CLIPPLANE4: boolean;
  41913. ALPHATEST: boolean;
  41914. DEPTHPREPASS: boolean;
  41915. ALPHAFROMDIFFUSE: boolean;
  41916. POINTSIZE: boolean;
  41917. FOG: boolean;
  41918. SPECULARTERM: boolean;
  41919. DIFFUSEFRESNEL: boolean;
  41920. OPACITYFRESNEL: boolean;
  41921. REFLECTIONFRESNEL: boolean;
  41922. REFRACTIONFRESNEL: boolean;
  41923. EMISSIVEFRESNEL: boolean;
  41924. FRESNEL: boolean;
  41925. NORMAL: boolean;
  41926. UV1: boolean;
  41927. UV2: boolean;
  41928. VERTEXCOLOR: boolean;
  41929. VERTEXALPHA: boolean;
  41930. NUM_BONE_INFLUENCERS: number;
  41931. BonesPerMesh: number;
  41932. BONETEXTURE: boolean;
  41933. INSTANCES: boolean;
  41934. GLOSSINESS: boolean;
  41935. ROUGHNESS: boolean;
  41936. EMISSIVEASILLUMINATION: boolean;
  41937. LINKEMISSIVEWITHDIFFUSE: boolean;
  41938. REFLECTIONFRESNELFROMSPECULAR: boolean;
  41939. LIGHTMAP: boolean;
  41940. LIGHTMAPDIRECTUV: number;
  41941. OBJECTSPACE_NORMALMAP: boolean;
  41942. USELIGHTMAPASSHADOWMAP: boolean;
  41943. REFLECTIONMAP_3D: boolean;
  41944. REFLECTIONMAP_SPHERICAL: boolean;
  41945. REFLECTIONMAP_PLANAR: boolean;
  41946. REFLECTIONMAP_CUBIC: boolean;
  41947. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  41948. REFLECTIONMAP_PROJECTION: boolean;
  41949. REFLECTIONMAP_SKYBOX: boolean;
  41950. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  41951. REFLECTIONMAP_EXPLICIT: boolean;
  41952. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  41953. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  41954. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  41955. INVERTCUBICMAP: boolean;
  41956. LOGARITHMICDEPTH: boolean;
  41957. REFRACTION: boolean;
  41958. REFRACTIONMAP_3D: boolean;
  41959. REFLECTIONOVERALPHA: boolean;
  41960. TWOSIDEDLIGHTING: boolean;
  41961. SHADOWFLOAT: boolean;
  41962. MORPHTARGETS: boolean;
  41963. MORPHTARGETS_NORMAL: boolean;
  41964. MORPHTARGETS_TANGENT: boolean;
  41965. MORPHTARGETS_UV: boolean;
  41966. NUM_MORPH_INFLUENCERS: number;
  41967. NONUNIFORMSCALING: boolean;
  41968. PREMULTIPLYALPHA: boolean;
  41969. IMAGEPROCESSING: boolean;
  41970. VIGNETTE: boolean;
  41971. VIGNETTEBLENDMODEMULTIPLY: boolean;
  41972. VIGNETTEBLENDMODEOPAQUE: boolean;
  41973. TONEMAPPING: boolean;
  41974. TONEMAPPING_ACES: boolean;
  41975. CONTRAST: boolean;
  41976. COLORCURVES: boolean;
  41977. COLORGRADING: boolean;
  41978. COLORGRADING3D: boolean;
  41979. SAMPLER3DGREENDEPTH: boolean;
  41980. SAMPLER3DBGRMAP: boolean;
  41981. IMAGEPROCESSINGPOSTPROCESS: boolean;
  41982. MULTIVIEW: boolean;
  41983. /**
  41984. * If the reflection texture on this material is in linear color space
  41985. * @hidden
  41986. */
  41987. IS_REFLECTION_LINEAR: boolean;
  41988. /**
  41989. * If the refraction texture on this material is in linear color space
  41990. * @hidden
  41991. */
  41992. IS_REFRACTION_LINEAR: boolean;
  41993. EXPOSURE: boolean;
  41994. constructor();
  41995. setReflectionMode(modeToEnable: string): void;
  41996. }
  41997. /**
  41998. * This is the default material used in Babylon. It is the best trade off between quality
  41999. * and performances.
  42000. * @see http://doc.babylonjs.com/babylon101/materials
  42001. */
  42002. export class StandardMaterial extends PushMaterial {
  42003. private _diffuseTexture;
  42004. /**
  42005. * The basic texture of the material as viewed under a light.
  42006. */
  42007. diffuseTexture: Nullable<BaseTexture>;
  42008. private _ambientTexture;
  42009. /**
  42010. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  42011. */
  42012. ambientTexture: Nullable<BaseTexture>;
  42013. private _opacityTexture;
  42014. /**
  42015. * Define the transparency of the material from a texture.
  42016. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  42017. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  42018. */
  42019. opacityTexture: Nullable<BaseTexture>;
  42020. private _reflectionTexture;
  42021. /**
  42022. * Define the texture used to display the reflection.
  42023. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42024. */
  42025. reflectionTexture: Nullable<BaseTexture>;
  42026. private _emissiveTexture;
  42027. /**
  42028. * Define texture of the material as if self lit.
  42029. * This will be mixed in the final result even in the absence of light.
  42030. */
  42031. emissiveTexture: Nullable<BaseTexture>;
  42032. private _specularTexture;
  42033. /**
  42034. * Define how the color and intensity of the highlight given by the light in the material.
  42035. */
  42036. specularTexture: Nullable<BaseTexture>;
  42037. private _bumpTexture;
  42038. /**
  42039. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  42040. * These are made by creating a normal map from an image. The means to do this can be found on the web, a search for 'normal map generator' will bring up free and paid for methods of doing this.
  42041. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  42042. */
  42043. bumpTexture: Nullable<BaseTexture>;
  42044. private _lightmapTexture;
  42045. /**
  42046. * Complex lighting can be computationally expensive to compute at runtime.
  42047. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  42048. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  42049. */
  42050. lightmapTexture: Nullable<BaseTexture>;
  42051. private _refractionTexture;
  42052. /**
  42053. * Define the texture used to display the refraction.
  42054. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42055. */
  42056. refractionTexture: Nullable<BaseTexture>;
  42057. /**
  42058. * The color of the material lit by the environmental background lighting.
  42059. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  42060. */
  42061. ambientColor: Color3;
  42062. /**
  42063. * The basic color of the material as viewed under a light.
  42064. */
  42065. diffuseColor: Color3;
  42066. /**
  42067. * Define how the color and intensity of the highlight given by the light in the material.
  42068. */
  42069. specularColor: Color3;
  42070. /**
  42071. * Define the color of the material as if self lit.
  42072. * This will be mixed in the final result even in the absence of light.
  42073. */
  42074. emissiveColor: Color3;
  42075. /**
  42076. * Defines how sharp are the highlights in the material.
  42077. * The bigger the value the sharper giving a more glossy feeling to the result.
  42078. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  42079. */
  42080. specularPower: number;
  42081. private _useAlphaFromDiffuseTexture;
  42082. /**
  42083. * Does the transparency come from the diffuse texture alpha channel.
  42084. */
  42085. useAlphaFromDiffuseTexture: boolean;
  42086. private _useEmissiveAsIllumination;
  42087. /**
  42088. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  42089. */
  42090. useEmissiveAsIllumination: boolean;
  42091. private _linkEmissiveWithDiffuse;
  42092. /**
  42093. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  42094. * the emissive level when the final color is close to one.
  42095. */
  42096. linkEmissiveWithDiffuse: boolean;
  42097. private _useSpecularOverAlpha;
  42098. /**
  42099. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  42100. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  42101. */
  42102. useSpecularOverAlpha: boolean;
  42103. private _useReflectionOverAlpha;
  42104. /**
  42105. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  42106. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  42107. */
  42108. useReflectionOverAlpha: boolean;
  42109. private _disableLighting;
  42110. /**
  42111. * Does lights from the scene impacts this material.
  42112. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  42113. */
  42114. disableLighting: boolean;
  42115. private _useObjectSpaceNormalMap;
  42116. /**
  42117. * Allows using an object space normal map (instead of tangent space).
  42118. */
  42119. useObjectSpaceNormalMap: boolean;
  42120. private _useParallax;
  42121. /**
  42122. * Is parallax enabled or not.
  42123. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  42124. */
  42125. useParallax: boolean;
  42126. private _useParallaxOcclusion;
  42127. /**
  42128. * Is parallax occlusion enabled or not.
  42129. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  42130. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  42131. */
  42132. useParallaxOcclusion: boolean;
  42133. /**
  42134. * Apply a scaling factor that determine which "depth" the height map should reprensent. A value between 0.05 and 0.1 is reasonnable in Parallax, you can reach 0.2 using Parallax Occlusion.
  42135. */
  42136. parallaxScaleBias: number;
  42137. private _roughness;
  42138. /**
  42139. * Helps to define how blurry the reflections should appears in the material.
  42140. */
  42141. roughness: number;
  42142. /**
  42143. * In case of refraction, define the value of the index of refraction.
  42144. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42145. */
  42146. indexOfRefraction: number;
  42147. /**
  42148. * Invert the refraction texture alongside the y axis.
  42149. * It can be useful with procedural textures or probe for instance.
  42150. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42151. */
  42152. invertRefractionY: boolean;
  42153. /**
  42154. * Defines the alpha limits in alpha test mode.
  42155. */
  42156. alphaCutOff: number;
  42157. private _useLightmapAsShadowmap;
  42158. /**
  42159. * In case of light mapping, define whether the map contains light or shadow informations.
  42160. */
  42161. useLightmapAsShadowmap: boolean;
  42162. private _diffuseFresnelParameters;
  42163. /**
  42164. * Define the diffuse fresnel parameters of the material.
  42165. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42166. */
  42167. diffuseFresnelParameters: FresnelParameters;
  42168. private _opacityFresnelParameters;
  42169. /**
  42170. * Define the opacity fresnel parameters of the material.
  42171. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42172. */
  42173. opacityFresnelParameters: FresnelParameters;
  42174. private _reflectionFresnelParameters;
  42175. /**
  42176. * Define the reflection fresnel parameters of the material.
  42177. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42178. */
  42179. reflectionFresnelParameters: FresnelParameters;
  42180. private _refractionFresnelParameters;
  42181. /**
  42182. * Define the refraction fresnel parameters of the material.
  42183. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42184. */
  42185. refractionFresnelParameters: FresnelParameters;
  42186. private _emissiveFresnelParameters;
  42187. /**
  42188. * Define the emissive fresnel parameters of the material.
  42189. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42190. */
  42191. emissiveFresnelParameters: FresnelParameters;
  42192. private _useReflectionFresnelFromSpecular;
  42193. /**
  42194. * If true automatically deducts the fresnels values from the material specularity.
  42195. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42196. */
  42197. useReflectionFresnelFromSpecular: boolean;
  42198. private _useGlossinessFromSpecularMapAlpha;
  42199. /**
  42200. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  42201. */
  42202. useGlossinessFromSpecularMapAlpha: boolean;
  42203. private _maxSimultaneousLights;
  42204. /**
  42205. * Defines the maximum number of lights that can be used in the material
  42206. */
  42207. maxSimultaneousLights: number;
  42208. private _invertNormalMapX;
  42209. /**
  42210. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  42211. */
  42212. invertNormalMapX: boolean;
  42213. private _invertNormalMapY;
  42214. /**
  42215. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  42216. */
  42217. invertNormalMapY: boolean;
  42218. private _twoSidedLighting;
  42219. /**
  42220. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  42221. */
  42222. twoSidedLighting: boolean;
  42223. /**
  42224. * Default configuration related to image processing available in the standard Material.
  42225. */
  42226. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42227. /**
  42228. * Gets the image processing configuration used either in this material.
  42229. */
  42230. /**
  42231. * Sets the Default image processing configuration used either in the this material.
  42232. *
  42233. * If sets to null, the scene one is in use.
  42234. */
  42235. imageProcessingConfiguration: ImageProcessingConfiguration;
  42236. /**
  42237. * Keep track of the image processing observer to allow dispose and replace.
  42238. */
  42239. private _imageProcessingObserver;
  42240. /**
  42241. * Attaches a new image processing configuration to the Standard Material.
  42242. * @param configuration
  42243. */
  42244. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  42245. /**
  42246. * Gets wether the color curves effect is enabled.
  42247. */
  42248. /**
  42249. * Sets wether the color curves effect is enabled.
  42250. */
  42251. cameraColorCurvesEnabled: boolean;
  42252. /**
  42253. * Gets wether the color grading effect is enabled.
  42254. */
  42255. /**
  42256. * Gets wether the color grading effect is enabled.
  42257. */
  42258. cameraColorGradingEnabled: boolean;
  42259. /**
  42260. * Gets wether tonemapping is enabled or not.
  42261. */
  42262. /**
  42263. * Sets wether tonemapping is enabled or not
  42264. */
  42265. cameraToneMappingEnabled: boolean;
  42266. /**
  42267. * The camera exposure used on this material.
  42268. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  42269. * This corresponds to a photographic exposure.
  42270. */
  42271. /**
  42272. * The camera exposure used on this material.
  42273. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  42274. * This corresponds to a photographic exposure.
  42275. */
  42276. cameraExposure: number;
  42277. /**
  42278. * Gets The camera contrast used on this material.
  42279. */
  42280. /**
  42281. * Sets The camera contrast used on this material.
  42282. */
  42283. cameraContrast: number;
  42284. /**
  42285. * Gets the Color Grading 2D Lookup Texture.
  42286. */
  42287. /**
  42288. * Sets the Color Grading 2D Lookup Texture.
  42289. */
  42290. cameraColorGradingTexture: Nullable<BaseTexture>;
  42291. /**
  42292. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  42293. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  42294. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  42295. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  42296. */
  42297. /**
  42298. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  42299. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  42300. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  42301. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  42302. */
  42303. cameraColorCurves: Nullable<ColorCurves>;
  42304. /**
  42305. * Custom callback helping to override the default shader used in the material.
  42306. */
  42307. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  42308. protected _renderTargets: SmartArray<RenderTargetTexture>;
  42309. protected _worldViewProjectionMatrix: Matrix;
  42310. protected _globalAmbientColor: Color3;
  42311. protected _useLogarithmicDepth: boolean;
  42312. protected _rebuildInParallel: boolean;
  42313. /**
  42314. * Instantiates a new standard material.
  42315. * This is the default material used in Babylon. It is the best trade off between quality
  42316. * and performances.
  42317. * @see http://doc.babylonjs.com/babylon101/materials
  42318. * @param name Define the name of the material in the scene
  42319. * @param scene Define the scene the material belong to
  42320. */
  42321. constructor(name: string, scene: Scene);
  42322. /**
  42323. * Gets a boolean indicating that current material needs to register RTT
  42324. */
  42325. readonly hasRenderTargetTextures: boolean;
  42326. /**
  42327. * Gets the current class name of the material e.g. "StandardMaterial"
  42328. * Mainly use in serialization.
  42329. * @returns the class name
  42330. */
  42331. getClassName(): string;
  42332. /**
  42333. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  42334. * You can try switching to logarithmic depth.
  42335. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  42336. */
  42337. useLogarithmicDepth: boolean;
  42338. /**
  42339. * Specifies if the material will require alpha blending
  42340. * @returns a boolean specifying if alpha blending is needed
  42341. */
  42342. needAlphaBlending(): boolean;
  42343. /**
  42344. * Specifies if this material should be rendered in alpha test mode
  42345. * @returns a boolean specifying if an alpha test is needed.
  42346. */
  42347. needAlphaTesting(): boolean;
  42348. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  42349. /**
  42350. * Get the texture used for alpha test purpose.
  42351. * @returns the diffuse texture in case of the standard material.
  42352. */
  42353. getAlphaTestTexture(): Nullable<BaseTexture>;
  42354. /**
  42355. * Get if the submesh is ready to be used and all its information available.
  42356. * Child classes can use it to update shaders
  42357. * @param mesh defines the mesh to check
  42358. * @param subMesh defines which submesh to check
  42359. * @param useInstances specifies that instances should be used
  42360. * @returns a boolean indicating that the submesh is ready or not
  42361. */
  42362. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  42363. /**
  42364. * Builds the material UBO layouts.
  42365. * Used internally during the effect preparation.
  42366. */
  42367. buildUniformLayout(): void;
  42368. /**
  42369. * Unbinds the material from the mesh
  42370. */
  42371. unbind(): void;
  42372. /**
  42373. * Binds the submesh to this material by preparing the effect and shader to draw
  42374. * @param world defines the world transformation matrix
  42375. * @param mesh defines the mesh containing the submesh
  42376. * @param subMesh defines the submesh to bind the material to
  42377. */
  42378. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  42379. /**
  42380. * Get the list of animatables in the material.
  42381. * @returns the list of animatables object used in the material
  42382. */
  42383. getAnimatables(): IAnimatable[];
  42384. /**
  42385. * Gets the active textures from the material
  42386. * @returns an array of textures
  42387. */
  42388. getActiveTextures(): BaseTexture[];
  42389. /**
  42390. * Specifies if the material uses a texture
  42391. * @param texture defines the texture to check against the material
  42392. * @returns a boolean specifying if the material uses the texture
  42393. */
  42394. hasTexture(texture: BaseTexture): boolean;
  42395. /**
  42396. * Disposes the material
  42397. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  42398. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  42399. */
  42400. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  42401. /**
  42402. * Makes a duplicate of the material, and gives it a new name
  42403. * @param name defines the new name for the duplicated material
  42404. * @returns the cloned material
  42405. */
  42406. clone(name: string): StandardMaterial;
  42407. /**
  42408. * Serializes this material in a JSON representation
  42409. * @returns the serialized material object
  42410. */
  42411. serialize(): any;
  42412. /**
  42413. * Creates a standard material from parsed material data
  42414. * @param source defines the JSON representation of the material
  42415. * @param scene defines the hosting scene
  42416. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  42417. * @returns a new standard material
  42418. */
  42419. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  42420. /**
  42421. * Are diffuse textures enabled in the application.
  42422. */
  42423. static DiffuseTextureEnabled: boolean;
  42424. /**
  42425. * Are ambient textures enabled in the application.
  42426. */
  42427. static AmbientTextureEnabled: boolean;
  42428. /**
  42429. * Are opacity textures enabled in the application.
  42430. */
  42431. static OpacityTextureEnabled: boolean;
  42432. /**
  42433. * Are reflection textures enabled in the application.
  42434. */
  42435. static ReflectionTextureEnabled: boolean;
  42436. /**
  42437. * Are emissive textures enabled in the application.
  42438. */
  42439. static EmissiveTextureEnabled: boolean;
  42440. /**
  42441. * Are specular textures enabled in the application.
  42442. */
  42443. static SpecularTextureEnabled: boolean;
  42444. /**
  42445. * Are bump textures enabled in the application.
  42446. */
  42447. static BumpTextureEnabled: boolean;
  42448. /**
  42449. * Are lightmap textures enabled in the application.
  42450. */
  42451. static LightmapTextureEnabled: boolean;
  42452. /**
  42453. * Are refraction textures enabled in the application.
  42454. */
  42455. static RefractionTextureEnabled: boolean;
  42456. /**
  42457. * Are color grading textures enabled in the application.
  42458. */
  42459. static ColorGradingTextureEnabled: boolean;
  42460. /**
  42461. * Are fresnels enabled in the application.
  42462. */
  42463. static FresnelEnabled: boolean;
  42464. }
  42465. }
  42466. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  42467. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  42468. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  42469. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  42470. /** @hidden */
  42471. export var imageProcessingPixelShader: {
  42472. name: string;
  42473. shader: string;
  42474. };
  42475. }
  42476. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  42477. import { Nullable } from "babylonjs/types";
  42478. import { Color4 } from "babylonjs/Maths/math.color";
  42479. import { Camera } from "babylonjs/Cameras/camera";
  42480. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42481. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  42482. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  42483. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  42484. import { Engine } from "babylonjs/Engines/engine";
  42485. import "babylonjs/Shaders/imageProcessing.fragment";
  42486. import "babylonjs/Shaders/postprocess.vertex";
  42487. /**
  42488. * ImageProcessingPostProcess
  42489. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  42490. */
  42491. export class ImageProcessingPostProcess extends PostProcess {
  42492. /**
  42493. * Default configuration related to image processing available in the PBR Material.
  42494. */
  42495. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42496. /**
  42497. * Gets the image processing configuration used either in this material.
  42498. */
  42499. /**
  42500. * Sets the Default image processing configuration used either in the this material.
  42501. *
  42502. * If sets to null, the scene one is in use.
  42503. */
  42504. imageProcessingConfiguration: ImageProcessingConfiguration;
  42505. /**
  42506. * Keep track of the image processing observer to allow dispose and replace.
  42507. */
  42508. private _imageProcessingObserver;
  42509. /**
  42510. * Attaches a new image processing configuration to the PBR Material.
  42511. * @param configuration
  42512. */
  42513. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  42514. /**
  42515. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  42516. */
  42517. /**
  42518. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  42519. */
  42520. colorCurves: Nullable<ColorCurves>;
  42521. /**
  42522. * Gets wether the color curves effect is enabled.
  42523. */
  42524. /**
  42525. * Sets wether the color curves effect is enabled.
  42526. */
  42527. colorCurvesEnabled: boolean;
  42528. /**
  42529. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  42530. */
  42531. /**
  42532. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  42533. */
  42534. colorGradingTexture: Nullable<BaseTexture>;
  42535. /**
  42536. * Gets wether the color grading effect is enabled.
  42537. */
  42538. /**
  42539. * Gets wether the color grading effect is enabled.
  42540. */
  42541. colorGradingEnabled: boolean;
  42542. /**
  42543. * Gets exposure used in the effect.
  42544. */
  42545. /**
  42546. * Sets exposure used in the effect.
  42547. */
  42548. exposure: number;
  42549. /**
  42550. * Gets wether tonemapping is enabled or not.
  42551. */
  42552. /**
  42553. * Sets wether tonemapping is enabled or not
  42554. */
  42555. toneMappingEnabled: boolean;
  42556. /**
  42557. * Gets the type of tone mapping effect.
  42558. */
  42559. /**
  42560. * Sets the type of tone mapping effect.
  42561. */
  42562. toneMappingType: number;
  42563. /**
  42564. * Gets contrast used in the effect.
  42565. */
  42566. /**
  42567. * Sets contrast used in the effect.
  42568. */
  42569. contrast: number;
  42570. /**
  42571. * Gets Vignette stretch size.
  42572. */
  42573. /**
  42574. * Sets Vignette stretch size.
  42575. */
  42576. vignetteStretch: number;
  42577. /**
  42578. * Gets Vignette centre X Offset.
  42579. */
  42580. /**
  42581. * Sets Vignette centre X Offset.
  42582. */
  42583. vignetteCentreX: number;
  42584. /**
  42585. * Gets Vignette centre Y Offset.
  42586. */
  42587. /**
  42588. * Sets Vignette centre Y Offset.
  42589. */
  42590. vignetteCentreY: number;
  42591. /**
  42592. * Gets Vignette weight or intensity of the vignette effect.
  42593. */
  42594. /**
  42595. * Sets Vignette weight or intensity of the vignette effect.
  42596. */
  42597. vignetteWeight: number;
  42598. /**
  42599. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42600. * if vignetteEnabled is set to true.
  42601. */
  42602. /**
  42603. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42604. * if vignetteEnabled is set to true.
  42605. */
  42606. vignetteColor: Color4;
  42607. /**
  42608. * Gets Camera field of view used by the Vignette effect.
  42609. */
  42610. /**
  42611. * Sets Camera field of view used by the Vignette effect.
  42612. */
  42613. vignetteCameraFov: number;
  42614. /**
  42615. * Gets the vignette blend mode allowing different kind of effect.
  42616. */
  42617. /**
  42618. * Sets the vignette blend mode allowing different kind of effect.
  42619. */
  42620. vignetteBlendMode: number;
  42621. /**
  42622. * Gets wether the vignette effect is enabled.
  42623. */
  42624. /**
  42625. * Sets wether the vignette effect is enabled.
  42626. */
  42627. vignetteEnabled: boolean;
  42628. private _fromLinearSpace;
  42629. /**
  42630. * Gets wether the input of the processing is in Gamma or Linear Space.
  42631. */
  42632. /**
  42633. * Sets wether the input of the processing is in Gamma or Linear Space.
  42634. */
  42635. fromLinearSpace: boolean;
  42636. /**
  42637. * Defines cache preventing GC.
  42638. */
  42639. private _defines;
  42640. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  42641. /**
  42642. * "ImageProcessingPostProcess"
  42643. * @returns "ImageProcessingPostProcess"
  42644. */
  42645. getClassName(): string;
  42646. protected _updateParameters(): void;
  42647. dispose(camera?: Camera): void;
  42648. }
  42649. }
  42650. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  42651. import { Scene } from "babylonjs/scene";
  42652. import { Color3 } from "babylonjs/Maths/math.color";
  42653. import { Mesh } from "babylonjs/Meshes/mesh";
  42654. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  42655. import { Nullable } from "babylonjs/types";
  42656. /**
  42657. * Class containing static functions to help procedurally build meshes
  42658. */
  42659. export class GroundBuilder {
  42660. /**
  42661. * Creates a ground mesh
  42662. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  42663. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  42664. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  42665. * @param name defines the name of the mesh
  42666. * @param options defines the options used to create the mesh
  42667. * @param scene defines the hosting scene
  42668. * @returns the ground mesh
  42669. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  42670. */
  42671. static CreateGround(name: string, options: {
  42672. width?: number;
  42673. height?: number;
  42674. subdivisions?: number;
  42675. subdivisionsX?: number;
  42676. subdivisionsY?: number;
  42677. updatable?: boolean;
  42678. }, scene: any): Mesh;
  42679. /**
  42680. * Creates a tiled ground mesh
  42681. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  42682. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  42683. * * The parameter `subdivisions` is a javascript object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  42684. * * The parameter `precision` is a javascript object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  42685. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42686. * @param name defines the name of the mesh
  42687. * @param options defines the options used to create the mesh
  42688. * @param scene defines the hosting scene
  42689. * @returns the tiled ground mesh
  42690. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  42691. */
  42692. static CreateTiledGround(name: string, options: {
  42693. xmin: number;
  42694. zmin: number;
  42695. xmax: number;
  42696. zmax: number;
  42697. subdivisions?: {
  42698. w: number;
  42699. h: number;
  42700. };
  42701. precision?: {
  42702. w: number;
  42703. h: number;
  42704. };
  42705. updatable?: boolean;
  42706. }, scene?: Nullable<Scene>): Mesh;
  42707. /**
  42708. * Creates a ground mesh from a height map
  42709. * * The parameter `url` sets the URL of the height map image resource.
  42710. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  42711. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  42712. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  42713. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  42714. * * The parameter `colorFilter` (optional Color3, default (0.3, 0.59, 0.11) ) is the filter to apply to the image pixel colors to compute the height.
  42715. * * The parameter `onReady` is a javascript callback function that will be called once the mesh is just built (the height map download can last some time).
  42716. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  42717. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42718. * @param name defines the name of the mesh
  42719. * @param url defines the url to the height map
  42720. * @param options defines the options used to create the mesh
  42721. * @param scene defines the hosting scene
  42722. * @returns the ground mesh
  42723. * @see https://doc.babylonjs.com/babylon101/height_map
  42724. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  42725. */
  42726. static CreateGroundFromHeightMap(name: string, url: string, options: {
  42727. width?: number;
  42728. height?: number;
  42729. subdivisions?: number;
  42730. minHeight?: number;
  42731. maxHeight?: number;
  42732. colorFilter?: Color3;
  42733. alphaFilter?: number;
  42734. updatable?: boolean;
  42735. onReady?: (mesh: GroundMesh) => void;
  42736. }, scene?: Nullable<Scene>): GroundMesh;
  42737. }
  42738. }
  42739. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  42740. import { Vector4 } from "babylonjs/Maths/math.vector";
  42741. import { Mesh } from "babylonjs/Meshes/mesh";
  42742. /**
  42743. * Class containing static functions to help procedurally build meshes
  42744. */
  42745. export class TorusBuilder {
  42746. /**
  42747. * Creates a torus mesh
  42748. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  42749. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  42750. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  42751. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42752. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42753. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42754. * @param name defines the name of the mesh
  42755. * @param options defines the options used to create the mesh
  42756. * @param scene defines the hosting scene
  42757. * @returns the torus mesh
  42758. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  42759. */
  42760. static CreateTorus(name: string, options: {
  42761. diameter?: number;
  42762. thickness?: number;
  42763. tessellation?: number;
  42764. updatable?: boolean;
  42765. sideOrientation?: number;
  42766. frontUVs?: Vector4;
  42767. backUVs?: Vector4;
  42768. }, scene: any): Mesh;
  42769. }
  42770. }
  42771. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  42772. import { Vector4 } from "babylonjs/Maths/math.vector";
  42773. import { Color4 } from "babylonjs/Maths/math.color";
  42774. import { Mesh } from "babylonjs/Meshes/mesh";
  42775. /**
  42776. * Class containing static functions to help procedurally build meshes
  42777. */
  42778. export class CylinderBuilder {
  42779. /**
  42780. * Creates a cylinder or a cone mesh
  42781. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  42782. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  42783. * * The parameters `diameterTop` and `diameterBottom` overwrite the parameter `diameter` and set respectively the top cap and bottom cap diameter (floats, default 1). The parameter "diameterBottom" can't be zero.
  42784. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  42785. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  42786. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  42787. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  42788. * * The parameter `cap` sets the way the cylinder is capped. Possible values : BABYLON.Mesh.NO_CAP, BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL (default).
  42789. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  42790. * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of n Color3 elements) and `faceUV` (an array of n Vector4 elements).
  42791. * * The value of n is the number of cylinder faces. If the cylinder has only 1 subdivisions, n equals : top face + cylinder surface + bottom face = 3
  42792. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  42793. * * Finally, if the cylinder has 5 independent subdivisions and is enclose, n equals : top face + 5 x (stripe surface + 2 closing faces) + bottom face = 2 + 5 * 3 = 17
  42794. * * Each array (color or UVs) is always ordered the same way : the first element is the bottom cap, the last element is the top cap. The other elements are each a ring surface.
  42795. * * If `enclose` is false, a ring surface is one element.
  42796. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  42797. * * Example how to set colors and textures on a sliced cylinder : https://www.html5gamedevs.com/topic/17945-creating-a-closed-slice-of-a-cylinder/#comment-106379
  42798. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42799. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42800. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42801. * @param name defines the name of the mesh
  42802. * @param options defines the options used to create the mesh
  42803. * @param scene defines the hosting scene
  42804. * @returns the cylinder mesh
  42805. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  42806. */
  42807. static CreateCylinder(name: string, options: {
  42808. height?: number;
  42809. diameterTop?: number;
  42810. diameterBottom?: number;
  42811. diameter?: number;
  42812. tessellation?: number;
  42813. subdivisions?: number;
  42814. arc?: number;
  42815. faceColors?: Color4[];
  42816. faceUV?: Vector4[];
  42817. updatable?: boolean;
  42818. hasRings?: boolean;
  42819. enclose?: boolean;
  42820. cap?: number;
  42821. sideOrientation?: number;
  42822. frontUVs?: Vector4;
  42823. backUVs?: Vector4;
  42824. }, scene: any): Mesh;
  42825. }
  42826. }
  42827. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  42828. import { Observable } from "babylonjs/Misc/observable";
  42829. import { Nullable } from "babylonjs/types";
  42830. import { Camera } from "babylonjs/Cameras/camera";
  42831. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  42832. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42833. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  42834. import { Scene } from "babylonjs/scene";
  42835. import { Vector3 } from "babylonjs/Maths/math.vector";
  42836. import { Color3 } from "babylonjs/Maths/math.color";
  42837. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  42838. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42839. import { Mesh } from "babylonjs/Meshes/mesh";
  42840. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  42841. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  42842. import "babylonjs/Meshes/Builders/groundBuilder";
  42843. import "babylonjs/Meshes/Builders/torusBuilder";
  42844. import "babylonjs/Meshes/Builders/cylinderBuilder";
  42845. import "babylonjs/Gamepads/gamepadSceneComponent";
  42846. import "babylonjs/Animations/animatable";
  42847. /**
  42848. * Options to modify the vr teleportation behavior.
  42849. */
  42850. export interface VRTeleportationOptions {
  42851. /**
  42852. * The name of the mesh which should be used as the teleportation floor. (default: null)
  42853. */
  42854. floorMeshName?: string;
  42855. /**
  42856. * A list of meshes to be used as the teleportation floor. (default: empty)
  42857. */
  42858. floorMeshes?: Mesh[];
  42859. }
  42860. /**
  42861. * Options to modify the vr experience helper's behavior.
  42862. */
  42863. export interface VRExperienceHelperOptions extends WebVROptions {
  42864. /**
  42865. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  42866. */
  42867. createDeviceOrientationCamera?: boolean;
  42868. /**
  42869. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  42870. */
  42871. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  42872. /**
  42873. * Uses the main button on the controller to toggle the laser casted. (default: true)
  42874. */
  42875. laserToggle?: boolean;
  42876. /**
  42877. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  42878. */
  42879. floorMeshes?: Mesh[];
  42880. /**
  42881. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  42882. */
  42883. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  42884. }
  42885. /**
  42886. * Event containing information after VR has been entered
  42887. */
  42888. export class OnAfterEnteringVRObservableEvent {
  42889. /**
  42890. * If entering vr was successful
  42891. */
  42892. success: boolean;
  42893. }
  42894. /**
  42895. * Helps to quickly add VR support to an existing scene.
  42896. * See http://doc.babylonjs.com/how_to/webvr_helper
  42897. */
  42898. export class VRExperienceHelper {
  42899. /** Options to modify the vr experience helper's behavior. */
  42900. webVROptions: VRExperienceHelperOptions;
  42901. private _scene;
  42902. private _position;
  42903. private _btnVR;
  42904. private _btnVRDisplayed;
  42905. private _webVRsupported;
  42906. private _webVRready;
  42907. private _webVRrequesting;
  42908. private _webVRpresenting;
  42909. private _hasEnteredVR;
  42910. private _fullscreenVRpresenting;
  42911. private _inputElement;
  42912. private _webVRCamera;
  42913. private _vrDeviceOrientationCamera;
  42914. private _deviceOrientationCamera;
  42915. private _existingCamera;
  42916. private _onKeyDown;
  42917. private _onVrDisplayPresentChange;
  42918. private _onVRDisplayChanged;
  42919. private _onVRRequestPresentStart;
  42920. private _onVRRequestPresentComplete;
  42921. /**
  42922. * Gets or sets a boolean indicating that gaze can be enabled even if pointer lock is not engage (useful on iOS where fullscreen mode and pointer lock are not supported)
  42923. */
  42924. enableGazeEvenWhenNoPointerLock: boolean;
  42925. /**
  42926. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  42927. */
  42928. exitVROnDoubleTap: boolean;
  42929. /**
  42930. * Observable raised right before entering VR.
  42931. */
  42932. onEnteringVRObservable: Observable<VRExperienceHelper>;
  42933. /**
  42934. * Observable raised when entering VR has completed.
  42935. */
  42936. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  42937. /**
  42938. * Observable raised when exiting VR.
  42939. */
  42940. onExitingVRObservable: Observable<VRExperienceHelper>;
  42941. /**
  42942. * Observable raised when controller mesh is loaded.
  42943. */
  42944. onControllerMeshLoadedObservable: Observable<WebVRController>;
  42945. /** Return this.onEnteringVRObservable
  42946. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  42947. */
  42948. readonly onEnteringVR: Observable<VRExperienceHelper>;
  42949. /** Return this.onExitingVRObservable
  42950. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  42951. */
  42952. readonly onExitingVR: Observable<VRExperienceHelper>;
  42953. /** Return this.onControllerMeshLoadedObservable
  42954. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  42955. */
  42956. readonly onControllerMeshLoaded: Observable<WebVRController>;
  42957. private _rayLength;
  42958. private _useCustomVRButton;
  42959. private _teleportationRequested;
  42960. private _teleportActive;
  42961. private _floorMeshName;
  42962. private _floorMeshesCollection;
  42963. private _rotationAllowed;
  42964. private _teleportBackwardsVector;
  42965. private _teleportationTarget;
  42966. private _isDefaultTeleportationTarget;
  42967. private _postProcessMove;
  42968. private _teleportationFillColor;
  42969. private _teleportationBorderColor;
  42970. private _rotationAngle;
  42971. private _haloCenter;
  42972. private _cameraGazer;
  42973. private _padSensibilityUp;
  42974. private _padSensibilityDown;
  42975. private _leftController;
  42976. private _rightController;
  42977. /**
  42978. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  42979. */
  42980. onNewMeshSelected: Observable<AbstractMesh>;
  42981. /**
  42982. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  42983. * This observable will provide the mesh and the controller used to select the mesh
  42984. */
  42985. onMeshSelectedWithController: Observable<{
  42986. mesh: AbstractMesh;
  42987. controller: WebVRController;
  42988. }>;
  42989. /**
  42990. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  42991. */
  42992. onNewMeshPicked: Observable<PickingInfo>;
  42993. private _circleEase;
  42994. /**
  42995. * Observable raised before camera teleportation
  42996. */
  42997. onBeforeCameraTeleport: Observable<Vector3>;
  42998. /**
  42999. * Observable raised after camera teleportation
  43000. */
  43001. onAfterCameraTeleport: Observable<Vector3>;
  43002. /**
  43003. * Observable raised when current selected mesh gets unselected
  43004. */
  43005. onSelectedMeshUnselected: Observable<AbstractMesh>;
  43006. private _raySelectionPredicate;
  43007. /**
  43008. * To be optionaly changed by user to define custom ray selection
  43009. */
  43010. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  43011. /**
  43012. * To be optionaly changed by user to define custom selection logic (after ray selection)
  43013. */
  43014. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  43015. /**
  43016. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  43017. */
  43018. teleportationEnabled: boolean;
  43019. private _defaultHeight;
  43020. private _teleportationInitialized;
  43021. private _interactionsEnabled;
  43022. private _interactionsRequested;
  43023. private _displayGaze;
  43024. private _displayLaserPointer;
  43025. /**
  43026. * The mesh used to display where the user is going to teleport.
  43027. */
  43028. /**
  43029. * Sets the mesh to be used to display where the user is going to teleport.
  43030. */
  43031. teleportationTarget: Mesh;
  43032. /**
  43033. * The mesh used to display where the user is selecting, this mesh will be cloned and set as the gazeTracker for the left and right controller
  43034. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  43035. * See http://doc.babylonjs.com/resources/baking_transformations
  43036. */
  43037. gazeTrackerMesh: Mesh;
  43038. /**
  43039. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  43040. */
  43041. updateGazeTrackerScale: boolean;
  43042. /**
  43043. * If the gaze trackers color should be updated when selecting meshes
  43044. */
  43045. updateGazeTrackerColor: boolean;
  43046. /**
  43047. * If the controller laser color should be updated when selecting meshes
  43048. */
  43049. updateControllerLaserColor: boolean;
  43050. /**
  43051. * The gaze tracking mesh corresponding to the left controller
  43052. */
  43053. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  43054. /**
  43055. * The gaze tracking mesh corresponding to the right controller
  43056. */
  43057. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  43058. /**
  43059. * If the ray of the gaze should be displayed.
  43060. */
  43061. /**
  43062. * Sets if the ray of the gaze should be displayed.
  43063. */
  43064. displayGaze: boolean;
  43065. /**
  43066. * If the ray of the LaserPointer should be displayed.
  43067. */
  43068. /**
  43069. * Sets if the ray of the LaserPointer should be displayed.
  43070. */
  43071. displayLaserPointer: boolean;
  43072. /**
  43073. * The deviceOrientationCamera used as the camera when not in VR.
  43074. */
  43075. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  43076. /**
  43077. * Based on the current WebVR support, returns the current VR camera used.
  43078. */
  43079. readonly currentVRCamera: Nullable<Camera>;
  43080. /**
  43081. * The webVRCamera which is used when in VR.
  43082. */
  43083. readonly webVRCamera: WebVRFreeCamera;
  43084. /**
  43085. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  43086. */
  43087. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  43088. /**
  43089. * The html button that is used to trigger entering into VR.
  43090. */
  43091. readonly vrButton: Nullable<HTMLButtonElement>;
  43092. private readonly _teleportationRequestInitiated;
  43093. /**
  43094. * Defines wether or not Pointer lock should be requested when switching to
  43095. * full screen.
  43096. */
  43097. requestPointerLockOnFullScreen: boolean;
  43098. /**
  43099. * Instantiates a VRExperienceHelper.
  43100. * Helps to quickly add VR support to an existing scene.
  43101. * @param scene The scene the VRExperienceHelper belongs to.
  43102. * @param webVROptions Options to modify the vr experience helper's behavior.
  43103. */
  43104. constructor(scene: Scene,
  43105. /** Options to modify the vr experience helper's behavior. */
  43106. webVROptions?: VRExperienceHelperOptions);
  43107. private _onDefaultMeshLoaded;
  43108. private _onResize;
  43109. private _onFullscreenChange;
  43110. /**
  43111. * Gets a value indicating if we are currently in VR mode.
  43112. */
  43113. readonly isInVRMode: boolean;
  43114. private onVrDisplayPresentChange;
  43115. private onVRDisplayChanged;
  43116. private moveButtonToBottomRight;
  43117. private displayVRButton;
  43118. private updateButtonVisibility;
  43119. private _cachedAngularSensibility;
  43120. /**
  43121. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  43122. * Otherwise, will use the fullscreen API.
  43123. */
  43124. enterVR(): void;
  43125. /**
  43126. * Attempt to exit VR, or fullscreen.
  43127. */
  43128. exitVR(): void;
  43129. /**
  43130. * The position of the vr experience helper.
  43131. */
  43132. /**
  43133. * Sets the position of the vr experience helper.
  43134. */
  43135. position: Vector3;
  43136. /**
  43137. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  43138. */
  43139. enableInteractions(): void;
  43140. private readonly _noControllerIsActive;
  43141. private beforeRender;
  43142. private _isTeleportationFloor;
  43143. /**
  43144. * Adds a floor mesh to be used for teleportation.
  43145. * @param floorMesh the mesh to be used for teleportation.
  43146. */
  43147. addFloorMesh(floorMesh: Mesh): void;
  43148. /**
  43149. * Removes a floor mesh from being used for teleportation.
  43150. * @param floorMesh the mesh to be removed.
  43151. */
  43152. removeFloorMesh(floorMesh: Mesh): void;
  43153. /**
  43154. * Enables interactions and teleportation using the VR controllers and gaze.
  43155. * @param vrTeleportationOptions options to modify teleportation behavior.
  43156. */
  43157. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  43158. private _onNewGamepadConnected;
  43159. private _tryEnableInteractionOnController;
  43160. private _onNewGamepadDisconnected;
  43161. private _enableInteractionOnController;
  43162. private _checkTeleportWithRay;
  43163. private _checkRotate;
  43164. private _checkTeleportBackwards;
  43165. private _enableTeleportationOnController;
  43166. private _createTeleportationCircles;
  43167. private _displayTeleportationTarget;
  43168. private _hideTeleportationTarget;
  43169. private _rotateCamera;
  43170. private _moveTeleportationSelectorTo;
  43171. private _workingVector;
  43172. private _workingQuaternion;
  43173. private _workingMatrix;
  43174. /**
  43175. * Teleports the users feet to the desired location
  43176. * @param location The location where the user's feet should be placed
  43177. */
  43178. teleportCamera(location: Vector3): void;
  43179. private _convertNormalToDirectionOfRay;
  43180. private _castRayAndSelectObject;
  43181. private _notifySelectedMeshUnselected;
  43182. /**
  43183. * Sets the color of the laser ray from the vr controllers.
  43184. * @param color new color for the ray.
  43185. */
  43186. changeLaserColor(color: Color3): void;
  43187. /**
  43188. * Sets the color of the ray from the vr headsets gaze.
  43189. * @param color new color for the ray.
  43190. */
  43191. changeGazeColor(color: Color3): void;
  43192. /**
  43193. * Exits VR and disposes of the vr experience helper
  43194. */
  43195. dispose(): void;
  43196. /**
  43197. * Gets the name of the VRExperienceHelper class
  43198. * @returns "VRExperienceHelper"
  43199. */
  43200. getClassName(): string;
  43201. }
  43202. }
  43203. declare module "babylonjs/Cameras/VR/index" {
  43204. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  43205. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  43206. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  43207. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  43208. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  43209. export * from "babylonjs/Cameras/VR/webVRCamera";
  43210. }
  43211. declare module "babylonjs/Cameras/XR/webXRTypes" {
  43212. import { Nullable } from "babylonjs/types";
  43213. import { IDisposable } from "babylonjs/scene";
  43214. /**
  43215. * States of the webXR experience
  43216. */
  43217. export enum WebXRState {
  43218. /**
  43219. * Transitioning to being in XR mode
  43220. */
  43221. ENTERING_XR = 0,
  43222. /**
  43223. * Transitioning to non XR mode
  43224. */
  43225. EXITING_XR = 1,
  43226. /**
  43227. * In XR mode and presenting
  43228. */
  43229. IN_XR = 2,
  43230. /**
  43231. * Not entered XR mode
  43232. */
  43233. NOT_IN_XR = 3
  43234. }
  43235. /**
  43236. * Abstraction of the XR render target
  43237. */
  43238. export interface WebXRRenderTarget extends IDisposable {
  43239. /**
  43240. * xrpresent context of the canvas which can be used to display/mirror xr content
  43241. */
  43242. canvasContext: WebGLRenderingContext;
  43243. /**
  43244. * xr layer for the canvas
  43245. */
  43246. xrLayer: Nullable<XRWebGLLayer>;
  43247. /**
  43248. * Initializes the xr layer for the session
  43249. * @param xrSession xr session
  43250. * @returns a promise that will resolve once the XR Layer has been created
  43251. */
  43252. initializeXRLayerAsync(xrSession: XRSession): Promise<void>;
  43253. }
  43254. }
  43255. declare module "babylonjs/Cameras/XR/webXRManagedOutputCanvas" {
  43256. import { Nullable } from "babylonjs/types";
  43257. import { Observable } from "babylonjs/Misc/observable";
  43258. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  43259. import { WebXRState, WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43260. /**
  43261. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  43262. */
  43263. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  43264. private _engine;
  43265. private _canvas;
  43266. /**
  43267. * xrpresent context of the canvas which can be used to display/mirror xr content
  43268. */
  43269. canvasContext: WebGLRenderingContext;
  43270. /**
  43271. * xr layer for the canvas
  43272. */
  43273. xrLayer: Nullable<XRWebGLLayer>;
  43274. /**
  43275. * Initializes the xr layer for the session
  43276. * @param xrSession xr session
  43277. * @returns a promise that will resolve once the XR Layer has been created
  43278. */
  43279. initializeXRLayerAsync(xrSession: any): any;
  43280. /**
  43281. * Initializes the canvas to be added/removed upon entering/exiting xr
  43282. * @param engine the Babylon engine
  43283. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  43284. * @param onStateChangedObservable the mechanism by which the canvas will be added/removed based on XR state
  43285. */
  43286. constructor(engine: ThinEngine, canvas?: HTMLCanvasElement, onStateChangedObservable?: Observable<WebXRState>);
  43287. /**
  43288. * Disposes of the object
  43289. */
  43290. dispose(): void;
  43291. private _setManagedOutputCanvas;
  43292. private _addCanvas;
  43293. private _removeCanvas;
  43294. }
  43295. }
  43296. declare module "babylonjs/Cameras/XR/webXRSessionManager" {
  43297. import { Observable } from "babylonjs/Misc/observable";
  43298. import { Nullable } from "babylonjs/types";
  43299. import { IDisposable, Scene } from "babylonjs/scene";
  43300. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  43301. import { WebXRRenderTarget, WebXRState } from "babylonjs/Cameras/XR/webXRTypes";
  43302. /**
  43303. * Manages an XRSession to work with Babylon's engine
  43304. * @see https://doc.babylonjs.com/how_to/webxr
  43305. */
  43306. export class WebXRSessionManager implements IDisposable {
  43307. private scene;
  43308. /**
  43309. * Fires every time a new xrFrame arrives which can be used to update the camera
  43310. */
  43311. onXRFrameObservable: Observable<any>;
  43312. /**
  43313. * Fires when the xr session is ended either by the device or manually done
  43314. */
  43315. onXRSessionEnded: Observable<any>;
  43316. /**
  43317. * Underlying xr session
  43318. */
  43319. session: XRSession;
  43320. /**
  43321. * Type of reference space used when creating the session
  43322. */
  43323. referenceSpace: XRReferenceSpace;
  43324. /**
  43325. * Current XR frame
  43326. */
  43327. currentFrame: Nullable<XRFrame>;
  43328. private _xrNavigator;
  43329. private baseLayer;
  43330. private _rttProvider;
  43331. private _sessionEnded;
  43332. /**
  43333. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  43334. * @param scene The scene which the session should be created for
  43335. */
  43336. constructor(scene: Scene);
  43337. /**
  43338. * Initializes the manager
  43339. * After initialization enterXR can be called to start an XR session
  43340. * @returns Promise which resolves after it is initialized
  43341. */
  43342. initializeAsync(): Promise<void>;
  43343. /**
  43344. * Initializes an xr session
  43345. * @param xrSessionMode mode to initialize
  43346. * @param optionalFeatures defines optional values to pass to the session builder
  43347. * @returns a promise which will resolve once the session has been initialized
  43348. */
  43349. initializeSessionAsync(xrSessionMode: XRSessionMode, optionalFeatures?: any): any;
  43350. /**
  43351. * Sets the reference space on the xr session
  43352. * @param referenceSpace space to set
  43353. * @returns a promise that will resolve once the reference space has been set
  43354. */
  43355. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  43356. /**
  43357. * Updates the render state of the session
  43358. * @param state state to set
  43359. * @returns a promise that resolves once the render state has been updated
  43360. */
  43361. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  43362. /**
  43363. * Starts rendering to the xr layer
  43364. * @returns a promise that will resolve once rendering has started
  43365. */
  43366. startRenderingToXRAsync(): Promise<void>;
  43367. /**
  43368. * Gets the correct render target texture to be rendered this frame for this eye
  43369. * @param eye the eye for which to get the render target
  43370. * @returns the render target for the specified eye
  43371. */
  43372. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  43373. /**
  43374. * Stops the xrSession and restores the renderloop
  43375. * @returns Promise which resolves after it exits XR
  43376. */
  43377. exitXRAsync(): Promise<void>;
  43378. /**
  43379. * Checks if a session would be supported for the creation options specified
  43380. * @param sessionMode session mode to check if supported eg. immersive-vr
  43381. * @returns true if supported
  43382. */
  43383. supportsSessionAsync(sessionMode: XRSessionMode): any;
  43384. /**
  43385. * Creates a WebXRRenderTarget object for the XR session
  43386. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  43387. * @returns a WebXR render target to which the session can render
  43388. */
  43389. getWebXRRenderTarget(onStateChangedObservable?: Observable<WebXRState>): WebXRRenderTarget;
  43390. /**
  43391. * @hidden
  43392. * Converts the render layer of xrSession to a render target
  43393. * @param session session to create render target for
  43394. * @param scene scene the new render target should be created for
  43395. */
  43396. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  43397. /**
  43398. * Disposes of the session manager
  43399. */
  43400. dispose(): void;
  43401. }
  43402. }
  43403. declare module "babylonjs/Cameras/XR/webXRCamera" {
  43404. import { Scene } from "babylonjs/scene";
  43405. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  43406. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  43407. /**
  43408. * WebXR Camera which holds the views for the xrSession
  43409. * @see https://doc.babylonjs.com/how_to/webxr
  43410. */
  43411. export class WebXRCamera extends FreeCamera {
  43412. private static _TmpMatrix;
  43413. /**
  43414. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  43415. * @param name the name of the camera
  43416. * @param scene the scene to add the camera to
  43417. */
  43418. constructor(name: string, scene: Scene);
  43419. private _updateNumberOfRigCameras;
  43420. /** @hidden */
  43421. _updateForDualEyeDebugging(): void;
  43422. /**
  43423. * Updates the cameras position from the current pose information of the XR session
  43424. * @param xrSessionManager the session containing pose information
  43425. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  43426. */
  43427. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  43428. }
  43429. }
  43430. declare module "babylonjs/Cameras/XR/webXRExperienceHelper" {
  43431. import { Observable } from "babylonjs/Misc/observable";
  43432. import { IDisposable, Scene } from "babylonjs/scene";
  43433. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  43434. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43435. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  43436. import { WebXRCamera } from "babylonjs/Cameras/XR/webXRCamera";
  43437. import { WebXRState, WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43438. /**
  43439. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  43440. * @see https://doc.babylonjs.com/how_to/webxr
  43441. */
  43442. export class WebXRExperienceHelper implements IDisposable {
  43443. private scene;
  43444. /**
  43445. * Container which stores the xr camera and controllers as children. This can be used to move the camera/user as the camera's position is updated by the xr device
  43446. */
  43447. container: AbstractMesh;
  43448. /**
  43449. * Camera used to render xr content
  43450. */
  43451. camera: WebXRCamera;
  43452. /**
  43453. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  43454. */
  43455. state: WebXRState;
  43456. private _setState;
  43457. private static _TmpVector;
  43458. /**
  43459. * Fires when the state of the experience helper has changed
  43460. */
  43461. onStateChangedObservable: Observable<WebXRState>;
  43462. /** Session manager used to keep track of xr session */
  43463. sessionManager: WebXRSessionManager;
  43464. private _nonVRCamera;
  43465. private _originalSceneAutoClear;
  43466. private _supported;
  43467. /**
  43468. * Creates the experience helper
  43469. * @param scene the scene to attach the experience helper to
  43470. * @returns a promise for the experience helper
  43471. */
  43472. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  43473. /**
  43474. * Creates a WebXRExperienceHelper
  43475. * @param scene The scene the helper should be created in
  43476. */
  43477. private constructor();
  43478. /**
  43479. * Exits XR mode and returns the scene to its original state
  43480. * @returns promise that resolves after xr mode has exited
  43481. */
  43482. exitXRAsync(): Promise<void>;
  43483. /**
  43484. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  43485. * @param sessionMode options for the XR session
  43486. * @param referenceSpaceType frame of reference of the XR session
  43487. * @param renderTarget the output canvas that will be used to enter XR mode
  43488. * @returns promise that resolves after xr mode has entered
  43489. */
  43490. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget: WebXRRenderTarget): any;
  43491. /**
  43492. * Updates the global position of the camera by moving the camera's container
  43493. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  43494. * @param position The desired global position of the camera
  43495. */
  43496. setPositionOfCameraUsingContainer(position: Vector3): void;
  43497. /**
  43498. * Rotates the xr camera by rotating the camera's container around the camera's position
  43499. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  43500. * @param rotation the desired quaternion rotation to apply to the camera
  43501. */
  43502. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  43503. /**
  43504. * Disposes of the experience helper
  43505. */
  43506. dispose(): void;
  43507. }
  43508. }
  43509. declare module "babylonjs/Cameras/XR/webXREnterExitUI" {
  43510. import { Nullable } from "babylonjs/types";
  43511. import { Observable } from "babylonjs/Misc/observable";
  43512. import { IDisposable, Scene } from "babylonjs/scene";
  43513. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43514. import { WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43515. /**
  43516. * Button which can be used to enter a different mode of XR
  43517. */
  43518. export class WebXREnterExitUIButton {
  43519. /** button element */
  43520. element: HTMLElement;
  43521. /** XR initialization options for the button */
  43522. sessionMode: XRSessionMode;
  43523. /** Reference space type */
  43524. referenceSpaceType: XRReferenceSpaceType;
  43525. /**
  43526. * Creates a WebXREnterExitUIButton
  43527. * @param element button element
  43528. * @param sessionMode XR initialization session mode
  43529. * @param referenceSpaceType the type of reference space to be used
  43530. */
  43531. constructor(
  43532. /** button element */
  43533. element: HTMLElement,
  43534. /** XR initialization options for the button */
  43535. sessionMode: XRSessionMode,
  43536. /** Reference space type */
  43537. referenceSpaceType: XRReferenceSpaceType);
  43538. /**
  43539. * Overwritable function which can be used to update the button's visuals when the state changes
  43540. * @param activeButton the current active button in the UI
  43541. */
  43542. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  43543. }
  43544. /**
  43545. * Options to create the webXR UI
  43546. */
  43547. export class WebXREnterExitUIOptions {
  43548. /**
  43549. * Context to enter xr with
  43550. */
  43551. renderTarget?: Nullable<WebXRRenderTarget>;
  43552. /**
  43553. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  43554. */
  43555. customButtons?: Array<WebXREnterExitUIButton>;
  43556. }
  43557. /**
  43558. * UI to allow the user to enter/exit XR mode
  43559. */
  43560. export class WebXREnterExitUI implements IDisposable {
  43561. private scene;
  43562. private _overlay;
  43563. private _buttons;
  43564. private _activeButton;
  43565. /**
  43566. * Fired every time the active button is changed.
  43567. *
  43568. * When xr is entered via a button that launches xr that button will be the callback parameter
  43569. *
  43570. * When exiting xr the callback parameter will be null)
  43571. */
  43572. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  43573. /**
  43574. * Creates UI to allow the user to enter/exit XR mode
  43575. * @param scene the scene to add the ui to
  43576. * @param helper the xr experience helper to enter/exit xr with
  43577. * @param options options to configure the UI
  43578. * @returns the created ui
  43579. */
  43580. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  43581. private constructor();
  43582. private _updateButtons;
  43583. /**
  43584. * Disposes of the object
  43585. */
  43586. dispose(): void;
  43587. }
  43588. }
  43589. declare module "babylonjs/Cameras/XR/webXRController" {
  43590. import { Nullable } from "babylonjs/types";
  43591. import { Observable } from "babylonjs/Misc/observable";
  43592. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43593. import { Ray } from "babylonjs/Culling/ray";
  43594. import { Scene } from "babylonjs/scene";
  43595. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43596. /**
  43597. * Represents an XR input
  43598. */
  43599. export class WebXRController {
  43600. private scene;
  43601. /** The underlying input source for the controller */
  43602. inputSource: XRInputSource;
  43603. private parentContainer;
  43604. /**
  43605. * Represents the part of the controller that is held. This may not exist if the controller is the head mounted display itself, if thats the case only the pointer from the head will be availible
  43606. */
  43607. grip?: AbstractMesh;
  43608. /**
  43609. * Pointer which can be used to select objects or attach a visible laser to
  43610. */
  43611. pointer: AbstractMesh;
  43612. private _gamepadMode;
  43613. /**
  43614. * If available, this is the gamepad object related to this controller.
  43615. * Using this object it is possible to get click events and trackpad changes of the
  43616. * webxr controller that is currently being used.
  43617. */
  43618. gamepadController?: WebVRController;
  43619. /**
  43620. * Event that fires when the controller is removed/disposed
  43621. */
  43622. onDisposeObservable: Observable<{}>;
  43623. private _tmpMatrix;
  43624. private _tmpQuaternion;
  43625. private _tmpVector;
  43626. /**
  43627. * Creates the controller
  43628. * @see https://doc.babylonjs.com/how_to/webxr
  43629. * @param scene the scene which the controller should be associated to
  43630. * @param inputSource the underlying input source for the controller
  43631. * @param parentContainer parent that the controller meshes should be children of
  43632. */
  43633. constructor(scene: Scene,
  43634. /** The underlying input source for the controller */
  43635. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  43636. /**
  43637. * Updates the controller pose based on the given XRFrame
  43638. * @param xrFrame xr frame to update the pose with
  43639. * @param referenceSpace reference space to use
  43640. */
  43641. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  43642. /**
  43643. * Gets a world space ray coming from the controller
  43644. * @param result the resulting ray
  43645. */
  43646. getWorldPointerRayToRef(result: Ray): void;
  43647. /**
  43648. * Get the scene associated with this controller
  43649. * @returns the scene object
  43650. */
  43651. getScene(): Scene;
  43652. /**
  43653. * Disposes of the object
  43654. */
  43655. dispose(): void;
  43656. }
  43657. }
  43658. declare module "babylonjs/Cameras/XR/webXRInput" {
  43659. import { Observable } from "babylonjs/Misc/observable";
  43660. import { IDisposable } from "babylonjs/scene";
  43661. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43662. import { WebXRController } from "babylonjs/Cameras/XR/webXRController";
  43663. /**
  43664. * XR input used to track XR inputs such as controllers/rays
  43665. */
  43666. export class WebXRInput implements IDisposable {
  43667. /**
  43668. * Base experience the input listens to
  43669. */
  43670. baseExperience: WebXRExperienceHelper;
  43671. /**
  43672. * XR controllers being tracked
  43673. */
  43674. controllers: Array<WebXRController>;
  43675. private _frameObserver;
  43676. private _stateObserver;
  43677. /**
  43678. * Event when a controller has been connected/added
  43679. */
  43680. onControllerAddedObservable: Observable<WebXRController>;
  43681. /**
  43682. * Event when a controller has been removed/disconnected
  43683. */
  43684. onControllerRemovedObservable: Observable<WebXRController>;
  43685. /**
  43686. * Initializes the WebXRInput
  43687. * @param baseExperience experience helper which the input should be created for
  43688. */
  43689. constructor(
  43690. /**
  43691. * Base experience the input listens to
  43692. */
  43693. baseExperience: WebXRExperienceHelper);
  43694. private _onInputSourcesChange;
  43695. private _addAndRemoveControllers;
  43696. /**
  43697. * Disposes of the object
  43698. */
  43699. dispose(): void;
  43700. }
  43701. }
  43702. declare module "babylonjs/Cameras/XR/webXRControllerTeleportation" {
  43703. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43704. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43705. /**
  43706. * Enables teleportation
  43707. */
  43708. export class WebXRControllerTeleportation {
  43709. private _teleportationFillColor;
  43710. private _teleportationBorderColor;
  43711. private _tmpRay;
  43712. private _tmpVector;
  43713. /**
  43714. * Creates a WebXRControllerTeleportation
  43715. * @param input input manager to add teleportation to
  43716. * @param floorMeshes floormeshes which can be teleported to
  43717. */
  43718. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  43719. }
  43720. }
  43721. declare module "babylonjs/Cameras/XR/webXRControllerPointerSelection" {
  43722. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43723. /**
  43724. * Handles pointer input automatically for the pointer of XR controllers
  43725. */
  43726. export class WebXRControllerPointerSelection {
  43727. private static _idCounter;
  43728. private _tmpRay;
  43729. /**
  43730. * Creates a WebXRControllerPointerSelection
  43731. * @param input input manager to setup pointer selection
  43732. */
  43733. constructor(input: WebXRInput);
  43734. private _convertNormalToDirectionOfRay;
  43735. private _updatePointerDistance;
  43736. }
  43737. }
  43738. declare module "babylonjs/Loading/sceneLoader" {
  43739. import { Observable } from "babylonjs/Misc/observable";
  43740. import { Nullable } from "babylonjs/types";
  43741. import { Scene } from "babylonjs/scene";
  43742. import { Engine } from "babylonjs/Engines/engine";
  43743. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43744. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  43745. import { AssetContainer } from "babylonjs/assetContainer";
  43746. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  43747. import { Skeleton } from "babylonjs/Bones/skeleton";
  43748. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  43749. import { WebRequest } from "babylonjs/Misc/webRequest";
  43750. /**
  43751. * Class used to represent data loading progression
  43752. */
  43753. export class SceneLoaderProgressEvent {
  43754. /** defines if data length to load can be evaluated */
  43755. readonly lengthComputable: boolean;
  43756. /** defines the loaded data length */
  43757. readonly loaded: number;
  43758. /** defines the data length to load */
  43759. readonly total: number;
  43760. /**
  43761. * Create a new progress event
  43762. * @param lengthComputable defines if data length to load can be evaluated
  43763. * @param loaded defines the loaded data length
  43764. * @param total defines the data length to load
  43765. */
  43766. constructor(
  43767. /** defines if data length to load can be evaluated */
  43768. lengthComputable: boolean,
  43769. /** defines the loaded data length */
  43770. loaded: number,
  43771. /** defines the data length to load */
  43772. total: number);
  43773. /**
  43774. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  43775. * @param event defines the source event
  43776. * @returns a new SceneLoaderProgressEvent
  43777. */
  43778. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  43779. }
  43780. /**
  43781. * Interface used by SceneLoader plugins to define supported file extensions
  43782. */
  43783. export interface ISceneLoaderPluginExtensions {
  43784. /**
  43785. * Defines the list of supported extensions
  43786. */
  43787. [extension: string]: {
  43788. isBinary: boolean;
  43789. };
  43790. }
  43791. /**
  43792. * Interface used by SceneLoader plugin factory
  43793. */
  43794. export interface ISceneLoaderPluginFactory {
  43795. /**
  43796. * Defines the name of the factory
  43797. */
  43798. name: string;
  43799. /**
  43800. * Function called to create a new plugin
  43801. * @return the new plugin
  43802. */
  43803. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  43804. /**
  43805. * The callback that returns true if the data can be directly loaded.
  43806. * @param data string containing the file data
  43807. * @returns if the data can be loaded directly
  43808. */
  43809. canDirectLoad?(data: string): boolean;
  43810. }
  43811. /**
  43812. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  43813. */
  43814. export interface ISceneLoaderPluginBase {
  43815. /**
  43816. * The friendly name of this plugin.
  43817. */
  43818. name: string;
  43819. /**
  43820. * The file extensions supported by this plugin.
  43821. */
  43822. extensions: string | ISceneLoaderPluginExtensions;
  43823. /**
  43824. * The callback called when loading from a url.
  43825. * @param scene scene loading this url
  43826. * @param url url to load
  43827. * @param onSuccess callback called when the file successfully loads
  43828. * @param onProgress callback called while file is loading (if the server supports this mode)
  43829. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  43830. * @param onError callback called when the file fails to load
  43831. * @returns a file request object
  43832. */
  43833. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  43834. /**
  43835. * The callback called when loading from a file object.
  43836. * @param scene scene loading this file
  43837. * @param file defines the file to load
  43838. * @param onSuccess defines the callback to call when data is loaded
  43839. * @param onProgress defines the callback to call during loading process
  43840. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  43841. * @param onError defines the callback to call when an error occurs
  43842. * @returns a file request object
  43843. */
  43844. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  43845. /**
  43846. * The callback that returns true if the data can be directly loaded.
  43847. * @param data string containing the file data
  43848. * @returns if the data can be loaded directly
  43849. */
  43850. canDirectLoad?(data: string): boolean;
  43851. /**
  43852. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  43853. * @param scene scene loading this data
  43854. * @param data string containing the data
  43855. * @returns data to pass to the plugin
  43856. */
  43857. directLoad?(scene: Scene, data: string): any;
  43858. /**
  43859. * The callback that allows custom handling of the root url based on the response url.
  43860. * @param rootUrl the original root url
  43861. * @param responseURL the response url if available
  43862. * @returns the new root url
  43863. */
  43864. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  43865. }
  43866. /**
  43867. * Interface used to define a SceneLoader plugin
  43868. */
  43869. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  43870. /**
  43871. * Import meshes into a scene.
  43872. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43873. * @param scene The scene to import into
  43874. * @param data The data to import
  43875. * @param rootUrl The root url for scene and resources
  43876. * @param meshes The meshes array to import into
  43877. * @param particleSystems The particle systems array to import into
  43878. * @param skeletons The skeletons array to import into
  43879. * @param onError The callback when import fails
  43880. * @returns True if successful or false otherwise
  43881. */
  43882. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  43883. /**
  43884. * Load into a scene.
  43885. * @param scene The scene to load into
  43886. * @param data The data to import
  43887. * @param rootUrl The root url for scene and resources
  43888. * @param onError The callback when import fails
  43889. * @returns True if successful or false otherwise
  43890. */
  43891. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  43892. /**
  43893. * Load into an asset container.
  43894. * @param scene The scene to load into
  43895. * @param data The data to import
  43896. * @param rootUrl The root url for scene and resources
  43897. * @param onError The callback when import fails
  43898. * @returns The loaded asset container
  43899. */
  43900. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  43901. }
  43902. /**
  43903. * Interface used to define an async SceneLoader plugin
  43904. */
  43905. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  43906. /**
  43907. * Import meshes into a scene.
  43908. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  43909. * @param scene The scene to import into
  43910. * @param data The data to import
  43911. * @param rootUrl The root url for scene and resources
  43912. * @param onProgress The callback when the load progresses
  43913. * @param fileName Defines the name of the file to load
  43914. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  43915. */
  43916. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  43917. meshes: AbstractMesh[];
  43918. particleSystems: IParticleSystem[];
  43919. skeletons: Skeleton[];
  43920. animationGroups: AnimationGroup[];
  43921. }>;
  43922. /**
  43923. * Load into a scene.
  43924. * @param scene The scene to load into
  43925. * @param data The data to import
  43926. * @param rootUrl The root url for scene and resources
  43927. * @param onProgress The callback when the load progresses
  43928. * @param fileName Defines the name of the file to load
  43929. * @returns Nothing
  43930. */
  43931. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  43932. /**
  43933. * Load into an asset container.
  43934. * @param scene The scene to load into
  43935. * @param data The data to import
  43936. * @param rootUrl The root url for scene and resources
  43937. * @param onProgress The callback when the load progresses
  43938. * @param fileName Defines the name of the file to load
  43939. * @returns The loaded asset container
  43940. */
  43941. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  43942. }
  43943. /**
  43944. * Class used to load scene from various file formats using registered plugins
  43945. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  43946. */
  43947. export class SceneLoader {
  43948. /**
  43949. * No logging while loading
  43950. */
  43951. static readonly NO_LOGGING: number;
  43952. /**
  43953. * Minimal logging while loading
  43954. */
  43955. static readonly MINIMAL_LOGGING: number;
  43956. /**
  43957. * Summary logging while loading
  43958. */
  43959. static readonly SUMMARY_LOGGING: number;
  43960. /**
  43961. * Detailled logging while loading
  43962. */
  43963. static readonly DETAILED_LOGGING: number;
  43964. /**
  43965. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  43966. */
  43967. static ForceFullSceneLoadingForIncremental: boolean;
  43968. /**
  43969. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  43970. */
  43971. static ShowLoadingScreen: boolean;
  43972. /**
  43973. * Defines the current logging level (while loading the scene)
  43974. * @ignorenaming
  43975. */
  43976. static loggingLevel: number;
  43977. /**
  43978. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  43979. */
  43980. static CleanBoneMatrixWeights: boolean;
  43981. /**
  43982. * Event raised when a plugin is used to load a scene
  43983. */
  43984. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  43985. private static _registeredPlugins;
  43986. private static _getDefaultPlugin;
  43987. private static _getPluginForExtension;
  43988. private static _getPluginForDirectLoad;
  43989. private static _getPluginForFilename;
  43990. private static _getDirectLoad;
  43991. private static _loadData;
  43992. private static _getFileInfo;
  43993. /**
  43994. * Gets a plugin that can load the given extension
  43995. * @param extension defines the extension to load
  43996. * @returns a plugin or null if none works
  43997. */
  43998. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  43999. /**
  44000. * Gets a boolean indicating that the given extension can be loaded
  44001. * @param extension defines the extension to load
  44002. * @returns true if the extension is supported
  44003. */
  44004. static IsPluginForExtensionAvailable(extension: string): boolean;
  44005. /**
  44006. * Adds a new plugin to the list of registered plugins
  44007. * @param plugin defines the plugin to add
  44008. */
  44009. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  44010. /**
  44011. * Import meshes into a scene
  44012. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  44013. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  44014. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  44015. * @param scene the instance of BABYLON.Scene to append to
  44016. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  44017. * @param onProgress a callback with a progress event for each file being loaded
  44018. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44019. * @param pluginExtension the extension used to determine the plugin
  44020. * @returns The loaded plugin
  44021. */
  44022. static ImportMesh(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], animationGroups: AnimationGroup[]) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  44023. /**
  44024. * Import meshes into a scene
  44025. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  44026. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  44027. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  44028. * @param scene the instance of BABYLON.Scene to append to
  44029. * @param onProgress a callback with a progress event for each file being loaded
  44030. * @param pluginExtension the extension used to determine the plugin
  44031. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  44032. */
  44033. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  44034. meshes: AbstractMesh[];
  44035. particleSystems: IParticleSystem[];
  44036. skeletons: Skeleton[];
  44037. animationGroups: AnimationGroup[];
  44038. }>;
  44039. /**
  44040. * Load a scene
  44041. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  44042. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  44043. * @param engine is the instance of BABYLON.Engine to use to create the scene
  44044. * @param onSuccess a callback with the scene when import succeeds
  44045. * @param onProgress a callback with a progress event for each file being loaded
  44046. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44047. * @param pluginExtension the extension used to determine the plugin
  44048. * @returns The loaded plugin
  44049. */
  44050. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  44051. /**
  44052. * Load a scene
  44053. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  44054. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  44055. * @param engine is the instance of BABYLON.Engine to use to create the scene
  44056. * @param onProgress a callback with a progress event for each file being loaded
  44057. * @param pluginExtension the extension used to determine the plugin
  44058. * @returns The loaded scene
  44059. */
  44060. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  44061. /**
  44062. * Append a scene
  44063. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  44064. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  44065. * @param scene is the instance of BABYLON.Scene to append to
  44066. * @param onSuccess a callback with the scene when import succeeds
  44067. * @param onProgress a callback with a progress event for each file being loaded
  44068. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44069. * @param pluginExtension the extension used to determine the plugin
  44070. * @returns The loaded plugin
  44071. */
  44072. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  44073. /**
  44074. * Append a scene
  44075. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  44076. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  44077. * @param scene is the instance of BABYLON.Scene to append to
  44078. * @param onProgress a callback with a progress event for each file being loaded
  44079. * @param pluginExtension the extension used to determine the plugin
  44080. * @returns The given scene
  44081. */
  44082. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  44083. /**
  44084. * Load a scene into an asset container
  44085. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  44086. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  44087. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  44088. * @param onSuccess a callback with the scene when import succeeds
  44089. * @param onProgress a callback with a progress event for each file being loaded
  44090. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44091. * @param pluginExtension the extension used to determine the plugin
  44092. * @returns The loaded plugin
  44093. */
  44094. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  44095. /**
  44096. * Load a scene into an asset container
  44097. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  44098. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene (default: empty string)
  44099. * @param scene is the instance of Scene to append to
  44100. * @param onProgress a callback with a progress event for each file being loaded
  44101. * @param pluginExtension the extension used to determine the plugin
  44102. * @returns The loaded asset container
  44103. */
  44104. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  44105. }
  44106. }
  44107. declare module "babylonjs/Gamepads/Controllers/genericController" {
  44108. import { Scene } from "babylonjs/scene";
  44109. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44110. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44111. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44112. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44113. /**
  44114. * Generic Controller
  44115. */
  44116. export class GenericController extends WebVRController {
  44117. /**
  44118. * Base Url for the controller model.
  44119. */
  44120. static readonly MODEL_BASE_URL: string;
  44121. /**
  44122. * File name for the controller model.
  44123. */
  44124. static readonly MODEL_FILENAME: string;
  44125. /**
  44126. * Creates a new GenericController from a gamepad
  44127. * @param vrGamepad the gamepad that the controller should be created from
  44128. */
  44129. constructor(vrGamepad: any);
  44130. /**
  44131. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44132. * @param scene scene in which to add meshes
  44133. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44134. */
  44135. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44136. /**
  44137. * Called once for each button that changed state since the last frame
  44138. * @param buttonIdx Which button index changed
  44139. * @param state New state of the button
  44140. * @param changes Which properties on the state changed since last frame
  44141. */
  44142. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44143. }
  44144. }
  44145. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  44146. import { Observable } from "babylonjs/Misc/observable";
  44147. import { Scene } from "babylonjs/scene";
  44148. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44149. import { Ray } from "babylonjs/Culling/ray";
  44150. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44151. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44152. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44153. /**
  44154. * Defines the WindowsMotionController object that the state of the windows motion controller
  44155. */
  44156. export class WindowsMotionController extends WebVRController {
  44157. /**
  44158. * The base url used to load the left and right controller models
  44159. */
  44160. static MODEL_BASE_URL: string;
  44161. /**
  44162. * The name of the left controller model file
  44163. */
  44164. static MODEL_LEFT_FILENAME: string;
  44165. /**
  44166. * The name of the right controller model file
  44167. */
  44168. static MODEL_RIGHT_FILENAME: string;
  44169. /**
  44170. * The controller name prefix for this controller type
  44171. */
  44172. static readonly GAMEPAD_ID_PREFIX: string;
  44173. /**
  44174. * The controller id pattern for this controller type
  44175. */
  44176. private static readonly GAMEPAD_ID_PATTERN;
  44177. private _loadedMeshInfo;
  44178. private readonly _mapping;
  44179. /**
  44180. * Fired when the trackpad on this controller is clicked
  44181. */
  44182. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  44183. /**
  44184. * Fired when the trackpad on this controller is modified
  44185. */
  44186. onTrackpadValuesChangedObservable: Observable<StickValues>;
  44187. /**
  44188. * The current x and y values of this controller's trackpad
  44189. */
  44190. trackpad: StickValues;
  44191. /**
  44192. * Creates a new WindowsMotionController from a gamepad
  44193. * @param vrGamepad the gamepad that the controller should be created from
  44194. */
  44195. constructor(vrGamepad: any);
  44196. /**
  44197. * Fired when the trigger on this controller is modified
  44198. */
  44199. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44200. /**
  44201. * Fired when the menu button on this controller is modified
  44202. */
  44203. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44204. /**
  44205. * Fired when the grip button on this controller is modified
  44206. */
  44207. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44208. /**
  44209. * Fired when the thumbstick button on this controller is modified
  44210. */
  44211. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44212. /**
  44213. * Fired when the touchpad button on this controller is modified
  44214. */
  44215. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44216. /**
  44217. * Fired when the touchpad values on this controller are modified
  44218. */
  44219. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  44220. private _updateTrackpad;
  44221. /**
  44222. * Called once per frame by the engine.
  44223. */
  44224. update(): void;
  44225. /**
  44226. * Called once for each button that changed state since the last frame
  44227. * @param buttonIdx Which button index changed
  44228. * @param state New state of the button
  44229. * @param changes Which properties on the state changed since last frame
  44230. */
  44231. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44232. /**
  44233. * Moves the buttons on the controller mesh based on their current state
  44234. * @param buttonName the name of the button to move
  44235. * @param buttonValue the value of the button which determines the buttons new position
  44236. */
  44237. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  44238. /**
  44239. * Moves the axis on the controller mesh based on its current state
  44240. * @param axis the index of the axis
  44241. * @param axisValue the value of the axis which determines the meshes new position
  44242. * @hidden
  44243. */
  44244. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  44245. /**
  44246. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44247. * @param scene scene in which to add meshes
  44248. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44249. */
  44250. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  44251. /**
  44252. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  44253. * can be transformed by button presses and axes values, based on this._mapping.
  44254. *
  44255. * @param scene scene in which the meshes exist
  44256. * @param meshes list of meshes that make up the controller model to process
  44257. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  44258. */
  44259. private processModel;
  44260. private createMeshInfo;
  44261. /**
  44262. * Gets the ray of the controller in the direction the controller is pointing
  44263. * @param length the length the resulting ray should be
  44264. * @returns a ray in the direction the controller is pointing
  44265. */
  44266. getForwardRay(length?: number): Ray;
  44267. /**
  44268. * Disposes of the controller
  44269. */
  44270. dispose(): void;
  44271. }
  44272. }
  44273. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  44274. import { Observable } from "babylonjs/Misc/observable";
  44275. import { Scene } from "babylonjs/scene";
  44276. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44277. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44278. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44279. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44280. /**
  44281. * Oculus Touch Controller
  44282. */
  44283. export class OculusTouchController extends WebVRController {
  44284. /**
  44285. * Base Url for the controller model.
  44286. */
  44287. static MODEL_BASE_URL: string;
  44288. /**
  44289. * File name for the left controller model.
  44290. */
  44291. static MODEL_LEFT_FILENAME: string;
  44292. /**
  44293. * File name for the right controller model.
  44294. */
  44295. static MODEL_RIGHT_FILENAME: string;
  44296. /**
  44297. * Base Url for the Quest controller model.
  44298. */
  44299. static QUEST_MODEL_BASE_URL: string;
  44300. /**
  44301. * @hidden
  44302. * If the controllers are running on a device that needs the updated Quest controller models
  44303. */
  44304. static _IsQuest: boolean;
  44305. /**
  44306. * Fired when the secondary trigger on this controller is modified
  44307. */
  44308. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  44309. /**
  44310. * Fired when the thumb rest on this controller is modified
  44311. */
  44312. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  44313. /**
  44314. * Creates a new OculusTouchController from a gamepad
  44315. * @param vrGamepad the gamepad that the controller should be created from
  44316. */
  44317. constructor(vrGamepad: any);
  44318. /**
  44319. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44320. * @param scene scene in which to add meshes
  44321. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44322. */
  44323. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44324. /**
  44325. * Fired when the A button on this controller is modified
  44326. */
  44327. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44328. /**
  44329. * Fired when the B button on this controller is modified
  44330. */
  44331. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44332. /**
  44333. * Fired when the X button on this controller is modified
  44334. */
  44335. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44336. /**
  44337. * Fired when the Y button on this controller is modified
  44338. */
  44339. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44340. /**
  44341. * Called once for each button that changed state since the last frame
  44342. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  44343. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  44344. * 2) secondary trigger (same)
  44345. * 3) A (right) X (left), touch, pressed = value
  44346. * 4) B / Y
  44347. * 5) thumb rest
  44348. * @param buttonIdx Which button index changed
  44349. * @param state New state of the button
  44350. * @param changes Which properties on the state changed since last frame
  44351. */
  44352. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44353. }
  44354. }
  44355. declare module "babylonjs/Gamepads/Controllers/viveController" {
  44356. import { Scene } from "babylonjs/scene";
  44357. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44358. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44359. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44360. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44361. import { Observable } from "babylonjs/Misc/observable";
  44362. /**
  44363. * Vive Controller
  44364. */
  44365. export class ViveController extends WebVRController {
  44366. /**
  44367. * Base Url for the controller model.
  44368. */
  44369. static MODEL_BASE_URL: string;
  44370. /**
  44371. * File name for the controller model.
  44372. */
  44373. static MODEL_FILENAME: string;
  44374. /**
  44375. * Creates a new ViveController from a gamepad
  44376. * @param vrGamepad the gamepad that the controller should be created from
  44377. */
  44378. constructor(vrGamepad: any);
  44379. /**
  44380. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44381. * @param scene scene in which to add meshes
  44382. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44383. */
  44384. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44385. /**
  44386. * Fired when the left button on this controller is modified
  44387. */
  44388. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44389. /**
  44390. * Fired when the right button on this controller is modified
  44391. */
  44392. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44393. /**
  44394. * Fired when the menu button on this controller is modified
  44395. */
  44396. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44397. /**
  44398. * Called once for each button that changed state since the last frame
  44399. * Vive mapping:
  44400. * 0: touchpad
  44401. * 1: trigger
  44402. * 2: left AND right buttons
  44403. * 3: menu button
  44404. * @param buttonIdx Which button index changed
  44405. * @param state New state of the button
  44406. * @param changes Which properties on the state changed since last frame
  44407. */
  44408. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44409. }
  44410. }
  44411. declare module "babylonjs/Cameras/XR/webXRControllerModelLoader" {
  44412. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  44413. /**
  44414. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  44415. */
  44416. export class WebXRControllerModelLoader {
  44417. /**
  44418. * Creates the WebXRControllerModelLoader
  44419. * @param input xr input that creates the controllers
  44420. */
  44421. constructor(input: WebXRInput);
  44422. }
  44423. }
  44424. declare module "babylonjs/Cameras/XR/index" {
  44425. export * from "babylonjs/Cameras/XR/webXRCamera";
  44426. export * from "babylonjs/Cameras/XR/webXREnterExitUI";
  44427. export * from "babylonjs/Cameras/XR/webXRExperienceHelper";
  44428. export * from "babylonjs/Cameras/XR/webXRInput";
  44429. export * from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  44430. export * from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  44431. export * from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  44432. export * from "babylonjs/Cameras/XR/webXRController";
  44433. export * from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  44434. export * from "babylonjs/Cameras/XR/webXRTypes";
  44435. export * from "babylonjs/Cameras/XR/webXRSessionManager";
  44436. }
  44437. declare module "babylonjs/Cameras/RigModes/index" {
  44438. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  44439. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  44440. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  44441. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  44442. }
  44443. declare module "babylonjs/Cameras/index" {
  44444. export * from "babylonjs/Cameras/Inputs/index";
  44445. export * from "babylonjs/Cameras/cameraInputsManager";
  44446. export * from "babylonjs/Cameras/camera";
  44447. export * from "babylonjs/Cameras/targetCamera";
  44448. export * from "babylonjs/Cameras/freeCamera";
  44449. export * from "babylonjs/Cameras/freeCameraInputsManager";
  44450. export * from "babylonjs/Cameras/touchCamera";
  44451. export * from "babylonjs/Cameras/arcRotateCamera";
  44452. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44453. export * from "babylonjs/Cameras/deviceOrientationCamera";
  44454. export * from "babylonjs/Cameras/flyCamera";
  44455. export * from "babylonjs/Cameras/flyCameraInputsManager";
  44456. export * from "babylonjs/Cameras/followCamera";
  44457. export * from "babylonjs/Cameras/followCameraInputsManager";
  44458. export * from "babylonjs/Cameras/gamepadCamera";
  44459. export * from "babylonjs/Cameras/Stereoscopic/index";
  44460. export * from "babylonjs/Cameras/universalCamera";
  44461. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  44462. export * from "babylonjs/Cameras/VR/index";
  44463. export * from "babylonjs/Cameras/XR/index";
  44464. export * from "babylonjs/Cameras/RigModes/index";
  44465. }
  44466. declare module "babylonjs/Collisions/index" {
  44467. export * from "babylonjs/Collisions/collider";
  44468. export * from "babylonjs/Collisions/collisionCoordinator";
  44469. export * from "babylonjs/Collisions/pickingInfo";
  44470. export * from "babylonjs/Collisions/intersectionInfo";
  44471. export * from "babylonjs/Collisions/meshCollisionData";
  44472. }
  44473. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  44474. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  44475. import { Vector3 } from "babylonjs/Maths/math.vector";
  44476. import { Ray } from "babylonjs/Culling/ray";
  44477. import { Plane } from "babylonjs/Maths/math.plane";
  44478. /**
  44479. * Contains an array of blocks representing the octree
  44480. */
  44481. export interface IOctreeContainer<T> {
  44482. /**
  44483. * Blocks within the octree
  44484. */
  44485. blocks: Array<OctreeBlock<T>>;
  44486. }
  44487. /**
  44488. * Class used to store a cell in an octree
  44489. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44490. */
  44491. export class OctreeBlock<T> {
  44492. /**
  44493. * Gets the content of the current block
  44494. */
  44495. entries: T[];
  44496. /**
  44497. * Gets the list of block children
  44498. */
  44499. blocks: Array<OctreeBlock<T>>;
  44500. private _depth;
  44501. private _maxDepth;
  44502. private _capacity;
  44503. private _minPoint;
  44504. private _maxPoint;
  44505. private _boundingVectors;
  44506. private _creationFunc;
  44507. /**
  44508. * Creates a new block
  44509. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  44510. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  44511. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  44512. * @param depth defines the current depth of this block in the octree
  44513. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  44514. * @param creationFunc defines a callback to call when an element is added to the block
  44515. */
  44516. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  44517. /**
  44518. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  44519. */
  44520. readonly capacity: number;
  44521. /**
  44522. * Gets the minimum vector (in world space) of the block's bounding box
  44523. */
  44524. readonly minPoint: Vector3;
  44525. /**
  44526. * Gets the maximum vector (in world space) of the block's bounding box
  44527. */
  44528. readonly maxPoint: Vector3;
  44529. /**
  44530. * Add a new element to this block
  44531. * @param entry defines the element to add
  44532. */
  44533. addEntry(entry: T): void;
  44534. /**
  44535. * Remove an element from this block
  44536. * @param entry defines the element to remove
  44537. */
  44538. removeEntry(entry: T): void;
  44539. /**
  44540. * Add an array of elements to this block
  44541. * @param entries defines the array of elements to add
  44542. */
  44543. addEntries(entries: T[]): void;
  44544. /**
  44545. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  44546. * @param frustumPlanes defines the frustum planes to test
  44547. * @param selection defines the array to store current content if selection is positive
  44548. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44549. */
  44550. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  44551. /**
  44552. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  44553. * @param sphereCenter defines the bounding sphere center
  44554. * @param sphereRadius defines the bounding sphere radius
  44555. * @param selection defines the array to store current content if selection is positive
  44556. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44557. */
  44558. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  44559. /**
  44560. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  44561. * @param ray defines the ray to test with
  44562. * @param selection defines the array to store current content if selection is positive
  44563. */
  44564. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  44565. /**
  44566. * Subdivide the content into child blocks (this block will then be empty)
  44567. */
  44568. createInnerBlocks(): void;
  44569. /**
  44570. * @hidden
  44571. */
  44572. static _CreateBlocks<T>(worldMin: Vector3, worldMax: Vector3, entries: T[], maxBlockCapacity: number, currentDepth: number, maxDepth: number, target: IOctreeContainer<T>, creationFunc: (entry: T, block: OctreeBlock<T>) => void): void;
  44573. }
  44574. }
  44575. declare module "babylonjs/Culling/Octrees/octree" {
  44576. import { SmartArray } from "babylonjs/Misc/smartArray";
  44577. import { Vector3 } from "babylonjs/Maths/math.vector";
  44578. import { SubMesh } from "babylonjs/Meshes/subMesh";
  44579. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44580. import { Ray } from "babylonjs/Culling/ray";
  44581. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  44582. import { Plane } from "babylonjs/Maths/math.plane";
  44583. /**
  44584. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  44585. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44586. */
  44587. export class Octree<T> {
  44588. /** Defines the maximum depth (sub-levels) for your octree. Default value is 2, which means 8 8 8 = 512 blocks :) (This parameter takes precedence over capacity.) */
  44589. maxDepth: number;
  44590. /**
  44591. * Blocks within the octree containing objects
  44592. */
  44593. blocks: Array<OctreeBlock<T>>;
  44594. /**
  44595. * Content stored in the octree
  44596. */
  44597. dynamicContent: T[];
  44598. private _maxBlockCapacity;
  44599. private _selectionContent;
  44600. private _creationFunc;
  44601. /**
  44602. * Creates a octree
  44603. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44604. * @param creationFunc function to be used to instatiate the octree
  44605. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  44606. * @param maxDepth defines the maximum depth (sub-levels) for your octree. Default value is 2, which means 8 8 8 = 512 blocks :) (This parameter takes precedence over capacity.)
  44607. */
  44608. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  44609. /** Defines the maximum depth (sub-levels) for your octree. Default value is 2, which means 8 8 8 = 512 blocks :) (This parameter takes precedence over capacity.) */
  44610. maxDepth?: number);
  44611. /**
  44612. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  44613. * @param worldMin worldMin for the octree blocks var blockSize = new Vector3((worldMax.x - worldMin.x) / 2, (worldMax.y - worldMin.y) / 2, (worldMax.z - worldMin.z) / 2);
  44614. * @param worldMax worldMax for the octree blocks var blockSize = new Vector3((worldMax.x - worldMin.x) / 2, (worldMax.y - worldMin.y) / 2, (worldMax.z - worldMin.z) / 2);
  44615. * @param entries meshes to be added to the octree blocks
  44616. */
  44617. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  44618. /**
  44619. * Adds a mesh to the octree
  44620. * @param entry Mesh to add to the octree
  44621. */
  44622. addMesh(entry: T): void;
  44623. /**
  44624. * Remove an element from the octree
  44625. * @param entry defines the element to remove
  44626. */
  44627. removeMesh(entry: T): void;
  44628. /**
  44629. * Selects an array of meshes within the frustum
  44630. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  44631. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  44632. * @returns array of meshes within the frustum
  44633. */
  44634. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  44635. /**
  44636. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  44637. * @param sphereCenter defines the bounding sphere center
  44638. * @param sphereRadius defines the bounding sphere radius
  44639. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44640. * @returns an array of objects that intersect the sphere
  44641. */
  44642. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  44643. /**
  44644. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  44645. * @param ray defines the ray to test with
  44646. * @returns array of intersected objects
  44647. */
  44648. intersectsRay(ray: Ray): SmartArray<T>;
  44649. /**
  44650. * Adds a mesh into the octree block if it intersects the block
  44651. */
  44652. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  44653. /**
  44654. * Adds a submesh into the octree block if it intersects the block
  44655. */
  44656. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  44657. }
  44658. }
  44659. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  44660. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  44661. import { Scene } from "babylonjs/scene";
  44662. import { SubMesh } from "babylonjs/Meshes/subMesh";
  44663. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44664. import { Ray } from "babylonjs/Culling/ray";
  44665. import { Octree } from "babylonjs/Culling/Octrees/octree";
  44666. import { Collider } from "babylonjs/Collisions/collider";
  44667. module "babylonjs/scene" {
  44668. interface Scene {
  44669. /**
  44670. * @hidden
  44671. * Backing Filed
  44672. */
  44673. _selectionOctree: Octree<AbstractMesh>;
  44674. /**
  44675. * Gets the octree used to boost mesh selection (picking)
  44676. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44677. */
  44678. selectionOctree: Octree<AbstractMesh>;
  44679. /**
  44680. * Creates or updates the octree used to boost selection (picking)
  44681. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44682. * @param maxCapacity defines the maximum capacity per leaf
  44683. * @param maxDepth defines the maximum depth of the octree
  44684. * @returns an octree of AbstractMesh
  44685. */
  44686. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  44687. }
  44688. }
  44689. module "babylonjs/Meshes/abstractMesh" {
  44690. interface AbstractMesh {
  44691. /**
  44692. * @hidden
  44693. * Backing Field
  44694. */
  44695. _submeshesOctree: Octree<SubMesh>;
  44696. /**
  44697. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  44698. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  44699. * @param maxCapacity defines the maximum size of each block (64 by default)
  44700. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  44701. * @returns the new octree
  44702. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  44703. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44704. */
  44705. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  44706. }
  44707. }
  44708. /**
  44709. * Defines the octree scene component responsible to manage any octrees
  44710. * in a given scene.
  44711. */
  44712. export class OctreeSceneComponent {
  44713. /**
  44714. * The component name help to identify the component in the list of scene components.
  44715. */
  44716. readonly name: string;
  44717. /**
  44718. * The scene the component belongs to.
  44719. */
  44720. scene: Scene;
  44721. /**
  44722. * Indicates if the meshes have been checked to make sure they are isEnabled()
  44723. */
  44724. readonly checksIsEnabled: boolean;
  44725. /**
  44726. * Creates a new instance of the component for the given scene
  44727. * @param scene Defines the scene to register the component in
  44728. */
  44729. constructor(scene: Scene);
  44730. /**
  44731. * Registers the component in a given scene
  44732. */
  44733. register(): void;
  44734. /**
  44735. * Return the list of active meshes
  44736. * @returns the list of active meshes
  44737. */
  44738. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  44739. /**
  44740. * Return the list of active sub meshes
  44741. * @param mesh The mesh to get the candidates sub meshes from
  44742. * @returns the list of active sub meshes
  44743. */
  44744. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  44745. private _tempRay;
  44746. /**
  44747. * Return the list of sub meshes intersecting with a given local ray
  44748. * @param mesh defines the mesh to find the submesh for
  44749. * @param localRay defines the ray in local space
  44750. * @returns the list of intersecting sub meshes
  44751. */
  44752. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  44753. /**
  44754. * Return the list of sub meshes colliding with a collider
  44755. * @param mesh defines the mesh to find the submesh for
  44756. * @param collider defines the collider to evaluate the collision against
  44757. * @returns the list of colliding sub meshes
  44758. */
  44759. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  44760. /**
  44761. * Rebuilds the elements related to this component in case of
  44762. * context lost for instance.
  44763. */
  44764. rebuild(): void;
  44765. /**
  44766. * Disposes the component and the associated ressources.
  44767. */
  44768. dispose(): void;
  44769. }
  44770. }
  44771. declare module "babylonjs/Culling/Octrees/index" {
  44772. export * from "babylonjs/Culling/Octrees/octree";
  44773. export * from "babylonjs/Culling/Octrees/octreeBlock";
  44774. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  44775. }
  44776. declare module "babylonjs/Culling/index" {
  44777. export * from "babylonjs/Culling/boundingBox";
  44778. export * from "babylonjs/Culling/boundingInfo";
  44779. export * from "babylonjs/Culling/boundingSphere";
  44780. export * from "babylonjs/Culling/Octrees/index";
  44781. export * from "babylonjs/Culling/ray";
  44782. }
  44783. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  44784. import { IDisposable, Scene } from "babylonjs/scene";
  44785. import { Nullable } from "babylonjs/types";
  44786. import { Observable } from "babylonjs/Misc/observable";
  44787. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44788. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  44789. import { Camera } from "babylonjs/Cameras/camera";
  44790. /**
  44791. * Renders a layer on top of an existing scene
  44792. */
  44793. export class UtilityLayerRenderer implements IDisposable {
  44794. /** the original scene that will be rendered on top of */
  44795. originalScene: Scene;
  44796. private _pointerCaptures;
  44797. private _lastPointerEvents;
  44798. private static _DefaultUtilityLayer;
  44799. private static _DefaultKeepDepthUtilityLayer;
  44800. private _sharedGizmoLight;
  44801. private _renderCamera;
  44802. /**
  44803. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  44804. * @returns the camera that is used when rendering the utility layer
  44805. */
  44806. getRenderCamera(): Nullable<Camera>;
  44807. /**
  44808. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  44809. * @param cam the camera that should be used when rendering the utility layer
  44810. */
  44811. setRenderCamera(cam: Nullable<Camera>): void;
  44812. /**
  44813. * @hidden
  44814. * Light which used by gizmos to get light shading
  44815. */
  44816. _getSharedGizmoLight(): HemisphericLight;
  44817. /**
  44818. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  44819. */
  44820. pickUtilitySceneFirst: boolean;
  44821. /**
  44822. * A shared utility layer that can be used to overlay objects into a scene (Depth map of the previous scene is cleared before drawing on top of it)
  44823. */
  44824. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  44825. /**
  44826. * A shared utility layer that can be used to embed objects into a scene (Depth map of the previous scene is not cleared before drawing on top of it)
  44827. */
  44828. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  44829. /**
  44830. * The scene that is rendered on top of the original scene
  44831. */
  44832. utilityLayerScene: Scene;
  44833. /**
  44834. * If the utility layer should automatically be rendered on top of existing scene
  44835. */
  44836. shouldRender: boolean;
  44837. /**
  44838. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  44839. */
  44840. onlyCheckPointerDownEvents: boolean;
  44841. /**
  44842. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  44843. */
  44844. processAllEvents: boolean;
  44845. /**
  44846. * Observable raised when the pointer move from the utility layer scene to the main scene
  44847. */
  44848. onPointerOutObservable: Observable<number>;
  44849. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  44850. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  44851. private _afterRenderObserver;
  44852. private _sceneDisposeObserver;
  44853. private _originalPointerObserver;
  44854. /**
  44855. * Instantiates a UtilityLayerRenderer
  44856. * @param originalScene the original scene that will be rendered on top of
  44857. * @param handleEvents boolean indicating if the utility layer should handle events
  44858. */
  44859. constructor(
  44860. /** the original scene that will be rendered on top of */
  44861. originalScene: Scene, handleEvents?: boolean);
  44862. private _notifyObservers;
  44863. /**
  44864. * Renders the utility layers scene on top of the original scene
  44865. */
  44866. render(): void;
  44867. /**
  44868. * Disposes of the renderer
  44869. */
  44870. dispose(): void;
  44871. private _updateCamera;
  44872. }
  44873. }
  44874. declare module "babylonjs/Gizmos/gizmo" {
  44875. import { Nullable } from "babylonjs/types";
  44876. import { IDisposable } from "babylonjs/scene";
  44877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44878. import { Mesh } from "babylonjs/Meshes/mesh";
  44879. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44880. /**
  44881. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  44882. */
  44883. export class Gizmo implements IDisposable {
  44884. /** The utility layer the gizmo will be added to */
  44885. gizmoLayer: UtilityLayerRenderer;
  44886. /**
  44887. * The root mesh of the gizmo
  44888. */
  44889. _rootMesh: Mesh;
  44890. private _attachedMesh;
  44891. /**
  44892. * Ratio for the scale of the gizmo (Default: 1)
  44893. */
  44894. scaleRatio: number;
  44895. /**
  44896. * If a custom mesh has been set (Default: false)
  44897. */
  44898. protected _customMeshSet: boolean;
  44899. /**
  44900. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  44901. * * When set, interactions will be enabled
  44902. */
  44903. attachedMesh: Nullable<AbstractMesh>;
  44904. /**
  44905. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  44906. * @param mesh The mesh to replace the default mesh of the gizmo
  44907. */
  44908. setCustomMesh(mesh: Mesh): void;
  44909. /**
  44910. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  44911. */
  44912. updateGizmoRotationToMatchAttachedMesh: boolean;
  44913. /**
  44914. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  44915. */
  44916. updateGizmoPositionToMatchAttachedMesh: boolean;
  44917. /**
  44918. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  44919. */
  44920. updateScale: boolean;
  44921. protected _interactionsEnabled: boolean;
  44922. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44923. private _beforeRenderObserver;
  44924. private _tempVector;
  44925. /**
  44926. * Creates a gizmo
  44927. * @param gizmoLayer The utility layer the gizmo will be added to
  44928. */
  44929. constructor(
  44930. /** The utility layer the gizmo will be added to */
  44931. gizmoLayer?: UtilityLayerRenderer);
  44932. /**
  44933. * Updates the gizmo to match the attached mesh's position/rotation
  44934. */
  44935. protected _update(): void;
  44936. /**
  44937. * Disposes of the gizmo
  44938. */
  44939. dispose(): void;
  44940. }
  44941. }
  44942. declare module "babylonjs/Gizmos/planeDragGizmo" {
  44943. import { Observable } from "babylonjs/Misc/observable";
  44944. import { Nullable } from "babylonjs/types";
  44945. import { Vector3 } from "babylonjs/Maths/math.vector";
  44946. import { Color3 } from "babylonjs/Maths/math.color";
  44947. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44948. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44949. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  44950. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  44951. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  44952. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  44953. import { Scene } from "babylonjs/scene";
  44954. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  44955. /**
  44956. * Single plane drag gizmo
  44957. */
  44958. export class PlaneDragGizmo extends Gizmo {
  44959. /**
  44960. * Drag behavior responsible for the gizmos dragging interactions
  44961. */
  44962. dragBehavior: PointerDragBehavior;
  44963. private _pointerObserver;
  44964. /**
  44965. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  44966. */
  44967. snapDistance: number;
  44968. /**
  44969. * Event that fires each time the gizmo snaps to a new location.
  44970. * * snapDistance is the the change in distance
  44971. */
  44972. onSnapObservable: Observable<{
  44973. snapDistance: number;
  44974. }>;
  44975. private _plane;
  44976. private _coloredMaterial;
  44977. private _hoverMaterial;
  44978. private _isEnabled;
  44979. private _parent;
  44980. /** @hidden */
  44981. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  44982. /** @hidden */
  44983. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  44984. /**
  44985. * Creates a PlaneDragGizmo
  44986. * @param gizmoLayer The utility layer the gizmo will be added to
  44987. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  44988. * @param color The color of the gizmo
  44989. */
  44990. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  44991. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  44992. /**
  44993. * If the gizmo is enabled
  44994. */
  44995. isEnabled: boolean;
  44996. /**
  44997. * Disposes of the gizmo
  44998. */
  44999. dispose(): void;
  45000. }
  45001. }
  45002. declare module "babylonjs/Gizmos/positionGizmo" {
  45003. import { Observable } from "babylonjs/Misc/observable";
  45004. import { Nullable } from "babylonjs/types";
  45005. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45006. import { Mesh } from "babylonjs/Meshes/mesh";
  45007. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45008. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  45009. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  45010. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45011. /**
  45012. * Gizmo that enables dragging a mesh along 3 axis
  45013. */
  45014. export class PositionGizmo extends Gizmo {
  45015. /**
  45016. * Internal gizmo used for interactions on the x axis
  45017. */
  45018. xGizmo: AxisDragGizmo;
  45019. /**
  45020. * Internal gizmo used for interactions on the y axis
  45021. */
  45022. yGizmo: AxisDragGizmo;
  45023. /**
  45024. * Internal gizmo used for interactions on the z axis
  45025. */
  45026. zGizmo: AxisDragGizmo;
  45027. /**
  45028. * Internal gizmo used for interactions on the yz plane
  45029. */
  45030. xPlaneGizmo: PlaneDragGizmo;
  45031. /**
  45032. * Internal gizmo used for interactions on the xz plane
  45033. */
  45034. yPlaneGizmo: PlaneDragGizmo;
  45035. /**
  45036. * Internal gizmo used for interactions on the xy plane
  45037. */
  45038. zPlaneGizmo: PlaneDragGizmo;
  45039. /**
  45040. * private variables
  45041. */
  45042. private _meshAttached;
  45043. private _updateGizmoRotationToMatchAttachedMesh;
  45044. private _snapDistance;
  45045. private _scaleRatio;
  45046. /** Fires an event when any of it's sub gizmos are dragged */
  45047. onDragStartObservable: Observable<unknown>;
  45048. /** Fires an event when any of it's sub gizmos are released from dragging */
  45049. onDragEndObservable: Observable<unknown>;
  45050. /**
  45051. * If set to true, planar drag is enabled
  45052. */
  45053. private _planarGizmoEnabled;
  45054. attachedMesh: Nullable<AbstractMesh>;
  45055. /**
  45056. * Creates a PositionGizmo
  45057. * @param gizmoLayer The utility layer the gizmo will be added to
  45058. */
  45059. constructor(gizmoLayer?: UtilityLayerRenderer);
  45060. /**
  45061. * If the planar drag gizmo is enabled
  45062. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  45063. */
  45064. planarGizmoEnabled: boolean;
  45065. updateGizmoRotationToMatchAttachedMesh: boolean;
  45066. /**
  45067. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45068. */
  45069. snapDistance: number;
  45070. /**
  45071. * Ratio for the scale of the gizmo (Default: 1)
  45072. */
  45073. scaleRatio: number;
  45074. /**
  45075. * Disposes of the gizmo
  45076. */
  45077. dispose(): void;
  45078. /**
  45079. * CustomMeshes are not supported by this gizmo
  45080. * @param mesh The mesh to replace the default mesh of the gizmo
  45081. */
  45082. setCustomMesh(mesh: Mesh): void;
  45083. }
  45084. }
  45085. declare module "babylonjs/Gizmos/axisDragGizmo" {
  45086. import { Observable } from "babylonjs/Misc/observable";
  45087. import { Nullable } from "babylonjs/types";
  45088. import { Vector3 } from "babylonjs/Maths/math.vector";
  45089. import { TransformNode } from "babylonjs/Meshes/transformNode";
  45090. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45091. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45092. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45093. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45094. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  45095. import { Scene } from "babylonjs/scene";
  45096. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  45097. import { Color3 } from "babylonjs/Maths/math.color";
  45098. /**
  45099. * Single axis drag gizmo
  45100. */
  45101. export class AxisDragGizmo extends Gizmo {
  45102. /**
  45103. * Drag behavior responsible for the gizmos dragging interactions
  45104. */
  45105. dragBehavior: PointerDragBehavior;
  45106. private _pointerObserver;
  45107. /**
  45108. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45109. */
  45110. snapDistance: number;
  45111. /**
  45112. * Event that fires each time the gizmo snaps to a new location.
  45113. * * snapDistance is the the change in distance
  45114. */
  45115. onSnapObservable: Observable<{
  45116. snapDistance: number;
  45117. }>;
  45118. private _isEnabled;
  45119. private _parent;
  45120. private _arrow;
  45121. private _coloredMaterial;
  45122. private _hoverMaterial;
  45123. /** @hidden */
  45124. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  45125. /** @hidden */
  45126. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  45127. /**
  45128. * Creates an AxisDragGizmo
  45129. * @param gizmoLayer The utility layer the gizmo will be added to
  45130. * @param dragAxis The axis which the gizmo will be able to drag on
  45131. * @param color The color of the gizmo
  45132. */
  45133. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  45134. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  45135. /**
  45136. * If the gizmo is enabled
  45137. */
  45138. isEnabled: boolean;
  45139. /**
  45140. * Disposes of the gizmo
  45141. */
  45142. dispose(): void;
  45143. }
  45144. }
  45145. declare module "babylonjs/Debug/axesViewer" {
  45146. import { Vector3 } from "babylonjs/Maths/math.vector";
  45147. import { Nullable } from "babylonjs/types";
  45148. import { Scene } from "babylonjs/scene";
  45149. import { TransformNode } from "babylonjs/Meshes/transformNode";
  45150. /**
  45151. * The Axes viewer will show 3 axes in a specific point in space
  45152. */
  45153. export class AxesViewer {
  45154. private _xAxis;
  45155. private _yAxis;
  45156. private _zAxis;
  45157. private _scaleLinesFactor;
  45158. private _instanced;
  45159. /**
  45160. * Gets the hosting scene
  45161. */
  45162. scene: Scene;
  45163. /**
  45164. * Gets or sets a number used to scale line length
  45165. */
  45166. scaleLines: number;
  45167. /** Gets the node hierarchy used to render x-axis */
  45168. readonly xAxis: TransformNode;
  45169. /** Gets the node hierarchy used to render y-axis */
  45170. readonly yAxis: TransformNode;
  45171. /** Gets the node hierarchy used to render z-axis */
  45172. readonly zAxis: TransformNode;
  45173. /**
  45174. * Creates a new AxesViewer
  45175. * @param scene defines the hosting scene
  45176. * @param scaleLines defines a number used to scale line length (1 by default)
  45177. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  45178. * @param xAxis defines the node hierarchy used to render the x-axis
  45179. * @param yAxis defines the node hierarchy used to render the y-axis
  45180. * @param zAxis defines the node hierarchy used to render the z-axis
  45181. */
  45182. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  45183. /**
  45184. * Force the viewer to update
  45185. * @param position defines the position of the viewer
  45186. * @param xaxis defines the x axis of the viewer
  45187. * @param yaxis defines the y axis of the viewer
  45188. * @param zaxis defines the z axis of the viewer
  45189. */
  45190. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  45191. /**
  45192. * Creates an instance of this axes viewer.
  45193. * @returns a new axes viewer with instanced meshes
  45194. */
  45195. createInstance(): AxesViewer;
  45196. /** Releases resources */
  45197. dispose(): void;
  45198. private static _SetRenderingGroupId;
  45199. }
  45200. }
  45201. declare module "babylonjs/Debug/boneAxesViewer" {
  45202. import { Nullable } from "babylonjs/types";
  45203. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  45204. import { Vector3 } from "babylonjs/Maths/math.vector";
  45205. import { Mesh } from "babylonjs/Meshes/mesh";
  45206. import { Bone } from "babylonjs/Bones/bone";
  45207. import { Scene } from "babylonjs/scene";
  45208. /**
  45209. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  45210. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  45211. */
  45212. export class BoneAxesViewer extends AxesViewer {
  45213. /**
  45214. * Gets or sets the target mesh where to display the axes viewer
  45215. */
  45216. mesh: Nullable<Mesh>;
  45217. /**
  45218. * Gets or sets the target bone where to display the axes viewer
  45219. */
  45220. bone: Nullable<Bone>;
  45221. /** Gets current position */
  45222. pos: Vector3;
  45223. /** Gets direction of X axis */
  45224. xaxis: Vector3;
  45225. /** Gets direction of Y axis */
  45226. yaxis: Vector3;
  45227. /** Gets direction of Z axis */
  45228. zaxis: Vector3;
  45229. /**
  45230. * Creates a new BoneAxesViewer
  45231. * @param scene defines the hosting scene
  45232. * @param bone defines the target bone
  45233. * @param mesh defines the target mesh
  45234. * @param scaleLines defines a scaling factor for line length (1 by default)
  45235. */
  45236. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  45237. /**
  45238. * Force the viewer to update
  45239. */
  45240. update(): void;
  45241. /** Releases resources */
  45242. dispose(): void;
  45243. }
  45244. }
  45245. declare module "babylonjs/Debug/debugLayer" {
  45246. import { Scene } from "babylonjs/scene";
  45247. /**
  45248. * Interface used to define scene explorer extensibility option
  45249. */
  45250. export interface IExplorerExtensibilityOption {
  45251. /**
  45252. * Define the option label
  45253. */
  45254. label: string;
  45255. /**
  45256. * Defines the action to execute on click
  45257. */
  45258. action: (entity: any) => void;
  45259. }
  45260. /**
  45261. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  45262. */
  45263. export interface IExplorerExtensibilityGroup {
  45264. /**
  45265. * Defines a predicate to test if a given type mut be extended
  45266. */
  45267. predicate: (entity: any) => boolean;
  45268. /**
  45269. * Gets the list of options added to a type
  45270. */
  45271. entries: IExplorerExtensibilityOption[];
  45272. }
  45273. /**
  45274. * Interface used to define the options to use to create the Inspector
  45275. */
  45276. export interface IInspectorOptions {
  45277. /**
  45278. * Display in overlay mode (default: false)
  45279. */
  45280. overlay?: boolean;
  45281. /**
  45282. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  45283. */
  45284. globalRoot?: HTMLElement;
  45285. /**
  45286. * Display the Scene explorer
  45287. */
  45288. showExplorer?: boolean;
  45289. /**
  45290. * Display the property inspector
  45291. */
  45292. showInspector?: boolean;
  45293. /**
  45294. * Display in embed mode (both panes on the right)
  45295. */
  45296. embedMode?: boolean;
  45297. /**
  45298. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  45299. */
  45300. handleResize?: boolean;
  45301. /**
  45302. * Allow the panes to popup (default: true)
  45303. */
  45304. enablePopup?: boolean;
  45305. /**
  45306. * Allow the panes to be closed by users (default: true)
  45307. */
  45308. enableClose?: boolean;
  45309. /**
  45310. * Optional list of extensibility entries
  45311. */
  45312. explorerExtensibility?: IExplorerExtensibilityGroup[];
  45313. /**
  45314. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  45315. */
  45316. inspectorURL?: string;
  45317. }
  45318. module "babylonjs/scene" {
  45319. interface Scene {
  45320. /**
  45321. * @hidden
  45322. * Backing field
  45323. */
  45324. _debugLayer: DebugLayer;
  45325. /**
  45326. * Gets the debug layer (aka Inspector) associated with the scene
  45327. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45328. */
  45329. debugLayer: DebugLayer;
  45330. }
  45331. }
  45332. /**
  45333. * The debug layer (aka Inspector) is the go to tool in order to better understand
  45334. * what is happening in your scene
  45335. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45336. */
  45337. export class DebugLayer {
  45338. /**
  45339. * Define the url to get the inspector script from.
  45340. * By default it uses the babylonjs CDN.
  45341. * @ignoreNaming
  45342. */
  45343. static InspectorURL: string;
  45344. private _scene;
  45345. private BJSINSPECTOR;
  45346. private _onPropertyChangedObservable?;
  45347. /**
  45348. * Observable triggered when a property is changed through the inspector.
  45349. */
  45350. readonly onPropertyChangedObservable: any;
  45351. /**
  45352. * Instantiates a new debug layer.
  45353. * The debug layer (aka Inspector) is the go to tool in order to better understand
  45354. * what is happening in your scene
  45355. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45356. * @param scene Defines the scene to inspect
  45357. */
  45358. constructor(scene: Scene);
  45359. /** Creates the inspector window. */
  45360. private _createInspector;
  45361. /**
  45362. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  45363. * @param entity defines the entity to select
  45364. * @param lineContainerTitle defines the specific block to highlight
  45365. */
  45366. select(entity: any, lineContainerTitle?: string): void;
  45367. /** Get the inspector from bundle or global */
  45368. private _getGlobalInspector;
  45369. /**
  45370. * Get if the inspector is visible or not.
  45371. * @returns true if visible otherwise, false
  45372. */
  45373. isVisible(): boolean;
  45374. /**
  45375. * Hide the inspector and close its window.
  45376. */
  45377. hide(): void;
  45378. /**
  45379. * Launch the debugLayer.
  45380. * @param config Define the configuration of the inspector
  45381. * @return a promise fulfilled when the debug layer is visible
  45382. */
  45383. show(config?: IInspectorOptions): Promise<DebugLayer>;
  45384. }
  45385. }
  45386. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  45387. import { Nullable } from "babylonjs/types";
  45388. import { Scene } from "babylonjs/scene";
  45389. import { Vector4 } from "babylonjs/Maths/math.vector";
  45390. import { Color4 } from "babylonjs/Maths/math.color";
  45391. import { Mesh } from "babylonjs/Meshes/mesh";
  45392. /**
  45393. * Class containing static functions to help procedurally build meshes
  45394. */
  45395. export class BoxBuilder {
  45396. /**
  45397. * Creates a box mesh
  45398. * * The parameter `size` sets the size (float) of each box side (default 1)
  45399. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  45400. * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of 6 Color3 elements) and `faceUV` (an array of 6 Vector4 elements)
  45401. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  45402. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45403. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45404. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45405. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  45406. * @param name defines the name of the mesh
  45407. * @param options defines the options used to create the mesh
  45408. * @param scene defines the hosting scene
  45409. * @returns the box mesh
  45410. */
  45411. static CreateBox(name: string, options: {
  45412. size?: number;
  45413. width?: number;
  45414. height?: number;
  45415. depth?: number;
  45416. faceUV?: Vector4[];
  45417. faceColors?: Color4[];
  45418. sideOrientation?: number;
  45419. frontUVs?: Vector4;
  45420. backUVs?: Vector4;
  45421. wrap?: boolean;
  45422. topBaseAt?: number;
  45423. bottomBaseAt?: number;
  45424. updatable?: boolean;
  45425. }, scene?: Nullable<Scene>): Mesh;
  45426. }
  45427. }
  45428. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  45429. import { Vector4 } from "babylonjs/Maths/math.vector";
  45430. import { Mesh } from "babylonjs/Meshes/mesh";
  45431. import { Scene } from "babylonjs/scene";
  45432. import { Nullable } from "babylonjs/types";
  45433. /**
  45434. * Class containing static functions to help procedurally build meshes
  45435. */
  45436. export class SphereBuilder {
  45437. /**
  45438. * Creates a sphere mesh
  45439. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  45440. * * You can set some different sphere dimensions, for instance to build an ellipsoid, by using the parameters `diameterX`, `diameterY` and `diameterZ` (all by default have the same value of `diameter`)
  45441. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  45442. * * You can create an unclosed sphere with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference (latitude) : 2 x PI x ratio
  45443. * * You can create an unclosed sphere on its height with the parameter `slice` (positive float, default1), valued between 0 and 1, what is the height ratio (longitude)
  45444. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45445. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45446. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45447. * @param name defines the name of the mesh
  45448. * @param options defines the options used to create the mesh
  45449. * @param scene defines the hosting scene
  45450. * @returns the sphere mesh
  45451. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  45452. */
  45453. static CreateSphere(name: string, options: {
  45454. segments?: number;
  45455. diameter?: number;
  45456. diameterX?: number;
  45457. diameterY?: number;
  45458. diameterZ?: number;
  45459. arc?: number;
  45460. slice?: number;
  45461. sideOrientation?: number;
  45462. frontUVs?: Vector4;
  45463. backUVs?: Vector4;
  45464. updatable?: boolean;
  45465. }, scene?: Nullable<Scene>): Mesh;
  45466. }
  45467. }
  45468. declare module "babylonjs/Debug/physicsViewer" {
  45469. import { Nullable } from "babylonjs/types";
  45470. import { Scene } from "babylonjs/scene";
  45471. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45472. import { Mesh } from "babylonjs/Meshes/mesh";
  45473. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  45474. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  45475. /**
  45476. * Used to show the physics impostor around the specific mesh
  45477. */
  45478. export class PhysicsViewer {
  45479. /** @hidden */
  45480. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  45481. /** @hidden */
  45482. protected _meshes: Array<Nullable<AbstractMesh>>;
  45483. /** @hidden */
  45484. protected _scene: Nullable<Scene>;
  45485. /** @hidden */
  45486. protected _numMeshes: number;
  45487. /** @hidden */
  45488. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  45489. private _renderFunction;
  45490. private _utilityLayer;
  45491. private _debugBoxMesh;
  45492. private _debugSphereMesh;
  45493. private _debugCylinderMesh;
  45494. private _debugMaterial;
  45495. private _debugMeshMeshes;
  45496. /**
  45497. * Creates a new PhysicsViewer
  45498. * @param scene defines the hosting scene
  45499. */
  45500. constructor(scene: Scene);
  45501. /** @hidden */
  45502. protected _updateDebugMeshes(): void;
  45503. /**
  45504. * Renders a specified physic impostor
  45505. * @param impostor defines the impostor to render
  45506. * @param targetMesh defines the mesh represented by the impostor
  45507. * @returns the new debug mesh used to render the impostor
  45508. */
  45509. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  45510. /**
  45511. * Hides a specified physic impostor
  45512. * @param impostor defines the impostor to hide
  45513. */
  45514. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  45515. private _getDebugMaterial;
  45516. private _getDebugBoxMesh;
  45517. private _getDebugSphereMesh;
  45518. private _getDebugCylinderMesh;
  45519. private _getDebugMeshMesh;
  45520. private _getDebugMesh;
  45521. /** Releases all resources */
  45522. dispose(): void;
  45523. }
  45524. }
  45525. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  45526. import { Vector3 } from "babylonjs/Maths/math.vector";
  45527. import { Color4 } from "babylonjs/Maths/math.color";
  45528. import { Nullable } from "babylonjs/types";
  45529. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45530. import { Scene } from "babylonjs/scene";
  45531. /**
  45532. * Class containing static functions to help procedurally build meshes
  45533. */
  45534. export class LinesBuilder {
  45535. /**
  45536. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  45537. * * A line system mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of lines as an input parameter
  45538. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  45539. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  45540. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  45541. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  45542. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  45543. * * Updating a simple Line mesh, you just need to update every line in the `lines` array : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  45544. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  45545. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45546. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  45547. * @param name defines the name of the new line system
  45548. * @param options defines the options used to create the line system
  45549. * @param scene defines the hosting scene
  45550. * @returns a new line system mesh
  45551. */
  45552. static CreateLineSystem(name: string, options: {
  45553. lines: Vector3[][];
  45554. updatable?: boolean;
  45555. instance?: Nullable<LinesMesh>;
  45556. colors?: Nullable<Color4[][]>;
  45557. useVertexAlpha?: boolean;
  45558. }, scene: Nullable<Scene>): LinesMesh;
  45559. /**
  45560. * Creates a line mesh
  45561. * A line mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of points as an input parameter
  45562. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  45563. * * The parameter `points` is an array successive Vector3
  45564. * * The optional parameter `instance` is an instance of an existing LineMesh object to be updated with the passed `points` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  45565. * * The optional parameter `colors` is an array of successive Color4, one per line point
  45566. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  45567. * * When updating an instance, remember that only point positions can change, not the number of points
  45568. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45569. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  45570. * @param name defines the name of the new line system
  45571. * @param options defines the options used to create the line system
  45572. * @param scene defines the hosting scene
  45573. * @returns a new line mesh
  45574. */
  45575. static CreateLines(name: string, options: {
  45576. points: Vector3[];
  45577. updatable?: boolean;
  45578. instance?: Nullable<LinesMesh>;
  45579. colors?: Color4[];
  45580. useVertexAlpha?: boolean;
  45581. }, scene?: Nullable<Scene>): LinesMesh;
  45582. /**
  45583. * Creates a dashed line mesh
  45584. * * A dashed line mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of points as an input parameter
  45585. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  45586. * * The parameter `points` is an array successive Vector3
  45587. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  45588. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  45589. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  45590. * * The optional parameter `instance` is an instance of an existing LineMesh object to be updated with the passed `points` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  45591. * * When updating an instance, remember that only point positions can change, not the number of points
  45592. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45593. * @param name defines the name of the mesh
  45594. * @param options defines the options used to create the mesh
  45595. * @param scene defines the hosting scene
  45596. * @returns the dashed line mesh
  45597. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  45598. */
  45599. static CreateDashedLines(name: string, options: {
  45600. points: Vector3[];
  45601. dashSize?: number;
  45602. gapSize?: number;
  45603. dashNb?: number;
  45604. updatable?: boolean;
  45605. instance?: LinesMesh;
  45606. }, scene?: Nullable<Scene>): LinesMesh;
  45607. }
  45608. }
  45609. declare module "babylonjs/Debug/rayHelper" {
  45610. import { Nullable } from "babylonjs/types";
  45611. import { Ray } from "babylonjs/Culling/ray";
  45612. import { Vector3 } from "babylonjs/Maths/math.vector";
  45613. import { Color3 } from "babylonjs/Maths/math.color";
  45614. import { Scene } from "babylonjs/scene";
  45615. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45616. import "babylonjs/Meshes/Builders/linesBuilder";
  45617. /**
  45618. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  45619. * in order to better appreciate the issue one might have.
  45620. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  45621. */
  45622. export class RayHelper {
  45623. /**
  45624. * Defines the ray we are currently tryin to visualize.
  45625. */
  45626. ray: Nullable<Ray>;
  45627. private _renderPoints;
  45628. private _renderLine;
  45629. private _renderFunction;
  45630. private _scene;
  45631. private _updateToMeshFunction;
  45632. private _attachedToMesh;
  45633. private _meshSpaceDirection;
  45634. private _meshSpaceOrigin;
  45635. /**
  45636. * Helper function to create a colored helper in a scene in one line.
  45637. * @param ray Defines the ray we are currently tryin to visualize
  45638. * @param scene Defines the scene the ray is used in
  45639. * @param color Defines the color we want to see the ray in
  45640. * @returns The newly created ray helper.
  45641. */
  45642. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  45643. /**
  45644. * Instantiate a new ray helper.
  45645. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  45646. * in order to better appreciate the issue one might have.
  45647. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  45648. * @param ray Defines the ray we are currently tryin to visualize
  45649. */
  45650. constructor(ray: Ray);
  45651. /**
  45652. * Shows the ray we are willing to debug.
  45653. * @param scene Defines the scene the ray needs to be rendered in
  45654. * @param color Defines the color the ray needs to be rendered in
  45655. */
  45656. show(scene: Scene, color?: Color3): void;
  45657. /**
  45658. * Hides the ray we are debugging.
  45659. */
  45660. hide(): void;
  45661. private _render;
  45662. /**
  45663. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  45664. * @param mesh Defines the mesh we want the helper attached to
  45665. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  45666. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  45667. * @param length Defines the length of the ray
  45668. */
  45669. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  45670. /**
  45671. * Detach the ray helper from the mesh it has previously been attached to.
  45672. */
  45673. detachFromMesh(): void;
  45674. private _updateToMesh;
  45675. /**
  45676. * Dispose the helper and release its associated resources.
  45677. */
  45678. dispose(): void;
  45679. }
  45680. }
  45681. declare module "babylonjs/Debug/skeletonViewer" {
  45682. import { Color3 } from "babylonjs/Maths/math.color";
  45683. import { Scene } from "babylonjs/scene";
  45684. import { Nullable } from "babylonjs/types";
  45685. import { Skeleton } from "babylonjs/Bones/skeleton";
  45686. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45687. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45688. /**
  45689. * Class used to render a debug view of a given skeleton
  45690. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  45691. */
  45692. export class SkeletonViewer {
  45693. /** defines the skeleton to render */
  45694. skeleton: Skeleton;
  45695. /** defines the mesh attached to the skeleton */
  45696. mesh: AbstractMesh;
  45697. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45698. autoUpdateBonesMatrices: boolean;
  45699. /** defines the rendering group id to use with the viewer */
  45700. renderingGroupId: number;
  45701. /** Gets or sets the color used to render the skeleton */
  45702. color: Color3;
  45703. private _scene;
  45704. private _debugLines;
  45705. private _debugMesh;
  45706. private _isEnabled;
  45707. private _renderFunction;
  45708. private _utilityLayer;
  45709. /**
  45710. * Returns the mesh used to render the bones
  45711. */
  45712. readonly debugMesh: Nullable<LinesMesh>;
  45713. /**
  45714. * Creates a new SkeletonViewer
  45715. * @param skeleton defines the skeleton to render
  45716. * @param mesh defines the mesh attached to the skeleton
  45717. * @param scene defines the hosting scene
  45718. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  45719. * @param renderingGroupId defines the rendering group id to use with the viewer
  45720. */
  45721. constructor(
  45722. /** defines the skeleton to render */
  45723. skeleton: Skeleton,
  45724. /** defines the mesh attached to the skeleton */
  45725. mesh: AbstractMesh, scene: Scene,
  45726. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45727. autoUpdateBonesMatrices?: boolean,
  45728. /** defines the rendering group id to use with the viewer */
  45729. renderingGroupId?: number);
  45730. /** Gets or sets a boolean indicating if the viewer is enabled */
  45731. isEnabled: boolean;
  45732. private _getBonePosition;
  45733. private _getLinesForBonesWithLength;
  45734. private _getLinesForBonesNoLength;
  45735. /** Update the viewer to sync with current skeleton state */
  45736. update(): void;
  45737. /** Release associated resources */
  45738. dispose(): void;
  45739. }
  45740. }
  45741. declare module "babylonjs/Debug/index" {
  45742. export * from "babylonjs/Debug/axesViewer";
  45743. export * from "babylonjs/Debug/boneAxesViewer";
  45744. export * from "babylonjs/Debug/debugLayer";
  45745. export * from "babylonjs/Debug/physicsViewer";
  45746. export * from "babylonjs/Debug/rayHelper";
  45747. export * from "babylonjs/Debug/skeletonViewer";
  45748. }
  45749. declare module "babylonjs/Engines/nullEngine" {
  45750. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  45751. import { Scene } from "babylonjs/scene";
  45752. import { Engine } from "babylonjs/Engines/engine";
  45753. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  45754. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  45755. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  45756. import { Effect } from "babylonjs/Materials/effect";
  45757. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  45758. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  45759. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  45760. /**
  45761. * Options to create the null engine
  45762. */
  45763. export class NullEngineOptions {
  45764. /**
  45765. * Render width (Default: 512)
  45766. */
  45767. renderWidth: number;
  45768. /**
  45769. * Render height (Default: 256)
  45770. */
  45771. renderHeight: number;
  45772. /**
  45773. * Texture size (Default: 512)
  45774. */
  45775. textureSize: number;
  45776. /**
  45777. * If delta time between frames should be constant
  45778. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45779. */
  45780. deterministicLockstep: boolean;
  45781. /**
  45782. * Maximum about of steps between frames (Default: 4)
  45783. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45784. */
  45785. lockstepMaxSteps: number;
  45786. }
  45787. /**
  45788. * The null engine class provides support for headless version of babylon.js.
  45789. * This can be used in server side scenario or for testing purposes
  45790. */
  45791. export class NullEngine extends Engine {
  45792. private _options;
  45793. /**
  45794. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  45795. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45796. * @returns true if engine is in deterministic lock step mode
  45797. */
  45798. isDeterministicLockStep(): boolean;
  45799. /**
  45800. * Gets the max steps when engine is running in deterministic lock step
  45801. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45802. * @returns the max steps
  45803. */
  45804. getLockstepMaxSteps(): number;
  45805. /**
  45806. * Gets the current hardware scaling level.
  45807. * By default the hardware scaling level is computed from the window device ratio.
  45808. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  45809. * @returns a number indicating the current hardware scaling level
  45810. */
  45811. getHardwareScalingLevel(): number;
  45812. constructor(options?: NullEngineOptions);
  45813. /**
  45814. * Creates a vertex buffer
  45815. * @param vertices the data for the vertex buffer
  45816. * @returns the new WebGL static buffer
  45817. */
  45818. createVertexBuffer(vertices: FloatArray): DataBuffer;
  45819. /**
  45820. * Creates a new index buffer
  45821. * @param indices defines the content of the index buffer
  45822. * @param updatable defines if the index buffer must be updatable
  45823. * @returns a new webGL buffer
  45824. */
  45825. createIndexBuffer(indices: IndicesArray): DataBuffer;
  45826. /**
  45827. * Clear the current render buffer or the current render target (if any is set up)
  45828. * @param color defines the color to use
  45829. * @param backBuffer defines if the back buffer must be cleared
  45830. * @param depth defines if the depth buffer must be cleared
  45831. * @param stencil defines if the stencil buffer must be cleared
  45832. */
  45833. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  45834. /**
  45835. * Gets the current render width
  45836. * @param useScreen defines if screen size must be used (or the current render target if any)
  45837. * @returns a number defining the current render width
  45838. */
  45839. getRenderWidth(useScreen?: boolean): number;
  45840. /**
  45841. * Gets the current render height
  45842. * @param useScreen defines if screen size must be used (or the current render target if any)
  45843. * @returns a number defining the current render height
  45844. */
  45845. getRenderHeight(useScreen?: boolean): number;
  45846. /**
  45847. * Set the WebGL's viewport
  45848. * @param viewport defines the viewport element to be used
  45849. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  45850. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  45851. */
  45852. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  45853. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  45854. /**
  45855. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  45856. * @param pipelineContext defines the pipeline context to use
  45857. * @param uniformsNames defines the list of uniform names
  45858. * @returns an array of webGL uniform locations
  45859. */
  45860. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  45861. /**
  45862. * Gets the lsit of active attributes for a given webGL program
  45863. * @param pipelineContext defines the pipeline context to use
  45864. * @param attributesNames defines the list of attribute names to get
  45865. * @returns an array of indices indicating the offset of each attribute
  45866. */
  45867. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  45868. /**
  45869. * Binds an effect to the webGL context
  45870. * @param effect defines the effect to bind
  45871. */
  45872. bindSamplers(effect: Effect): void;
  45873. /**
  45874. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  45875. * @param effect defines the effect to activate
  45876. */
  45877. enableEffect(effect: Effect): void;
  45878. /**
  45879. * Set various states to the webGL context
  45880. * @param culling defines backface culling state
  45881. * @param zOffset defines the value to apply to zOffset (0 by default)
  45882. * @param force defines if states must be applied even if cache is up to date
  45883. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  45884. */
  45885. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  45886. /**
  45887. * Set the value of an uniform to an array of int32
  45888. * @param uniform defines the webGL uniform location where to store the value
  45889. * @param array defines the array of int32 to store
  45890. */
  45891. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  45892. /**
  45893. * Set the value of an uniform to an array of int32 (stored as vec2)
  45894. * @param uniform defines the webGL uniform location where to store the value
  45895. * @param array defines the array of int32 to store
  45896. */
  45897. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  45898. /**
  45899. * Set the value of an uniform to an array of int32 (stored as vec3)
  45900. * @param uniform defines the webGL uniform location where to store the value
  45901. * @param array defines the array of int32 to store
  45902. */
  45903. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  45904. /**
  45905. * Set the value of an uniform to an array of int32 (stored as vec4)
  45906. * @param uniform defines the webGL uniform location where to store the value
  45907. * @param array defines the array of int32 to store
  45908. */
  45909. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  45910. /**
  45911. * Set the value of an uniform to an array of float32
  45912. * @param uniform defines the webGL uniform location where to store the value
  45913. * @param array defines the array of float32 to store
  45914. */
  45915. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  45916. /**
  45917. * Set the value of an uniform to an array of float32 (stored as vec2)
  45918. * @param uniform defines the webGL uniform location where to store the value
  45919. * @param array defines the array of float32 to store
  45920. */
  45921. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  45922. /**
  45923. * Set the value of an uniform to an array of float32 (stored as vec3)
  45924. * @param uniform defines the webGL uniform location where to store the value
  45925. * @param array defines the array of float32 to store
  45926. */
  45927. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  45928. /**
  45929. * Set the value of an uniform to an array of float32 (stored as vec4)
  45930. * @param uniform defines the webGL uniform location where to store the value
  45931. * @param array defines the array of float32 to store
  45932. */
  45933. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  45934. /**
  45935. * Set the value of an uniform to an array of number
  45936. * @param uniform defines the webGL uniform location where to store the value
  45937. * @param array defines the array of number to store
  45938. */
  45939. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  45940. /**
  45941. * Set the value of an uniform to an array of number (stored as vec2)
  45942. * @param uniform defines the webGL uniform location where to store the value
  45943. * @param array defines the array of number to store
  45944. */
  45945. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  45946. /**
  45947. * Set the value of an uniform to an array of number (stored as vec3)
  45948. * @param uniform defines the webGL uniform location where to store the value
  45949. * @param array defines the array of number to store
  45950. */
  45951. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  45952. /**
  45953. * Set the value of an uniform to an array of number (stored as vec4)
  45954. * @param uniform defines the webGL uniform location where to store the value
  45955. * @param array defines the array of number to store
  45956. */
  45957. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  45958. /**
  45959. * Set the value of an uniform to an array of float32 (stored as matrices)
  45960. * @param uniform defines the webGL uniform location where to store the value
  45961. * @param matrices defines the array of float32 to store
  45962. */
  45963. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  45964. /**
  45965. * Set the value of an uniform to a matrix (3x3)
  45966. * @param uniform defines the webGL uniform location where to store the value
  45967. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  45968. */
  45969. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45970. /**
  45971. * Set the value of an uniform to a matrix (2x2)
  45972. * @param uniform defines the webGL uniform location where to store the value
  45973. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  45974. */
  45975. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  45976. /**
  45977. * Set the value of an uniform to a number (float)
  45978. * @param uniform defines the webGL uniform location where to store the value
  45979. * @param value defines the float number to store
  45980. */
  45981. setFloat(uniform: WebGLUniformLocation, value: number): void;
  45982. /**
  45983. * Set the value of an uniform to a vec2
  45984. * @param uniform defines the webGL uniform location where to store the value
  45985. * @param x defines the 1st component of the value
  45986. * @param y defines the 2nd component of the value
  45987. */
  45988. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  45989. /**
  45990. * Set the value of an uniform to a vec3
  45991. * @param uniform defines the webGL uniform location where to store the value
  45992. * @param x defines the 1st component of the value
  45993. * @param y defines the 2nd component of the value
  45994. * @param z defines the 3rd component of the value
  45995. */
  45996. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  45997. /**
  45998. * Set the value of an uniform to a boolean
  45999. * @param uniform defines the webGL uniform location where to store the value
  46000. * @param bool defines the boolean to store
  46001. */
  46002. setBool(uniform: WebGLUniformLocation, bool: number): void;
  46003. /**
  46004. * Set the value of an uniform to a vec4
  46005. * @param uniform defines the webGL uniform location where to store the value
  46006. * @param x defines the 1st component of the value
  46007. * @param y defines the 2nd component of the value
  46008. * @param z defines the 3rd component of the value
  46009. * @param w defines the 4th component of the value
  46010. */
  46011. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  46012. /**
  46013. * Sets the current alpha mode
  46014. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  46015. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  46016. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  46017. */
  46018. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  46019. /**
  46020. * Bind webGl buffers directly to the webGL context
  46021. * @param vertexBuffers defines the vertex buffer to bind
  46022. * @param indexBuffer defines the index buffer to bind
  46023. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  46024. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  46025. * @param effect defines the effect associated with the vertex buffer
  46026. */
  46027. bindBuffers(vertexBuffers: {
  46028. [key: string]: VertexBuffer;
  46029. }, indexBuffer: DataBuffer, effect: Effect): void;
  46030. /**
  46031. * Force the entire cache to be cleared
  46032. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  46033. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  46034. */
  46035. wipeCaches(bruteForce?: boolean): void;
  46036. /**
  46037. * Send a draw order
  46038. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  46039. * @param indexStart defines the starting index
  46040. * @param indexCount defines the number of index to draw
  46041. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46042. */
  46043. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  46044. /**
  46045. * Draw a list of indexed primitives
  46046. * @param fillMode defines the primitive to use
  46047. * @param indexStart defines the starting index
  46048. * @param indexCount defines the number of index to draw
  46049. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46050. */
  46051. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  46052. /**
  46053. * Draw a list of unindexed primitives
  46054. * @param fillMode defines the primitive to use
  46055. * @param verticesStart defines the index of first vertex to draw
  46056. * @param verticesCount defines the count of vertices to draw
  46057. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46058. */
  46059. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  46060. /** @hidden */
  46061. _createTexture(): WebGLTexture;
  46062. /** @hidden */
  46063. _releaseTexture(texture: InternalTexture): void;
  46064. /**
  46065. * Usually called from Texture.ts.
  46066. * Passed information to create a WebGLTexture
  46067. * @param urlArg defines a value which contains one of the following:
  46068. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  46069. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  46070. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  46071. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  46072. * @param invertY when true, image is flipped when loaded. You probably want true. Certain compressed textures may invert this if their default is inverted (eg. ktx)
  46073. * @param scene needed for loading to the correct scene
  46074. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  46075. * @param onLoad optional callback to be called upon successful completion
  46076. * @param onError optional callback to be called upon failure
  46077. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), HTMLImageElement (image format), or a Blob
  46078. * @param fallBack an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  46079. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  46080. * @param forcedExtension defines the extension to use to pick the right loader
  46081. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  46082. * @returns a InternalTexture for assignment back into BABYLON.Texture
  46083. */
  46084. createTexture(urlArg: string, noMipmap: boolean, invertY: boolean, scene: Scene, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<ArrayBuffer | HTMLImageElement>, fallBack?: InternalTexture, format?: number): InternalTexture;
  46085. /**
  46086. * Creates a new render target texture
  46087. * @param size defines the size of the texture
  46088. * @param options defines the options used to create the texture
  46089. * @returns a new render target texture stored in an InternalTexture
  46090. */
  46091. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  46092. /**
  46093. * Update the sampling mode of a given texture
  46094. * @param samplingMode defines the required sampling mode
  46095. * @param texture defines the texture to update
  46096. */
  46097. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  46098. /**
  46099. * Binds the frame buffer to the specified texture.
  46100. * @param texture The texture to render to or null for the default canvas
  46101. * @param faceIndex The face of the texture to render to in case of cube texture
  46102. * @param requiredWidth The width of the target to render to
  46103. * @param requiredHeight The height of the target to render to
  46104. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  46105. * @param depthStencilTexture The depth stencil texture to use to render
  46106. * @param lodLevel defines le lod level to bind to the frame buffer
  46107. */
  46108. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  46109. /**
  46110. * Unbind the current render target texture from the webGL context
  46111. * @param texture defines the render target texture to unbind
  46112. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  46113. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  46114. */
  46115. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  46116. /**
  46117. * Creates a dynamic vertex buffer
  46118. * @param vertices the data for the dynamic vertex buffer
  46119. * @returns the new WebGL dynamic buffer
  46120. */
  46121. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  46122. /**
  46123. * Update the content of a dynamic texture
  46124. * @param texture defines the texture to update
  46125. * @param canvas defines the canvas containing the source
  46126. * @param invertY defines if data must be stored with Y axis inverted
  46127. * @param premulAlpha defines if alpha is stored as premultiplied
  46128. * @param format defines the format of the data
  46129. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  46130. */
  46131. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  46132. /**
  46133. * Gets a boolean indicating if all created effects are ready
  46134. * @returns true if all effects are ready
  46135. */
  46136. areAllEffectsReady(): boolean;
  46137. /**
  46138. * @hidden
  46139. * Get the current error code of the webGL context
  46140. * @returns the error code
  46141. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  46142. */
  46143. getError(): number;
  46144. /** @hidden */
  46145. _getUnpackAlignement(): number;
  46146. /** @hidden */
  46147. _unpackFlipY(value: boolean): void;
  46148. /**
  46149. * Update a dynamic index buffer
  46150. * @param indexBuffer defines the target index buffer
  46151. * @param indices defines the data to update
  46152. * @param offset defines the offset in the target index buffer where update should start
  46153. */
  46154. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  46155. /**
  46156. * Updates a dynamic vertex buffer.
  46157. * @param vertexBuffer the vertex buffer to update
  46158. * @param vertices the data used to update the vertex buffer
  46159. * @param byteOffset the byte offset of the data (optional)
  46160. * @param byteLength the byte length of the data (optional)
  46161. */
  46162. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  46163. /** @hidden */
  46164. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  46165. /** @hidden */
  46166. _bindTexture(channel: number, texture: InternalTexture): void;
  46167. protected _deleteBuffer(buffer: WebGLBuffer): void;
  46168. /**
  46169. * Force the engine to release all cached effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled
  46170. */
  46171. releaseEffects(): void;
  46172. displayLoadingUI(): void;
  46173. hideLoadingUI(): void;
  46174. /** @hidden */
  46175. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46176. /** @hidden */
  46177. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46178. /** @hidden */
  46179. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46180. /** @hidden */
  46181. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  46182. }
  46183. }
  46184. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  46185. import { Nullable, int } from "babylonjs/types";
  46186. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  46187. /** @hidden */
  46188. export class _OcclusionDataStorage {
  46189. /** @hidden */
  46190. occlusionInternalRetryCounter: number;
  46191. /** @hidden */
  46192. isOcclusionQueryInProgress: boolean;
  46193. /** @hidden */
  46194. isOccluded: boolean;
  46195. /** @hidden */
  46196. occlusionRetryCount: number;
  46197. /** @hidden */
  46198. occlusionType: number;
  46199. /** @hidden */
  46200. occlusionQueryAlgorithmType: number;
  46201. }
  46202. module "babylonjs/Engines/engine" {
  46203. interface Engine {
  46204. /**
  46205. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  46206. * @return the new query
  46207. */
  46208. createQuery(): WebGLQuery;
  46209. /**
  46210. * Delete and release a webGL query
  46211. * @param query defines the query to delete
  46212. * @return the current engine
  46213. */
  46214. deleteQuery(query: WebGLQuery): Engine;
  46215. /**
  46216. * Check if a given query has resolved and got its value
  46217. * @param query defines the query to check
  46218. * @returns true if the query got its value
  46219. */
  46220. isQueryResultAvailable(query: WebGLQuery): boolean;
  46221. /**
  46222. * Gets the value of a given query
  46223. * @param query defines the query to check
  46224. * @returns the value of the query
  46225. */
  46226. getQueryResult(query: WebGLQuery): number;
  46227. /**
  46228. * Initiates an occlusion query
  46229. * @param algorithmType defines the algorithm to use
  46230. * @param query defines the query to use
  46231. * @returns the current engine
  46232. * @see http://doc.babylonjs.com/features/occlusionquery
  46233. */
  46234. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  46235. /**
  46236. * Ends an occlusion query
  46237. * @see http://doc.babylonjs.com/features/occlusionquery
  46238. * @param algorithmType defines the algorithm to use
  46239. * @returns the current engine
  46240. */
  46241. endOcclusionQuery(algorithmType: number): Engine;
  46242. /**
  46243. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  46244. * Please note that only one query can be issued at a time
  46245. * @returns a time token used to track the time span
  46246. */
  46247. startTimeQuery(): Nullable<_TimeToken>;
  46248. /**
  46249. * Ends a time query
  46250. * @param token defines the token used to measure the time span
  46251. * @returns the time spent (in ns)
  46252. */
  46253. endTimeQuery(token: _TimeToken): int;
  46254. /** @hidden */
  46255. _currentNonTimestampToken: Nullable<_TimeToken>;
  46256. /** @hidden */
  46257. _createTimeQuery(): WebGLQuery;
  46258. /** @hidden */
  46259. _deleteTimeQuery(query: WebGLQuery): void;
  46260. /** @hidden */
  46261. _getGlAlgorithmType(algorithmType: number): number;
  46262. /** @hidden */
  46263. _getTimeQueryResult(query: WebGLQuery): any;
  46264. /** @hidden */
  46265. _getTimeQueryAvailability(query: WebGLQuery): any;
  46266. }
  46267. }
  46268. module "babylonjs/Meshes/abstractMesh" {
  46269. interface AbstractMesh {
  46270. /**
  46271. * Backing filed
  46272. * @hidden
  46273. */
  46274. __occlusionDataStorage: _OcclusionDataStorage;
  46275. /**
  46276. * Access property
  46277. * @hidden
  46278. */
  46279. _occlusionDataStorage: _OcclusionDataStorage;
  46280. /**
  46281. * This number indicates the number of allowed retries before stop the occlusion query, this is useful if the occlusion query is taking long time before to the query result is retireved, the query result indicates if the object is visible within the scene or not and based on that Babylon.Js engine decideds to show or hide the object.
  46282. * The default value is -1 which means don't break the query and wait till the result
  46283. * @see http://doc.babylonjs.com/features/occlusionquery
  46284. */
  46285. occlusionRetryCount: number;
  46286. /**
  46287. * This property is responsible for starting the occlusion query within the Mesh or not, this property is also used to determine what should happen when the occlusionRetryCount is reached. It has supports 3 values:
  46288. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  46289. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  46290. * * OCCLUSION_TYPE_STRICT: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken restore the last state of the mesh occlusion if the mesh was visible then show the mesh if was hidden then hide don't show.
  46291. * @see http://doc.babylonjs.com/features/occlusionquery
  46292. */
  46293. occlusionType: number;
  46294. /**
  46295. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  46296. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  46297. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE (Default Value) which is mapped to GL_ANY_SAMPLES_PASSED_CONSERVATIVE which is a false positive algorithm that is faster than GL_ANY_SAMPLES_PASSED but less accurate.
  46298. * @see http://doc.babylonjs.com/features/occlusionquery
  46299. */
  46300. occlusionQueryAlgorithmType: number;
  46301. /**
  46302. * Gets or sets whether the mesh is occluded or not, it is used also to set the intial state of the mesh to be occluded or not
  46303. * @see http://doc.babylonjs.com/features/occlusionquery
  46304. */
  46305. isOccluded: boolean;
  46306. /**
  46307. * Flag to check the progress status of the query
  46308. * @see http://doc.babylonjs.com/features/occlusionquery
  46309. */
  46310. isOcclusionQueryInProgress: boolean;
  46311. }
  46312. }
  46313. }
  46314. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  46315. import { Nullable } from "babylonjs/types";
  46316. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  46317. /** @hidden */
  46318. export var _forceTransformFeedbackToBundle: boolean;
  46319. module "babylonjs/Engines/engine" {
  46320. interface Engine {
  46321. /**
  46322. * Creates a webGL transform feedback object
  46323. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  46324. * @returns the webGL transform feedback object
  46325. */
  46326. createTransformFeedback(): WebGLTransformFeedback;
  46327. /**
  46328. * Delete a webGL transform feedback object
  46329. * @param value defines the webGL transform feedback object to delete
  46330. */
  46331. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  46332. /**
  46333. * Bind a webGL transform feedback object to the webgl context
  46334. * @param value defines the webGL transform feedback object to bind
  46335. */
  46336. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  46337. /**
  46338. * Begins a transform feedback operation
  46339. * @param usePoints defines if points or triangles must be used
  46340. */
  46341. beginTransformFeedback(usePoints: boolean): void;
  46342. /**
  46343. * Ends a transform feedback operation
  46344. */
  46345. endTransformFeedback(): void;
  46346. /**
  46347. * Specify the varyings to use with transform feedback
  46348. * @param program defines the associated webGL program
  46349. * @param value defines the list of strings representing the varying names
  46350. */
  46351. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  46352. /**
  46353. * Bind a webGL buffer for a transform feedback operation
  46354. * @param value defines the webGL buffer to bind
  46355. */
  46356. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  46357. }
  46358. }
  46359. }
  46360. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  46361. import { Scene } from "babylonjs/scene";
  46362. import { Engine } from "babylonjs/Engines/engine";
  46363. import { Texture } from "babylonjs/Materials/Textures/texture";
  46364. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  46365. import "babylonjs/Engines/Extensions/engine.multiRender";
  46366. /**
  46367. * Creation options of the multi render target texture.
  46368. */
  46369. export interface IMultiRenderTargetOptions {
  46370. /**
  46371. * Define if the texture needs to create mip maps after render.
  46372. */
  46373. generateMipMaps?: boolean;
  46374. /**
  46375. * Define the types of all the draw buffers we want to create
  46376. */
  46377. types?: number[];
  46378. /**
  46379. * Define the sampling modes of all the draw buffers we want to create
  46380. */
  46381. samplingModes?: number[];
  46382. /**
  46383. * Define if a depth buffer is required
  46384. */
  46385. generateDepthBuffer?: boolean;
  46386. /**
  46387. * Define if a stencil buffer is required
  46388. */
  46389. generateStencilBuffer?: boolean;
  46390. /**
  46391. * Define if a depth texture is required instead of a depth buffer
  46392. */
  46393. generateDepthTexture?: boolean;
  46394. /**
  46395. * Define the number of desired draw buffers
  46396. */
  46397. textureCount?: number;
  46398. /**
  46399. * Define if aspect ratio should be adapted to the texture or stay the scene one
  46400. */
  46401. doNotChangeAspectRatio?: boolean;
  46402. /**
  46403. * Define the default type of the buffers we are creating
  46404. */
  46405. defaultType?: number;
  46406. }
  46407. /**
  46408. * A multi render target, like a render target provides the ability to render to a texture.
  46409. * Unlike the render target, it can render to several draw buffers in one draw.
  46410. * This is specially interesting in deferred rendering or for any effects requiring more than
  46411. * just one color from a single pass.
  46412. */
  46413. export class MultiRenderTarget extends RenderTargetTexture {
  46414. private _internalTextures;
  46415. private _textures;
  46416. private _multiRenderTargetOptions;
  46417. /**
  46418. * Get if draw buffers are currently supported by the used hardware and browser.
  46419. */
  46420. readonly isSupported: boolean;
  46421. /**
  46422. * Get the list of textures generated by the multi render target.
  46423. */
  46424. readonly textures: Texture[];
  46425. /**
  46426. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  46427. */
  46428. readonly depthTexture: Texture;
  46429. /**
  46430. * Set the wrapping mode on U of all the textures we are rendering to.
  46431. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  46432. */
  46433. wrapU: number;
  46434. /**
  46435. * Set the wrapping mode on V of all the textures we are rendering to.
  46436. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  46437. */
  46438. wrapV: number;
  46439. /**
  46440. * Instantiate a new multi render target texture.
  46441. * A multi render target, like a render target provides the ability to render to a texture.
  46442. * Unlike the render target, it can render to several draw buffers in one draw.
  46443. * This is specially interesting in deferred rendering or for any effects requiring more than
  46444. * just one color from a single pass.
  46445. * @param name Define the name of the texture
  46446. * @param size Define the size of the buffers to render to
  46447. * @param count Define the number of target we are rendering into
  46448. * @param scene Define the scene the texture belongs to
  46449. * @param options Define the options used to create the multi render target
  46450. */
  46451. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  46452. /** @hidden */
  46453. _rebuild(): void;
  46454. private _createInternalTextures;
  46455. private _createTextures;
  46456. /**
  46457. * Define the number of samples used if MSAA is enabled.
  46458. */
  46459. samples: number;
  46460. /**
  46461. * Resize all the textures in the multi render target.
  46462. * Be carrefull as it will recreate all the data in the new texture.
  46463. * @param size Define the new size
  46464. */
  46465. resize(size: any): void;
  46466. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  46467. /**
  46468. * Dispose the render targets and their associated resources
  46469. */
  46470. dispose(): void;
  46471. /**
  46472. * Release all the underlying texture used as draw buffers.
  46473. */
  46474. releaseInternalTextures(): void;
  46475. }
  46476. }
  46477. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  46478. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46479. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  46480. import { Nullable } from "babylonjs/types";
  46481. module "babylonjs/Engines/thinEngine" {
  46482. interface ThinEngine {
  46483. /**
  46484. * Unbind a list of render target textures from the webGL context
  46485. * This is used only when drawBuffer extension or webGL2 are active
  46486. * @param textures defines the render target textures to unbind
  46487. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  46488. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  46489. */
  46490. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  46491. /**
  46492. * Create a multi render target texture
  46493. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  46494. * @param size defines the size of the texture
  46495. * @param options defines the creation options
  46496. * @returns the cube texture as an InternalTexture
  46497. */
  46498. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  46499. /**
  46500. * Update the sample count for a given multiple render target texture
  46501. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  46502. * @param textures defines the textures to update
  46503. * @param samples defines the sample count to set
  46504. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  46505. */
  46506. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  46507. }
  46508. }
  46509. }
  46510. declare module "babylonjs/Engines/Extensions/engine.views" {
  46511. import { Camera } from "babylonjs/Cameras/camera";
  46512. import { Nullable } from "babylonjs/types";
  46513. /**
  46514. * Class used to define an additional view for the engine
  46515. * @see https://doc.babylonjs.com/how_to/multi_canvases
  46516. */
  46517. export class EngineView {
  46518. /** Defines the canvas where to render the view */
  46519. target: HTMLCanvasElement;
  46520. /** Defines an optional camera used to render the view (will use active camera else) */
  46521. camera?: Camera;
  46522. }
  46523. module "babylonjs/Engines/engine" {
  46524. interface Engine {
  46525. /**
  46526. * Gets or sets the HTML element to use for attaching events
  46527. */
  46528. inputElement: Nullable<HTMLElement>;
  46529. /**
  46530. * Gets the current engine view
  46531. * @see https://doc.babylonjs.com/how_to/multi_canvases
  46532. */
  46533. activeView: Nullable<EngineView>;
  46534. /** Gets or sets the list of views */
  46535. views: EngineView[];
  46536. /**
  46537. * Register a new child canvas
  46538. * @param canvas defines the canvas to register
  46539. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  46540. * @returns the associated view
  46541. */
  46542. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  46543. /**
  46544. * Remove a registered child canvas
  46545. * @param canvas defines the canvas to remove
  46546. * @returns the current engine
  46547. */
  46548. unRegisterView(canvas: HTMLCanvasElement): Engine;
  46549. }
  46550. }
  46551. }
  46552. declare module "babylonjs/Engines/Extensions/index" {
  46553. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  46554. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  46555. export * from "babylonjs/Engines/Extensions/engine.multiview";
  46556. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  46557. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  46558. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  46559. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  46560. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  46561. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  46562. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  46563. export * from "babylonjs/Engines/Extensions/engine.webVR";
  46564. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  46565. export * from "babylonjs/Engines/Extensions/engine.views";
  46566. }
  46567. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  46568. import { Nullable } from "babylonjs/types";
  46569. /**
  46570. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  46571. */
  46572. export interface CubeMapInfo {
  46573. /**
  46574. * The pixel array for the front face.
  46575. * This is stored in format, left to right, up to down format.
  46576. */
  46577. front: Nullable<ArrayBufferView>;
  46578. /**
  46579. * The pixel array for the back face.
  46580. * This is stored in format, left to right, up to down format.
  46581. */
  46582. back: Nullable<ArrayBufferView>;
  46583. /**
  46584. * The pixel array for the left face.
  46585. * This is stored in format, left to right, up to down format.
  46586. */
  46587. left: Nullable<ArrayBufferView>;
  46588. /**
  46589. * The pixel array for the right face.
  46590. * This is stored in format, left to right, up to down format.
  46591. */
  46592. right: Nullable<ArrayBufferView>;
  46593. /**
  46594. * The pixel array for the up face.
  46595. * This is stored in format, left to right, up to down format.
  46596. */
  46597. up: Nullable<ArrayBufferView>;
  46598. /**
  46599. * The pixel array for the down face.
  46600. * This is stored in format, left to right, up to down format.
  46601. */
  46602. down: Nullable<ArrayBufferView>;
  46603. /**
  46604. * The size of the cubemap stored.
  46605. *
  46606. * Each faces will be size * size pixels.
  46607. */
  46608. size: number;
  46609. /**
  46610. * The format of the texture.
  46611. *
  46612. * RGBA, RGB.
  46613. */
  46614. format: number;
  46615. /**
  46616. * The type of the texture data.
  46617. *
  46618. * UNSIGNED_INT, FLOAT.
  46619. */
  46620. type: number;
  46621. /**
  46622. * Specifies whether the texture is in gamma space.
  46623. */
  46624. gammaSpace: boolean;
  46625. }
  46626. /**
  46627. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  46628. */
  46629. export class PanoramaToCubeMapTools {
  46630. private static FACE_FRONT;
  46631. private static FACE_BACK;
  46632. private static FACE_RIGHT;
  46633. private static FACE_LEFT;
  46634. private static FACE_DOWN;
  46635. private static FACE_UP;
  46636. /**
  46637. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  46638. *
  46639. * @param float32Array The source data.
  46640. * @param inputWidth The width of the input panorama.
  46641. * @param inputHeight The height of the input panorama.
  46642. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  46643. * @return The cubemap data
  46644. */
  46645. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  46646. private static CreateCubemapTexture;
  46647. private static CalcProjectionSpherical;
  46648. }
  46649. }
  46650. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  46651. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46652. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46653. import { Nullable } from "babylonjs/types";
  46654. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  46655. /**
  46656. * Helper class dealing with the extraction of spherical polynomial dataArray
  46657. * from a cube map.
  46658. */
  46659. export class CubeMapToSphericalPolynomialTools {
  46660. private static FileFaces;
  46661. /**
  46662. * Converts a texture to the according Spherical Polynomial data.
  46663. * This extracts the first 3 orders only as they are the only one used in the lighting.
  46664. *
  46665. * @param texture The texture to extract the information from.
  46666. * @return The Spherical Polynomial data.
  46667. */
  46668. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  46669. /**
  46670. * Converts a cubemap to the according Spherical Polynomial data.
  46671. * This extracts the first 3 orders only as they are the only one used in the lighting.
  46672. *
  46673. * @param cubeInfo The Cube map to extract the information from.
  46674. * @return The Spherical Polynomial data.
  46675. */
  46676. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  46677. }
  46678. }
  46679. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  46680. import { Nullable } from "babylonjs/types";
  46681. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46682. module "babylonjs/Materials/Textures/baseTexture" {
  46683. interface BaseTexture {
  46684. /**
  46685. * Get the polynomial representation of the texture data.
  46686. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  46687. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  46688. */
  46689. sphericalPolynomial: Nullable<SphericalPolynomial>;
  46690. }
  46691. }
  46692. }
  46693. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  46694. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46695. /** @hidden */
  46696. export var rgbdEncodePixelShader: {
  46697. name: string;
  46698. shader: string;
  46699. };
  46700. }
  46701. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  46702. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46703. /** @hidden */
  46704. export var rgbdDecodePixelShader: {
  46705. name: string;
  46706. shader: string;
  46707. };
  46708. }
  46709. declare module "babylonjs/Misc/environmentTextureTools" {
  46710. import { Nullable } from "babylonjs/types";
  46711. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46712. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46713. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  46714. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  46715. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  46716. import "babylonjs/Shaders/rgbdEncode.fragment";
  46717. import "babylonjs/Shaders/rgbdDecode.fragment";
  46718. /**
  46719. * Raw texture data and descriptor sufficient for WebGL texture upload
  46720. */
  46721. export interface EnvironmentTextureInfo {
  46722. /**
  46723. * Version of the environment map
  46724. */
  46725. version: number;
  46726. /**
  46727. * Width of image
  46728. */
  46729. width: number;
  46730. /**
  46731. * Irradiance information stored in the file.
  46732. */
  46733. irradiance: any;
  46734. /**
  46735. * Specular information stored in the file.
  46736. */
  46737. specular: any;
  46738. }
  46739. /**
  46740. * Defines One Image in the file. It requires only the position in the file
  46741. * as well as the length.
  46742. */
  46743. interface BufferImageData {
  46744. /**
  46745. * Length of the image data.
  46746. */
  46747. length: number;
  46748. /**
  46749. * Position of the data from the null terminator delimiting the end of the JSON.
  46750. */
  46751. position: number;
  46752. }
  46753. /**
  46754. * Defines the specular data enclosed in the file.
  46755. * This corresponds to the version 1 of the data.
  46756. */
  46757. export interface EnvironmentTextureSpecularInfoV1 {
  46758. /**
  46759. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  46760. */
  46761. specularDataPosition?: number;
  46762. /**
  46763. * This contains all the images data needed to reconstruct the cubemap.
  46764. */
  46765. mipmaps: Array<BufferImageData>;
  46766. /**
  46767. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  46768. */
  46769. lodGenerationScale: number;
  46770. }
  46771. /**
  46772. * Sets of helpers addressing the serialization and deserialization of environment texture
  46773. * stored in a BabylonJS env file.
  46774. * Those files are usually stored as .env files.
  46775. */
  46776. export class EnvironmentTextureTools {
  46777. /**
  46778. * Magic number identifying the env file.
  46779. */
  46780. private static _MagicBytes;
  46781. /**
  46782. * Gets the environment info from an env file.
  46783. * @param data The array buffer containing the .env bytes.
  46784. * @returns the environment file info (the json header) if successfully parsed.
  46785. */
  46786. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  46787. /**
  46788. * Creates an environment texture from a loaded cube texture.
  46789. * @param texture defines the cube texture to convert in env file
  46790. * @return a promise containing the environment data if succesfull.
  46791. */
  46792. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  46793. /**
  46794. * Creates a JSON representation of the spherical data.
  46795. * @param texture defines the texture containing the polynomials
  46796. * @return the JSON representation of the spherical info
  46797. */
  46798. private static _CreateEnvTextureIrradiance;
  46799. /**
  46800. * Creates the ArrayBufferViews used for initializing environment texture image data.
  46801. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  46802. * @param info parameters that determine what views will be created for accessing the underlying buffer
  46803. * @return the views described by info providing access to the underlying buffer
  46804. */
  46805. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  46806. /**
  46807. * Uploads the texture info contained in the env file to the GPU.
  46808. * @param texture defines the internal texture to upload to
  46809. * @param arrayBuffer defines the buffer cotaining the data to load
  46810. * @param info defines the texture info retrieved through the GetEnvInfo method
  46811. * @returns a promise
  46812. */
  46813. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  46814. private static _OnImageReadyAsync;
  46815. /**
  46816. * Uploads the levels of image data to the GPU.
  46817. * @param texture defines the internal texture to upload to
  46818. * @param imageData defines the array buffer views of image data [mipmap][face]
  46819. * @returns a promise
  46820. */
  46821. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  46822. /**
  46823. * Uploads spherical polynomials information to the texture.
  46824. * @param texture defines the texture we are trying to upload the information to
  46825. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  46826. */
  46827. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  46828. /** @hidden */
  46829. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  46830. }
  46831. }
  46832. declare module "babylonjs/Maths/math.vertexFormat" {
  46833. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  46834. /**
  46835. * Contains position and normal vectors for a vertex
  46836. */
  46837. export class PositionNormalVertex {
  46838. /** the position of the vertex (defaut: 0,0,0) */
  46839. position: Vector3;
  46840. /** the normal of the vertex (defaut: 0,1,0) */
  46841. normal: Vector3;
  46842. /**
  46843. * Creates a PositionNormalVertex
  46844. * @param position the position of the vertex (defaut: 0,0,0)
  46845. * @param normal the normal of the vertex (defaut: 0,1,0)
  46846. */
  46847. constructor(
  46848. /** the position of the vertex (defaut: 0,0,0) */
  46849. position?: Vector3,
  46850. /** the normal of the vertex (defaut: 0,1,0) */
  46851. normal?: Vector3);
  46852. /**
  46853. * Clones the PositionNormalVertex
  46854. * @returns the cloned PositionNormalVertex
  46855. */
  46856. clone(): PositionNormalVertex;
  46857. }
  46858. /**
  46859. * Contains position, normal and uv vectors for a vertex
  46860. */
  46861. export class PositionNormalTextureVertex {
  46862. /** the position of the vertex (defaut: 0,0,0) */
  46863. position: Vector3;
  46864. /** the normal of the vertex (defaut: 0,1,0) */
  46865. normal: Vector3;
  46866. /** the uv of the vertex (default: 0,0) */
  46867. uv: Vector2;
  46868. /**
  46869. * Creates a PositionNormalTextureVertex
  46870. * @param position the position of the vertex (defaut: 0,0,0)
  46871. * @param normal the normal of the vertex (defaut: 0,1,0)
  46872. * @param uv the uv of the vertex (default: 0,0)
  46873. */
  46874. constructor(
  46875. /** the position of the vertex (defaut: 0,0,0) */
  46876. position?: Vector3,
  46877. /** the normal of the vertex (defaut: 0,1,0) */
  46878. normal?: Vector3,
  46879. /** the uv of the vertex (default: 0,0) */
  46880. uv?: Vector2);
  46881. /**
  46882. * Clones the PositionNormalTextureVertex
  46883. * @returns the cloned PositionNormalTextureVertex
  46884. */
  46885. clone(): PositionNormalTextureVertex;
  46886. }
  46887. }
  46888. declare module "babylonjs/Maths/math" {
  46889. export * from "babylonjs/Maths/math.axis";
  46890. export * from "babylonjs/Maths/math.color";
  46891. export * from "babylonjs/Maths/math.constants";
  46892. export * from "babylonjs/Maths/math.frustum";
  46893. export * from "babylonjs/Maths/math.path";
  46894. export * from "babylonjs/Maths/math.plane";
  46895. export * from "babylonjs/Maths/math.size";
  46896. export * from "babylonjs/Maths/math.vector";
  46897. export * from "babylonjs/Maths/math.vertexFormat";
  46898. export * from "babylonjs/Maths/math.viewport";
  46899. }
  46900. declare module "babylonjs/Engines/Native/nativeShaderProcessor" {
  46901. import { WebGL2ShaderProcessor } from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  46902. /** @hidden */
  46903. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  46904. private _genericAttributeLocation;
  46905. private _varyingLocationCount;
  46906. private _varyingLocationMap;
  46907. private _replacements;
  46908. private _textureCount;
  46909. private _uniforms;
  46910. lineProcessor(line: string): string;
  46911. attributeProcessor(attribute: string): string;
  46912. varyingProcessor(varying: string, isFragment: boolean): string;
  46913. uniformProcessor(uniform: string): string;
  46914. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  46915. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  46916. }
  46917. }
  46918. declare module "babylonjs/Engines/nativeEngine" {
  46919. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  46920. import { Engine } from "babylonjs/Engines/engine";
  46921. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  46922. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46923. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46924. import { Effect } from "babylonjs/Materials/effect";
  46925. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  46926. import { Color4, Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  46927. import { Scene } from "babylonjs/scene";
  46928. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  46929. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  46930. /**
  46931. * Container for accessors for natively-stored mesh data buffers.
  46932. */
  46933. class NativeDataBuffer extends DataBuffer {
  46934. /**
  46935. * Accessor value used to identify/retrieve a natively-stored index buffer.
  46936. */
  46937. nativeIndexBuffer?: any;
  46938. /**
  46939. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  46940. */
  46941. nativeVertexBuffer?: any;
  46942. }
  46943. /** @hidden */
  46944. class NativeTexture extends InternalTexture {
  46945. getInternalTexture(): InternalTexture;
  46946. getViewCount(): number;
  46947. }
  46948. /** @hidden */
  46949. export class NativeEngine extends Engine {
  46950. private readonly _native;
  46951. getHardwareScalingLevel(): number;
  46952. constructor();
  46953. /**
  46954. * Can be used to override the current requestAnimationFrame requester.
  46955. * @hidden
  46956. */
  46957. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  46958. /**
  46959. * Override default engine behavior.
  46960. * @param color
  46961. * @param backBuffer
  46962. * @param depth
  46963. * @param stencil
  46964. */
  46965. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  46966. clear(color: Color4, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  46967. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  46968. createVertexBuffer(data: DataArray): NativeDataBuffer;
  46969. recordVertexArrayObject(vertexBuffers: {
  46970. [key: string]: VertexBuffer;
  46971. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  46972. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  46973. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  46974. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  46975. /**
  46976. * Draw a list of indexed primitives
  46977. * @param fillMode defines the primitive to use
  46978. * @param indexStart defines the starting index
  46979. * @param indexCount defines the number of index to draw
  46980. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46981. */
  46982. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  46983. /**
  46984. * Draw a list of unindexed primitives
  46985. * @param fillMode defines the primitive to use
  46986. * @param verticesStart defines the index of first vertex to draw
  46987. * @param verticesCount defines the count of vertices to draw
  46988. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46989. */
  46990. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  46991. createPipelineContext(): IPipelineContext;
  46992. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  46993. /** @hidden */
  46994. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  46995. /** @hidden */
  46996. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  46997. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  46998. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  46999. protected _setProgram(program: WebGLProgram): void;
  47000. _releaseEffect(effect: Effect): void;
  47001. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  47002. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  47003. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  47004. bindSamplers(effect: Effect): void;
  47005. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  47006. getRenderWidth(useScreen?: boolean): number;
  47007. getRenderHeight(useScreen?: boolean): number;
  47008. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  47009. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  47010. /**
  47011. * Set the z offset to apply to current rendering
  47012. * @param value defines the offset to apply
  47013. */
  47014. setZOffset(value: number): void;
  47015. /**
  47016. * Gets the current value of the zOffset
  47017. * @returns the current zOffset state
  47018. */
  47019. getZOffset(): number;
  47020. /**
  47021. * Enable or disable depth buffering
  47022. * @param enable defines the state to set
  47023. */
  47024. setDepthBuffer(enable: boolean): void;
  47025. /**
  47026. * Gets a boolean indicating if depth writing is enabled
  47027. * @returns the current depth writing state
  47028. */
  47029. getDepthWrite(): boolean;
  47030. /**
  47031. * Enable or disable depth writing
  47032. * @param enable defines the state to set
  47033. */
  47034. setDepthWrite(enable: boolean): void;
  47035. /**
  47036. * Enable or disable color writing
  47037. * @param enable defines the state to set
  47038. */
  47039. setColorWrite(enable: boolean): void;
  47040. /**
  47041. * Gets a boolean indicating if color writing is enabled
  47042. * @returns the current color writing state
  47043. */
  47044. getColorWrite(): boolean;
  47045. /**
  47046. * Sets alpha constants used by some alpha blending modes
  47047. * @param r defines the red component
  47048. * @param g defines the green component
  47049. * @param b defines the blue component
  47050. * @param a defines the alpha component
  47051. */
  47052. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  47053. /**
  47054. * Sets the current alpha mode
  47055. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  47056. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  47057. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  47058. */
  47059. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  47060. /**
  47061. * Gets the current alpha mode
  47062. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  47063. * @returns the current alpha mode
  47064. */
  47065. getAlphaMode(): number;
  47066. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  47067. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  47068. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  47069. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  47070. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  47071. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  47072. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  47073. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  47074. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  47075. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  47076. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  47077. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  47078. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  47079. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  47080. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  47081. setFloat(uniform: WebGLUniformLocation, value: number): void;
  47082. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  47083. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  47084. setBool(uniform: WebGLUniformLocation, bool: number): void;
  47085. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  47086. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  47087. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  47088. wipeCaches(bruteForce?: boolean): void;
  47089. _createTexture(): WebGLTexture;
  47090. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  47091. /**
  47092. * Usually called from BABYLON.Texture.ts.
  47093. * Passed information to create a WebGLTexture
  47094. * @param urlArg defines a value which contains one of the following:
  47095. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  47096. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  47097. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  47098. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  47099. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  47100. * @param scene needed for loading to the correct scene
  47101. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  47102. * @param onLoad optional callback to be called upon successful completion
  47103. * @param onError optional callback to be called upon failure
  47104. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  47105. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  47106. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  47107. * @param forcedExtension defines the extension to use to pick the right loader
  47108. * @returns a InternalTexture for assignment back into BABYLON.Texture
  47109. */
  47110. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<Scene>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>): InternalTexture;
  47111. /**
  47112. * Creates a cube texture
  47113. * @param rootUrl defines the url where the files to load is located
  47114. * @param scene defines the current scene
  47115. * @param files defines the list of files to load (1 per face)
  47116. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  47117. * @param onLoad defines an optional callback raised when the texture is loaded
  47118. * @param onError defines an optional callback raised if there is an issue to load the texture
  47119. * @param format defines the format of the data
  47120. * @param forcedExtension defines the extension to use to pick the right loader
  47121. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  47122. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  47123. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  47124. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  47125. * @returns the cube texture as an InternalTexture
  47126. */
  47127. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap?: boolean, onLoad?: Nullable<(data?: any) => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number, fallback?: Nullable<InternalTexture>): InternalTexture;
  47128. private _getSamplingFilter;
  47129. private static _GetNativeTextureFormat;
  47130. createRenderTargetTexture(size: number | {
  47131. width: number;
  47132. height: number;
  47133. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  47134. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  47135. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  47136. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  47137. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  47138. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  47139. /**
  47140. * Updates a dynamic vertex buffer.
  47141. * @param vertexBuffer the vertex buffer to update
  47142. * @param data the data used to update the vertex buffer
  47143. * @param byteOffset the byte offset of the data (optional)
  47144. * @param byteLength the byte length of the data (optional)
  47145. */
  47146. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  47147. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  47148. private _updateAnisotropicLevel;
  47149. private _getAddressMode;
  47150. /** @hidden */
  47151. _bindTexture(channel: number, texture: InternalTexture): void;
  47152. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  47153. releaseEffects(): void;
  47154. /** @hidden */
  47155. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  47156. /** @hidden */
  47157. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  47158. /** @hidden */
  47159. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  47160. /** @hidden */
  47161. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  47162. }
  47163. }
  47164. declare module "babylonjs/Engines/index" {
  47165. export * from "babylonjs/Engines/constants";
  47166. export * from "babylonjs/Engines/engineCapabilities";
  47167. export * from "babylonjs/Engines/instancingAttributeInfo";
  47168. export * from "babylonjs/Engines/thinEngine";
  47169. export * from "babylonjs/Engines/engine";
  47170. export * from "babylonjs/Engines/engineStore";
  47171. export * from "babylonjs/Engines/nullEngine";
  47172. export * from "babylonjs/Engines/Extensions/index";
  47173. export * from "babylonjs/Engines/IPipelineContext";
  47174. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  47175. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  47176. export * from "babylonjs/Engines/nativeEngine";
  47177. }
  47178. declare module "babylonjs/Events/clipboardEvents" {
  47179. /**
  47180. * Gather the list of clipboard event types as constants.
  47181. */
  47182. export class ClipboardEventTypes {
  47183. /**
  47184. * The clipboard event is fired when a copy command is active (pressed).
  47185. */
  47186. static readonly COPY: number;
  47187. /**
  47188. * The clipboard event is fired when a cut command is active (pressed).
  47189. */
  47190. static readonly CUT: number;
  47191. /**
  47192. * The clipboard event is fired when a paste command is active (pressed).
  47193. */
  47194. static readonly PASTE: number;
  47195. }
  47196. /**
  47197. * This class is used to store clipboard related info for the onClipboardObservable event.
  47198. */
  47199. export class ClipboardInfo {
  47200. /**
  47201. * Defines the type of event (BABYLON.ClipboardEventTypes)
  47202. */
  47203. type: number;
  47204. /**
  47205. * Defines the related dom event
  47206. */
  47207. event: ClipboardEvent;
  47208. /**
  47209. *Creates an instance of ClipboardInfo.
  47210. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  47211. * @param event Defines the related dom event
  47212. */
  47213. constructor(
  47214. /**
  47215. * Defines the type of event (BABYLON.ClipboardEventTypes)
  47216. */
  47217. type: number,
  47218. /**
  47219. * Defines the related dom event
  47220. */
  47221. event: ClipboardEvent);
  47222. /**
  47223. * Get the clipboard event's type from the keycode.
  47224. * @param keyCode Defines the keyCode for the current keyboard event.
  47225. * @return {number}
  47226. */
  47227. static GetTypeFromCharacter(keyCode: number): number;
  47228. }
  47229. }
  47230. declare module "babylonjs/Events/index" {
  47231. export * from "babylonjs/Events/keyboardEvents";
  47232. export * from "babylonjs/Events/pointerEvents";
  47233. export * from "babylonjs/Events/clipboardEvents";
  47234. }
  47235. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  47236. import { Scene } from "babylonjs/scene";
  47237. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47238. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  47239. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  47240. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47241. /**
  47242. * Google Daydream controller
  47243. */
  47244. export class DaydreamController extends WebVRController {
  47245. /**
  47246. * Base Url for the controller model.
  47247. */
  47248. static MODEL_BASE_URL: string;
  47249. /**
  47250. * File name for the controller model.
  47251. */
  47252. static MODEL_FILENAME: string;
  47253. /**
  47254. * Gamepad Id prefix used to identify Daydream Controller.
  47255. */
  47256. static readonly GAMEPAD_ID_PREFIX: string;
  47257. /**
  47258. * Creates a new DaydreamController from a gamepad
  47259. * @param vrGamepad the gamepad that the controller should be created from
  47260. */
  47261. constructor(vrGamepad: any);
  47262. /**
  47263. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  47264. * @param scene scene in which to add meshes
  47265. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  47266. */
  47267. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  47268. /**
  47269. * Called once for each button that changed state since the last frame
  47270. * @param buttonIdx Which button index changed
  47271. * @param state New state of the button
  47272. * @param changes Which properties on the state changed since last frame
  47273. */
  47274. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  47275. }
  47276. }
  47277. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  47278. import { Scene } from "babylonjs/scene";
  47279. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47280. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  47281. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  47282. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47283. /**
  47284. * Gear VR Controller
  47285. */
  47286. export class GearVRController extends WebVRController {
  47287. /**
  47288. * Base Url for the controller model.
  47289. */
  47290. static MODEL_BASE_URL: string;
  47291. /**
  47292. * File name for the controller model.
  47293. */
  47294. static MODEL_FILENAME: string;
  47295. /**
  47296. * Gamepad Id prefix used to identify this controller.
  47297. */
  47298. static readonly GAMEPAD_ID_PREFIX: string;
  47299. private readonly _buttonIndexToObservableNameMap;
  47300. /**
  47301. * Creates a new GearVRController from a gamepad
  47302. * @param vrGamepad the gamepad that the controller should be created from
  47303. */
  47304. constructor(vrGamepad: any);
  47305. /**
  47306. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  47307. * @param scene scene in which to add meshes
  47308. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  47309. */
  47310. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  47311. /**
  47312. * Called once for each button that changed state since the last frame
  47313. * @param buttonIdx Which button index changed
  47314. * @param state New state of the button
  47315. * @param changes Which properties on the state changed since last frame
  47316. */
  47317. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  47318. }
  47319. }
  47320. declare module "babylonjs/Gamepads/Controllers/index" {
  47321. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  47322. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  47323. export * from "babylonjs/Gamepads/Controllers/genericController";
  47324. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  47325. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47326. export * from "babylonjs/Gamepads/Controllers/viveController";
  47327. export * from "babylonjs/Gamepads/Controllers/webVRController";
  47328. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  47329. }
  47330. declare module "babylonjs/Gamepads/index" {
  47331. export * from "babylonjs/Gamepads/Controllers/index";
  47332. export * from "babylonjs/Gamepads/gamepad";
  47333. export * from "babylonjs/Gamepads/gamepadManager";
  47334. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  47335. export * from "babylonjs/Gamepads/xboxGamepad";
  47336. export * from "babylonjs/Gamepads/dualShockGamepad";
  47337. }
  47338. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  47339. import { Scene } from "babylonjs/scene";
  47340. import { Vector4 } from "babylonjs/Maths/math.vector";
  47341. import { Color4 } from "babylonjs/Maths/math.color";
  47342. import { Mesh } from "babylonjs/Meshes/mesh";
  47343. import { Nullable } from "babylonjs/types";
  47344. /**
  47345. * Class containing static functions to help procedurally build meshes
  47346. */
  47347. export class PolyhedronBuilder {
  47348. /**
  47349. * Creates a polyhedron mesh
  47350. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  47351. * * The parameter `size` (positive float, default 1) sets the polygon size
  47352. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  47353. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  47354. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  47355. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  47356. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  47357. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  47358. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  47359. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  47360. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  47361. * @param name defines the name of the mesh
  47362. * @param options defines the options used to create the mesh
  47363. * @param scene defines the hosting scene
  47364. * @returns the polyhedron mesh
  47365. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  47366. */
  47367. static CreatePolyhedron(name: string, options: {
  47368. type?: number;
  47369. size?: number;
  47370. sizeX?: number;
  47371. sizeY?: number;
  47372. sizeZ?: number;
  47373. custom?: any;
  47374. faceUV?: Vector4[];
  47375. faceColors?: Color4[];
  47376. flat?: boolean;
  47377. updatable?: boolean;
  47378. sideOrientation?: number;
  47379. frontUVs?: Vector4;
  47380. backUVs?: Vector4;
  47381. }, scene?: Nullable<Scene>): Mesh;
  47382. }
  47383. }
  47384. declare module "babylonjs/Gizmos/scaleGizmo" {
  47385. import { Observable } from "babylonjs/Misc/observable";
  47386. import { Nullable } from "babylonjs/types";
  47387. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47388. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47389. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  47390. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47391. /**
  47392. * Gizmo that enables scaling a mesh along 3 axis
  47393. */
  47394. export class ScaleGizmo extends Gizmo {
  47395. /**
  47396. * Internal gizmo used for interactions on the x axis
  47397. */
  47398. xGizmo: AxisScaleGizmo;
  47399. /**
  47400. * Internal gizmo used for interactions on the y axis
  47401. */
  47402. yGizmo: AxisScaleGizmo;
  47403. /**
  47404. * Internal gizmo used for interactions on the z axis
  47405. */
  47406. zGizmo: AxisScaleGizmo;
  47407. /**
  47408. * Internal gizmo used to scale all axis equally
  47409. */
  47410. uniformScaleGizmo: AxisScaleGizmo;
  47411. private _meshAttached;
  47412. private _updateGizmoRotationToMatchAttachedMesh;
  47413. private _snapDistance;
  47414. private _scaleRatio;
  47415. private _uniformScalingMesh;
  47416. private _octahedron;
  47417. /** Fires an event when any of it's sub gizmos are dragged */
  47418. onDragStartObservable: Observable<unknown>;
  47419. /** Fires an event when any of it's sub gizmos are released from dragging */
  47420. onDragEndObservable: Observable<unknown>;
  47421. attachedMesh: Nullable<AbstractMesh>;
  47422. /**
  47423. * Creates a ScaleGizmo
  47424. * @param gizmoLayer The utility layer the gizmo will be added to
  47425. */
  47426. constructor(gizmoLayer?: UtilityLayerRenderer);
  47427. updateGizmoRotationToMatchAttachedMesh: boolean;
  47428. /**
  47429. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47430. */
  47431. snapDistance: number;
  47432. /**
  47433. * Ratio for the scale of the gizmo (Default: 1)
  47434. */
  47435. scaleRatio: number;
  47436. /**
  47437. * Disposes of the gizmo
  47438. */
  47439. dispose(): void;
  47440. }
  47441. }
  47442. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  47443. import { Observable } from "babylonjs/Misc/observable";
  47444. import { Nullable } from "babylonjs/types";
  47445. import { Vector3 } from "babylonjs/Maths/math.vector";
  47446. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47447. import { Mesh } from "babylonjs/Meshes/mesh";
  47448. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  47449. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47450. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47451. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  47452. import { Color3 } from "babylonjs/Maths/math.color";
  47453. /**
  47454. * Single axis scale gizmo
  47455. */
  47456. export class AxisScaleGizmo extends Gizmo {
  47457. /**
  47458. * Drag behavior responsible for the gizmos dragging interactions
  47459. */
  47460. dragBehavior: PointerDragBehavior;
  47461. private _pointerObserver;
  47462. /**
  47463. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47464. */
  47465. snapDistance: number;
  47466. /**
  47467. * Event that fires each time the gizmo snaps to a new location.
  47468. * * snapDistance is the the change in distance
  47469. */
  47470. onSnapObservable: Observable<{
  47471. snapDistance: number;
  47472. }>;
  47473. /**
  47474. * If the scaling operation should be done on all axis (default: false)
  47475. */
  47476. uniformScaling: boolean;
  47477. private _isEnabled;
  47478. private _parent;
  47479. private _arrow;
  47480. private _coloredMaterial;
  47481. private _hoverMaterial;
  47482. /**
  47483. * Creates an AxisScaleGizmo
  47484. * @param gizmoLayer The utility layer the gizmo will be added to
  47485. * @param dragAxis The axis which the gizmo will be able to scale on
  47486. * @param color The color of the gizmo
  47487. */
  47488. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  47489. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47490. /**
  47491. * If the gizmo is enabled
  47492. */
  47493. isEnabled: boolean;
  47494. /**
  47495. * Disposes of the gizmo
  47496. */
  47497. dispose(): void;
  47498. /**
  47499. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  47500. * @param mesh The mesh to replace the default mesh of the gizmo
  47501. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  47502. */
  47503. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  47504. }
  47505. }
  47506. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  47507. import { Observable } from "babylonjs/Misc/observable";
  47508. import { Nullable } from "babylonjs/types";
  47509. import { Vector3 } from "babylonjs/Maths/math.vector";
  47510. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47511. import { Mesh } from "babylonjs/Meshes/mesh";
  47512. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47513. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47514. import { Color3 } from "babylonjs/Maths/math.color";
  47515. import "babylonjs/Meshes/Builders/boxBuilder";
  47516. /**
  47517. * Bounding box gizmo
  47518. */
  47519. export class BoundingBoxGizmo extends Gizmo {
  47520. private _lineBoundingBox;
  47521. private _rotateSpheresParent;
  47522. private _scaleBoxesParent;
  47523. private _boundingDimensions;
  47524. private _renderObserver;
  47525. private _pointerObserver;
  47526. private _scaleDragSpeed;
  47527. private _tmpQuaternion;
  47528. private _tmpVector;
  47529. private _tmpRotationMatrix;
  47530. /**
  47531. * If child meshes should be ignored when calculating the boudning box. This should be set to true to avoid perf hits with heavily nested meshes (Default: false)
  47532. */
  47533. ignoreChildren: boolean;
  47534. /**
  47535. * Returns true if a descendant should be included when computing the bounding box. When null, all descendants are included. If ignoreChildren is set this will be ignored. (Default: null)
  47536. */
  47537. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  47538. /**
  47539. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  47540. */
  47541. rotationSphereSize: number;
  47542. /**
  47543. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  47544. */
  47545. scaleBoxSize: number;
  47546. /**
  47547. * If set, the rotation spheres and scale boxes will increase in size based on the distance away from the camera to have a consistent screen size (Default: false)
  47548. */
  47549. fixedDragMeshScreenSize: boolean;
  47550. /**
  47551. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  47552. */
  47553. fixedDragMeshScreenSizeDistanceFactor: number;
  47554. /**
  47555. * Fired when a rotation sphere or scale box is dragged
  47556. */
  47557. onDragStartObservable: Observable<{}>;
  47558. /**
  47559. * Fired when a scale box is dragged
  47560. */
  47561. onScaleBoxDragObservable: Observable<{}>;
  47562. /**
  47563. * Fired when a scale box drag is ended
  47564. */
  47565. onScaleBoxDragEndObservable: Observable<{}>;
  47566. /**
  47567. * Fired when a rotation sphere is dragged
  47568. */
  47569. onRotationSphereDragObservable: Observable<{}>;
  47570. /**
  47571. * Fired when a rotation sphere drag is ended
  47572. */
  47573. onRotationSphereDragEndObservable: Observable<{}>;
  47574. /**
  47575. * Relative bounding box pivot used when scaling the attached mesh. When null object with scale from the opposite corner. 0.5,0.5,0.5 for center and 0.5,0,0.5 for bottom (Default: null)
  47576. */
  47577. scalePivot: Nullable<Vector3>;
  47578. /**
  47579. * Mesh used as a pivot to rotate the attached mesh
  47580. */
  47581. private _anchorMesh;
  47582. private _existingMeshScale;
  47583. private _dragMesh;
  47584. private pointerDragBehavior;
  47585. private coloredMaterial;
  47586. private hoverColoredMaterial;
  47587. /**
  47588. * Sets the color of the bounding box gizmo
  47589. * @param color the color to set
  47590. */
  47591. setColor(color: Color3): void;
  47592. /**
  47593. * Creates an BoundingBoxGizmo
  47594. * @param gizmoLayer The utility layer the gizmo will be added to
  47595. * @param color The color of the gizmo
  47596. */
  47597. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  47598. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47599. private _selectNode;
  47600. /**
  47601. * Updates the bounding box information for the Gizmo
  47602. */
  47603. updateBoundingBox(): void;
  47604. private _updateRotationSpheres;
  47605. private _updateScaleBoxes;
  47606. /**
  47607. * Enables rotation on the specified axis and disables rotation on the others
  47608. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  47609. */
  47610. setEnabledRotationAxis(axis: string): void;
  47611. /**
  47612. * Enables/disables scaling
  47613. * @param enable if scaling should be enabled
  47614. */
  47615. setEnabledScaling(enable: boolean): void;
  47616. private _updateDummy;
  47617. /**
  47618. * Enables a pointer drag behavior on the bounding box of the gizmo
  47619. */
  47620. enableDragBehavior(): void;
  47621. /**
  47622. * Disposes of the gizmo
  47623. */
  47624. dispose(): void;
  47625. /**
  47626. * Makes a mesh not pickable and wraps the mesh inside of a bounding box mesh that is pickable. (This is useful to avoid picking within complex geometry)
  47627. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  47628. * @returns the bounding box mesh with the passed in mesh as a child
  47629. */
  47630. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  47631. /**
  47632. * CustomMeshes are not supported by this gizmo
  47633. * @param mesh The mesh to replace the default mesh of the gizmo
  47634. */
  47635. setCustomMesh(mesh: Mesh): void;
  47636. }
  47637. }
  47638. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  47639. import { Observable } from "babylonjs/Misc/observable";
  47640. import { Nullable } from "babylonjs/types";
  47641. import { Vector3 } from "babylonjs/Maths/math.vector";
  47642. import { Color3 } from "babylonjs/Maths/math.color";
  47643. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47644. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  47645. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47646. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47647. import "babylonjs/Meshes/Builders/linesBuilder";
  47648. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  47649. /**
  47650. * Single plane rotation gizmo
  47651. */
  47652. export class PlaneRotationGizmo extends Gizmo {
  47653. /**
  47654. * Drag behavior responsible for the gizmos dragging interactions
  47655. */
  47656. dragBehavior: PointerDragBehavior;
  47657. private _pointerObserver;
  47658. /**
  47659. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  47660. */
  47661. snapDistance: number;
  47662. /**
  47663. * Event that fires each time the gizmo snaps to a new location.
  47664. * * snapDistance is the the change in distance
  47665. */
  47666. onSnapObservable: Observable<{
  47667. snapDistance: number;
  47668. }>;
  47669. private _isEnabled;
  47670. private _parent;
  47671. /**
  47672. * Creates a PlaneRotationGizmo
  47673. * @param gizmoLayer The utility layer the gizmo will be added to
  47674. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  47675. * @param color The color of the gizmo
  47676. * @param tessellation Amount of tessellation to be used when creating rotation circles
  47677. * @param useEulerRotation Use and update Euler angle instead of quaternion
  47678. */
  47679. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  47680. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47681. /**
  47682. * If the gizmo is enabled
  47683. */
  47684. isEnabled: boolean;
  47685. /**
  47686. * Disposes of the gizmo
  47687. */
  47688. dispose(): void;
  47689. }
  47690. }
  47691. declare module "babylonjs/Gizmos/rotationGizmo" {
  47692. import { Observable } from "babylonjs/Misc/observable";
  47693. import { Nullable } from "babylonjs/types";
  47694. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47695. import { Mesh } from "babylonjs/Meshes/mesh";
  47696. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47697. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  47698. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47699. /**
  47700. * Gizmo that enables rotating a mesh along 3 axis
  47701. */
  47702. export class RotationGizmo extends Gizmo {
  47703. /**
  47704. * Internal gizmo used for interactions on the x axis
  47705. */
  47706. xGizmo: PlaneRotationGizmo;
  47707. /**
  47708. * Internal gizmo used for interactions on the y axis
  47709. */
  47710. yGizmo: PlaneRotationGizmo;
  47711. /**
  47712. * Internal gizmo used for interactions on the z axis
  47713. */
  47714. zGizmo: PlaneRotationGizmo;
  47715. /** Fires an event when any of it's sub gizmos are dragged */
  47716. onDragStartObservable: Observable<unknown>;
  47717. /** Fires an event when any of it's sub gizmos are released from dragging */
  47718. onDragEndObservable: Observable<unknown>;
  47719. private _meshAttached;
  47720. attachedMesh: Nullable<AbstractMesh>;
  47721. /**
  47722. * Creates a RotationGizmo
  47723. * @param gizmoLayer The utility layer the gizmo will be added to
  47724. * @param tessellation Amount of tessellation to be used when creating rotation circles
  47725. * @param useEulerRotation Use and update Euler angle instead of quaternion
  47726. */
  47727. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  47728. updateGizmoRotationToMatchAttachedMesh: boolean;
  47729. /**
  47730. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47731. */
  47732. snapDistance: number;
  47733. /**
  47734. * Ratio for the scale of the gizmo (Default: 1)
  47735. */
  47736. scaleRatio: number;
  47737. /**
  47738. * Disposes of the gizmo
  47739. */
  47740. dispose(): void;
  47741. /**
  47742. * CustomMeshes are not supported by this gizmo
  47743. * @param mesh The mesh to replace the default mesh of the gizmo
  47744. */
  47745. setCustomMesh(mesh: Mesh): void;
  47746. }
  47747. }
  47748. declare module "babylonjs/Gizmos/gizmoManager" {
  47749. import { Observable } from "babylonjs/Misc/observable";
  47750. import { Nullable } from "babylonjs/types";
  47751. import { Scene, IDisposable } from "babylonjs/scene";
  47752. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47753. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47754. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  47755. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  47756. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  47757. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  47758. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  47759. /**
  47760. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  47761. */
  47762. export class GizmoManager implements IDisposable {
  47763. private scene;
  47764. /**
  47765. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  47766. */
  47767. gizmos: {
  47768. positionGizmo: Nullable<PositionGizmo>;
  47769. rotationGizmo: Nullable<RotationGizmo>;
  47770. scaleGizmo: Nullable<ScaleGizmo>;
  47771. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  47772. };
  47773. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  47774. clearGizmoOnEmptyPointerEvent: boolean;
  47775. /** Fires an event when the manager is attached to a mesh */
  47776. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  47777. private _gizmosEnabled;
  47778. private _pointerObserver;
  47779. private _attachedMesh;
  47780. private _boundingBoxColor;
  47781. private _defaultUtilityLayer;
  47782. private _defaultKeepDepthUtilityLayer;
  47783. /**
  47784. * When bounding box gizmo is enabled, this can be used to track drag/end events
  47785. */
  47786. boundingBoxDragBehavior: SixDofDragBehavior;
  47787. /**
  47788. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  47789. */
  47790. attachableMeshes: Nullable<Array<AbstractMesh>>;
  47791. /**
  47792. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  47793. */
  47794. usePointerToAttachGizmos: boolean;
  47795. /**
  47796. * Utility layer that the bounding box gizmo belongs to
  47797. */
  47798. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  47799. /**
  47800. * Utility layer that all gizmos besides bounding box belong to
  47801. */
  47802. readonly utilityLayer: UtilityLayerRenderer;
  47803. /**
  47804. * Instatiates a gizmo manager
  47805. * @param scene the scene to overlay the gizmos on top of
  47806. */
  47807. constructor(scene: Scene);
  47808. /**
  47809. * Attaches a set of gizmos to the specified mesh
  47810. * @param mesh The mesh the gizmo's should be attached to
  47811. */
  47812. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  47813. /**
  47814. * If the position gizmo is enabled
  47815. */
  47816. positionGizmoEnabled: boolean;
  47817. /**
  47818. * If the rotation gizmo is enabled
  47819. */
  47820. rotationGizmoEnabled: boolean;
  47821. /**
  47822. * If the scale gizmo is enabled
  47823. */
  47824. scaleGizmoEnabled: boolean;
  47825. /**
  47826. * If the boundingBox gizmo is enabled
  47827. */
  47828. boundingBoxGizmoEnabled: boolean;
  47829. /**
  47830. * Disposes of the gizmo manager
  47831. */
  47832. dispose(): void;
  47833. }
  47834. }
  47835. declare module "babylonjs/Lights/directionalLight" {
  47836. import { Camera } from "babylonjs/Cameras/camera";
  47837. import { Scene } from "babylonjs/scene";
  47838. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  47839. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47840. import { Light } from "babylonjs/Lights/light";
  47841. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  47842. import { Effect } from "babylonjs/Materials/effect";
  47843. /**
  47844. * A directional light is defined by a direction (what a surprise!).
  47845. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  47846. * An example of a directional light is when a distance planet is lit by the apparently parallel lines of light from its sun. Light in a downward direction will light the top of an object.
  47847. * Documentation: https://doc.babylonjs.com/babylon101/lights
  47848. */
  47849. export class DirectionalLight extends ShadowLight {
  47850. private _shadowFrustumSize;
  47851. /**
  47852. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  47853. */
  47854. /**
  47855. * Specifies a fix frustum size for the shadow generation.
  47856. */
  47857. shadowFrustumSize: number;
  47858. private _shadowOrthoScale;
  47859. /**
  47860. * Gets the shadow projection scale against the optimal computed one.
  47861. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  47862. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  47863. */
  47864. /**
  47865. * Sets the shadow projection scale against the optimal computed one.
  47866. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  47867. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  47868. */
  47869. shadowOrthoScale: number;
  47870. /**
  47871. * Automatically compute the projection matrix to best fit (including all the casters)
  47872. * on each frame.
  47873. */
  47874. autoUpdateExtends: boolean;
  47875. private _orthoLeft;
  47876. private _orthoRight;
  47877. private _orthoTop;
  47878. private _orthoBottom;
  47879. /**
  47880. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  47881. * The directional light is emitted from everywhere in the given direction.
  47882. * It can cast shadows.
  47883. * Documentation : https://doc.babylonjs.com/babylon101/lights
  47884. * @param name The friendly name of the light
  47885. * @param direction The direction of the light
  47886. * @param scene The scene the light belongs to
  47887. */
  47888. constructor(name: string, direction: Vector3, scene: Scene);
  47889. /**
  47890. * Returns the string "DirectionalLight".
  47891. * @return The class name
  47892. */
  47893. getClassName(): string;
  47894. /**
  47895. * Returns the integer 1.
  47896. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  47897. */
  47898. getTypeID(): number;
  47899. /**
  47900. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  47901. * Returns the DirectionalLight Shadow projection matrix.
  47902. */
  47903. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  47904. /**
  47905. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  47906. * Returns the DirectionalLight Shadow projection matrix.
  47907. */
  47908. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  47909. /**
  47910. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  47911. * Returns the DirectionalLight Shadow projection matrix.
  47912. */
  47913. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  47914. protected _buildUniformLayout(): void;
  47915. /**
  47916. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  47917. * @param effect The effect to update
  47918. * @param lightIndex The index of the light in the effect to update
  47919. * @returns The directional light
  47920. */
  47921. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  47922. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  47923. /**
  47924. * Gets the minZ used for shadow according to both the scene and the light.
  47925. *
  47926. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  47927. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  47928. * @param activeCamera The camera we are returning the min for
  47929. * @returns the depth min z
  47930. */
  47931. getDepthMinZ(activeCamera: Camera): number;
  47932. /**
  47933. * Gets the maxZ used for shadow according to both the scene and the light.
  47934. *
  47935. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  47936. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  47937. * @param activeCamera The camera we are returning the max for
  47938. * @returns the depth max z
  47939. */
  47940. getDepthMaxZ(activeCamera: Camera): number;
  47941. /**
  47942. * Prepares the list of defines specific to the light type.
  47943. * @param defines the list of defines
  47944. * @param lightIndex defines the index of the light for the effect
  47945. */
  47946. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  47947. }
  47948. }
  47949. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  47950. import { Mesh } from "babylonjs/Meshes/mesh";
  47951. /**
  47952. * Class containing static functions to help procedurally build meshes
  47953. */
  47954. export class HemisphereBuilder {
  47955. /**
  47956. * Creates a hemisphere mesh
  47957. * @param name defines the name of the mesh
  47958. * @param options defines the options used to create the mesh
  47959. * @param scene defines the hosting scene
  47960. * @returns the hemisphere mesh
  47961. */
  47962. static CreateHemisphere(name: string, options: {
  47963. segments?: number;
  47964. diameter?: number;
  47965. sideOrientation?: number;
  47966. }, scene: any): Mesh;
  47967. }
  47968. }
  47969. declare module "babylonjs/Lights/spotLight" {
  47970. import { Nullable } from "babylonjs/types";
  47971. import { Scene } from "babylonjs/scene";
  47972. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  47973. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47974. import { Effect } from "babylonjs/Materials/effect";
  47975. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47976. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  47977. /**
  47978. * A spot light is defined by a position, a direction, an angle, and an exponent.
  47979. * These values define a cone of light starting from the position, emitting toward the direction.
  47980. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  47981. * and the exponent defines the speed of the decay of the light with distance (reach).
  47982. * Documentation: https://doc.babylonjs.com/babylon101/lights
  47983. */
  47984. export class SpotLight extends ShadowLight {
  47985. private _angle;
  47986. private _innerAngle;
  47987. private _cosHalfAngle;
  47988. private _lightAngleScale;
  47989. private _lightAngleOffset;
  47990. /**
  47991. * Gets the cone angle of the spot light in Radians.
  47992. */
  47993. /**
  47994. * Sets the cone angle of the spot light in Radians.
  47995. */
  47996. angle: number;
  47997. /**
  47998. * Only used in gltf falloff mode, this defines the angle where
  47999. * the directional falloff will start before cutting at angle which could be seen
  48000. * as outer angle.
  48001. */
  48002. /**
  48003. * Only used in gltf falloff mode, this defines the angle where
  48004. * the directional falloff will start before cutting at angle which could be seen
  48005. * as outer angle.
  48006. */
  48007. innerAngle: number;
  48008. private _shadowAngleScale;
  48009. /**
  48010. * Allows scaling the angle of the light for shadow generation only.
  48011. */
  48012. /**
  48013. * Allows scaling the angle of the light for shadow generation only.
  48014. */
  48015. shadowAngleScale: number;
  48016. /**
  48017. * The light decay speed with the distance from the emission spot.
  48018. */
  48019. exponent: number;
  48020. private _projectionTextureMatrix;
  48021. /**
  48022. * Allows reading the projecton texture
  48023. */
  48024. readonly projectionTextureMatrix: Matrix;
  48025. protected _projectionTextureLightNear: number;
  48026. /**
  48027. * Gets the near clip of the Spotlight for texture projection.
  48028. */
  48029. /**
  48030. * Sets the near clip of the Spotlight for texture projection.
  48031. */
  48032. projectionTextureLightNear: number;
  48033. protected _projectionTextureLightFar: number;
  48034. /**
  48035. * Gets the far clip of the Spotlight for texture projection.
  48036. */
  48037. /**
  48038. * Sets the far clip of the Spotlight for texture projection.
  48039. */
  48040. projectionTextureLightFar: number;
  48041. protected _projectionTextureUpDirection: Vector3;
  48042. /**
  48043. * Gets the Up vector of the Spotlight for texture projection.
  48044. */
  48045. /**
  48046. * Sets the Up vector of the Spotlight for texture projection.
  48047. */
  48048. projectionTextureUpDirection: Vector3;
  48049. private _projectionTexture;
  48050. /**
  48051. * Gets the projection texture of the light.
  48052. */
  48053. /**
  48054. * Sets the projection texture of the light.
  48055. */
  48056. projectionTexture: Nullable<BaseTexture>;
  48057. private _projectionTextureViewLightDirty;
  48058. private _projectionTextureProjectionLightDirty;
  48059. private _projectionTextureDirty;
  48060. private _projectionTextureViewTargetVector;
  48061. private _projectionTextureViewLightMatrix;
  48062. private _projectionTextureProjectionLightMatrix;
  48063. private _projectionTextureScalingMatrix;
  48064. /**
  48065. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  48066. * It can cast shadows.
  48067. * Documentation : https://doc.babylonjs.com/babylon101/lights
  48068. * @param name The light friendly name
  48069. * @param position The position of the spot light in the scene
  48070. * @param direction The direction of the light in the scene
  48071. * @param angle The cone angle of the light in Radians
  48072. * @param exponent The light decay speed with the distance from the emission spot
  48073. * @param scene The scene the lights belongs to
  48074. */
  48075. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  48076. /**
  48077. * Returns the string "SpotLight".
  48078. * @returns the class name
  48079. */
  48080. getClassName(): string;
  48081. /**
  48082. * Returns the integer 2.
  48083. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  48084. */
  48085. getTypeID(): number;
  48086. /**
  48087. * Overrides the direction setter to recompute the projection texture view light Matrix.
  48088. */
  48089. protected _setDirection(value: Vector3): void;
  48090. /**
  48091. * Overrides the position setter to recompute the projection texture view light Matrix.
  48092. */
  48093. protected _setPosition(value: Vector3): void;
  48094. /**
  48095. * Sets the passed matrix "matrix" as perspective projection matrix for the shadows and the passed view matrix with the fov equal to the SpotLight angle and and aspect ratio of 1.0.
  48096. * Returns the SpotLight.
  48097. */
  48098. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  48099. protected _computeProjectionTextureViewLightMatrix(): void;
  48100. protected _computeProjectionTextureProjectionLightMatrix(): void;
  48101. /**
  48102. * Main function for light texture projection matrix computing.
  48103. */
  48104. protected _computeProjectionTextureMatrix(): void;
  48105. protected _buildUniformLayout(): void;
  48106. private _computeAngleValues;
  48107. /**
  48108. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  48109. * @param effect The effect to update
  48110. * @param lightIndex The index of the light in the effect to update
  48111. * @returns The spot light
  48112. */
  48113. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  48114. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  48115. /**
  48116. * Disposes the light and the associated resources.
  48117. */
  48118. dispose(): void;
  48119. /**
  48120. * Prepares the list of defines specific to the light type.
  48121. * @param defines the list of defines
  48122. * @param lightIndex defines the index of the light for the effect
  48123. */
  48124. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  48125. }
  48126. }
  48127. declare module "babylonjs/Gizmos/lightGizmo" {
  48128. import { Nullable } from "babylonjs/types";
  48129. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  48130. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  48131. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  48132. import { Light } from "babylonjs/Lights/light";
  48133. /**
  48134. * Gizmo that enables viewing a light
  48135. */
  48136. export class LightGizmo extends Gizmo {
  48137. private _lightMesh;
  48138. private _material;
  48139. private cachedPosition;
  48140. private cachedForward;
  48141. /**
  48142. * Creates a LightGizmo
  48143. * @param gizmoLayer The utility layer the gizmo will be added to
  48144. */
  48145. constructor(gizmoLayer?: UtilityLayerRenderer);
  48146. private _light;
  48147. /**
  48148. * The light that the gizmo is attached to
  48149. */
  48150. light: Nullable<Light>;
  48151. /**
  48152. * Gets the material used to render the light gizmo
  48153. */
  48154. readonly material: StandardMaterial;
  48155. /**
  48156. * @hidden
  48157. * Updates the gizmo to match the attached mesh's position/rotation
  48158. */
  48159. protected _update(): void;
  48160. private static _Scale;
  48161. /**
  48162. * Creates the lines for a light mesh
  48163. */
  48164. private static _createLightLines;
  48165. /**
  48166. * Disposes of the light gizmo
  48167. */
  48168. dispose(): void;
  48169. private static _CreateHemisphericLightMesh;
  48170. private static _CreatePointLightMesh;
  48171. private static _CreateSpotLightMesh;
  48172. private static _CreateDirectionalLightMesh;
  48173. }
  48174. }
  48175. declare module "babylonjs/Gizmos/index" {
  48176. export * from "babylonjs/Gizmos/axisDragGizmo";
  48177. export * from "babylonjs/Gizmos/axisScaleGizmo";
  48178. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  48179. export * from "babylonjs/Gizmos/gizmo";
  48180. export * from "babylonjs/Gizmos/gizmoManager";
  48181. export * from "babylonjs/Gizmos/planeRotationGizmo";
  48182. export * from "babylonjs/Gizmos/positionGizmo";
  48183. export * from "babylonjs/Gizmos/rotationGizmo";
  48184. export * from "babylonjs/Gizmos/scaleGizmo";
  48185. export * from "babylonjs/Gizmos/lightGizmo";
  48186. export * from "babylonjs/Gizmos/planeDragGizmo";
  48187. }
  48188. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  48189. /** @hidden */
  48190. export var backgroundFragmentDeclaration: {
  48191. name: string;
  48192. shader: string;
  48193. };
  48194. }
  48195. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  48196. /** @hidden */
  48197. export var backgroundUboDeclaration: {
  48198. name: string;
  48199. shader: string;
  48200. };
  48201. }
  48202. declare module "babylonjs/Shaders/background.fragment" {
  48203. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  48204. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  48205. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  48206. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  48207. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48208. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48209. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48210. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  48211. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  48212. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  48213. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  48214. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  48215. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  48216. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  48217. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  48218. /** @hidden */
  48219. export var backgroundPixelShader: {
  48220. name: string;
  48221. shader: string;
  48222. };
  48223. }
  48224. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  48225. /** @hidden */
  48226. export var backgroundVertexDeclaration: {
  48227. name: string;
  48228. shader: string;
  48229. };
  48230. }
  48231. declare module "babylonjs/Shaders/background.vertex" {
  48232. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  48233. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  48234. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48235. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  48236. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  48237. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  48238. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  48239. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48240. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48241. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  48242. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  48243. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  48244. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  48245. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  48246. /** @hidden */
  48247. export var backgroundVertexShader: {
  48248. name: string;
  48249. shader: string;
  48250. };
  48251. }
  48252. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  48253. import { Nullable, int, float } from "babylonjs/types";
  48254. import { Scene } from "babylonjs/scene";
  48255. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  48256. import { SubMesh } from "babylonjs/Meshes/subMesh";
  48257. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48258. import { Mesh } from "babylonjs/Meshes/mesh";
  48259. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  48260. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  48261. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  48262. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48263. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  48264. import { Color3 } from "babylonjs/Maths/math.color";
  48265. import "babylonjs/Shaders/background.fragment";
  48266. import "babylonjs/Shaders/background.vertex";
  48267. /**
  48268. * Background material used to create an efficient environement around your scene.
  48269. */
  48270. export class BackgroundMaterial extends PushMaterial {
  48271. /**
  48272. * Standard reflectance value at parallel view angle.
  48273. */
  48274. static StandardReflectance0: number;
  48275. /**
  48276. * Standard reflectance value at grazing angle.
  48277. */
  48278. static StandardReflectance90: number;
  48279. protected _primaryColor: Color3;
  48280. /**
  48281. * Key light Color (multiply against the environement texture)
  48282. */
  48283. primaryColor: Color3;
  48284. protected __perceptualColor: Nullable<Color3>;
  48285. /**
  48286. * Experimental Internal Use Only.
  48287. *
  48288. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  48289. * This acts as a helper to set the primary color to a more "human friendly" value.
  48290. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  48291. * output color as close as possible from the chosen value.
  48292. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  48293. * part of lighting setup.)
  48294. */
  48295. _perceptualColor: Nullable<Color3>;
  48296. protected _primaryColorShadowLevel: float;
  48297. /**
  48298. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  48299. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  48300. */
  48301. primaryColorShadowLevel: float;
  48302. protected _primaryColorHighlightLevel: float;
  48303. /**
  48304. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  48305. * The primary color is used at the level chosen to define what the white area would look.
  48306. */
  48307. primaryColorHighlightLevel: float;
  48308. protected _reflectionTexture: Nullable<BaseTexture>;
  48309. /**
  48310. * Reflection Texture used in the material.
  48311. * Should be author in a specific way for the best result (refer to the documentation).
  48312. */
  48313. reflectionTexture: Nullable<BaseTexture>;
  48314. protected _reflectionBlur: float;
  48315. /**
  48316. * Reflection Texture level of blur.
  48317. *
  48318. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  48319. * texture twice.
  48320. */
  48321. reflectionBlur: float;
  48322. protected _diffuseTexture: Nullable<BaseTexture>;
  48323. /**
  48324. * Diffuse Texture used in the material.
  48325. * Should be author in a specific way for the best result (refer to the documentation).
  48326. */
  48327. diffuseTexture: Nullable<BaseTexture>;
  48328. protected _shadowLights: Nullable<IShadowLight[]>;
  48329. /**
  48330. * Specify the list of lights casting shadow on the material.
  48331. * All scene shadow lights will be included if null.
  48332. */
  48333. shadowLights: Nullable<IShadowLight[]>;
  48334. protected _shadowLevel: float;
  48335. /**
  48336. * Helps adjusting the shadow to a softer level if required.
  48337. * 0 means black shadows and 1 means no shadows.
  48338. */
  48339. shadowLevel: float;
  48340. protected _sceneCenter: Vector3;
  48341. /**
  48342. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  48343. * It is usually zero but might be interesting to modify according to your setup.
  48344. */
  48345. sceneCenter: Vector3;
  48346. protected _opacityFresnel: boolean;
  48347. /**
  48348. * This helps specifying that the material is falling off to the sky box at grazing angle.
  48349. * This helps ensuring a nice transition when the camera goes under the ground.
  48350. */
  48351. opacityFresnel: boolean;
  48352. protected _reflectionFresnel: boolean;
  48353. /**
  48354. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  48355. * This helps adding a mirror texture on the ground.
  48356. */
  48357. reflectionFresnel: boolean;
  48358. protected _reflectionFalloffDistance: number;
  48359. /**
  48360. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  48361. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  48362. */
  48363. reflectionFalloffDistance: number;
  48364. protected _reflectionAmount: number;
  48365. /**
  48366. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  48367. */
  48368. reflectionAmount: number;
  48369. protected _reflectionReflectance0: number;
  48370. /**
  48371. * This specifies the weight of the reflection at grazing angle.
  48372. */
  48373. reflectionReflectance0: number;
  48374. protected _reflectionReflectance90: number;
  48375. /**
  48376. * This specifies the weight of the reflection at a perpendicular point of view.
  48377. */
  48378. reflectionReflectance90: number;
  48379. /**
  48380. * Sets the reflection reflectance fresnel values according to the default standard
  48381. * empirically know to work well :-)
  48382. */
  48383. reflectionStandardFresnelWeight: number;
  48384. protected _useRGBColor: boolean;
  48385. /**
  48386. * Helps to directly use the maps channels instead of their level.
  48387. */
  48388. useRGBColor: boolean;
  48389. protected _enableNoise: boolean;
  48390. /**
  48391. * This helps reducing the banding effect that could occur on the background.
  48392. */
  48393. enableNoise: boolean;
  48394. /**
  48395. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  48396. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  48397. * Recommended to be keep at 1.0 except for special cases.
  48398. */
  48399. fovMultiplier: number;
  48400. private _fovMultiplier;
  48401. /**
  48402. * Enable the FOV adjustment feature controlled by fovMultiplier.
  48403. */
  48404. useEquirectangularFOV: boolean;
  48405. private _maxSimultaneousLights;
  48406. /**
  48407. * Number of Simultaneous lights allowed on the material.
  48408. */
  48409. maxSimultaneousLights: int;
  48410. /**
  48411. * Default configuration related to image processing available in the Background Material.
  48412. */
  48413. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  48414. /**
  48415. * Keep track of the image processing observer to allow dispose and replace.
  48416. */
  48417. private _imageProcessingObserver;
  48418. /**
  48419. * Attaches a new image processing configuration to the PBR Material.
  48420. * @param configuration (if null the scene configuration will be use)
  48421. */
  48422. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  48423. /**
  48424. * Gets the image processing configuration used either in this material.
  48425. */
  48426. /**
  48427. * Sets the Default image processing configuration used either in the this material.
  48428. *
  48429. * If sets to null, the scene one is in use.
  48430. */
  48431. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  48432. /**
  48433. * Gets wether the color curves effect is enabled.
  48434. */
  48435. /**
  48436. * Sets wether the color curves effect is enabled.
  48437. */
  48438. cameraColorCurvesEnabled: boolean;
  48439. /**
  48440. * Gets wether the color grading effect is enabled.
  48441. */
  48442. /**
  48443. * Gets wether the color grading effect is enabled.
  48444. */
  48445. cameraColorGradingEnabled: boolean;
  48446. /**
  48447. * Gets wether tonemapping is enabled or not.
  48448. */
  48449. /**
  48450. * Sets wether tonemapping is enabled or not
  48451. */
  48452. cameraToneMappingEnabled: boolean;
  48453. /**
  48454. * The camera exposure used on this material.
  48455. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  48456. * This corresponds to a photographic exposure.
  48457. */
  48458. /**
  48459. * The camera exposure used on this material.
  48460. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  48461. * This corresponds to a photographic exposure.
  48462. */
  48463. cameraExposure: float;
  48464. /**
  48465. * Gets The camera contrast used on this material.
  48466. */
  48467. /**
  48468. * Sets The camera contrast used on this material.
  48469. */
  48470. cameraContrast: float;
  48471. /**
  48472. * Gets the Color Grading 2D Lookup Texture.
  48473. */
  48474. /**
  48475. * Sets the Color Grading 2D Lookup Texture.
  48476. */
  48477. cameraColorGradingTexture: Nullable<BaseTexture>;
  48478. /**
  48479. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  48480. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  48481. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  48482. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  48483. */
  48484. /**
  48485. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  48486. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  48487. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  48488. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  48489. */
  48490. cameraColorCurves: Nullable<ColorCurves>;
  48491. /**
  48492. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  48493. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  48494. */
  48495. switchToBGR: boolean;
  48496. private _renderTargets;
  48497. private _reflectionControls;
  48498. private _white;
  48499. private _primaryShadowColor;
  48500. private _primaryHighlightColor;
  48501. /**
  48502. * Instantiates a Background Material in the given scene
  48503. * @param name The friendly name of the material
  48504. * @param scene The scene to add the material to
  48505. */
  48506. constructor(name: string, scene: Scene);
  48507. /**
  48508. * Gets a boolean indicating that current material needs to register RTT
  48509. */
  48510. readonly hasRenderTargetTextures: boolean;
  48511. /**
  48512. * The entire material has been created in order to prevent overdraw.
  48513. * @returns false
  48514. */
  48515. needAlphaTesting(): boolean;
  48516. /**
  48517. * The entire material has been created in order to prevent overdraw.
  48518. * @returns true if blending is enable
  48519. */
  48520. needAlphaBlending(): boolean;
  48521. /**
  48522. * Checks wether the material is ready to be rendered for a given mesh.
  48523. * @param mesh The mesh to render
  48524. * @param subMesh The submesh to check against
  48525. * @param useInstances Specify wether or not the material is used with instances
  48526. * @returns true if all the dependencies are ready (Textures, Effects...)
  48527. */
  48528. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  48529. /**
  48530. * Compute the primary color according to the chosen perceptual color.
  48531. */
  48532. private _computePrimaryColorFromPerceptualColor;
  48533. /**
  48534. * Compute the highlights and shadow colors according to their chosen levels.
  48535. */
  48536. private _computePrimaryColors;
  48537. /**
  48538. * Build the uniform buffer used in the material.
  48539. */
  48540. buildUniformLayout(): void;
  48541. /**
  48542. * Unbind the material.
  48543. */
  48544. unbind(): void;
  48545. /**
  48546. * Bind only the world matrix to the material.
  48547. * @param world The world matrix to bind.
  48548. */
  48549. bindOnlyWorldMatrix(world: Matrix): void;
  48550. /**
  48551. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  48552. * @param world The world matrix to bind.
  48553. * @param subMesh The submesh to bind for.
  48554. */
  48555. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  48556. /**
  48557. * Checks to see if a texture is used in the material.
  48558. * @param texture - Base texture to use.
  48559. * @returns - Boolean specifying if a texture is used in the material.
  48560. */
  48561. hasTexture(texture: BaseTexture): boolean;
  48562. /**
  48563. * Dispose the material.
  48564. * @param forceDisposeEffect Force disposal of the associated effect.
  48565. * @param forceDisposeTextures Force disposal of the associated textures.
  48566. */
  48567. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  48568. /**
  48569. * Clones the material.
  48570. * @param name The cloned name.
  48571. * @returns The cloned material.
  48572. */
  48573. clone(name: string): BackgroundMaterial;
  48574. /**
  48575. * Serializes the current material to its JSON representation.
  48576. * @returns The JSON representation.
  48577. */
  48578. serialize(): any;
  48579. /**
  48580. * Gets the class name of the material
  48581. * @returns "BackgroundMaterial"
  48582. */
  48583. getClassName(): string;
  48584. /**
  48585. * Parse a JSON input to create back a background material.
  48586. * @param source The JSON data to parse
  48587. * @param scene The scene to create the parsed material in
  48588. * @param rootUrl The root url of the assets the material depends upon
  48589. * @returns the instantiated BackgroundMaterial.
  48590. */
  48591. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  48592. }
  48593. }
  48594. declare module "babylonjs/Helpers/environmentHelper" {
  48595. import { Observable } from "babylonjs/Misc/observable";
  48596. import { Nullable } from "babylonjs/types";
  48597. import { Scene } from "babylonjs/scene";
  48598. import { Vector3 } from "babylonjs/Maths/math.vector";
  48599. import { Color3 } from "babylonjs/Maths/math.color";
  48600. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48601. import { Mesh } from "babylonjs/Meshes/mesh";
  48602. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48603. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  48604. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  48605. import "babylonjs/Meshes/Builders/planeBuilder";
  48606. import "babylonjs/Meshes/Builders/boxBuilder";
  48607. /**
  48608. * Represents the different options available during the creation of
  48609. * a Environment helper.
  48610. *
  48611. * This can control the default ground, skybox and image processing setup of your scene.
  48612. */
  48613. export interface IEnvironmentHelperOptions {
  48614. /**
  48615. * Specifies wether or not to create a ground.
  48616. * True by default.
  48617. */
  48618. createGround: boolean;
  48619. /**
  48620. * Specifies the ground size.
  48621. * 15 by default.
  48622. */
  48623. groundSize: number;
  48624. /**
  48625. * The texture used on the ground for the main color.
  48626. * Comes from the BabylonJS CDN by default.
  48627. *
  48628. * Remarks: Can be either a texture or a url.
  48629. */
  48630. groundTexture: string | BaseTexture;
  48631. /**
  48632. * The color mixed in the ground texture by default.
  48633. * BabylonJS clearColor by default.
  48634. */
  48635. groundColor: Color3;
  48636. /**
  48637. * Specifies the ground opacity.
  48638. * 1 by default.
  48639. */
  48640. groundOpacity: number;
  48641. /**
  48642. * Enables the ground to receive shadows.
  48643. * True by default.
  48644. */
  48645. enableGroundShadow: boolean;
  48646. /**
  48647. * Helps preventing the shadow to be fully black on the ground.
  48648. * 0.5 by default.
  48649. */
  48650. groundShadowLevel: number;
  48651. /**
  48652. * Creates a mirror texture attach to the ground.
  48653. * false by default.
  48654. */
  48655. enableGroundMirror: boolean;
  48656. /**
  48657. * Specifies the ground mirror size ratio.
  48658. * 0.3 by default as the default kernel is 64.
  48659. */
  48660. groundMirrorSizeRatio: number;
  48661. /**
  48662. * Specifies the ground mirror blur kernel size.
  48663. * 64 by default.
  48664. */
  48665. groundMirrorBlurKernel: number;
  48666. /**
  48667. * Specifies the ground mirror visibility amount.
  48668. * 1 by default
  48669. */
  48670. groundMirrorAmount: number;
  48671. /**
  48672. * Specifies the ground mirror reflectance weight.
  48673. * This uses the standard weight of the background material to setup the fresnel effect
  48674. * of the mirror.
  48675. * 1 by default.
  48676. */
  48677. groundMirrorFresnelWeight: number;
  48678. /**
  48679. * Specifies the ground mirror Falloff distance.
  48680. * This can helps reducing the size of the reflection.
  48681. * 0 by Default.
  48682. */
  48683. groundMirrorFallOffDistance: number;
  48684. /**
  48685. * Specifies the ground mirror texture type.
  48686. * Unsigned Int by Default.
  48687. */
  48688. groundMirrorTextureType: number;
  48689. /**
  48690. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  48691. * the shown objects.
  48692. */
  48693. groundYBias: number;
  48694. /**
  48695. * Specifies wether or not to create a skybox.
  48696. * True by default.
  48697. */
  48698. createSkybox: boolean;
  48699. /**
  48700. * Specifies the skybox size.
  48701. * 20 by default.
  48702. */
  48703. skyboxSize: number;
  48704. /**
  48705. * The texture used on the skybox for the main color.
  48706. * Comes from the BabylonJS CDN by default.
  48707. *
  48708. * Remarks: Can be either a texture or a url.
  48709. */
  48710. skyboxTexture: string | BaseTexture;
  48711. /**
  48712. * The color mixed in the skybox texture by default.
  48713. * BabylonJS clearColor by default.
  48714. */
  48715. skyboxColor: Color3;
  48716. /**
  48717. * The background rotation around the Y axis of the scene.
  48718. * This helps aligning the key lights of your scene with the background.
  48719. * 0 by default.
  48720. */
  48721. backgroundYRotation: number;
  48722. /**
  48723. * Compute automatically the size of the elements to best fit with the scene.
  48724. */
  48725. sizeAuto: boolean;
  48726. /**
  48727. * Default position of the rootMesh if autoSize is not true.
  48728. */
  48729. rootPosition: Vector3;
  48730. /**
  48731. * Sets up the image processing in the scene.
  48732. * true by default.
  48733. */
  48734. setupImageProcessing: boolean;
  48735. /**
  48736. * The texture used as your environment texture in the scene.
  48737. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  48738. *
  48739. * Remarks: Can be either a texture or a url.
  48740. */
  48741. environmentTexture: string | BaseTexture;
  48742. /**
  48743. * The value of the exposure to apply to the scene.
  48744. * 0.6 by default if setupImageProcessing is true.
  48745. */
  48746. cameraExposure: number;
  48747. /**
  48748. * The value of the contrast to apply to the scene.
  48749. * 1.6 by default if setupImageProcessing is true.
  48750. */
  48751. cameraContrast: number;
  48752. /**
  48753. * Specifies wether or not tonemapping should be enabled in the scene.
  48754. * true by default if setupImageProcessing is true.
  48755. */
  48756. toneMappingEnabled: boolean;
  48757. }
  48758. /**
  48759. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  48760. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  48761. * It also helps with the default setup of your imageProcessing configuration.
  48762. */
  48763. export class EnvironmentHelper {
  48764. /**
  48765. * Default ground texture URL.
  48766. */
  48767. private static _groundTextureCDNUrl;
  48768. /**
  48769. * Default skybox texture URL.
  48770. */
  48771. private static _skyboxTextureCDNUrl;
  48772. /**
  48773. * Default environment texture URL.
  48774. */
  48775. private static _environmentTextureCDNUrl;
  48776. /**
  48777. * Creates the default options for the helper.
  48778. */
  48779. private static _getDefaultOptions;
  48780. private _rootMesh;
  48781. /**
  48782. * Gets the root mesh created by the helper.
  48783. */
  48784. readonly rootMesh: Mesh;
  48785. private _skybox;
  48786. /**
  48787. * Gets the skybox created by the helper.
  48788. */
  48789. readonly skybox: Nullable<Mesh>;
  48790. private _skyboxTexture;
  48791. /**
  48792. * Gets the skybox texture created by the helper.
  48793. */
  48794. readonly skyboxTexture: Nullable<BaseTexture>;
  48795. private _skyboxMaterial;
  48796. /**
  48797. * Gets the skybox material created by the helper.
  48798. */
  48799. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  48800. private _ground;
  48801. /**
  48802. * Gets the ground mesh created by the helper.
  48803. */
  48804. readonly ground: Nullable<Mesh>;
  48805. private _groundTexture;
  48806. /**
  48807. * Gets the ground texture created by the helper.
  48808. */
  48809. readonly groundTexture: Nullable<BaseTexture>;
  48810. private _groundMirror;
  48811. /**
  48812. * Gets the ground mirror created by the helper.
  48813. */
  48814. readonly groundMirror: Nullable<MirrorTexture>;
  48815. /**
  48816. * Gets the ground mirror render list to helps pushing the meshes
  48817. * you wish in the ground reflection.
  48818. */
  48819. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  48820. private _groundMaterial;
  48821. /**
  48822. * Gets the ground material created by the helper.
  48823. */
  48824. readonly groundMaterial: Nullable<BackgroundMaterial>;
  48825. /**
  48826. * Stores the creation options.
  48827. */
  48828. private readonly _scene;
  48829. private _options;
  48830. /**
  48831. * This observable will be notified with any error during the creation of the environment,
  48832. * mainly texture creation errors.
  48833. */
  48834. onErrorObservable: Observable<{
  48835. message?: string;
  48836. exception?: any;
  48837. }>;
  48838. /**
  48839. * constructor
  48840. * @param options Defines the options we want to customize the helper
  48841. * @param scene The scene to add the material to
  48842. */
  48843. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  48844. /**
  48845. * Updates the background according to the new options
  48846. * @param options
  48847. */
  48848. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  48849. /**
  48850. * Sets the primary color of all the available elements.
  48851. * @param color the main color to affect to the ground and the background
  48852. */
  48853. setMainColor(color: Color3): void;
  48854. /**
  48855. * Setup the image processing according to the specified options.
  48856. */
  48857. private _setupImageProcessing;
  48858. /**
  48859. * Setup the environment texture according to the specified options.
  48860. */
  48861. private _setupEnvironmentTexture;
  48862. /**
  48863. * Setup the background according to the specified options.
  48864. */
  48865. private _setupBackground;
  48866. /**
  48867. * Get the scene sizes according to the setup.
  48868. */
  48869. private _getSceneSize;
  48870. /**
  48871. * Setup the ground according to the specified options.
  48872. */
  48873. private _setupGround;
  48874. /**
  48875. * Setup the ground material according to the specified options.
  48876. */
  48877. private _setupGroundMaterial;
  48878. /**
  48879. * Setup the ground diffuse texture according to the specified options.
  48880. */
  48881. private _setupGroundDiffuseTexture;
  48882. /**
  48883. * Setup the ground mirror texture according to the specified options.
  48884. */
  48885. private _setupGroundMirrorTexture;
  48886. /**
  48887. * Setup the ground to receive the mirror texture.
  48888. */
  48889. private _setupMirrorInGroundMaterial;
  48890. /**
  48891. * Setup the skybox according to the specified options.
  48892. */
  48893. private _setupSkybox;
  48894. /**
  48895. * Setup the skybox material according to the specified options.
  48896. */
  48897. private _setupSkyboxMaterial;
  48898. /**
  48899. * Setup the skybox reflection texture according to the specified options.
  48900. */
  48901. private _setupSkyboxReflectionTexture;
  48902. private _errorHandler;
  48903. /**
  48904. * Dispose all the elements created by the Helper.
  48905. */
  48906. dispose(): void;
  48907. }
  48908. }
  48909. declare module "babylonjs/Helpers/photoDome" {
  48910. import { Observable } from "babylonjs/Misc/observable";
  48911. import { Nullable } from "babylonjs/types";
  48912. import { Scene } from "babylonjs/scene";
  48913. import { TransformNode } from "babylonjs/Meshes/transformNode";
  48914. import { Mesh } from "babylonjs/Meshes/mesh";
  48915. import { Texture } from "babylonjs/Materials/Textures/texture";
  48916. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  48917. import "babylonjs/Meshes/Builders/sphereBuilder";
  48918. /**
  48919. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  48920. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  48921. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  48922. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  48923. */
  48924. export class PhotoDome extends TransformNode {
  48925. /**
  48926. * Define the image as a Monoscopic panoramic 360 image.
  48927. */
  48928. static readonly MODE_MONOSCOPIC: number;
  48929. /**
  48930. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  48931. */
  48932. static readonly MODE_TOPBOTTOM: number;
  48933. /**
  48934. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  48935. */
  48936. static readonly MODE_SIDEBYSIDE: number;
  48937. private _useDirectMapping;
  48938. /**
  48939. * The texture being displayed on the sphere
  48940. */
  48941. protected _photoTexture: Texture;
  48942. /**
  48943. * Gets or sets the texture being displayed on the sphere
  48944. */
  48945. photoTexture: Texture;
  48946. /**
  48947. * Observable raised when an error occured while loading the 360 image
  48948. */
  48949. onLoadErrorObservable: Observable<string>;
  48950. /**
  48951. * The skybox material
  48952. */
  48953. protected _material: BackgroundMaterial;
  48954. /**
  48955. * The surface used for the skybox
  48956. */
  48957. protected _mesh: Mesh;
  48958. /**
  48959. * Gets the mesh used for the skybox.
  48960. */
  48961. readonly mesh: Mesh;
  48962. /**
  48963. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  48964. * Also see the options.resolution property.
  48965. */
  48966. fovMultiplier: number;
  48967. private _imageMode;
  48968. /**
  48969. * Gets or set the current video mode for the video. It can be:
  48970. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  48971. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  48972. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  48973. */
  48974. imageMode: number;
  48975. /**
  48976. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  48977. * @param name Element's name, child elements will append suffixes for their own names.
  48978. * @param urlsOfPhoto defines the url of the photo to display
  48979. * @param options defines an object containing optional or exposed sub element properties
  48980. * @param onError defines a callback called when an error occured while loading the texture
  48981. */
  48982. constructor(name: string, urlOfPhoto: string, options: {
  48983. resolution?: number;
  48984. size?: number;
  48985. useDirectMapping?: boolean;
  48986. faceForward?: boolean;
  48987. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  48988. private _onBeforeCameraRenderObserver;
  48989. private _changeImageMode;
  48990. /**
  48991. * Releases resources associated with this node.
  48992. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  48993. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  48994. */
  48995. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  48996. }
  48997. }
  48998. declare module "babylonjs/Misc/rgbdTextureTools" {
  48999. import "babylonjs/Shaders/rgbdDecode.fragment";
  49000. import "babylonjs/Engines/Extensions/engine.renderTarget";
  49001. import { Texture } from "babylonjs/Materials/Textures/texture";
  49002. /**
  49003. * Class used to host RGBD texture specific utilities
  49004. */
  49005. export class RGBDTextureTools {
  49006. /**
  49007. * Expand the RGBD Texture from RGBD to Half Float if possible.
  49008. * @param texture the texture to expand.
  49009. */
  49010. static ExpandRGBDTexture(texture: Texture): void;
  49011. }
  49012. }
  49013. declare module "babylonjs/Misc/brdfTextureTools" {
  49014. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49015. import { Scene } from "babylonjs/scene";
  49016. /**
  49017. * Class used to host texture specific utilities
  49018. */
  49019. export class BRDFTextureTools {
  49020. /**
  49021. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  49022. * @param scene defines the hosting scene
  49023. * @returns the environment BRDF texture
  49024. */
  49025. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  49026. private static _environmentBRDFBase64Texture;
  49027. }
  49028. }
  49029. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  49030. import { Nullable } from "babylonjs/types";
  49031. import { Color3 } from "babylonjs/Maths/math.color";
  49032. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49033. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49034. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49035. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49036. import { Engine } from "babylonjs/Engines/engine";
  49037. import { Scene } from "babylonjs/scene";
  49038. /**
  49039. * @hidden
  49040. */
  49041. export interface IMaterialClearCoatDefines {
  49042. CLEARCOAT: boolean;
  49043. CLEARCOAT_DEFAULTIOR: boolean;
  49044. CLEARCOAT_TEXTURE: boolean;
  49045. CLEARCOAT_TEXTUREDIRECTUV: number;
  49046. CLEARCOAT_BUMP: boolean;
  49047. CLEARCOAT_BUMPDIRECTUV: number;
  49048. CLEARCOAT_TINT: boolean;
  49049. CLEARCOAT_TINT_TEXTURE: boolean;
  49050. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  49051. /** @hidden */
  49052. _areTexturesDirty: boolean;
  49053. }
  49054. /**
  49055. * Define the code related to the clear coat parameters of the pbr material.
  49056. */
  49057. export class PBRClearCoatConfiguration {
  49058. /**
  49059. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  49060. * The default fits with a polyurethane material.
  49061. */
  49062. private static readonly _DefaultIndexOfRefraction;
  49063. private _isEnabled;
  49064. /**
  49065. * Defines if the clear coat is enabled in the material.
  49066. */
  49067. isEnabled: boolean;
  49068. /**
  49069. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  49070. */
  49071. intensity: number;
  49072. /**
  49073. * Defines the clear coat layer roughness.
  49074. */
  49075. roughness: number;
  49076. private _indexOfRefraction;
  49077. /**
  49078. * Defines the index of refraction of the clear coat.
  49079. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  49080. * The default fits with a polyurethane material.
  49081. * Changing the default value is more performance intensive.
  49082. */
  49083. indexOfRefraction: number;
  49084. private _texture;
  49085. /**
  49086. * Stores the clear coat values in a texture.
  49087. */
  49088. texture: Nullable<BaseTexture>;
  49089. private _bumpTexture;
  49090. /**
  49091. * Define the clear coat specific bump texture.
  49092. */
  49093. bumpTexture: Nullable<BaseTexture>;
  49094. private _isTintEnabled;
  49095. /**
  49096. * Defines if the clear coat tint is enabled in the material.
  49097. */
  49098. isTintEnabled: boolean;
  49099. /**
  49100. * Defines the clear coat tint of the material.
  49101. * This is only use if tint is enabled
  49102. */
  49103. tintColor: Color3;
  49104. /**
  49105. * Defines the distance at which the tint color should be found in the
  49106. * clear coat media.
  49107. * This is only use if tint is enabled
  49108. */
  49109. tintColorAtDistance: number;
  49110. /**
  49111. * Defines the clear coat layer thickness.
  49112. * This is only use if tint is enabled
  49113. */
  49114. tintThickness: number;
  49115. private _tintTexture;
  49116. /**
  49117. * Stores the clear tint values in a texture.
  49118. * rgb is tint
  49119. * a is a thickness factor
  49120. */
  49121. tintTexture: Nullable<BaseTexture>;
  49122. /** @hidden */
  49123. private _internalMarkAllSubMeshesAsTexturesDirty;
  49124. /** @hidden */
  49125. _markAllSubMeshesAsTexturesDirty(): void;
  49126. /**
  49127. * Instantiate a new istance of clear coat configuration.
  49128. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49129. */
  49130. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49131. /**
  49132. * Gets wehter the submesh is ready to be used or not.
  49133. * @param defines the list of "defines" to update.
  49134. * @param scene defines the scene the material belongs to.
  49135. * @param engine defines the engine the material belongs to.
  49136. * @param disableBumpMap defines wether the material disables bump or not.
  49137. * @returns - boolean indicating that the submesh is ready or not.
  49138. */
  49139. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  49140. /**
  49141. * Checks to see if a texture is used in the material.
  49142. * @param defines the list of "defines" to update.
  49143. * @param scene defines the scene to the material belongs to.
  49144. */
  49145. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  49146. /**
  49147. * Binds the material data.
  49148. * @param uniformBuffer defines the Uniform buffer to fill in.
  49149. * @param scene defines the scene the material belongs to.
  49150. * @param engine defines the engine the material belongs to.
  49151. * @param disableBumpMap defines wether the material disables bump or not.
  49152. * @param isFrozen defines wether the material is frozen or not.
  49153. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  49154. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  49155. */
  49156. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  49157. /**
  49158. * Checks to see if a texture is used in the material.
  49159. * @param texture - Base texture to use.
  49160. * @returns - Boolean specifying if a texture is used in the material.
  49161. */
  49162. hasTexture(texture: BaseTexture): boolean;
  49163. /**
  49164. * Returns an array of the actively used textures.
  49165. * @param activeTextures Array of BaseTextures
  49166. */
  49167. getActiveTextures(activeTextures: BaseTexture[]): void;
  49168. /**
  49169. * Returns the animatable textures.
  49170. * @param animatables Array of animatable textures.
  49171. */
  49172. getAnimatables(animatables: IAnimatable[]): void;
  49173. /**
  49174. * Disposes the resources of the material.
  49175. * @param forceDisposeTextures - Forces the disposal of all textures.
  49176. */
  49177. dispose(forceDisposeTextures?: boolean): void;
  49178. /**
  49179. * Get the current class name of the texture useful for serialization or dynamic coding.
  49180. * @returns "PBRClearCoatConfiguration"
  49181. */
  49182. getClassName(): string;
  49183. /**
  49184. * Add fallbacks to the effect fallbacks list.
  49185. * @param defines defines the Base texture to use.
  49186. * @param fallbacks defines the current fallback list.
  49187. * @param currentRank defines the current fallback rank.
  49188. * @returns the new fallback rank.
  49189. */
  49190. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49191. /**
  49192. * Add the required uniforms to the current list.
  49193. * @param uniforms defines the current uniform list.
  49194. */
  49195. static AddUniforms(uniforms: string[]): void;
  49196. /**
  49197. * Add the required samplers to the current list.
  49198. * @param samplers defines the current sampler list.
  49199. */
  49200. static AddSamplers(samplers: string[]): void;
  49201. /**
  49202. * Add the required uniforms to the current buffer.
  49203. * @param uniformBuffer defines the current uniform buffer.
  49204. */
  49205. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49206. /**
  49207. * Makes a duplicate of the current configuration into another one.
  49208. * @param clearCoatConfiguration define the config where to copy the info
  49209. */
  49210. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  49211. /**
  49212. * Serializes this clear coat configuration.
  49213. * @returns - An object with the serialized config.
  49214. */
  49215. serialize(): any;
  49216. /**
  49217. * Parses a anisotropy Configuration from a serialized object.
  49218. * @param source - Serialized object.
  49219. * @param scene Defines the scene we are parsing for
  49220. * @param rootUrl Defines the rootUrl to load from
  49221. */
  49222. parse(source: any, scene: Scene, rootUrl: string): void;
  49223. }
  49224. }
  49225. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  49226. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49227. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49228. import { Vector2 } from "babylonjs/Maths/math.vector";
  49229. import { Scene } from "babylonjs/scene";
  49230. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49231. import { Nullable } from "babylonjs/types";
  49232. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49233. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49234. /**
  49235. * @hidden
  49236. */
  49237. export interface IMaterialAnisotropicDefines {
  49238. ANISOTROPIC: boolean;
  49239. ANISOTROPIC_TEXTURE: boolean;
  49240. ANISOTROPIC_TEXTUREDIRECTUV: number;
  49241. MAINUV1: boolean;
  49242. _areTexturesDirty: boolean;
  49243. _needUVs: boolean;
  49244. }
  49245. /**
  49246. * Define the code related to the anisotropic parameters of the pbr material.
  49247. */
  49248. export class PBRAnisotropicConfiguration {
  49249. private _isEnabled;
  49250. /**
  49251. * Defines if the anisotropy is enabled in the material.
  49252. */
  49253. isEnabled: boolean;
  49254. /**
  49255. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  49256. */
  49257. intensity: number;
  49258. /**
  49259. * Defines if the effect is along the tangents, bitangents or in between.
  49260. * By default, the effect is "strectching" the highlights along the tangents.
  49261. */
  49262. direction: Vector2;
  49263. private _texture;
  49264. /**
  49265. * Stores the anisotropy values in a texture.
  49266. * rg is direction (like normal from -1 to 1)
  49267. * b is a intensity
  49268. */
  49269. texture: Nullable<BaseTexture>;
  49270. /** @hidden */
  49271. private _internalMarkAllSubMeshesAsTexturesDirty;
  49272. /** @hidden */
  49273. _markAllSubMeshesAsTexturesDirty(): void;
  49274. /**
  49275. * Instantiate a new istance of anisotropy configuration.
  49276. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49277. */
  49278. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49279. /**
  49280. * Specifies that the submesh is ready to be used.
  49281. * @param defines the list of "defines" to update.
  49282. * @param scene defines the scene the material belongs to.
  49283. * @returns - boolean indicating that the submesh is ready or not.
  49284. */
  49285. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  49286. /**
  49287. * Checks to see if a texture is used in the material.
  49288. * @param defines the list of "defines" to update.
  49289. * @param mesh the mesh we are preparing the defines for.
  49290. * @param scene defines the scene the material belongs to.
  49291. */
  49292. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  49293. /**
  49294. * Binds the material data.
  49295. * @param uniformBuffer defines the Uniform buffer to fill in.
  49296. * @param scene defines the scene the material belongs to.
  49297. * @param isFrozen defines wether the material is frozen or not.
  49298. */
  49299. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  49300. /**
  49301. * Checks to see if a texture is used in the material.
  49302. * @param texture - Base texture to use.
  49303. * @returns - Boolean specifying if a texture is used in the material.
  49304. */
  49305. hasTexture(texture: BaseTexture): boolean;
  49306. /**
  49307. * Returns an array of the actively used textures.
  49308. * @param activeTextures Array of BaseTextures
  49309. */
  49310. getActiveTextures(activeTextures: BaseTexture[]): void;
  49311. /**
  49312. * Returns the animatable textures.
  49313. * @param animatables Array of animatable textures.
  49314. */
  49315. getAnimatables(animatables: IAnimatable[]): void;
  49316. /**
  49317. * Disposes the resources of the material.
  49318. * @param forceDisposeTextures - Forces the disposal of all textures.
  49319. */
  49320. dispose(forceDisposeTextures?: boolean): void;
  49321. /**
  49322. * Get the current class name of the texture useful for serialization or dynamic coding.
  49323. * @returns "PBRAnisotropicConfiguration"
  49324. */
  49325. getClassName(): string;
  49326. /**
  49327. * Add fallbacks to the effect fallbacks list.
  49328. * @param defines defines the Base texture to use.
  49329. * @param fallbacks defines the current fallback list.
  49330. * @param currentRank defines the current fallback rank.
  49331. * @returns the new fallback rank.
  49332. */
  49333. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49334. /**
  49335. * Add the required uniforms to the current list.
  49336. * @param uniforms defines the current uniform list.
  49337. */
  49338. static AddUniforms(uniforms: string[]): void;
  49339. /**
  49340. * Add the required uniforms to the current buffer.
  49341. * @param uniformBuffer defines the current uniform buffer.
  49342. */
  49343. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49344. /**
  49345. * Add the required samplers to the current list.
  49346. * @param samplers defines the current sampler list.
  49347. */
  49348. static AddSamplers(samplers: string[]): void;
  49349. /**
  49350. * Makes a duplicate of the current configuration into another one.
  49351. * @param anisotropicConfiguration define the config where to copy the info
  49352. */
  49353. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  49354. /**
  49355. * Serializes this anisotropy configuration.
  49356. * @returns - An object with the serialized config.
  49357. */
  49358. serialize(): any;
  49359. /**
  49360. * Parses a anisotropy Configuration from a serialized object.
  49361. * @param source - Serialized object.
  49362. * @param scene Defines the scene we are parsing for
  49363. * @param rootUrl Defines the rootUrl to load from
  49364. */
  49365. parse(source: any, scene: Scene, rootUrl: string): void;
  49366. }
  49367. }
  49368. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  49369. import { Scene } from "babylonjs/scene";
  49370. /**
  49371. * @hidden
  49372. */
  49373. export interface IMaterialBRDFDefines {
  49374. BRDF_V_HEIGHT_CORRELATED: boolean;
  49375. MS_BRDF_ENERGY_CONSERVATION: boolean;
  49376. SPHERICAL_HARMONICS: boolean;
  49377. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  49378. /** @hidden */
  49379. _areMiscDirty: boolean;
  49380. }
  49381. /**
  49382. * Define the code related to the BRDF parameters of the pbr material.
  49383. */
  49384. export class PBRBRDFConfiguration {
  49385. /**
  49386. * Default value used for the energy conservation.
  49387. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  49388. */
  49389. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  49390. /**
  49391. * Default value used for the Smith Visibility Height Correlated mode.
  49392. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  49393. */
  49394. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  49395. /**
  49396. * Default value used for the IBL diffuse part.
  49397. * This can help switching back to the polynomials mode globally which is a tiny bit
  49398. * less GPU intensive at the drawback of a lower quality.
  49399. */
  49400. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  49401. /**
  49402. * Default value used for activating energy conservation for the specular workflow.
  49403. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  49404. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  49405. */
  49406. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  49407. private _useEnergyConservation;
  49408. /**
  49409. * Defines if the material uses energy conservation.
  49410. */
  49411. useEnergyConservation: boolean;
  49412. private _useSmithVisibilityHeightCorrelated;
  49413. /**
  49414. * LEGACY Mode set to false
  49415. * Defines if the material uses height smith correlated visibility term.
  49416. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  49417. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  49418. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  49419. * Not relying on height correlated will also disable energy conservation.
  49420. */
  49421. useSmithVisibilityHeightCorrelated: boolean;
  49422. private _useSphericalHarmonics;
  49423. /**
  49424. * LEGACY Mode set to false
  49425. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  49426. * diffuse part of the IBL.
  49427. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  49428. * to the ground truth.
  49429. */
  49430. useSphericalHarmonics: boolean;
  49431. private _useSpecularGlossinessInputEnergyConservation;
  49432. /**
  49433. * Defines if the material uses energy conservation, when the specular workflow is active.
  49434. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  49435. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  49436. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  49437. */
  49438. useSpecularGlossinessInputEnergyConservation: boolean;
  49439. /** @hidden */
  49440. private _internalMarkAllSubMeshesAsMiscDirty;
  49441. /** @hidden */
  49442. _markAllSubMeshesAsMiscDirty(): void;
  49443. /**
  49444. * Instantiate a new istance of clear coat configuration.
  49445. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  49446. */
  49447. constructor(markAllSubMeshesAsMiscDirty: () => void);
  49448. /**
  49449. * Checks to see if a texture is used in the material.
  49450. * @param defines the list of "defines" to update.
  49451. */
  49452. prepareDefines(defines: IMaterialBRDFDefines): void;
  49453. /**
  49454. * Get the current class name of the texture useful for serialization or dynamic coding.
  49455. * @returns "PBRClearCoatConfiguration"
  49456. */
  49457. getClassName(): string;
  49458. /**
  49459. * Makes a duplicate of the current configuration into another one.
  49460. * @param brdfConfiguration define the config where to copy the info
  49461. */
  49462. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  49463. /**
  49464. * Serializes this BRDF configuration.
  49465. * @returns - An object with the serialized config.
  49466. */
  49467. serialize(): any;
  49468. /**
  49469. * Parses a anisotropy Configuration from a serialized object.
  49470. * @param source - Serialized object.
  49471. * @param scene Defines the scene we are parsing for
  49472. * @param rootUrl Defines the rootUrl to load from
  49473. */
  49474. parse(source: any, scene: Scene, rootUrl: string): void;
  49475. }
  49476. }
  49477. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  49478. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49479. import { Color3 } from "babylonjs/Maths/math.color";
  49480. import { Scene } from "babylonjs/scene";
  49481. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49482. import { Nullable } from "babylonjs/types";
  49483. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49484. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49485. /**
  49486. * @hidden
  49487. */
  49488. export interface IMaterialSheenDefines {
  49489. SHEEN: boolean;
  49490. SHEEN_TEXTURE: boolean;
  49491. SHEEN_TEXTUREDIRECTUV: number;
  49492. SHEEN_LINKWITHALBEDO: boolean;
  49493. /** @hidden */
  49494. _areTexturesDirty: boolean;
  49495. }
  49496. /**
  49497. * Define the code related to the Sheen parameters of the pbr material.
  49498. */
  49499. export class PBRSheenConfiguration {
  49500. private _isEnabled;
  49501. /**
  49502. * Defines if the material uses sheen.
  49503. */
  49504. isEnabled: boolean;
  49505. private _linkSheenWithAlbedo;
  49506. /**
  49507. * Defines if the sheen is linked to the sheen color.
  49508. */
  49509. linkSheenWithAlbedo: boolean;
  49510. /**
  49511. * Defines the sheen intensity.
  49512. */
  49513. intensity: number;
  49514. /**
  49515. * Defines the sheen color.
  49516. */
  49517. color: Color3;
  49518. private _texture;
  49519. /**
  49520. * Stores the sheen tint values in a texture.
  49521. * rgb is tint
  49522. * a is a intensity
  49523. */
  49524. texture: Nullable<BaseTexture>;
  49525. /** @hidden */
  49526. private _internalMarkAllSubMeshesAsTexturesDirty;
  49527. /** @hidden */
  49528. _markAllSubMeshesAsTexturesDirty(): void;
  49529. /**
  49530. * Instantiate a new istance of clear coat configuration.
  49531. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49532. */
  49533. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49534. /**
  49535. * Specifies that the submesh is ready to be used.
  49536. * @param defines the list of "defines" to update.
  49537. * @param scene defines the scene the material belongs to.
  49538. * @returns - boolean indicating that the submesh is ready or not.
  49539. */
  49540. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  49541. /**
  49542. * Checks to see if a texture is used in the material.
  49543. * @param defines the list of "defines" to update.
  49544. * @param scene defines the scene the material belongs to.
  49545. */
  49546. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  49547. /**
  49548. * Binds the material data.
  49549. * @param uniformBuffer defines the Uniform buffer to fill in.
  49550. * @param scene defines the scene the material belongs to.
  49551. * @param isFrozen defines wether the material is frozen or not.
  49552. */
  49553. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  49554. /**
  49555. * Checks to see if a texture is used in the material.
  49556. * @param texture - Base texture to use.
  49557. * @returns - Boolean specifying if a texture is used in the material.
  49558. */
  49559. hasTexture(texture: BaseTexture): boolean;
  49560. /**
  49561. * Returns an array of the actively used textures.
  49562. * @param activeTextures Array of BaseTextures
  49563. */
  49564. getActiveTextures(activeTextures: BaseTexture[]): void;
  49565. /**
  49566. * Returns the animatable textures.
  49567. * @param animatables Array of animatable textures.
  49568. */
  49569. getAnimatables(animatables: IAnimatable[]): void;
  49570. /**
  49571. * Disposes the resources of the material.
  49572. * @param forceDisposeTextures - Forces the disposal of all textures.
  49573. */
  49574. dispose(forceDisposeTextures?: boolean): void;
  49575. /**
  49576. * Get the current class name of the texture useful for serialization or dynamic coding.
  49577. * @returns "PBRSheenConfiguration"
  49578. */
  49579. getClassName(): string;
  49580. /**
  49581. * Add fallbacks to the effect fallbacks list.
  49582. * @param defines defines the Base texture to use.
  49583. * @param fallbacks defines the current fallback list.
  49584. * @param currentRank defines the current fallback rank.
  49585. * @returns the new fallback rank.
  49586. */
  49587. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49588. /**
  49589. * Add the required uniforms to the current list.
  49590. * @param uniforms defines the current uniform list.
  49591. */
  49592. static AddUniforms(uniforms: string[]): void;
  49593. /**
  49594. * Add the required uniforms to the current buffer.
  49595. * @param uniformBuffer defines the current uniform buffer.
  49596. */
  49597. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49598. /**
  49599. * Add the required samplers to the current list.
  49600. * @param samplers defines the current sampler list.
  49601. */
  49602. static AddSamplers(samplers: string[]): void;
  49603. /**
  49604. * Makes a duplicate of the current configuration into another one.
  49605. * @param sheenConfiguration define the config where to copy the info
  49606. */
  49607. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  49608. /**
  49609. * Serializes this BRDF configuration.
  49610. * @returns - An object with the serialized config.
  49611. */
  49612. serialize(): any;
  49613. /**
  49614. * Parses a anisotropy Configuration from a serialized object.
  49615. * @param source - Serialized object.
  49616. * @param scene Defines the scene we are parsing for
  49617. * @param rootUrl Defines the rootUrl to load from
  49618. */
  49619. parse(source: any, scene: Scene, rootUrl: string): void;
  49620. }
  49621. }
  49622. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  49623. import { Nullable } from "babylonjs/types";
  49624. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49625. import { Color3 } from "babylonjs/Maths/math.color";
  49626. import { SmartArray } from "babylonjs/Misc/smartArray";
  49627. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49628. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  49629. import { Effect } from "babylonjs/Materials/effect";
  49630. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49631. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49632. import { Engine } from "babylonjs/Engines/engine";
  49633. import { Scene } from "babylonjs/scene";
  49634. /**
  49635. * @hidden
  49636. */
  49637. export interface IMaterialSubSurfaceDefines {
  49638. SUBSURFACE: boolean;
  49639. SS_REFRACTION: boolean;
  49640. SS_TRANSLUCENCY: boolean;
  49641. SS_SCATERRING: boolean;
  49642. SS_THICKNESSANDMASK_TEXTURE: boolean;
  49643. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  49644. SS_REFRACTIONMAP_3D: boolean;
  49645. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  49646. SS_LODINREFRACTIONALPHA: boolean;
  49647. SS_GAMMAREFRACTION: boolean;
  49648. SS_RGBDREFRACTION: boolean;
  49649. SS_LINEARSPECULARREFRACTION: boolean;
  49650. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  49651. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  49652. /** @hidden */
  49653. _areTexturesDirty: boolean;
  49654. }
  49655. /**
  49656. * Define the code related to the sub surface parameters of the pbr material.
  49657. */
  49658. export class PBRSubSurfaceConfiguration {
  49659. private _isRefractionEnabled;
  49660. /**
  49661. * Defines if the refraction is enabled in the material.
  49662. */
  49663. isRefractionEnabled: boolean;
  49664. private _isTranslucencyEnabled;
  49665. /**
  49666. * Defines if the translucency is enabled in the material.
  49667. */
  49668. isTranslucencyEnabled: boolean;
  49669. private _isScatteringEnabled;
  49670. /**
  49671. * Defines the refraction intensity of the material.
  49672. * The refraction when enabled replaces the Diffuse part of the material.
  49673. * The intensity helps transitionning between diffuse and refraction.
  49674. */
  49675. refractionIntensity: number;
  49676. /**
  49677. * Defines the translucency intensity of the material.
  49678. * When translucency has been enabled, this defines how much of the "translucency"
  49679. * is addded to the diffuse part of the material.
  49680. */
  49681. translucencyIntensity: number;
  49682. /**
  49683. * Defines the scattering intensity of the material.
  49684. * When scattering has been enabled, this defines how much of the "scattered light"
  49685. * is addded to the diffuse part of the material.
  49686. */
  49687. scatteringIntensity: number;
  49688. private _thicknessTexture;
  49689. /**
  49690. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  49691. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  49692. * 0 would mean minimumThickness
  49693. * 1 would mean maximumThickness
  49694. * The other channels might be use as a mask to vary the different effects intensity.
  49695. */
  49696. thicknessTexture: Nullable<BaseTexture>;
  49697. private _refractionTexture;
  49698. /**
  49699. * Defines the texture to use for refraction.
  49700. */
  49701. refractionTexture: Nullable<BaseTexture>;
  49702. private _indexOfRefraction;
  49703. /**
  49704. * Defines the index of refraction used in the material.
  49705. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  49706. */
  49707. indexOfRefraction: number;
  49708. private _invertRefractionY;
  49709. /**
  49710. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  49711. */
  49712. invertRefractionY: boolean;
  49713. private _linkRefractionWithTransparency;
  49714. /**
  49715. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  49716. * Materials half opaque for instance using refraction could benefit from this control.
  49717. */
  49718. linkRefractionWithTransparency: boolean;
  49719. /**
  49720. * Defines the minimum thickness stored in the thickness map.
  49721. * If no thickness map is defined, this value will be used to simulate thickness.
  49722. */
  49723. minimumThickness: number;
  49724. /**
  49725. * Defines the maximum thickness stored in the thickness map.
  49726. */
  49727. maximumThickness: number;
  49728. /**
  49729. * Defines the volume tint of the material.
  49730. * This is used for both translucency and scattering.
  49731. */
  49732. tintColor: Color3;
  49733. /**
  49734. * Defines the distance at which the tint color should be found in the media.
  49735. * This is used for refraction only.
  49736. */
  49737. tintColorAtDistance: number;
  49738. /**
  49739. * Defines how far each channel transmit through the media.
  49740. * It is defined as a color to simplify it selection.
  49741. */
  49742. diffusionDistance: Color3;
  49743. private _useMaskFromThicknessTexture;
  49744. /**
  49745. * Stores the intensity of the different subsurface effects in the thickness texture.
  49746. * * the green channel is the translucency intensity.
  49747. * * the blue channel is the scattering intensity.
  49748. * * the alpha channel is the refraction intensity.
  49749. */
  49750. useMaskFromThicknessTexture: boolean;
  49751. /** @hidden */
  49752. private _internalMarkAllSubMeshesAsTexturesDirty;
  49753. /** @hidden */
  49754. _markAllSubMeshesAsTexturesDirty(): void;
  49755. /**
  49756. * Instantiate a new istance of sub surface configuration.
  49757. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49758. */
  49759. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49760. /**
  49761. * Gets wehter the submesh is ready to be used or not.
  49762. * @param defines the list of "defines" to update.
  49763. * @param scene defines the scene the material belongs to.
  49764. * @returns - boolean indicating that the submesh is ready or not.
  49765. */
  49766. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  49767. /**
  49768. * Checks to see if a texture is used in the material.
  49769. * @param defines the list of "defines" to update.
  49770. * @param scene defines the scene to the material belongs to.
  49771. */
  49772. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  49773. /**
  49774. * Binds the material data.
  49775. * @param uniformBuffer defines the Uniform buffer to fill in.
  49776. * @param scene defines the scene the material belongs to.
  49777. * @param engine defines the engine the material belongs to.
  49778. * @param isFrozen defines wether the material is frozen or not.
  49779. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  49780. */
  49781. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  49782. /**
  49783. * Unbinds the material from the mesh.
  49784. * @param activeEffect defines the effect that should be unbound from.
  49785. * @returns true if unbound, otherwise false
  49786. */
  49787. unbind(activeEffect: Effect): boolean;
  49788. /**
  49789. * Returns the texture used for refraction or null if none is used.
  49790. * @param scene defines the scene the material belongs to.
  49791. * @returns - Refraction texture if present. If no refraction texture and refraction
  49792. * is linked with transparency, returns environment texture. Otherwise, returns null.
  49793. */
  49794. private _getRefractionTexture;
  49795. /**
  49796. * Returns true if alpha blending should be disabled.
  49797. */
  49798. readonly disableAlphaBlending: boolean;
  49799. /**
  49800. * Fills the list of render target textures.
  49801. * @param renderTargets the list of render targets to update
  49802. */
  49803. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  49804. /**
  49805. * Checks to see if a texture is used in the material.
  49806. * @param texture - Base texture to use.
  49807. * @returns - Boolean specifying if a texture is used in the material.
  49808. */
  49809. hasTexture(texture: BaseTexture): boolean;
  49810. /**
  49811. * Gets a boolean indicating that current material needs to register RTT
  49812. * @returns true if this uses a render target otherwise false.
  49813. */
  49814. hasRenderTargetTextures(): boolean;
  49815. /**
  49816. * Returns an array of the actively used textures.
  49817. * @param activeTextures Array of BaseTextures
  49818. */
  49819. getActiveTextures(activeTextures: BaseTexture[]): void;
  49820. /**
  49821. * Returns the animatable textures.
  49822. * @param animatables Array of animatable textures.
  49823. */
  49824. getAnimatables(animatables: IAnimatable[]): void;
  49825. /**
  49826. * Disposes the resources of the material.
  49827. * @param forceDisposeTextures - Forces the disposal of all textures.
  49828. */
  49829. dispose(forceDisposeTextures?: boolean): void;
  49830. /**
  49831. * Get the current class name of the texture useful for serialization or dynamic coding.
  49832. * @returns "PBRSubSurfaceConfiguration"
  49833. */
  49834. getClassName(): string;
  49835. /**
  49836. * Add fallbacks to the effect fallbacks list.
  49837. * @param defines defines the Base texture to use.
  49838. * @param fallbacks defines the current fallback list.
  49839. * @param currentRank defines the current fallback rank.
  49840. * @returns the new fallback rank.
  49841. */
  49842. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49843. /**
  49844. * Add the required uniforms to the current list.
  49845. * @param uniforms defines the current uniform list.
  49846. */
  49847. static AddUniforms(uniforms: string[]): void;
  49848. /**
  49849. * Add the required samplers to the current list.
  49850. * @param samplers defines the current sampler list.
  49851. */
  49852. static AddSamplers(samplers: string[]): void;
  49853. /**
  49854. * Add the required uniforms to the current buffer.
  49855. * @param uniformBuffer defines the current uniform buffer.
  49856. */
  49857. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49858. /**
  49859. * Makes a duplicate of the current configuration into another one.
  49860. * @param configuration define the config where to copy the info
  49861. */
  49862. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  49863. /**
  49864. * Serializes this Sub Surface configuration.
  49865. * @returns - An object with the serialized config.
  49866. */
  49867. serialize(): any;
  49868. /**
  49869. * Parses a anisotropy Configuration from a serialized object.
  49870. * @param source - Serialized object.
  49871. * @param scene Defines the scene we are parsing for
  49872. * @param rootUrl Defines the rootUrl to load from
  49873. */
  49874. parse(source: any, scene: Scene, rootUrl: string): void;
  49875. }
  49876. }
  49877. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  49878. /** @hidden */
  49879. export var pbrFragmentDeclaration: {
  49880. name: string;
  49881. shader: string;
  49882. };
  49883. }
  49884. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  49885. /** @hidden */
  49886. export var pbrUboDeclaration: {
  49887. name: string;
  49888. shader: string;
  49889. };
  49890. }
  49891. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  49892. /** @hidden */
  49893. export var pbrFragmentExtraDeclaration: {
  49894. name: string;
  49895. shader: string;
  49896. };
  49897. }
  49898. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  49899. /** @hidden */
  49900. export var pbrFragmentSamplersDeclaration: {
  49901. name: string;
  49902. shader: string;
  49903. };
  49904. }
  49905. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  49906. /** @hidden */
  49907. export var pbrHelperFunctions: {
  49908. name: string;
  49909. shader: string;
  49910. };
  49911. }
  49912. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  49913. /** @hidden */
  49914. export var harmonicsFunctions: {
  49915. name: string;
  49916. shader: string;
  49917. };
  49918. }
  49919. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  49920. /** @hidden */
  49921. export var pbrDirectLightingSetupFunctions: {
  49922. name: string;
  49923. shader: string;
  49924. };
  49925. }
  49926. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  49927. /** @hidden */
  49928. export var pbrDirectLightingFalloffFunctions: {
  49929. name: string;
  49930. shader: string;
  49931. };
  49932. }
  49933. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  49934. /** @hidden */
  49935. export var pbrBRDFFunctions: {
  49936. name: string;
  49937. shader: string;
  49938. };
  49939. }
  49940. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  49941. /** @hidden */
  49942. export var pbrDirectLightingFunctions: {
  49943. name: string;
  49944. shader: string;
  49945. };
  49946. }
  49947. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  49948. /** @hidden */
  49949. export var pbrIBLFunctions: {
  49950. name: string;
  49951. shader: string;
  49952. };
  49953. }
  49954. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  49955. /** @hidden */
  49956. export var pbrDebug: {
  49957. name: string;
  49958. shader: string;
  49959. };
  49960. }
  49961. declare module "babylonjs/Shaders/pbr.fragment" {
  49962. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  49963. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  49964. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  49965. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  49966. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  49967. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  49968. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  49969. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  49970. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  49971. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  49972. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  49973. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  49974. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  49975. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  49976. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  49977. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  49978. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  49979. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  49980. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  49981. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  49982. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  49983. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  49984. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  49985. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  49986. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  49987. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  49988. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  49989. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  49990. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  49991. /** @hidden */
  49992. export var pbrPixelShader: {
  49993. name: string;
  49994. shader: string;
  49995. };
  49996. }
  49997. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  49998. /** @hidden */
  49999. export var pbrVertexDeclaration: {
  50000. name: string;
  50001. shader: string;
  50002. };
  50003. }
  50004. declare module "babylonjs/Shaders/pbr.vertex" {
  50005. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  50006. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  50007. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  50008. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  50009. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  50010. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  50011. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  50012. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  50013. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  50014. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  50015. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  50016. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  50017. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  50018. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  50019. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  50020. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  50021. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  50022. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  50023. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  50024. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  50025. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  50026. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  50027. /** @hidden */
  50028. export var pbrVertexShader: {
  50029. name: string;
  50030. shader: string;
  50031. };
  50032. }
  50033. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  50034. import { Nullable } from "babylonjs/types";
  50035. import { Scene } from "babylonjs/scene";
  50036. import { Matrix } from "babylonjs/Maths/math.vector";
  50037. import { SubMesh } from "babylonjs/Meshes/subMesh";
  50038. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50039. import { Mesh } from "babylonjs/Meshes/mesh";
  50040. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  50041. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  50042. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  50043. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  50044. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  50045. import { Color3 } from "babylonjs/Maths/math.color";
  50046. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  50047. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  50048. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  50049. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  50050. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  50051. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  50052. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  50053. import "babylonjs/Shaders/pbr.fragment";
  50054. import "babylonjs/Shaders/pbr.vertex";
  50055. /**
  50056. * Manages the defines for the PBR Material.
  50057. * @hidden
  50058. */
  50059. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  50060. PBR: boolean;
  50061. MAINUV1: boolean;
  50062. MAINUV2: boolean;
  50063. UV1: boolean;
  50064. UV2: boolean;
  50065. ALBEDO: boolean;
  50066. ALBEDODIRECTUV: number;
  50067. VERTEXCOLOR: boolean;
  50068. AMBIENT: boolean;
  50069. AMBIENTDIRECTUV: number;
  50070. AMBIENTINGRAYSCALE: boolean;
  50071. OPACITY: boolean;
  50072. VERTEXALPHA: boolean;
  50073. OPACITYDIRECTUV: number;
  50074. OPACITYRGB: boolean;
  50075. ALPHATEST: boolean;
  50076. DEPTHPREPASS: boolean;
  50077. ALPHABLEND: boolean;
  50078. ALPHAFROMALBEDO: boolean;
  50079. ALPHATESTVALUE: string;
  50080. SPECULAROVERALPHA: boolean;
  50081. RADIANCEOVERALPHA: boolean;
  50082. ALPHAFRESNEL: boolean;
  50083. LINEARALPHAFRESNEL: boolean;
  50084. PREMULTIPLYALPHA: boolean;
  50085. EMISSIVE: boolean;
  50086. EMISSIVEDIRECTUV: number;
  50087. REFLECTIVITY: boolean;
  50088. REFLECTIVITYDIRECTUV: number;
  50089. SPECULARTERM: boolean;
  50090. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  50091. MICROSURFACEAUTOMATIC: boolean;
  50092. LODBASEDMICROSFURACE: boolean;
  50093. MICROSURFACEMAP: boolean;
  50094. MICROSURFACEMAPDIRECTUV: number;
  50095. METALLICWORKFLOW: boolean;
  50096. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  50097. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  50098. METALLNESSSTOREINMETALMAPBLUE: boolean;
  50099. AOSTOREINMETALMAPRED: boolean;
  50100. METALLICF0FACTORFROMMETALLICMAP: boolean;
  50101. ENVIRONMENTBRDF: boolean;
  50102. ENVIRONMENTBRDF_RGBD: boolean;
  50103. NORMAL: boolean;
  50104. TANGENT: boolean;
  50105. BUMP: boolean;
  50106. BUMPDIRECTUV: number;
  50107. OBJECTSPACE_NORMALMAP: boolean;
  50108. PARALLAX: boolean;
  50109. PARALLAXOCCLUSION: boolean;
  50110. NORMALXYSCALE: boolean;
  50111. LIGHTMAP: boolean;
  50112. LIGHTMAPDIRECTUV: number;
  50113. USELIGHTMAPASSHADOWMAP: boolean;
  50114. GAMMALIGHTMAP: boolean;
  50115. RGBDLIGHTMAP: boolean;
  50116. REFLECTION: boolean;
  50117. REFLECTIONMAP_3D: boolean;
  50118. REFLECTIONMAP_SPHERICAL: boolean;
  50119. REFLECTIONMAP_PLANAR: boolean;
  50120. REFLECTIONMAP_CUBIC: boolean;
  50121. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  50122. REFLECTIONMAP_PROJECTION: boolean;
  50123. REFLECTIONMAP_SKYBOX: boolean;
  50124. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  50125. REFLECTIONMAP_EXPLICIT: boolean;
  50126. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  50127. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  50128. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  50129. INVERTCUBICMAP: boolean;
  50130. USESPHERICALFROMREFLECTIONMAP: boolean;
  50131. USEIRRADIANCEMAP: boolean;
  50132. SPHERICAL_HARMONICS: boolean;
  50133. USESPHERICALINVERTEX: boolean;
  50134. REFLECTIONMAP_OPPOSITEZ: boolean;
  50135. LODINREFLECTIONALPHA: boolean;
  50136. GAMMAREFLECTION: boolean;
  50137. RGBDREFLECTION: boolean;
  50138. LINEARSPECULARREFLECTION: boolean;
  50139. RADIANCEOCCLUSION: boolean;
  50140. HORIZONOCCLUSION: boolean;
  50141. INSTANCES: boolean;
  50142. NUM_BONE_INFLUENCERS: number;
  50143. BonesPerMesh: number;
  50144. BONETEXTURE: boolean;
  50145. NONUNIFORMSCALING: boolean;
  50146. MORPHTARGETS: boolean;
  50147. MORPHTARGETS_NORMAL: boolean;
  50148. MORPHTARGETS_TANGENT: boolean;
  50149. MORPHTARGETS_UV: boolean;
  50150. NUM_MORPH_INFLUENCERS: number;
  50151. IMAGEPROCESSING: boolean;
  50152. VIGNETTE: boolean;
  50153. VIGNETTEBLENDMODEMULTIPLY: boolean;
  50154. VIGNETTEBLENDMODEOPAQUE: boolean;
  50155. TONEMAPPING: boolean;
  50156. TONEMAPPING_ACES: boolean;
  50157. CONTRAST: boolean;
  50158. COLORCURVES: boolean;
  50159. COLORGRADING: boolean;
  50160. COLORGRADING3D: boolean;
  50161. SAMPLER3DGREENDEPTH: boolean;
  50162. SAMPLER3DBGRMAP: boolean;
  50163. IMAGEPROCESSINGPOSTPROCESS: boolean;
  50164. EXPOSURE: boolean;
  50165. MULTIVIEW: boolean;
  50166. USEPHYSICALLIGHTFALLOFF: boolean;
  50167. USEGLTFLIGHTFALLOFF: boolean;
  50168. TWOSIDEDLIGHTING: boolean;
  50169. SHADOWFLOAT: boolean;
  50170. CLIPPLANE: boolean;
  50171. CLIPPLANE2: boolean;
  50172. CLIPPLANE3: boolean;
  50173. CLIPPLANE4: boolean;
  50174. POINTSIZE: boolean;
  50175. FOG: boolean;
  50176. LOGARITHMICDEPTH: boolean;
  50177. FORCENORMALFORWARD: boolean;
  50178. SPECULARAA: boolean;
  50179. CLEARCOAT: boolean;
  50180. CLEARCOAT_DEFAULTIOR: boolean;
  50181. CLEARCOAT_TEXTURE: boolean;
  50182. CLEARCOAT_TEXTUREDIRECTUV: number;
  50183. CLEARCOAT_BUMP: boolean;
  50184. CLEARCOAT_BUMPDIRECTUV: number;
  50185. CLEARCOAT_TINT: boolean;
  50186. CLEARCOAT_TINT_TEXTURE: boolean;
  50187. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  50188. ANISOTROPIC: boolean;
  50189. ANISOTROPIC_TEXTURE: boolean;
  50190. ANISOTROPIC_TEXTUREDIRECTUV: number;
  50191. BRDF_V_HEIGHT_CORRELATED: boolean;
  50192. MS_BRDF_ENERGY_CONSERVATION: boolean;
  50193. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  50194. SHEEN: boolean;
  50195. SHEEN_TEXTURE: boolean;
  50196. SHEEN_TEXTUREDIRECTUV: number;
  50197. SHEEN_LINKWITHALBEDO: boolean;
  50198. SUBSURFACE: boolean;
  50199. SS_REFRACTION: boolean;
  50200. SS_TRANSLUCENCY: boolean;
  50201. SS_SCATERRING: boolean;
  50202. SS_THICKNESSANDMASK_TEXTURE: boolean;
  50203. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  50204. SS_REFRACTIONMAP_3D: boolean;
  50205. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  50206. SS_LODINREFRACTIONALPHA: boolean;
  50207. SS_GAMMAREFRACTION: boolean;
  50208. SS_RGBDREFRACTION: boolean;
  50209. SS_LINEARSPECULARREFRACTION: boolean;
  50210. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  50211. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  50212. UNLIT: boolean;
  50213. DEBUGMODE: number;
  50214. /**
  50215. * Initializes the PBR Material defines.
  50216. */
  50217. constructor();
  50218. /**
  50219. * Resets the PBR Material defines.
  50220. */
  50221. reset(): void;
  50222. }
  50223. /**
  50224. * The Physically based material base class of BJS.
  50225. *
  50226. * This offers the main features of a standard PBR material.
  50227. * For more information, please refer to the documentation :
  50228. * https://doc.babylonjs.com/how_to/physically_based_rendering
  50229. */
  50230. export abstract class PBRBaseMaterial extends PushMaterial {
  50231. /**
  50232. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  50233. */
  50234. static readonly PBRMATERIAL_OPAQUE: number;
  50235. /**
  50236. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  50237. */
  50238. static readonly PBRMATERIAL_ALPHATEST: number;
  50239. /**
  50240. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50241. */
  50242. static readonly PBRMATERIAL_ALPHABLEND: number;
  50243. /**
  50244. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50245. * They are also discarded below the alpha cutoff threshold to improve performances.
  50246. */
  50247. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  50248. /**
  50249. * Defines the default value of how much AO map is occluding the analytical lights
  50250. * (point spot...).
  50251. */
  50252. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  50253. /**
  50254. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  50255. */
  50256. static readonly LIGHTFALLOFF_PHYSICAL: number;
  50257. /**
  50258. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  50259. * to enhance interoperability with other engines.
  50260. */
  50261. static readonly LIGHTFALLOFF_GLTF: number;
  50262. /**
  50263. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  50264. * to enhance interoperability with other materials.
  50265. */
  50266. static readonly LIGHTFALLOFF_STANDARD: number;
  50267. /**
  50268. * Intensity of the direct lights e.g. the four lights available in your scene.
  50269. * This impacts both the direct diffuse and specular highlights.
  50270. */
  50271. protected _directIntensity: number;
  50272. /**
  50273. * Intensity of the emissive part of the material.
  50274. * This helps controlling the emissive effect without modifying the emissive color.
  50275. */
  50276. protected _emissiveIntensity: number;
  50277. /**
  50278. * Intensity of the environment e.g. how much the environment will light the object
  50279. * either through harmonics for rough material or through the refelction for shiny ones.
  50280. */
  50281. protected _environmentIntensity: number;
  50282. /**
  50283. * This is a special control allowing the reduction of the specular highlights coming from the
  50284. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  50285. */
  50286. protected _specularIntensity: number;
  50287. /**
  50288. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  50289. */
  50290. private _lightingInfos;
  50291. /**
  50292. * Debug Control allowing disabling the bump map on this material.
  50293. */
  50294. protected _disableBumpMap: boolean;
  50295. /**
  50296. * AKA Diffuse Texture in standard nomenclature.
  50297. */
  50298. protected _albedoTexture: Nullable<BaseTexture>;
  50299. /**
  50300. * AKA Occlusion Texture in other nomenclature.
  50301. */
  50302. protected _ambientTexture: Nullable<BaseTexture>;
  50303. /**
  50304. * AKA Occlusion Texture Intensity in other nomenclature.
  50305. */
  50306. protected _ambientTextureStrength: number;
  50307. /**
  50308. * Defines how much the AO map is occluding the analytical lights (point spot...).
  50309. * 1 means it completely occludes it
  50310. * 0 mean it has no impact
  50311. */
  50312. protected _ambientTextureImpactOnAnalyticalLights: number;
  50313. /**
  50314. * Stores the alpha values in a texture.
  50315. */
  50316. protected _opacityTexture: Nullable<BaseTexture>;
  50317. /**
  50318. * Stores the reflection values in a texture.
  50319. */
  50320. protected _reflectionTexture: Nullable<BaseTexture>;
  50321. /**
  50322. * Stores the emissive values in a texture.
  50323. */
  50324. protected _emissiveTexture: Nullable<BaseTexture>;
  50325. /**
  50326. * AKA Specular texture in other nomenclature.
  50327. */
  50328. protected _reflectivityTexture: Nullable<BaseTexture>;
  50329. /**
  50330. * Used to switch from specular/glossiness to metallic/roughness workflow.
  50331. */
  50332. protected _metallicTexture: Nullable<BaseTexture>;
  50333. /**
  50334. * Specifies the metallic scalar of the metallic/roughness workflow.
  50335. * Can also be used to scale the metalness values of the metallic texture.
  50336. */
  50337. protected _metallic: Nullable<number>;
  50338. /**
  50339. * Specifies the roughness scalar of the metallic/roughness workflow.
  50340. * Can also be used to scale the roughness values of the metallic texture.
  50341. */
  50342. protected _roughness: Nullable<number>;
  50343. /**
  50344. * Specifies the an F0 factor to help configuring the material F0.
  50345. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  50346. * to 0.5 the previously hard coded value stays the same.
  50347. * Can also be used to scale the F0 values of the metallic texture.
  50348. */
  50349. protected _metallicF0Factor: number;
  50350. /**
  50351. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  50352. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  50353. * your expectation as it multiplies with the texture data.
  50354. */
  50355. protected _useMetallicF0FactorFromMetallicTexture: boolean;
  50356. /**
  50357. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  50358. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  50359. */
  50360. protected _microSurfaceTexture: Nullable<BaseTexture>;
  50361. /**
  50362. * Stores surface normal data used to displace a mesh in a texture.
  50363. */
  50364. protected _bumpTexture: Nullable<BaseTexture>;
  50365. /**
  50366. * Stores the pre-calculated light information of a mesh in a texture.
  50367. */
  50368. protected _lightmapTexture: Nullable<BaseTexture>;
  50369. /**
  50370. * The color of a material in ambient lighting.
  50371. */
  50372. protected _ambientColor: Color3;
  50373. /**
  50374. * AKA Diffuse Color in other nomenclature.
  50375. */
  50376. protected _albedoColor: Color3;
  50377. /**
  50378. * AKA Specular Color in other nomenclature.
  50379. */
  50380. protected _reflectivityColor: Color3;
  50381. /**
  50382. * The color applied when light is reflected from a material.
  50383. */
  50384. protected _reflectionColor: Color3;
  50385. /**
  50386. * The color applied when light is emitted from a material.
  50387. */
  50388. protected _emissiveColor: Color3;
  50389. /**
  50390. * AKA Glossiness in other nomenclature.
  50391. */
  50392. protected _microSurface: number;
  50393. /**
  50394. * Specifies that the material will use the light map as a show map.
  50395. */
  50396. protected _useLightmapAsShadowmap: boolean;
  50397. /**
  50398. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  50399. * makes the reflect vector face the model (under horizon).
  50400. */
  50401. protected _useHorizonOcclusion: boolean;
  50402. /**
  50403. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  50404. * too much the area relying on ambient texture to define their ambient occlusion.
  50405. */
  50406. protected _useRadianceOcclusion: boolean;
  50407. /**
  50408. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  50409. */
  50410. protected _useAlphaFromAlbedoTexture: boolean;
  50411. /**
  50412. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  50413. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  50414. */
  50415. protected _useSpecularOverAlpha: boolean;
  50416. /**
  50417. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  50418. */
  50419. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  50420. /**
  50421. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  50422. */
  50423. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  50424. /**
  50425. * Specifies if the metallic texture contains the roughness information in its green channel.
  50426. */
  50427. protected _useRoughnessFromMetallicTextureGreen: boolean;
  50428. /**
  50429. * Specifies if the metallic texture contains the metallness information in its blue channel.
  50430. */
  50431. protected _useMetallnessFromMetallicTextureBlue: boolean;
  50432. /**
  50433. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  50434. */
  50435. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  50436. /**
  50437. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  50438. */
  50439. protected _useAmbientInGrayScale: boolean;
  50440. /**
  50441. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  50442. * The material will try to infer what glossiness each pixel should be.
  50443. */
  50444. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  50445. /**
  50446. * Defines the falloff type used in this material.
  50447. * It by default is Physical.
  50448. */
  50449. protected _lightFalloff: number;
  50450. /**
  50451. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  50452. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  50453. */
  50454. protected _useRadianceOverAlpha: boolean;
  50455. /**
  50456. * Allows using an object space normal map (instead of tangent space).
  50457. */
  50458. protected _useObjectSpaceNormalMap: boolean;
  50459. /**
  50460. * Allows using the bump map in parallax mode.
  50461. */
  50462. protected _useParallax: boolean;
  50463. /**
  50464. * Allows using the bump map in parallax occlusion mode.
  50465. */
  50466. protected _useParallaxOcclusion: boolean;
  50467. /**
  50468. * Controls the scale bias of the parallax mode.
  50469. */
  50470. protected _parallaxScaleBias: number;
  50471. /**
  50472. * If sets to true, disables all the lights affecting the material.
  50473. */
  50474. protected _disableLighting: boolean;
  50475. /**
  50476. * Number of Simultaneous lights allowed on the material.
  50477. */
  50478. protected _maxSimultaneousLights: number;
  50479. /**
  50480. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  50481. */
  50482. protected _invertNormalMapX: boolean;
  50483. /**
  50484. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  50485. */
  50486. protected _invertNormalMapY: boolean;
  50487. /**
  50488. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  50489. */
  50490. protected _twoSidedLighting: boolean;
  50491. /**
  50492. * Defines the alpha limits in alpha test mode.
  50493. */
  50494. protected _alphaCutOff: number;
  50495. /**
  50496. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  50497. */
  50498. protected _forceAlphaTest: boolean;
  50499. /**
  50500. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50501. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  50502. */
  50503. protected _useAlphaFresnel: boolean;
  50504. /**
  50505. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50506. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  50507. */
  50508. protected _useLinearAlphaFresnel: boolean;
  50509. /**
  50510. * The transparency mode of the material.
  50511. */
  50512. protected _transparencyMode: Nullable<number>;
  50513. /**
  50514. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  50515. * from cos thetav and roughness:
  50516. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  50517. */
  50518. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  50519. /**
  50520. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  50521. */
  50522. protected _forceIrradianceInFragment: boolean;
  50523. /**
  50524. * Force normal to face away from face.
  50525. */
  50526. protected _forceNormalForward: boolean;
  50527. /**
  50528. * Enables specular anti aliasing in the PBR shader.
  50529. * It will both interacts on the Geometry for analytical and IBL lighting.
  50530. * It also prefilter the roughness map based on the bump values.
  50531. */
  50532. protected _enableSpecularAntiAliasing: boolean;
  50533. /**
  50534. * Default configuration related to image processing available in the PBR Material.
  50535. */
  50536. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  50537. /**
  50538. * Keep track of the image processing observer to allow dispose and replace.
  50539. */
  50540. private _imageProcessingObserver;
  50541. /**
  50542. * Attaches a new image processing configuration to the PBR Material.
  50543. * @param configuration
  50544. */
  50545. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  50546. /**
  50547. * Stores the available render targets.
  50548. */
  50549. private _renderTargets;
  50550. /**
  50551. * Sets the global ambient color for the material used in lighting calculations.
  50552. */
  50553. private _globalAmbientColor;
  50554. /**
  50555. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  50556. */
  50557. private _useLogarithmicDepth;
  50558. /**
  50559. * If set to true, no lighting calculations will be applied.
  50560. */
  50561. private _unlit;
  50562. private _debugMode;
  50563. /**
  50564. * @hidden
  50565. * This is reserved for the inspector.
  50566. * Defines the material debug mode.
  50567. * It helps seeing only some components of the material while troubleshooting.
  50568. */
  50569. debugMode: number;
  50570. /**
  50571. * @hidden
  50572. * This is reserved for the inspector.
  50573. * Specify from where on screen the debug mode should start.
  50574. * The value goes from -1 (full screen) to 1 (not visible)
  50575. * It helps with side by side comparison against the final render
  50576. * This defaults to -1
  50577. */
  50578. private debugLimit;
  50579. /**
  50580. * @hidden
  50581. * This is reserved for the inspector.
  50582. * As the default viewing range might not be enough (if the ambient is really small for instance)
  50583. * You can use the factor to better multiply the final value.
  50584. */
  50585. private debugFactor;
  50586. /**
  50587. * Defines the clear coat layer parameters for the material.
  50588. */
  50589. readonly clearCoat: PBRClearCoatConfiguration;
  50590. /**
  50591. * Defines the anisotropic parameters for the material.
  50592. */
  50593. readonly anisotropy: PBRAnisotropicConfiguration;
  50594. /**
  50595. * Defines the BRDF parameters for the material.
  50596. */
  50597. readonly brdf: PBRBRDFConfiguration;
  50598. /**
  50599. * Defines the Sheen parameters for the material.
  50600. */
  50601. readonly sheen: PBRSheenConfiguration;
  50602. /**
  50603. * Defines the SubSurface parameters for the material.
  50604. */
  50605. readonly subSurface: PBRSubSurfaceConfiguration;
  50606. /**
  50607. * Custom callback helping to override the default shader used in the material.
  50608. */
  50609. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  50610. protected _rebuildInParallel: boolean;
  50611. /**
  50612. * Instantiates a new PBRMaterial instance.
  50613. *
  50614. * @param name The material name
  50615. * @param scene The scene the material will be use in.
  50616. */
  50617. constructor(name: string, scene: Scene);
  50618. /**
  50619. * Gets a boolean indicating that current material needs to register RTT
  50620. */
  50621. readonly hasRenderTargetTextures: boolean;
  50622. /**
  50623. * Gets the name of the material class.
  50624. */
  50625. getClassName(): string;
  50626. /**
  50627. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  50628. */
  50629. /**
  50630. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  50631. */
  50632. useLogarithmicDepth: boolean;
  50633. /**
  50634. * Gets the current transparency mode.
  50635. */
  50636. /**
  50637. * Sets the transparency mode of the material.
  50638. *
  50639. * | Value | Type | Description |
  50640. * | ----- | ----------------------------------- | ----------- |
  50641. * | 0 | OPAQUE | |
  50642. * | 1 | ALPHATEST | |
  50643. * | 2 | ALPHABLEND | |
  50644. * | 3 | ALPHATESTANDBLEND | |
  50645. *
  50646. */
  50647. transparencyMode: Nullable<number>;
  50648. /**
  50649. * Returns true if alpha blending should be disabled.
  50650. */
  50651. private readonly _disableAlphaBlending;
  50652. /**
  50653. * Specifies whether or not this material should be rendered in alpha blend mode.
  50654. */
  50655. needAlphaBlending(): boolean;
  50656. /**
  50657. * Specifies if the mesh will require alpha blending.
  50658. * @param mesh - BJS mesh.
  50659. */
  50660. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  50661. /**
  50662. * Specifies whether or not this material should be rendered in alpha test mode.
  50663. */
  50664. needAlphaTesting(): boolean;
  50665. /**
  50666. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  50667. */
  50668. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  50669. /**
  50670. * Gets the texture used for the alpha test.
  50671. */
  50672. getAlphaTestTexture(): Nullable<BaseTexture>;
  50673. /**
  50674. * Specifies that the submesh is ready to be used.
  50675. * @param mesh - BJS mesh.
  50676. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  50677. * @param useInstances - Specifies that instances should be used.
  50678. * @returns - boolean indicating that the submesh is ready or not.
  50679. */
  50680. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  50681. /**
  50682. * Specifies if the material uses metallic roughness workflow.
  50683. * @returns boolean specifiying if the material uses metallic roughness workflow.
  50684. */
  50685. isMetallicWorkflow(): boolean;
  50686. private _prepareEffect;
  50687. private _prepareDefines;
  50688. /**
  50689. * Force shader compilation
  50690. */
  50691. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  50692. /**
  50693. * Initializes the uniform buffer layout for the shader.
  50694. */
  50695. buildUniformLayout(): void;
  50696. /**
  50697. * Unbinds the material from the mesh
  50698. */
  50699. unbind(): void;
  50700. /**
  50701. * Binds the submesh data.
  50702. * @param world - The world matrix.
  50703. * @param mesh - The BJS mesh.
  50704. * @param subMesh - A submesh of the BJS mesh.
  50705. */
  50706. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  50707. /**
  50708. * Returns the animatable textures.
  50709. * @returns - Array of animatable textures.
  50710. */
  50711. getAnimatables(): IAnimatable[];
  50712. /**
  50713. * Returns the texture used for reflections.
  50714. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  50715. */
  50716. private _getReflectionTexture;
  50717. /**
  50718. * Returns an array of the actively used textures.
  50719. * @returns - Array of BaseTextures
  50720. */
  50721. getActiveTextures(): BaseTexture[];
  50722. /**
  50723. * Checks to see if a texture is used in the material.
  50724. * @param texture - Base texture to use.
  50725. * @returns - Boolean specifying if a texture is used in the material.
  50726. */
  50727. hasTexture(texture: BaseTexture): boolean;
  50728. /**
  50729. * Disposes the resources of the material.
  50730. * @param forceDisposeEffect - Forces the disposal of effects.
  50731. * @param forceDisposeTextures - Forces the disposal of all textures.
  50732. */
  50733. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  50734. }
  50735. }
  50736. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  50737. import { Nullable } from "babylonjs/types";
  50738. import { Scene } from "babylonjs/scene";
  50739. import { Color3 } from "babylonjs/Maths/math.color";
  50740. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  50741. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  50742. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  50743. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  50744. /**
  50745. * The Physically based material of BJS.
  50746. *
  50747. * This offers the main features of a standard PBR material.
  50748. * For more information, please refer to the documentation :
  50749. * https://doc.babylonjs.com/how_to/physically_based_rendering
  50750. */
  50751. export class PBRMaterial extends PBRBaseMaterial {
  50752. /**
  50753. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  50754. */
  50755. static readonly PBRMATERIAL_OPAQUE: number;
  50756. /**
  50757. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  50758. */
  50759. static readonly PBRMATERIAL_ALPHATEST: number;
  50760. /**
  50761. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50762. */
  50763. static readonly PBRMATERIAL_ALPHABLEND: number;
  50764. /**
  50765. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50766. * They are also discarded below the alpha cutoff threshold to improve performances.
  50767. */
  50768. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  50769. /**
  50770. * Defines the default value of how much AO map is occluding the analytical lights
  50771. * (point spot...).
  50772. */
  50773. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  50774. /**
  50775. * Intensity of the direct lights e.g. the four lights available in your scene.
  50776. * This impacts both the direct diffuse and specular highlights.
  50777. */
  50778. directIntensity: number;
  50779. /**
  50780. * Intensity of the emissive part of the material.
  50781. * This helps controlling the emissive effect without modifying the emissive color.
  50782. */
  50783. emissiveIntensity: number;
  50784. /**
  50785. * Intensity of the environment e.g. how much the environment will light the object
  50786. * either through harmonics for rough material or through the refelction for shiny ones.
  50787. */
  50788. environmentIntensity: number;
  50789. /**
  50790. * This is a special control allowing the reduction of the specular highlights coming from the
  50791. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  50792. */
  50793. specularIntensity: number;
  50794. /**
  50795. * Debug Control allowing disabling the bump map on this material.
  50796. */
  50797. disableBumpMap: boolean;
  50798. /**
  50799. * AKA Diffuse Texture in standard nomenclature.
  50800. */
  50801. albedoTexture: BaseTexture;
  50802. /**
  50803. * AKA Occlusion Texture in other nomenclature.
  50804. */
  50805. ambientTexture: BaseTexture;
  50806. /**
  50807. * AKA Occlusion Texture Intensity in other nomenclature.
  50808. */
  50809. ambientTextureStrength: number;
  50810. /**
  50811. * Defines how much the AO map is occluding the analytical lights (point spot...).
  50812. * 1 means it completely occludes it
  50813. * 0 mean it has no impact
  50814. */
  50815. ambientTextureImpactOnAnalyticalLights: number;
  50816. /**
  50817. * Stores the alpha values in a texture.
  50818. */
  50819. opacityTexture: BaseTexture;
  50820. /**
  50821. * Stores the reflection values in a texture.
  50822. */
  50823. reflectionTexture: Nullable<BaseTexture>;
  50824. /**
  50825. * Stores the emissive values in a texture.
  50826. */
  50827. emissiveTexture: BaseTexture;
  50828. /**
  50829. * AKA Specular texture in other nomenclature.
  50830. */
  50831. reflectivityTexture: BaseTexture;
  50832. /**
  50833. * Used to switch from specular/glossiness to metallic/roughness workflow.
  50834. */
  50835. metallicTexture: BaseTexture;
  50836. /**
  50837. * Specifies the metallic scalar of the metallic/roughness workflow.
  50838. * Can also be used to scale the metalness values of the metallic texture.
  50839. */
  50840. metallic: Nullable<number>;
  50841. /**
  50842. * Specifies the roughness scalar of the metallic/roughness workflow.
  50843. * Can also be used to scale the roughness values of the metallic texture.
  50844. */
  50845. roughness: Nullable<number>;
  50846. /**
  50847. * Specifies the an F0 factor to help configuring the material F0.
  50848. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  50849. * to 0.5 the previously hard coded value stays the same.
  50850. * Can also be used to scale the F0 values of the metallic texture.
  50851. */
  50852. metallicF0Factor: number;
  50853. /**
  50854. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  50855. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  50856. * your expectation as it multiplies with the texture data.
  50857. */
  50858. useMetallicF0FactorFromMetallicTexture: boolean;
  50859. /**
  50860. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  50861. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  50862. */
  50863. microSurfaceTexture: BaseTexture;
  50864. /**
  50865. * Stores surface normal data used to displace a mesh in a texture.
  50866. */
  50867. bumpTexture: BaseTexture;
  50868. /**
  50869. * Stores the pre-calculated light information of a mesh in a texture.
  50870. */
  50871. lightmapTexture: BaseTexture;
  50872. /**
  50873. * Stores the refracted light information in a texture.
  50874. */
  50875. refractionTexture: Nullable<BaseTexture>;
  50876. /**
  50877. * The color of a material in ambient lighting.
  50878. */
  50879. ambientColor: Color3;
  50880. /**
  50881. * AKA Diffuse Color in other nomenclature.
  50882. */
  50883. albedoColor: Color3;
  50884. /**
  50885. * AKA Specular Color in other nomenclature.
  50886. */
  50887. reflectivityColor: Color3;
  50888. /**
  50889. * The color reflected from the material.
  50890. */
  50891. reflectionColor: Color3;
  50892. /**
  50893. * The color emitted from the material.
  50894. */
  50895. emissiveColor: Color3;
  50896. /**
  50897. * AKA Glossiness in other nomenclature.
  50898. */
  50899. microSurface: number;
  50900. /**
  50901. * source material index of refraction (IOR)' / 'destination material IOR.
  50902. */
  50903. indexOfRefraction: number;
  50904. /**
  50905. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  50906. */
  50907. invertRefractionY: boolean;
  50908. /**
  50909. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  50910. * Materials half opaque for instance using refraction could benefit from this control.
  50911. */
  50912. linkRefractionWithTransparency: boolean;
  50913. /**
  50914. * If true, the light map contains occlusion information instead of lighting info.
  50915. */
  50916. useLightmapAsShadowmap: boolean;
  50917. /**
  50918. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  50919. */
  50920. useAlphaFromAlbedoTexture: boolean;
  50921. /**
  50922. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  50923. */
  50924. forceAlphaTest: boolean;
  50925. /**
  50926. * Defines the alpha limits in alpha test mode.
  50927. */
  50928. alphaCutOff: number;
  50929. /**
  50930. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  50931. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  50932. */
  50933. useSpecularOverAlpha: boolean;
  50934. /**
  50935. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  50936. */
  50937. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  50938. /**
  50939. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  50940. */
  50941. useRoughnessFromMetallicTextureAlpha: boolean;
  50942. /**
  50943. * Specifies if the metallic texture contains the roughness information in its green channel.
  50944. */
  50945. useRoughnessFromMetallicTextureGreen: boolean;
  50946. /**
  50947. * Specifies if the metallic texture contains the metallness information in its blue channel.
  50948. */
  50949. useMetallnessFromMetallicTextureBlue: boolean;
  50950. /**
  50951. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  50952. */
  50953. useAmbientOcclusionFromMetallicTextureRed: boolean;
  50954. /**
  50955. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  50956. */
  50957. useAmbientInGrayScale: boolean;
  50958. /**
  50959. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  50960. * The material will try to infer what glossiness each pixel should be.
  50961. */
  50962. useAutoMicroSurfaceFromReflectivityMap: boolean;
  50963. /**
  50964. * BJS is using an harcoded light falloff based on a manually sets up range.
  50965. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  50966. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  50967. */
  50968. /**
  50969. * BJS is using an harcoded light falloff based on a manually sets up range.
  50970. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  50971. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  50972. */
  50973. usePhysicalLightFalloff: boolean;
  50974. /**
  50975. * In order to support the falloff compatibility with gltf, a special mode has been added
  50976. * to reproduce the gltf light falloff.
  50977. */
  50978. /**
  50979. * In order to support the falloff compatibility with gltf, a special mode has been added
  50980. * to reproduce the gltf light falloff.
  50981. */
  50982. useGLTFLightFalloff: boolean;
  50983. /**
  50984. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  50985. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  50986. */
  50987. useRadianceOverAlpha: boolean;
  50988. /**
  50989. * Allows using an object space normal map (instead of tangent space).
  50990. */
  50991. useObjectSpaceNormalMap: boolean;
  50992. /**
  50993. * Allows using the bump map in parallax mode.
  50994. */
  50995. useParallax: boolean;
  50996. /**
  50997. * Allows using the bump map in parallax occlusion mode.
  50998. */
  50999. useParallaxOcclusion: boolean;
  51000. /**
  51001. * Controls the scale bias of the parallax mode.
  51002. */
  51003. parallaxScaleBias: number;
  51004. /**
  51005. * If sets to true, disables all the lights affecting the material.
  51006. */
  51007. disableLighting: boolean;
  51008. /**
  51009. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  51010. */
  51011. forceIrradianceInFragment: boolean;
  51012. /**
  51013. * Number of Simultaneous lights allowed on the material.
  51014. */
  51015. maxSimultaneousLights: number;
  51016. /**
  51017. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  51018. */
  51019. invertNormalMapX: boolean;
  51020. /**
  51021. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  51022. */
  51023. invertNormalMapY: boolean;
  51024. /**
  51025. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  51026. */
  51027. twoSidedLighting: boolean;
  51028. /**
  51029. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  51030. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  51031. */
  51032. useAlphaFresnel: boolean;
  51033. /**
  51034. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  51035. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  51036. */
  51037. useLinearAlphaFresnel: boolean;
  51038. /**
  51039. * Let user defines the brdf lookup texture used for IBL.
  51040. * A default 8bit version is embedded but you could point at :
  51041. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  51042. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  51043. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  51044. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  51045. */
  51046. environmentBRDFTexture: Nullable<BaseTexture>;
  51047. /**
  51048. * Force normal to face away from face.
  51049. */
  51050. forceNormalForward: boolean;
  51051. /**
  51052. * Enables specular anti aliasing in the PBR shader.
  51053. * It will both interacts on the Geometry for analytical and IBL lighting.
  51054. * It also prefilter the roughness map based on the bump values.
  51055. */
  51056. enableSpecularAntiAliasing: boolean;
  51057. /**
  51058. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  51059. * makes the reflect vector face the model (under horizon).
  51060. */
  51061. useHorizonOcclusion: boolean;
  51062. /**
  51063. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  51064. * too much the area relying on ambient texture to define their ambient occlusion.
  51065. */
  51066. useRadianceOcclusion: boolean;
  51067. /**
  51068. * If set to true, no lighting calculations will be applied.
  51069. */
  51070. unlit: boolean;
  51071. /**
  51072. * Gets the image processing configuration used either in this material.
  51073. */
  51074. /**
  51075. * Sets the Default image processing configuration used either in the this material.
  51076. *
  51077. * If sets to null, the scene one is in use.
  51078. */
  51079. imageProcessingConfiguration: ImageProcessingConfiguration;
  51080. /**
  51081. * Gets wether the color curves effect is enabled.
  51082. */
  51083. /**
  51084. * Sets wether the color curves effect is enabled.
  51085. */
  51086. cameraColorCurvesEnabled: boolean;
  51087. /**
  51088. * Gets wether the color grading effect is enabled.
  51089. */
  51090. /**
  51091. * Gets wether the color grading effect is enabled.
  51092. */
  51093. cameraColorGradingEnabled: boolean;
  51094. /**
  51095. * Gets wether tonemapping is enabled or not.
  51096. */
  51097. /**
  51098. * Sets wether tonemapping is enabled or not
  51099. */
  51100. cameraToneMappingEnabled: boolean;
  51101. /**
  51102. * The camera exposure used on this material.
  51103. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  51104. * This corresponds to a photographic exposure.
  51105. */
  51106. /**
  51107. * The camera exposure used on this material.
  51108. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  51109. * This corresponds to a photographic exposure.
  51110. */
  51111. cameraExposure: number;
  51112. /**
  51113. * Gets The camera contrast used on this material.
  51114. */
  51115. /**
  51116. * Sets The camera contrast used on this material.
  51117. */
  51118. cameraContrast: number;
  51119. /**
  51120. * Gets the Color Grading 2D Lookup Texture.
  51121. */
  51122. /**
  51123. * Sets the Color Grading 2D Lookup Texture.
  51124. */
  51125. cameraColorGradingTexture: Nullable<BaseTexture>;
  51126. /**
  51127. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  51128. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  51129. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  51130. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  51131. */
  51132. /**
  51133. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  51134. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  51135. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  51136. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  51137. */
  51138. cameraColorCurves: Nullable<ColorCurves>;
  51139. /**
  51140. * Instantiates a new PBRMaterial instance.
  51141. *
  51142. * @param name The material name
  51143. * @param scene The scene the material will be use in.
  51144. */
  51145. constructor(name: string, scene: Scene);
  51146. /**
  51147. * Returns the name of this material class.
  51148. */
  51149. getClassName(): string;
  51150. /**
  51151. * Makes a duplicate of the current material.
  51152. * @param name - name to use for the new material.
  51153. */
  51154. clone(name: string): PBRMaterial;
  51155. /**
  51156. * Serializes this PBR Material.
  51157. * @returns - An object with the serialized material.
  51158. */
  51159. serialize(): any;
  51160. /**
  51161. * Parses a PBR Material from a serialized object.
  51162. * @param source - Serialized object.
  51163. * @param scene - BJS scene instance.
  51164. * @param rootUrl - url for the scene object
  51165. * @returns - PBRMaterial
  51166. */
  51167. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  51168. }
  51169. }
  51170. declare module "babylonjs/Misc/dds" {
  51171. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  51172. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51173. import { Nullable } from "babylonjs/types";
  51174. import { Scene } from "babylonjs/scene";
  51175. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  51176. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  51177. /**
  51178. * Direct draw surface info
  51179. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  51180. */
  51181. export interface DDSInfo {
  51182. /**
  51183. * Width of the texture
  51184. */
  51185. width: number;
  51186. /**
  51187. * Width of the texture
  51188. */
  51189. height: number;
  51190. /**
  51191. * Number of Mipmaps for the texture
  51192. * @see https://en.wikipedia.org/wiki/Mipmap
  51193. */
  51194. mipmapCount: number;
  51195. /**
  51196. * If the textures format is a known fourCC format
  51197. * @see https://www.fourcc.org/
  51198. */
  51199. isFourCC: boolean;
  51200. /**
  51201. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  51202. */
  51203. isRGB: boolean;
  51204. /**
  51205. * If the texture is a lumincance format
  51206. */
  51207. isLuminance: boolean;
  51208. /**
  51209. * If this is a cube texture
  51210. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  51211. */
  51212. isCube: boolean;
  51213. /**
  51214. * If the texture is a compressed format eg. FOURCC_DXT1
  51215. */
  51216. isCompressed: boolean;
  51217. /**
  51218. * The dxgiFormat of the texture
  51219. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  51220. */
  51221. dxgiFormat: number;
  51222. /**
  51223. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  51224. */
  51225. textureType: number;
  51226. /**
  51227. * Sphericle polynomial created for the dds texture
  51228. */
  51229. sphericalPolynomial?: SphericalPolynomial;
  51230. }
  51231. /**
  51232. * Class used to provide DDS decompression tools
  51233. */
  51234. export class DDSTools {
  51235. /**
  51236. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  51237. */
  51238. static StoreLODInAlphaChannel: boolean;
  51239. /**
  51240. * Gets DDS information from an array buffer
  51241. * @param arrayBuffer defines the array buffer to read data from
  51242. * @returns the DDS information
  51243. */
  51244. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  51245. private static _FloatView;
  51246. private static _Int32View;
  51247. private static _ToHalfFloat;
  51248. private static _FromHalfFloat;
  51249. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  51250. private static _GetHalfFloatRGBAArrayBuffer;
  51251. private static _GetFloatRGBAArrayBuffer;
  51252. private static _GetFloatAsUIntRGBAArrayBuffer;
  51253. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  51254. private static _GetRGBAArrayBuffer;
  51255. private static _ExtractLongWordOrder;
  51256. private static _GetRGBArrayBuffer;
  51257. private static _GetLuminanceArrayBuffer;
  51258. /**
  51259. * Uploads DDS Levels to a Babylon Texture
  51260. * @hidden
  51261. */
  51262. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  51263. }
  51264. module "babylonjs/Engines/thinEngine" {
  51265. interface ThinEngine {
  51266. /**
  51267. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  51268. * @param rootUrl defines the url where the file to load is located
  51269. * @param scene defines the current scene
  51270. * @param lodScale defines scale to apply to the mip map selection
  51271. * @param lodOffset defines offset to apply to the mip map selection
  51272. * @param onLoad defines an optional callback raised when the texture is loaded
  51273. * @param onError defines an optional callback raised if there is an issue to load the texture
  51274. * @param format defines the format of the data
  51275. * @param forcedExtension defines the extension to use to pick the right loader
  51276. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  51277. * @returns the cube texture as an InternalTexture
  51278. */
  51279. createPrefilteredCubeTexture(rootUrl: string, scene: Nullable<Scene>, lodScale: number, lodOffset: number, onLoad?: Nullable<(internalTexture: Nullable<InternalTexture>) => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, forcedExtension?: any, createPolynomials?: boolean): InternalTexture;
  51280. }
  51281. }
  51282. }
  51283. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  51284. import { Nullable } from "babylonjs/types";
  51285. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51286. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51287. /**
  51288. * Implementation of the DDS Texture Loader.
  51289. * @hidden
  51290. */
  51291. export class _DDSTextureLoader implements IInternalTextureLoader {
  51292. /**
  51293. * Defines wether the loader supports cascade loading the different faces.
  51294. */
  51295. readonly supportCascades: boolean;
  51296. /**
  51297. * This returns if the loader support the current file information.
  51298. * @param extension defines the file extension of the file being loaded
  51299. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51300. * @param fallback defines the fallback internal texture if any
  51301. * @param isBase64 defines whether the texture is encoded as a base64
  51302. * @param isBuffer defines whether the texture data are stored as a buffer
  51303. * @returns true if the loader can load the specified file
  51304. */
  51305. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51306. /**
  51307. * Transform the url before loading if required.
  51308. * @param rootUrl the url of the texture
  51309. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51310. * @returns the transformed texture
  51311. */
  51312. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51313. /**
  51314. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51315. * @param rootUrl the url of the texture
  51316. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51317. * @returns the fallback texture
  51318. */
  51319. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51320. /**
  51321. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51322. * @param data contains the texture data
  51323. * @param texture defines the BabylonJS internal texture
  51324. * @param createPolynomials will be true if polynomials have been requested
  51325. * @param onLoad defines the callback to trigger once the texture is ready
  51326. * @param onError defines the callback to trigger in case of error
  51327. */
  51328. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51329. /**
  51330. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51331. * @param data contains the texture data
  51332. * @param texture defines the BabylonJS internal texture
  51333. * @param callback defines the method to call once ready to upload
  51334. */
  51335. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  51336. }
  51337. }
  51338. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  51339. import { Nullable } from "babylonjs/types";
  51340. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51341. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51342. /**
  51343. * Implementation of the ENV Texture Loader.
  51344. * @hidden
  51345. */
  51346. export class _ENVTextureLoader implements IInternalTextureLoader {
  51347. /**
  51348. * Defines wether the loader supports cascade loading the different faces.
  51349. */
  51350. readonly supportCascades: boolean;
  51351. /**
  51352. * This returns if the loader support the current file information.
  51353. * @param extension defines the file extension of the file being loaded
  51354. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51355. * @param fallback defines the fallback internal texture if any
  51356. * @param isBase64 defines whether the texture is encoded as a base64
  51357. * @param isBuffer defines whether the texture data are stored as a buffer
  51358. * @returns true if the loader can load the specified file
  51359. */
  51360. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51361. /**
  51362. * Transform the url before loading if required.
  51363. * @param rootUrl the url of the texture
  51364. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51365. * @returns the transformed texture
  51366. */
  51367. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51368. /**
  51369. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51370. * @param rootUrl the url of the texture
  51371. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51372. * @returns the fallback texture
  51373. */
  51374. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51375. /**
  51376. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51377. * @param data contains the texture data
  51378. * @param texture defines the BabylonJS internal texture
  51379. * @param createPolynomials will be true if polynomials have been requested
  51380. * @param onLoad defines the callback to trigger once the texture is ready
  51381. * @param onError defines the callback to trigger in case of error
  51382. */
  51383. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51384. /**
  51385. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51386. * @param data contains the texture data
  51387. * @param texture defines the BabylonJS internal texture
  51388. * @param callback defines the method to call once ready to upload
  51389. */
  51390. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  51391. }
  51392. }
  51393. declare module "babylonjs/Misc/khronosTextureContainer" {
  51394. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51395. /**
  51396. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  51397. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  51398. */
  51399. export class KhronosTextureContainer {
  51400. /** contents of the KTX container file */
  51401. arrayBuffer: any;
  51402. private static HEADER_LEN;
  51403. private static COMPRESSED_2D;
  51404. private static COMPRESSED_3D;
  51405. private static TEX_2D;
  51406. private static TEX_3D;
  51407. /**
  51408. * Gets the openGL type
  51409. */
  51410. glType: number;
  51411. /**
  51412. * Gets the openGL type size
  51413. */
  51414. glTypeSize: number;
  51415. /**
  51416. * Gets the openGL format
  51417. */
  51418. glFormat: number;
  51419. /**
  51420. * Gets the openGL internal format
  51421. */
  51422. glInternalFormat: number;
  51423. /**
  51424. * Gets the base internal format
  51425. */
  51426. glBaseInternalFormat: number;
  51427. /**
  51428. * Gets image width in pixel
  51429. */
  51430. pixelWidth: number;
  51431. /**
  51432. * Gets image height in pixel
  51433. */
  51434. pixelHeight: number;
  51435. /**
  51436. * Gets image depth in pixels
  51437. */
  51438. pixelDepth: number;
  51439. /**
  51440. * Gets the number of array elements
  51441. */
  51442. numberOfArrayElements: number;
  51443. /**
  51444. * Gets the number of faces
  51445. */
  51446. numberOfFaces: number;
  51447. /**
  51448. * Gets the number of mipmap levels
  51449. */
  51450. numberOfMipmapLevels: number;
  51451. /**
  51452. * Gets the bytes of key value data
  51453. */
  51454. bytesOfKeyValueData: number;
  51455. /**
  51456. * Gets the load type
  51457. */
  51458. loadType: number;
  51459. /**
  51460. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  51461. */
  51462. isInvalid: boolean;
  51463. /**
  51464. * Creates a new KhronosTextureContainer
  51465. * @param arrayBuffer contents of the KTX container file
  51466. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  51467. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  51468. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  51469. */
  51470. constructor(
  51471. /** contents of the KTX container file */
  51472. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  51473. /**
  51474. * Uploads KTX content to a Babylon Texture.
  51475. * It is assumed that the texture has already been created & is currently bound
  51476. * @hidden
  51477. */
  51478. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  51479. private _upload2DCompressedLevels;
  51480. }
  51481. }
  51482. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  51483. import { Nullable } from "babylonjs/types";
  51484. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51485. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51486. /**
  51487. * Implementation of the KTX Texture Loader.
  51488. * @hidden
  51489. */
  51490. export class _KTXTextureLoader implements IInternalTextureLoader {
  51491. /**
  51492. * Defines wether the loader supports cascade loading the different faces.
  51493. */
  51494. readonly supportCascades: boolean;
  51495. /**
  51496. * This returns if the loader support the current file information.
  51497. * @param extension defines the file extension of the file being loaded
  51498. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51499. * @param fallback defines the fallback internal texture if any
  51500. * @param isBase64 defines whether the texture is encoded as a base64
  51501. * @param isBuffer defines whether the texture data are stored as a buffer
  51502. * @returns true if the loader can load the specified file
  51503. */
  51504. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51505. /**
  51506. * Transform the url before loading if required.
  51507. * @param rootUrl the url of the texture
  51508. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51509. * @returns the transformed texture
  51510. */
  51511. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51512. /**
  51513. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51514. * @param rootUrl the url of the texture
  51515. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51516. * @returns the fallback texture
  51517. */
  51518. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51519. /**
  51520. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51521. * @param data contains the texture data
  51522. * @param texture defines the BabylonJS internal texture
  51523. * @param createPolynomials will be true if polynomials have been requested
  51524. * @param onLoad defines the callback to trigger once the texture is ready
  51525. * @param onError defines the callback to trigger in case of error
  51526. */
  51527. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51528. /**
  51529. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51530. * @param data contains the texture data
  51531. * @param texture defines the BabylonJS internal texture
  51532. * @param callback defines the method to call once ready to upload
  51533. */
  51534. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  51535. }
  51536. }
  51537. declare module "babylonjs/Cameras/XR/webXRDefaultExperience" {
  51538. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  51539. import { Scene } from "babylonjs/scene";
  51540. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  51541. import { WebXRControllerModelLoader } from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  51542. import { WebXRControllerPointerSelection } from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  51543. import { WebXRControllerTeleportation } from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  51544. import { WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  51545. import { WebXREnterExitUI } from "babylonjs/Cameras/XR/webXREnterExitUI";
  51546. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51547. /**
  51548. * Options for the default xr helper
  51549. */
  51550. export class WebXRDefaultExperienceOptions {
  51551. /**
  51552. * Floor meshes that should be used for teleporting
  51553. */
  51554. floorMeshes: Array<AbstractMesh>;
  51555. /**
  51556. * Enable or disable default UI to enter XR
  51557. */
  51558. disableDefaultUI: boolean;
  51559. }
  51560. /**
  51561. * Default experience which provides a similar setup to the previous webVRExperience
  51562. */
  51563. export class WebXRDefaultExperience {
  51564. /**
  51565. * Base experience
  51566. */
  51567. baseExperience: WebXRExperienceHelper;
  51568. /**
  51569. * Input experience extension
  51570. */
  51571. input: WebXRInput;
  51572. /**
  51573. * Loads the controller models
  51574. */
  51575. controllerModelLoader: WebXRControllerModelLoader;
  51576. /**
  51577. * Enables laser pointer and selection
  51578. */
  51579. pointerSelection: WebXRControllerPointerSelection;
  51580. /**
  51581. * Enables teleportation
  51582. */
  51583. teleportation: WebXRControllerTeleportation;
  51584. /**
  51585. * Enables ui for enetering/exiting xr
  51586. */
  51587. enterExitUI: WebXREnterExitUI;
  51588. /**
  51589. * Default target xr should render to
  51590. */
  51591. renderTarget: WebXRRenderTarget;
  51592. /**
  51593. * Creates the default xr experience
  51594. * @param scene scene
  51595. * @param options options for basic configuration
  51596. * @returns resulting WebXRDefaultExperience
  51597. */
  51598. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51599. private constructor();
  51600. /**
  51601. * DIsposes of the experience helper
  51602. */
  51603. dispose(): void;
  51604. }
  51605. }
  51606. declare module "babylonjs/Helpers/sceneHelpers" {
  51607. import { Nullable } from "babylonjs/types";
  51608. import { Mesh } from "babylonjs/Meshes/mesh";
  51609. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  51610. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  51611. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  51612. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  51613. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  51614. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  51615. import "babylonjs/Meshes/Builders/boxBuilder";
  51616. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/Cameras/XR/webXRDefaultExperience";
  51617. /** @hidden */
  51618. export var _forceSceneHelpersToBundle: boolean;
  51619. module "babylonjs/scene" {
  51620. interface Scene {
  51621. /**
  51622. * Creates a default light for the scene.
  51623. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  51624. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  51625. */
  51626. createDefaultLight(replace?: boolean): void;
  51627. /**
  51628. * Creates a default camera for the scene.
  51629. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  51630. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  51631. * @param replace has default false, when true replaces the active camera in the scene
  51632. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  51633. */
  51634. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  51635. /**
  51636. * Creates a default camera and a default light.
  51637. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  51638. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  51639. * @param replace has the default false, when true replaces the active camera/light in the scene
  51640. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  51641. */
  51642. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  51643. /**
  51644. * Creates a new sky box
  51645. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  51646. * @param environmentTexture defines the texture to use as environment texture
  51647. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  51648. * @param scale defines the overall scale of the skybox
  51649. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  51650. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  51651. * @returns a new mesh holding the sky box
  51652. */
  51653. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  51654. /**
  51655. * Creates a new environment
  51656. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  51657. * @param options defines the options you can use to configure the environment
  51658. * @returns the new EnvironmentHelper
  51659. */
  51660. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  51661. /**
  51662. * Creates a new VREXperienceHelper
  51663. * @see http://doc.babylonjs.com/how_to/webvr_helper
  51664. * @param webVROptions defines the options used to create the new VREXperienceHelper
  51665. * @returns a new VREXperienceHelper
  51666. */
  51667. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  51668. /**
  51669. * Creates a new WebXRDefaultExperience
  51670. * @see http://doc.babylonjs.com/how_to/webxr
  51671. * @param options experience options
  51672. * @returns a promise for a new WebXRDefaultExperience
  51673. */
  51674. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51675. }
  51676. }
  51677. }
  51678. declare module "babylonjs/Helpers/videoDome" {
  51679. import { Scene } from "babylonjs/scene";
  51680. import { TransformNode } from "babylonjs/Meshes/transformNode";
  51681. import { Mesh } from "babylonjs/Meshes/mesh";
  51682. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  51683. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  51684. import "babylonjs/Meshes/Builders/sphereBuilder";
  51685. /**
  51686. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  51687. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  51688. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  51689. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  51690. */
  51691. export class VideoDome extends TransformNode {
  51692. /**
  51693. * Define the video source as a Monoscopic panoramic 360 video.
  51694. */
  51695. static readonly MODE_MONOSCOPIC: number;
  51696. /**
  51697. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  51698. */
  51699. static readonly MODE_TOPBOTTOM: number;
  51700. /**
  51701. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  51702. */
  51703. static readonly MODE_SIDEBYSIDE: number;
  51704. private _halfDome;
  51705. private _useDirectMapping;
  51706. /**
  51707. * The video texture being displayed on the sphere
  51708. */
  51709. protected _videoTexture: VideoTexture;
  51710. /**
  51711. * Gets the video texture being displayed on the sphere
  51712. */
  51713. readonly videoTexture: VideoTexture;
  51714. /**
  51715. * The skybox material
  51716. */
  51717. protected _material: BackgroundMaterial;
  51718. /**
  51719. * The surface used for the skybox
  51720. */
  51721. protected _mesh: Mesh;
  51722. /**
  51723. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  51724. */
  51725. private _halfDomeMask;
  51726. /**
  51727. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  51728. * Also see the options.resolution property.
  51729. */
  51730. fovMultiplier: number;
  51731. private _videoMode;
  51732. /**
  51733. * Gets or set the current video mode for the video. It can be:
  51734. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  51735. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  51736. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  51737. */
  51738. videoMode: number;
  51739. /**
  51740. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  51741. *
  51742. */
  51743. /**
  51744. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  51745. */
  51746. halfDome: boolean;
  51747. /**
  51748. * Oberserver used in Stereoscopic VR Mode.
  51749. */
  51750. private _onBeforeCameraRenderObserver;
  51751. /**
  51752. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  51753. * @param name Element's name, child elements will append suffixes for their own names.
  51754. * @param urlsOrVideo defines the url(s) or the video element to use
  51755. * @param options An object containing optional or exposed sub element properties
  51756. */
  51757. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  51758. resolution?: number;
  51759. clickToPlay?: boolean;
  51760. autoPlay?: boolean;
  51761. loop?: boolean;
  51762. size?: number;
  51763. poster?: string;
  51764. faceForward?: boolean;
  51765. useDirectMapping?: boolean;
  51766. halfDomeMode?: boolean;
  51767. }, scene: Scene);
  51768. private _changeVideoMode;
  51769. /**
  51770. * Releases resources associated with this node.
  51771. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  51772. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  51773. */
  51774. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  51775. }
  51776. }
  51777. declare module "babylonjs/Helpers/index" {
  51778. export * from "babylonjs/Helpers/environmentHelper";
  51779. export * from "babylonjs/Helpers/photoDome";
  51780. export * from "babylonjs/Helpers/sceneHelpers";
  51781. export * from "babylonjs/Helpers/videoDome";
  51782. }
  51783. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  51784. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  51785. import { IDisposable } from "babylonjs/scene";
  51786. import { Engine } from "babylonjs/Engines/engine";
  51787. /**
  51788. * This class can be used to get instrumentation data from a Babylon engine
  51789. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  51790. */
  51791. export class EngineInstrumentation implements IDisposable {
  51792. /**
  51793. * Define the instrumented engine.
  51794. */
  51795. engine: Engine;
  51796. private _captureGPUFrameTime;
  51797. private _gpuFrameTimeToken;
  51798. private _gpuFrameTime;
  51799. private _captureShaderCompilationTime;
  51800. private _shaderCompilationTime;
  51801. private _onBeginFrameObserver;
  51802. private _onEndFrameObserver;
  51803. private _onBeforeShaderCompilationObserver;
  51804. private _onAfterShaderCompilationObserver;
  51805. /**
  51806. * Gets the perf counter used for GPU frame time
  51807. */
  51808. readonly gpuFrameTimeCounter: PerfCounter;
  51809. /**
  51810. * Gets the GPU frame time capture status
  51811. */
  51812. /**
  51813. * Enable or disable the GPU frame time capture
  51814. */
  51815. captureGPUFrameTime: boolean;
  51816. /**
  51817. * Gets the perf counter used for shader compilation time
  51818. */
  51819. readonly shaderCompilationTimeCounter: PerfCounter;
  51820. /**
  51821. * Gets the shader compilation time capture status
  51822. */
  51823. /**
  51824. * Enable or disable the shader compilation time capture
  51825. */
  51826. captureShaderCompilationTime: boolean;
  51827. /**
  51828. * Instantiates a new engine instrumentation.
  51829. * This class can be used to get instrumentation data from a Babylon engine
  51830. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  51831. * @param engine Defines the engine to instrument
  51832. */
  51833. constructor(
  51834. /**
  51835. * Define the instrumented engine.
  51836. */
  51837. engine: Engine);
  51838. /**
  51839. * Dispose and release associated resources.
  51840. */
  51841. dispose(): void;
  51842. }
  51843. }
  51844. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  51845. import { Scene, IDisposable } from "babylonjs/scene";
  51846. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  51847. /**
  51848. * This class can be used to get instrumentation data from a Babylon engine
  51849. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  51850. */
  51851. export class SceneInstrumentation implements IDisposable {
  51852. /**
  51853. * Defines the scene to instrument
  51854. */
  51855. scene: Scene;
  51856. private _captureActiveMeshesEvaluationTime;
  51857. private _activeMeshesEvaluationTime;
  51858. private _captureRenderTargetsRenderTime;
  51859. private _renderTargetsRenderTime;
  51860. private _captureFrameTime;
  51861. private _frameTime;
  51862. private _captureRenderTime;
  51863. private _renderTime;
  51864. private _captureInterFrameTime;
  51865. private _interFrameTime;
  51866. private _captureParticlesRenderTime;
  51867. private _particlesRenderTime;
  51868. private _captureSpritesRenderTime;
  51869. private _spritesRenderTime;
  51870. private _capturePhysicsTime;
  51871. private _physicsTime;
  51872. private _captureAnimationsTime;
  51873. private _animationsTime;
  51874. private _captureCameraRenderTime;
  51875. private _cameraRenderTime;
  51876. private _onBeforeActiveMeshesEvaluationObserver;
  51877. private _onAfterActiveMeshesEvaluationObserver;
  51878. private _onBeforeRenderTargetsRenderObserver;
  51879. private _onAfterRenderTargetsRenderObserver;
  51880. private _onAfterRenderObserver;
  51881. private _onBeforeDrawPhaseObserver;
  51882. private _onAfterDrawPhaseObserver;
  51883. private _onBeforeAnimationsObserver;
  51884. private _onBeforeParticlesRenderingObserver;
  51885. private _onAfterParticlesRenderingObserver;
  51886. private _onBeforeSpritesRenderingObserver;
  51887. private _onAfterSpritesRenderingObserver;
  51888. private _onBeforePhysicsObserver;
  51889. private _onAfterPhysicsObserver;
  51890. private _onAfterAnimationsObserver;
  51891. private _onBeforeCameraRenderObserver;
  51892. private _onAfterCameraRenderObserver;
  51893. /**
  51894. * Gets the perf counter used for active meshes evaluation time
  51895. */
  51896. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  51897. /**
  51898. * Gets the active meshes evaluation time capture status
  51899. */
  51900. /**
  51901. * Enable or disable the active meshes evaluation time capture
  51902. */
  51903. captureActiveMeshesEvaluationTime: boolean;
  51904. /**
  51905. * Gets the perf counter used for render targets render time
  51906. */
  51907. readonly renderTargetsRenderTimeCounter: PerfCounter;
  51908. /**
  51909. * Gets the render targets render time capture status
  51910. */
  51911. /**
  51912. * Enable or disable the render targets render time capture
  51913. */
  51914. captureRenderTargetsRenderTime: boolean;
  51915. /**
  51916. * Gets the perf counter used for particles render time
  51917. */
  51918. readonly particlesRenderTimeCounter: PerfCounter;
  51919. /**
  51920. * Gets the particles render time capture status
  51921. */
  51922. /**
  51923. * Enable or disable the particles render time capture
  51924. */
  51925. captureParticlesRenderTime: boolean;
  51926. /**
  51927. * Gets the perf counter used for sprites render time
  51928. */
  51929. readonly spritesRenderTimeCounter: PerfCounter;
  51930. /**
  51931. * Gets the sprites render time capture status
  51932. */
  51933. /**
  51934. * Enable or disable the sprites render time capture
  51935. */
  51936. captureSpritesRenderTime: boolean;
  51937. /**
  51938. * Gets the perf counter used for physics time
  51939. */
  51940. readonly physicsTimeCounter: PerfCounter;
  51941. /**
  51942. * Gets the physics time capture status
  51943. */
  51944. /**
  51945. * Enable or disable the physics time capture
  51946. */
  51947. capturePhysicsTime: boolean;
  51948. /**
  51949. * Gets the perf counter used for animations time
  51950. */
  51951. readonly animationsTimeCounter: PerfCounter;
  51952. /**
  51953. * Gets the animations time capture status
  51954. */
  51955. /**
  51956. * Enable or disable the animations time capture
  51957. */
  51958. captureAnimationsTime: boolean;
  51959. /**
  51960. * Gets the perf counter used for frame time capture
  51961. */
  51962. readonly frameTimeCounter: PerfCounter;
  51963. /**
  51964. * Gets the frame time capture status
  51965. */
  51966. /**
  51967. * Enable or disable the frame time capture
  51968. */
  51969. captureFrameTime: boolean;
  51970. /**
  51971. * Gets the perf counter used for inter-frames time capture
  51972. */
  51973. readonly interFrameTimeCounter: PerfCounter;
  51974. /**
  51975. * Gets the inter-frames time capture status
  51976. */
  51977. /**
  51978. * Enable or disable the inter-frames time capture
  51979. */
  51980. captureInterFrameTime: boolean;
  51981. /**
  51982. * Gets the perf counter used for render time capture
  51983. */
  51984. readonly renderTimeCounter: PerfCounter;
  51985. /**
  51986. * Gets the render time capture status
  51987. */
  51988. /**
  51989. * Enable or disable the render time capture
  51990. */
  51991. captureRenderTime: boolean;
  51992. /**
  51993. * Gets the perf counter used for camera render time capture
  51994. */
  51995. readonly cameraRenderTimeCounter: PerfCounter;
  51996. /**
  51997. * Gets the camera render time capture status
  51998. */
  51999. /**
  52000. * Enable or disable the camera render time capture
  52001. */
  52002. captureCameraRenderTime: boolean;
  52003. /**
  52004. * Gets the perf counter used for draw calls
  52005. */
  52006. readonly drawCallsCounter: PerfCounter;
  52007. /**
  52008. * Instantiates a new scene instrumentation.
  52009. * This class can be used to get instrumentation data from a Babylon engine
  52010. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  52011. * @param scene Defines the scene to instrument
  52012. */
  52013. constructor(
  52014. /**
  52015. * Defines the scene to instrument
  52016. */
  52017. scene: Scene);
  52018. /**
  52019. * Dispose and release associated resources.
  52020. */
  52021. dispose(): void;
  52022. }
  52023. }
  52024. declare module "babylonjs/Instrumentation/index" {
  52025. export * from "babylonjs/Instrumentation/engineInstrumentation";
  52026. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  52027. export * from "babylonjs/Instrumentation/timeToken";
  52028. }
  52029. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  52030. /** @hidden */
  52031. export var glowMapGenerationPixelShader: {
  52032. name: string;
  52033. shader: string;
  52034. };
  52035. }
  52036. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  52037. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  52038. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  52039. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  52040. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  52041. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  52042. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  52043. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  52044. /** @hidden */
  52045. export var glowMapGenerationVertexShader: {
  52046. name: string;
  52047. shader: string;
  52048. };
  52049. }
  52050. declare module "babylonjs/Layers/effectLayer" {
  52051. import { Observable } from "babylonjs/Misc/observable";
  52052. import { Nullable } from "babylonjs/types";
  52053. import { Camera } from "babylonjs/Cameras/camera";
  52054. import { Scene } from "babylonjs/scene";
  52055. import { ISize } from "babylonjs/Maths/math.size";
  52056. import { Color4 } from "babylonjs/Maths/math.color";
  52057. import { Engine } from "babylonjs/Engines/engine";
  52058. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52059. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52060. import { Mesh } from "babylonjs/Meshes/mesh";
  52061. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  52062. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  52063. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  52064. import { Effect } from "babylonjs/Materials/effect";
  52065. import { Material } from "babylonjs/Materials/material";
  52066. import "babylonjs/Shaders/glowMapGeneration.fragment";
  52067. import "babylonjs/Shaders/glowMapGeneration.vertex";
  52068. /**
  52069. * Effect layer options. This helps customizing the behaviour
  52070. * of the effect layer.
  52071. */
  52072. export interface IEffectLayerOptions {
  52073. /**
  52074. * Multiplication factor apply to the canvas size to compute the render target size
  52075. * used to generated the objects (the smaller the faster).
  52076. */
  52077. mainTextureRatio: number;
  52078. /**
  52079. * Enforces a fixed size texture to ensure effect stability across devices.
  52080. */
  52081. mainTextureFixedSize?: number;
  52082. /**
  52083. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  52084. */
  52085. alphaBlendingMode: number;
  52086. /**
  52087. * The camera attached to the layer.
  52088. */
  52089. camera: Nullable<Camera>;
  52090. /**
  52091. * The rendering group to draw the layer in.
  52092. */
  52093. renderingGroupId: number;
  52094. }
  52095. /**
  52096. * The effect layer Helps adding post process effect blended with the main pass.
  52097. *
  52098. * This can be for instance use to generate glow or higlight effects on the scene.
  52099. *
  52100. * The effect layer class can not be used directly and is intented to inherited from to be
  52101. * customized per effects.
  52102. */
  52103. export abstract class EffectLayer {
  52104. private _vertexBuffers;
  52105. private _indexBuffer;
  52106. private _cachedDefines;
  52107. private _effectLayerMapGenerationEffect;
  52108. private _effectLayerOptions;
  52109. private _mergeEffect;
  52110. protected _scene: Scene;
  52111. protected _engine: Engine;
  52112. protected _maxSize: number;
  52113. protected _mainTextureDesiredSize: ISize;
  52114. protected _mainTexture: RenderTargetTexture;
  52115. protected _shouldRender: boolean;
  52116. protected _postProcesses: PostProcess[];
  52117. protected _textures: BaseTexture[];
  52118. protected _emissiveTextureAndColor: {
  52119. texture: Nullable<BaseTexture>;
  52120. color: Color4;
  52121. };
  52122. /**
  52123. * The name of the layer
  52124. */
  52125. name: string;
  52126. /**
  52127. * The clear color of the texture used to generate the glow map.
  52128. */
  52129. neutralColor: Color4;
  52130. /**
  52131. * Specifies wether the highlight layer is enabled or not.
  52132. */
  52133. isEnabled: boolean;
  52134. /**
  52135. * Gets the camera attached to the layer.
  52136. */
  52137. readonly camera: Nullable<Camera>;
  52138. /**
  52139. * Gets the rendering group id the layer should render in.
  52140. */
  52141. renderingGroupId: number;
  52142. /**
  52143. * An event triggered when the effect layer has been disposed.
  52144. */
  52145. onDisposeObservable: Observable<EffectLayer>;
  52146. /**
  52147. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  52148. */
  52149. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  52150. /**
  52151. * An event triggered when the generated texture is being merged in the scene.
  52152. */
  52153. onBeforeComposeObservable: Observable<EffectLayer>;
  52154. /**
  52155. * An event triggered when the mesh is rendered into the effect render target.
  52156. */
  52157. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  52158. /**
  52159. * An event triggered after the mesh has been rendered into the effect render target.
  52160. */
  52161. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  52162. /**
  52163. * An event triggered when the generated texture has been merged in the scene.
  52164. */
  52165. onAfterComposeObservable: Observable<EffectLayer>;
  52166. /**
  52167. * An event triggered when the efffect layer changes its size.
  52168. */
  52169. onSizeChangedObservable: Observable<EffectLayer>;
  52170. /** @hidden */
  52171. static _SceneComponentInitialization: (scene: Scene) => void;
  52172. /**
  52173. * Instantiates a new effect Layer and references it in the scene.
  52174. * @param name The name of the layer
  52175. * @param scene The scene to use the layer in
  52176. */
  52177. constructor(
  52178. /** The Friendly of the effect in the scene */
  52179. name: string, scene: Scene);
  52180. /**
  52181. * Get the effect name of the layer.
  52182. * @return The effect name
  52183. */
  52184. abstract getEffectName(): string;
  52185. /**
  52186. * Checks for the readiness of the element composing the layer.
  52187. * @param subMesh the mesh to check for
  52188. * @param useInstances specify wether or not to use instances to render the mesh
  52189. * @return true if ready otherwise, false
  52190. */
  52191. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52192. /**
  52193. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52194. * @returns true if the effect requires stencil during the main canvas render pass.
  52195. */
  52196. abstract needStencil(): boolean;
  52197. /**
  52198. * Create the merge effect. This is the shader use to blit the information back
  52199. * to the main canvas at the end of the scene rendering.
  52200. * @returns The effect containing the shader used to merge the effect on the main canvas
  52201. */
  52202. protected abstract _createMergeEffect(): Effect;
  52203. /**
  52204. * Creates the render target textures and post processes used in the effect layer.
  52205. */
  52206. protected abstract _createTextureAndPostProcesses(): void;
  52207. /**
  52208. * Implementation specific of rendering the generating effect on the main canvas.
  52209. * @param effect The effect used to render through
  52210. */
  52211. protected abstract _internalRender(effect: Effect): void;
  52212. /**
  52213. * Sets the required values for both the emissive texture and and the main color.
  52214. */
  52215. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52216. /**
  52217. * Free any resources and references associated to a mesh.
  52218. * Internal use
  52219. * @param mesh The mesh to free.
  52220. */
  52221. abstract _disposeMesh(mesh: Mesh): void;
  52222. /**
  52223. * Serializes this layer (Glow or Highlight for example)
  52224. * @returns a serialized layer object
  52225. */
  52226. abstract serialize?(): any;
  52227. /**
  52228. * Initializes the effect layer with the required options.
  52229. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  52230. */
  52231. protected _init(options: Partial<IEffectLayerOptions>): void;
  52232. /**
  52233. * Generates the index buffer of the full screen quad blending to the main canvas.
  52234. */
  52235. private _generateIndexBuffer;
  52236. /**
  52237. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  52238. */
  52239. private _generateVertexBuffer;
  52240. /**
  52241. * Sets the main texture desired size which is the closest power of two
  52242. * of the engine canvas size.
  52243. */
  52244. private _setMainTextureSize;
  52245. /**
  52246. * Creates the main texture for the effect layer.
  52247. */
  52248. protected _createMainTexture(): void;
  52249. /**
  52250. * Adds specific effects defines.
  52251. * @param defines The defines to add specifics to.
  52252. */
  52253. protected _addCustomEffectDefines(defines: string[]): void;
  52254. /**
  52255. * Checks for the readiness of the element composing the layer.
  52256. * @param subMesh the mesh to check for
  52257. * @param useInstances specify wether or not to use instances to render the mesh
  52258. * @param emissiveTexture the associated emissive texture used to generate the glow
  52259. * @return true if ready otherwise, false
  52260. */
  52261. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  52262. /**
  52263. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  52264. */
  52265. render(): void;
  52266. /**
  52267. * Determine if a given mesh will be used in the current effect.
  52268. * @param mesh mesh to test
  52269. * @returns true if the mesh will be used
  52270. */
  52271. hasMesh(mesh: AbstractMesh): boolean;
  52272. /**
  52273. * Returns true if the layer contains information to display, otherwise false.
  52274. * @returns true if the glow layer should be rendered
  52275. */
  52276. shouldRender(): boolean;
  52277. /**
  52278. * Returns true if the mesh should render, otherwise false.
  52279. * @param mesh The mesh to render
  52280. * @returns true if it should render otherwise false
  52281. */
  52282. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  52283. /**
  52284. * Returns true if the mesh can be rendered, otherwise false.
  52285. * @param mesh The mesh to render
  52286. * @param material The material used on the mesh
  52287. * @returns true if it can be rendered otherwise false
  52288. */
  52289. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  52290. /**
  52291. * Returns true if the mesh should render, otherwise false.
  52292. * @param mesh The mesh to render
  52293. * @returns true if it should render otherwise false
  52294. */
  52295. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  52296. /**
  52297. * Renders the submesh passed in parameter to the generation map.
  52298. */
  52299. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  52300. /**
  52301. * Defines wether the current material of the mesh should be use to render the effect.
  52302. * @param mesh defines the current mesh to render
  52303. */
  52304. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  52305. /**
  52306. * Rebuild the required buffers.
  52307. * @hidden Internal use only.
  52308. */
  52309. _rebuild(): void;
  52310. /**
  52311. * Dispose only the render target textures and post process.
  52312. */
  52313. private _disposeTextureAndPostProcesses;
  52314. /**
  52315. * Dispose the highlight layer and free resources.
  52316. */
  52317. dispose(): void;
  52318. /**
  52319. * Gets the class name of the effect layer
  52320. * @returns the string with the class name of the effect layer
  52321. */
  52322. getClassName(): string;
  52323. /**
  52324. * Creates an effect layer from parsed effect layer data
  52325. * @param parsedEffectLayer defines effect layer data
  52326. * @param scene defines the current scene
  52327. * @param rootUrl defines the root URL containing the effect layer information
  52328. * @returns a parsed effect Layer
  52329. */
  52330. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  52331. }
  52332. }
  52333. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  52334. import { Scene } from "babylonjs/scene";
  52335. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  52336. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52337. import { AbstractScene } from "babylonjs/abstractScene";
  52338. module "babylonjs/abstractScene" {
  52339. interface AbstractScene {
  52340. /**
  52341. * The list of effect layers (highlights/glow) added to the scene
  52342. * @see http://doc.babylonjs.com/how_to/highlight_layer
  52343. * @see http://doc.babylonjs.com/how_to/glow_layer
  52344. */
  52345. effectLayers: Array<EffectLayer>;
  52346. /**
  52347. * Removes the given effect layer from this scene.
  52348. * @param toRemove defines the effect layer to remove
  52349. * @returns the index of the removed effect layer
  52350. */
  52351. removeEffectLayer(toRemove: EffectLayer): number;
  52352. /**
  52353. * Adds the given effect layer to this scene
  52354. * @param newEffectLayer defines the effect layer to add
  52355. */
  52356. addEffectLayer(newEffectLayer: EffectLayer): void;
  52357. }
  52358. }
  52359. /**
  52360. * Defines the layer scene component responsible to manage any effect layers
  52361. * in a given scene.
  52362. */
  52363. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  52364. /**
  52365. * The component name helpfull to identify the component in the list of scene components.
  52366. */
  52367. readonly name: string;
  52368. /**
  52369. * The scene the component belongs to.
  52370. */
  52371. scene: Scene;
  52372. private _engine;
  52373. private _renderEffects;
  52374. private _needStencil;
  52375. private _previousStencilState;
  52376. /**
  52377. * Creates a new instance of the component for the given scene
  52378. * @param scene Defines the scene to register the component in
  52379. */
  52380. constructor(scene: Scene);
  52381. /**
  52382. * Registers the component in a given scene
  52383. */
  52384. register(): void;
  52385. /**
  52386. * Rebuilds the elements related to this component in case of
  52387. * context lost for instance.
  52388. */
  52389. rebuild(): void;
  52390. /**
  52391. * Serializes the component data to the specified json object
  52392. * @param serializationObject The object to serialize to
  52393. */
  52394. serialize(serializationObject: any): void;
  52395. /**
  52396. * Adds all the elements from the container to the scene
  52397. * @param container the container holding the elements
  52398. */
  52399. addFromContainer(container: AbstractScene): void;
  52400. /**
  52401. * Removes all the elements in the container from the scene
  52402. * @param container contains the elements to remove
  52403. * @param dispose if the removed element should be disposed (default: false)
  52404. */
  52405. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  52406. /**
  52407. * Disposes the component and the associated ressources.
  52408. */
  52409. dispose(): void;
  52410. private _isReadyForMesh;
  52411. private _renderMainTexture;
  52412. private _setStencil;
  52413. private _setStencilBack;
  52414. private _draw;
  52415. private _drawCamera;
  52416. private _drawRenderingGroup;
  52417. }
  52418. }
  52419. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  52420. /** @hidden */
  52421. export var glowMapMergePixelShader: {
  52422. name: string;
  52423. shader: string;
  52424. };
  52425. }
  52426. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  52427. /** @hidden */
  52428. export var glowMapMergeVertexShader: {
  52429. name: string;
  52430. shader: string;
  52431. };
  52432. }
  52433. declare module "babylonjs/Layers/glowLayer" {
  52434. import { Nullable } from "babylonjs/types";
  52435. import { Camera } from "babylonjs/Cameras/camera";
  52436. import { Scene } from "babylonjs/scene";
  52437. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52438. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52439. import { Mesh } from "babylonjs/Meshes/mesh";
  52440. import { Texture } from "babylonjs/Materials/Textures/texture";
  52441. import { Effect } from "babylonjs/Materials/effect";
  52442. import { Material } from "babylonjs/Materials/material";
  52443. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52444. import { Color4 } from "babylonjs/Maths/math.color";
  52445. import "babylonjs/Shaders/glowMapMerge.fragment";
  52446. import "babylonjs/Shaders/glowMapMerge.vertex";
  52447. import "babylonjs/Layers/effectLayerSceneComponent";
  52448. module "babylonjs/abstractScene" {
  52449. interface AbstractScene {
  52450. /**
  52451. * Return a the first highlight layer of the scene with a given name.
  52452. * @param name The name of the highlight layer to look for.
  52453. * @return The highlight layer if found otherwise null.
  52454. */
  52455. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  52456. }
  52457. }
  52458. /**
  52459. * Glow layer options. This helps customizing the behaviour
  52460. * of the glow layer.
  52461. */
  52462. export interface IGlowLayerOptions {
  52463. /**
  52464. * Multiplication factor apply to the canvas size to compute the render target size
  52465. * used to generated the glowing objects (the smaller the faster).
  52466. */
  52467. mainTextureRatio: number;
  52468. /**
  52469. * Enforces a fixed size texture to ensure resize independant blur.
  52470. */
  52471. mainTextureFixedSize?: number;
  52472. /**
  52473. * How big is the kernel of the blur texture.
  52474. */
  52475. blurKernelSize: number;
  52476. /**
  52477. * The camera attached to the layer.
  52478. */
  52479. camera: Nullable<Camera>;
  52480. /**
  52481. * Enable MSAA by chosing the number of samples.
  52482. */
  52483. mainTextureSamples?: number;
  52484. /**
  52485. * The rendering group to draw the layer in.
  52486. */
  52487. renderingGroupId: number;
  52488. }
  52489. /**
  52490. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  52491. *
  52492. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  52493. *
  52494. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  52495. */
  52496. export class GlowLayer extends EffectLayer {
  52497. /**
  52498. * Effect Name of the layer.
  52499. */
  52500. static readonly EffectName: string;
  52501. /**
  52502. * The default blur kernel size used for the glow.
  52503. */
  52504. static DefaultBlurKernelSize: number;
  52505. /**
  52506. * The default texture size ratio used for the glow.
  52507. */
  52508. static DefaultTextureRatio: number;
  52509. /**
  52510. * Sets the kernel size of the blur.
  52511. */
  52512. /**
  52513. * Gets the kernel size of the blur.
  52514. */
  52515. blurKernelSize: number;
  52516. /**
  52517. * Sets the glow intensity.
  52518. */
  52519. /**
  52520. * Gets the glow intensity.
  52521. */
  52522. intensity: number;
  52523. private _options;
  52524. private _intensity;
  52525. private _horizontalBlurPostprocess1;
  52526. private _verticalBlurPostprocess1;
  52527. private _horizontalBlurPostprocess2;
  52528. private _verticalBlurPostprocess2;
  52529. private _blurTexture1;
  52530. private _blurTexture2;
  52531. private _postProcesses1;
  52532. private _postProcesses2;
  52533. private _includedOnlyMeshes;
  52534. private _excludedMeshes;
  52535. private _meshesUsingTheirOwnMaterials;
  52536. /**
  52537. * Callback used to let the user override the color selection on a per mesh basis
  52538. */
  52539. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  52540. /**
  52541. * Callback used to let the user override the texture selection on a per mesh basis
  52542. */
  52543. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  52544. /**
  52545. * Instantiates a new glow Layer and references it to the scene.
  52546. * @param name The name of the layer
  52547. * @param scene The scene to use the layer in
  52548. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  52549. */
  52550. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  52551. /**
  52552. * Get the effect name of the layer.
  52553. * @return The effect name
  52554. */
  52555. getEffectName(): string;
  52556. /**
  52557. * Create the merge effect. This is the shader use to blit the information back
  52558. * to the main canvas at the end of the scene rendering.
  52559. */
  52560. protected _createMergeEffect(): Effect;
  52561. /**
  52562. * Creates the render target textures and post processes used in the glow layer.
  52563. */
  52564. protected _createTextureAndPostProcesses(): void;
  52565. /**
  52566. * Checks for the readiness of the element composing the layer.
  52567. * @param subMesh the mesh to check for
  52568. * @param useInstances specify wether or not to use instances to render the mesh
  52569. * @param emissiveTexture the associated emissive texture used to generate the glow
  52570. * @return true if ready otherwise, false
  52571. */
  52572. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52573. /**
  52574. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52575. */
  52576. needStencil(): boolean;
  52577. /**
  52578. * Returns true if the mesh can be rendered, otherwise false.
  52579. * @param mesh The mesh to render
  52580. * @param material The material used on the mesh
  52581. * @returns true if it can be rendered otherwise false
  52582. */
  52583. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  52584. /**
  52585. * Implementation specific of rendering the generating effect on the main canvas.
  52586. * @param effect The effect used to render through
  52587. */
  52588. protected _internalRender(effect: Effect): void;
  52589. /**
  52590. * Sets the required values for both the emissive texture and and the main color.
  52591. */
  52592. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52593. /**
  52594. * Returns true if the mesh should render, otherwise false.
  52595. * @param mesh The mesh to render
  52596. * @returns true if it should render otherwise false
  52597. */
  52598. protected _shouldRenderMesh(mesh: Mesh): boolean;
  52599. /**
  52600. * Adds specific effects defines.
  52601. * @param defines The defines to add specifics to.
  52602. */
  52603. protected _addCustomEffectDefines(defines: string[]): void;
  52604. /**
  52605. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  52606. * @param mesh The mesh to exclude from the glow layer
  52607. */
  52608. addExcludedMesh(mesh: Mesh): void;
  52609. /**
  52610. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  52611. * @param mesh The mesh to remove
  52612. */
  52613. removeExcludedMesh(mesh: Mesh): void;
  52614. /**
  52615. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  52616. * @param mesh The mesh to include in the glow layer
  52617. */
  52618. addIncludedOnlyMesh(mesh: Mesh): void;
  52619. /**
  52620. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  52621. * @param mesh The mesh to remove
  52622. */
  52623. removeIncludedOnlyMesh(mesh: Mesh): void;
  52624. /**
  52625. * Determine if a given mesh will be used in the glow layer
  52626. * @param mesh The mesh to test
  52627. * @returns true if the mesh will be highlighted by the current glow layer
  52628. */
  52629. hasMesh(mesh: AbstractMesh): boolean;
  52630. /**
  52631. * Defines wether the current material of the mesh should be use to render the effect.
  52632. * @param mesh defines the current mesh to render
  52633. */
  52634. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  52635. /**
  52636. * Add a mesh to be rendered through its own material and not with emissive only.
  52637. * @param mesh The mesh for which we need to use its material
  52638. */
  52639. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  52640. /**
  52641. * Remove a mesh from being rendered through its own material and not with emissive only.
  52642. * @param mesh The mesh for which we need to not use its material
  52643. */
  52644. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  52645. /**
  52646. * Free any resources and references associated to a mesh.
  52647. * Internal use
  52648. * @param mesh The mesh to free.
  52649. * @hidden
  52650. */
  52651. _disposeMesh(mesh: Mesh): void;
  52652. /**
  52653. * Gets the class name of the effect layer
  52654. * @returns the string with the class name of the effect layer
  52655. */
  52656. getClassName(): string;
  52657. /**
  52658. * Serializes this glow layer
  52659. * @returns a serialized glow layer object
  52660. */
  52661. serialize(): any;
  52662. /**
  52663. * Creates a Glow Layer from parsed glow layer data
  52664. * @param parsedGlowLayer defines glow layer data
  52665. * @param scene defines the current scene
  52666. * @param rootUrl defines the root URL containing the glow layer information
  52667. * @returns a parsed Glow Layer
  52668. */
  52669. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  52670. }
  52671. }
  52672. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  52673. /** @hidden */
  52674. export var glowBlurPostProcessPixelShader: {
  52675. name: string;
  52676. shader: string;
  52677. };
  52678. }
  52679. declare module "babylonjs/Layers/highlightLayer" {
  52680. import { Observable } from "babylonjs/Misc/observable";
  52681. import { Nullable } from "babylonjs/types";
  52682. import { Camera } from "babylonjs/Cameras/camera";
  52683. import { Scene } from "babylonjs/scene";
  52684. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52685. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52686. import { Mesh } from "babylonjs/Meshes/mesh";
  52687. import { Effect } from "babylonjs/Materials/effect";
  52688. import { Material } from "babylonjs/Materials/material";
  52689. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52690. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  52691. import "babylonjs/Shaders/glowMapMerge.fragment";
  52692. import "babylonjs/Shaders/glowMapMerge.vertex";
  52693. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  52694. module "babylonjs/abstractScene" {
  52695. interface AbstractScene {
  52696. /**
  52697. * Return a the first highlight layer of the scene with a given name.
  52698. * @param name The name of the highlight layer to look for.
  52699. * @return The highlight layer if found otherwise null.
  52700. */
  52701. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  52702. }
  52703. }
  52704. /**
  52705. * Highlight layer options. This helps customizing the behaviour
  52706. * of the highlight layer.
  52707. */
  52708. export interface IHighlightLayerOptions {
  52709. /**
  52710. * Multiplication factor apply to the canvas size to compute the render target size
  52711. * used to generated the glowing objects (the smaller the faster).
  52712. */
  52713. mainTextureRatio: number;
  52714. /**
  52715. * Enforces a fixed size texture to ensure resize independant blur.
  52716. */
  52717. mainTextureFixedSize?: number;
  52718. /**
  52719. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  52720. * of the picture to blur (the smaller the faster).
  52721. */
  52722. blurTextureSizeRatio: number;
  52723. /**
  52724. * How big in texel of the blur texture is the vertical blur.
  52725. */
  52726. blurVerticalSize: number;
  52727. /**
  52728. * How big in texel of the blur texture is the horizontal blur.
  52729. */
  52730. blurHorizontalSize: number;
  52731. /**
  52732. * Alpha blending mode used to apply the blur. Default is combine.
  52733. */
  52734. alphaBlendingMode: number;
  52735. /**
  52736. * The camera attached to the layer.
  52737. */
  52738. camera: Nullable<Camera>;
  52739. /**
  52740. * Should we display highlight as a solid stroke?
  52741. */
  52742. isStroke?: boolean;
  52743. /**
  52744. * The rendering group to draw the layer in.
  52745. */
  52746. renderingGroupId: number;
  52747. }
  52748. /**
  52749. * The highlight layer Helps adding a glow effect around a mesh.
  52750. *
  52751. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  52752. * glowy meshes to your scene.
  52753. *
  52754. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  52755. */
  52756. export class HighlightLayer extends EffectLayer {
  52757. name: string;
  52758. /**
  52759. * Effect Name of the highlight layer.
  52760. */
  52761. static readonly EffectName: string;
  52762. /**
  52763. * The neutral color used during the preparation of the glow effect.
  52764. * This is black by default as the blend operation is a blend operation.
  52765. */
  52766. static NeutralColor: Color4;
  52767. /**
  52768. * Stencil value used for glowing meshes.
  52769. */
  52770. static GlowingMeshStencilReference: number;
  52771. /**
  52772. * Stencil value used for the other meshes in the scene.
  52773. */
  52774. static NormalMeshStencilReference: number;
  52775. /**
  52776. * Specifies whether or not the inner glow is ACTIVE in the layer.
  52777. */
  52778. innerGlow: boolean;
  52779. /**
  52780. * Specifies whether or not the outer glow is ACTIVE in the layer.
  52781. */
  52782. outerGlow: boolean;
  52783. /**
  52784. * Specifies the horizontal size of the blur.
  52785. */
  52786. /**
  52787. * Gets the horizontal size of the blur.
  52788. */
  52789. blurHorizontalSize: number;
  52790. /**
  52791. * Specifies the vertical size of the blur.
  52792. */
  52793. /**
  52794. * Gets the vertical size of the blur.
  52795. */
  52796. blurVerticalSize: number;
  52797. /**
  52798. * An event triggered when the highlight layer is being blurred.
  52799. */
  52800. onBeforeBlurObservable: Observable<HighlightLayer>;
  52801. /**
  52802. * An event triggered when the highlight layer has been blurred.
  52803. */
  52804. onAfterBlurObservable: Observable<HighlightLayer>;
  52805. private _instanceGlowingMeshStencilReference;
  52806. private _options;
  52807. private _downSamplePostprocess;
  52808. private _horizontalBlurPostprocess;
  52809. private _verticalBlurPostprocess;
  52810. private _blurTexture;
  52811. private _meshes;
  52812. private _excludedMeshes;
  52813. /**
  52814. * Instantiates a new highlight Layer and references it to the scene..
  52815. * @param name The name of the layer
  52816. * @param scene The scene to use the layer in
  52817. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  52818. */
  52819. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  52820. /**
  52821. * Get the effect name of the layer.
  52822. * @return The effect name
  52823. */
  52824. getEffectName(): string;
  52825. /**
  52826. * Create the merge effect. This is the shader use to blit the information back
  52827. * to the main canvas at the end of the scene rendering.
  52828. */
  52829. protected _createMergeEffect(): Effect;
  52830. /**
  52831. * Creates the render target textures and post processes used in the highlight layer.
  52832. */
  52833. protected _createTextureAndPostProcesses(): void;
  52834. /**
  52835. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52836. */
  52837. needStencil(): boolean;
  52838. /**
  52839. * Checks for the readiness of the element composing the layer.
  52840. * @param subMesh the mesh to check for
  52841. * @param useInstances specify wether or not to use instances to render the mesh
  52842. * @param emissiveTexture the associated emissive texture used to generate the glow
  52843. * @return true if ready otherwise, false
  52844. */
  52845. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52846. /**
  52847. * Implementation specific of rendering the generating effect on the main canvas.
  52848. * @param effect The effect used to render through
  52849. */
  52850. protected _internalRender(effect: Effect): void;
  52851. /**
  52852. * Returns true if the layer contains information to display, otherwise false.
  52853. */
  52854. shouldRender(): boolean;
  52855. /**
  52856. * Returns true if the mesh should render, otherwise false.
  52857. * @param mesh The mesh to render
  52858. * @returns true if it should render otherwise false
  52859. */
  52860. protected _shouldRenderMesh(mesh: Mesh): boolean;
  52861. /**
  52862. * Sets the required values for both the emissive texture and and the main color.
  52863. */
  52864. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52865. /**
  52866. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  52867. * @param mesh The mesh to exclude from the highlight layer
  52868. */
  52869. addExcludedMesh(mesh: Mesh): void;
  52870. /**
  52871. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  52872. * @param mesh The mesh to highlight
  52873. */
  52874. removeExcludedMesh(mesh: Mesh): void;
  52875. /**
  52876. * Determine if a given mesh will be highlighted by the current HighlightLayer
  52877. * @param mesh mesh to test
  52878. * @returns true if the mesh will be highlighted by the current HighlightLayer
  52879. */
  52880. hasMesh(mesh: AbstractMesh): boolean;
  52881. /**
  52882. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  52883. * @param mesh The mesh to highlight
  52884. * @param color The color of the highlight
  52885. * @param glowEmissiveOnly Extract the glow from the emissive texture
  52886. */
  52887. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  52888. /**
  52889. * Remove a mesh from the highlight layer in order to make it stop glowing.
  52890. * @param mesh The mesh to highlight
  52891. */
  52892. removeMesh(mesh: Mesh): void;
  52893. /**
  52894. * Force the stencil to the normal expected value for none glowing parts
  52895. */
  52896. private _defaultStencilReference;
  52897. /**
  52898. * Free any resources and references associated to a mesh.
  52899. * Internal use
  52900. * @param mesh The mesh to free.
  52901. * @hidden
  52902. */
  52903. _disposeMesh(mesh: Mesh): void;
  52904. /**
  52905. * Dispose the highlight layer and free resources.
  52906. */
  52907. dispose(): void;
  52908. /**
  52909. * Gets the class name of the effect layer
  52910. * @returns the string with the class name of the effect layer
  52911. */
  52912. getClassName(): string;
  52913. /**
  52914. * Serializes this Highlight layer
  52915. * @returns a serialized Highlight layer object
  52916. */
  52917. serialize(): any;
  52918. /**
  52919. * Creates a Highlight layer from parsed Highlight layer data
  52920. * @param parsedHightlightLayer defines the Highlight layer data
  52921. * @param scene defines the current scene
  52922. * @param rootUrl defines the root URL containing the Highlight layer information
  52923. * @returns a parsed Highlight layer
  52924. */
  52925. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  52926. }
  52927. }
  52928. declare module "babylonjs/Layers/layerSceneComponent" {
  52929. import { Scene } from "babylonjs/scene";
  52930. import { ISceneComponent } from "babylonjs/sceneComponent";
  52931. import { Layer } from "babylonjs/Layers/layer";
  52932. import { AbstractScene } from "babylonjs/abstractScene";
  52933. module "babylonjs/abstractScene" {
  52934. interface AbstractScene {
  52935. /**
  52936. * The list of layers (background and foreground) of the scene
  52937. */
  52938. layers: Array<Layer>;
  52939. }
  52940. }
  52941. /**
  52942. * Defines the layer scene component responsible to manage any layers
  52943. * in a given scene.
  52944. */
  52945. export class LayerSceneComponent implements ISceneComponent {
  52946. /**
  52947. * The component name helpfull to identify the component in the list of scene components.
  52948. */
  52949. readonly name: string;
  52950. /**
  52951. * The scene the component belongs to.
  52952. */
  52953. scene: Scene;
  52954. private _engine;
  52955. /**
  52956. * Creates a new instance of the component for the given scene
  52957. * @param scene Defines the scene to register the component in
  52958. */
  52959. constructor(scene: Scene);
  52960. /**
  52961. * Registers the component in a given scene
  52962. */
  52963. register(): void;
  52964. /**
  52965. * Rebuilds the elements related to this component in case of
  52966. * context lost for instance.
  52967. */
  52968. rebuild(): void;
  52969. /**
  52970. * Disposes the component and the associated ressources.
  52971. */
  52972. dispose(): void;
  52973. private _draw;
  52974. private _drawCameraPredicate;
  52975. private _drawCameraBackground;
  52976. private _drawCameraForeground;
  52977. private _drawRenderTargetPredicate;
  52978. private _drawRenderTargetBackground;
  52979. private _drawRenderTargetForeground;
  52980. /**
  52981. * Adds all the elements from the container to the scene
  52982. * @param container the container holding the elements
  52983. */
  52984. addFromContainer(container: AbstractScene): void;
  52985. /**
  52986. * Removes all the elements in the container from the scene
  52987. * @param container contains the elements to remove
  52988. * @param dispose if the removed element should be disposed (default: false)
  52989. */
  52990. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  52991. }
  52992. }
  52993. declare module "babylonjs/Shaders/layer.fragment" {
  52994. /** @hidden */
  52995. export var layerPixelShader: {
  52996. name: string;
  52997. shader: string;
  52998. };
  52999. }
  53000. declare module "babylonjs/Shaders/layer.vertex" {
  53001. /** @hidden */
  53002. export var layerVertexShader: {
  53003. name: string;
  53004. shader: string;
  53005. };
  53006. }
  53007. declare module "babylonjs/Layers/layer" {
  53008. import { Observable } from "babylonjs/Misc/observable";
  53009. import { Nullable } from "babylonjs/types";
  53010. import { Scene } from "babylonjs/scene";
  53011. import { Vector2 } from "babylonjs/Maths/math.vector";
  53012. import { Color4 } from "babylonjs/Maths/math.color";
  53013. import { Texture } from "babylonjs/Materials/Textures/texture";
  53014. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  53015. import "babylonjs/Shaders/layer.fragment";
  53016. import "babylonjs/Shaders/layer.vertex";
  53017. /**
  53018. * This represents a full screen 2d layer.
  53019. * This can be useful to display a picture in the background of your scene for instance.
  53020. * @see https://www.babylonjs-playground.com/#08A2BS#1
  53021. */
  53022. export class Layer {
  53023. /**
  53024. * Define the name of the layer.
  53025. */
  53026. name: string;
  53027. /**
  53028. * Define the texture the layer should display.
  53029. */
  53030. texture: Nullable<Texture>;
  53031. /**
  53032. * Is the layer in background or foreground.
  53033. */
  53034. isBackground: boolean;
  53035. /**
  53036. * Define the color of the layer (instead of texture).
  53037. */
  53038. color: Color4;
  53039. /**
  53040. * Define the scale of the layer in order to zoom in out of the texture.
  53041. */
  53042. scale: Vector2;
  53043. /**
  53044. * Define an offset for the layer in order to shift the texture.
  53045. */
  53046. offset: Vector2;
  53047. /**
  53048. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  53049. */
  53050. alphaBlendingMode: number;
  53051. /**
  53052. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  53053. * Alpha test will not mix with the background color in case of transparency.
  53054. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  53055. */
  53056. alphaTest: boolean;
  53057. /**
  53058. * Define a mask to restrict the layer to only some of the scene cameras.
  53059. */
  53060. layerMask: number;
  53061. /**
  53062. * Define the list of render target the layer is visible into.
  53063. */
  53064. renderTargetTextures: RenderTargetTexture[];
  53065. /**
  53066. * Define if the layer is only used in renderTarget or if it also
  53067. * renders in the main frame buffer of the canvas.
  53068. */
  53069. renderOnlyInRenderTargetTextures: boolean;
  53070. private _scene;
  53071. private _vertexBuffers;
  53072. private _indexBuffer;
  53073. private _effect;
  53074. private _alphaTestEffect;
  53075. /**
  53076. * An event triggered when the layer is disposed.
  53077. */
  53078. onDisposeObservable: Observable<Layer>;
  53079. private _onDisposeObserver;
  53080. /**
  53081. * Back compatibility with callback before the onDisposeObservable existed.
  53082. * The set callback will be triggered when the layer has been disposed.
  53083. */
  53084. onDispose: () => void;
  53085. /**
  53086. * An event triggered before rendering the scene
  53087. */
  53088. onBeforeRenderObservable: Observable<Layer>;
  53089. private _onBeforeRenderObserver;
  53090. /**
  53091. * Back compatibility with callback before the onBeforeRenderObservable existed.
  53092. * The set callback will be triggered just before rendering the layer.
  53093. */
  53094. onBeforeRender: () => void;
  53095. /**
  53096. * An event triggered after rendering the scene
  53097. */
  53098. onAfterRenderObservable: Observable<Layer>;
  53099. private _onAfterRenderObserver;
  53100. /**
  53101. * Back compatibility with callback before the onAfterRenderObservable existed.
  53102. * The set callback will be triggered just after rendering the layer.
  53103. */
  53104. onAfterRender: () => void;
  53105. /**
  53106. * Instantiates a new layer.
  53107. * This represents a full screen 2d layer.
  53108. * This can be useful to display a picture in the background of your scene for instance.
  53109. * @see https://www.babylonjs-playground.com/#08A2BS#1
  53110. * @param name Define the name of the layer in the scene
  53111. * @param imgUrl Define the url of the texture to display in the layer
  53112. * @param scene Define the scene the layer belongs to
  53113. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  53114. * @param color Defines a color for the layer
  53115. */
  53116. constructor(
  53117. /**
  53118. * Define the name of the layer.
  53119. */
  53120. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  53121. private _createIndexBuffer;
  53122. /** @hidden */
  53123. _rebuild(): void;
  53124. /**
  53125. * Renders the layer in the scene.
  53126. */
  53127. render(): void;
  53128. /**
  53129. * Disposes and releases the associated ressources.
  53130. */
  53131. dispose(): void;
  53132. }
  53133. }
  53134. declare module "babylonjs/Layers/index" {
  53135. export * from "babylonjs/Layers/effectLayer";
  53136. export * from "babylonjs/Layers/effectLayerSceneComponent";
  53137. export * from "babylonjs/Layers/glowLayer";
  53138. export * from "babylonjs/Layers/highlightLayer";
  53139. export * from "babylonjs/Layers/layer";
  53140. export * from "babylonjs/Layers/layerSceneComponent";
  53141. }
  53142. declare module "babylonjs/Shaders/lensFlare.fragment" {
  53143. /** @hidden */
  53144. export var lensFlarePixelShader: {
  53145. name: string;
  53146. shader: string;
  53147. };
  53148. }
  53149. declare module "babylonjs/Shaders/lensFlare.vertex" {
  53150. /** @hidden */
  53151. export var lensFlareVertexShader: {
  53152. name: string;
  53153. shader: string;
  53154. };
  53155. }
  53156. declare module "babylonjs/LensFlares/lensFlareSystem" {
  53157. import { Scene } from "babylonjs/scene";
  53158. import { Vector3 } from "babylonjs/Maths/math.vector";
  53159. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53160. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  53161. import "babylonjs/Shaders/lensFlare.fragment";
  53162. import "babylonjs/Shaders/lensFlare.vertex";
  53163. import { Viewport } from "babylonjs/Maths/math.viewport";
  53164. /**
  53165. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  53166. * It is usually composed of several `lensFlare`.
  53167. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53168. */
  53169. export class LensFlareSystem {
  53170. /**
  53171. * Define the name of the lens flare system
  53172. */
  53173. name: string;
  53174. /**
  53175. * List of lens flares used in this system.
  53176. */
  53177. lensFlares: LensFlare[];
  53178. /**
  53179. * Define a limit from the border the lens flare can be visible.
  53180. */
  53181. borderLimit: number;
  53182. /**
  53183. * Define a viewport border we do not want to see the lens flare in.
  53184. */
  53185. viewportBorder: number;
  53186. /**
  53187. * Define a predicate which could limit the list of meshes able to occlude the effect.
  53188. */
  53189. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  53190. /**
  53191. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  53192. */
  53193. layerMask: number;
  53194. /**
  53195. * Define the id of the lens flare system in the scene.
  53196. * (equal to name by default)
  53197. */
  53198. id: string;
  53199. private _scene;
  53200. private _emitter;
  53201. private _vertexBuffers;
  53202. private _indexBuffer;
  53203. private _effect;
  53204. private _positionX;
  53205. private _positionY;
  53206. private _isEnabled;
  53207. /** @hidden */
  53208. static _SceneComponentInitialization: (scene: Scene) => void;
  53209. /**
  53210. * Instantiates a lens flare system.
  53211. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  53212. * It is usually composed of several `lensFlare`.
  53213. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53214. * @param name Define the name of the lens flare system in the scene
  53215. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  53216. * @param scene Define the scene the lens flare system belongs to
  53217. */
  53218. constructor(
  53219. /**
  53220. * Define the name of the lens flare system
  53221. */
  53222. name: string, emitter: any, scene: Scene);
  53223. /**
  53224. * Define if the lens flare system is enabled.
  53225. */
  53226. isEnabled: boolean;
  53227. /**
  53228. * Get the scene the effects belongs to.
  53229. * @returns the scene holding the lens flare system
  53230. */
  53231. getScene(): Scene;
  53232. /**
  53233. * Get the emitter of the lens flare system.
  53234. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  53235. * @returns the emitter of the lens flare system
  53236. */
  53237. getEmitter(): any;
  53238. /**
  53239. * Set the emitter of the lens flare system.
  53240. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  53241. * @param newEmitter Define the new emitter of the system
  53242. */
  53243. setEmitter(newEmitter: any): void;
  53244. /**
  53245. * Get the lens flare system emitter position.
  53246. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  53247. * @returns the position
  53248. */
  53249. getEmitterPosition(): Vector3;
  53250. /**
  53251. * @hidden
  53252. */
  53253. computeEffectivePosition(globalViewport: Viewport): boolean;
  53254. /** @hidden */
  53255. _isVisible(): boolean;
  53256. /**
  53257. * @hidden
  53258. */
  53259. render(): boolean;
  53260. /**
  53261. * Dispose and release the lens flare with its associated resources.
  53262. */
  53263. dispose(): void;
  53264. /**
  53265. * Parse a lens flare system from a JSON repressentation
  53266. * @param parsedLensFlareSystem Define the JSON to parse
  53267. * @param scene Define the scene the parsed system should be instantiated in
  53268. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  53269. * @returns the parsed system
  53270. */
  53271. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  53272. /**
  53273. * Serialize the current Lens Flare System into a JSON representation.
  53274. * @returns the serialized JSON
  53275. */
  53276. serialize(): any;
  53277. }
  53278. }
  53279. declare module "babylonjs/LensFlares/lensFlare" {
  53280. import { Nullable } from "babylonjs/types";
  53281. import { Color3 } from "babylonjs/Maths/math.color";
  53282. import { Texture } from "babylonjs/Materials/Textures/texture";
  53283. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  53284. /**
  53285. * This represents one of the lens effect in a `lensFlareSystem`.
  53286. * It controls one of the indiviual texture used in the effect.
  53287. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53288. */
  53289. export class LensFlare {
  53290. /**
  53291. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  53292. */
  53293. size: number;
  53294. /**
  53295. * Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
  53296. */
  53297. position: number;
  53298. /**
  53299. * Define the lens color.
  53300. */
  53301. color: Color3;
  53302. /**
  53303. * Define the lens texture.
  53304. */
  53305. texture: Nullable<Texture>;
  53306. /**
  53307. * Define the alpha mode to render this particular lens.
  53308. */
  53309. alphaMode: number;
  53310. private _system;
  53311. /**
  53312. * Creates a new Lens Flare.
  53313. * This represents one of the lens effect in a `lensFlareSystem`.
  53314. * It controls one of the indiviual texture used in the effect.
  53315. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53316. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  53317. * @param position Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
  53318. * @param color Define the lens color
  53319. * @param imgUrl Define the lens texture url
  53320. * @param system Define the `lensFlareSystem` this flare is part of
  53321. * @returns The newly created Lens Flare
  53322. */
  53323. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  53324. /**
  53325. * Instantiates a new Lens Flare.
  53326. * This represents one of the lens effect in a `lensFlareSystem`.
  53327. * It controls one of the indiviual texture used in the effect.
  53328. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53329. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  53330. * @param position Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
  53331. * @param color Define the lens color
  53332. * @param imgUrl Define the lens texture url
  53333. * @param system Define the `lensFlareSystem` this flare is part of
  53334. */
  53335. constructor(
  53336. /**
  53337. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  53338. */
  53339. size: number,
  53340. /**
  53341. * Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
  53342. */
  53343. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  53344. /**
  53345. * Dispose and release the lens flare with its associated resources.
  53346. */
  53347. dispose(): void;
  53348. }
  53349. }
  53350. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  53351. import { Nullable } from "babylonjs/types";
  53352. import { Scene } from "babylonjs/scene";
  53353. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  53354. import { AbstractScene } from "babylonjs/abstractScene";
  53355. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  53356. module "babylonjs/abstractScene" {
  53357. interface AbstractScene {
  53358. /**
  53359. * The list of lens flare system added to the scene
  53360. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53361. */
  53362. lensFlareSystems: Array<LensFlareSystem>;
  53363. /**
  53364. * Removes the given lens flare system from this scene.
  53365. * @param toRemove The lens flare system to remove
  53366. * @returns The index of the removed lens flare system
  53367. */
  53368. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  53369. /**
  53370. * Adds the given lens flare system to this scene
  53371. * @param newLensFlareSystem The lens flare system to add
  53372. */
  53373. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  53374. /**
  53375. * Gets a lens flare system using its name
  53376. * @param name defines the name to look for
  53377. * @returns the lens flare system or null if not found
  53378. */
  53379. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  53380. /**
  53381. * Gets a lens flare system using its id
  53382. * @param id defines the id to look for
  53383. * @returns the lens flare system or null if not found
  53384. */
  53385. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  53386. }
  53387. }
  53388. /**
  53389. * Defines the lens flare scene component responsible to manage any lens flares
  53390. * in a given scene.
  53391. */
  53392. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  53393. /**
  53394. * The component name helpfull to identify the component in the list of scene components.
  53395. */
  53396. readonly name: string;
  53397. /**
  53398. * The scene the component belongs to.
  53399. */
  53400. scene: Scene;
  53401. /**
  53402. * Creates a new instance of the component for the given scene
  53403. * @param scene Defines the scene to register the component in
  53404. */
  53405. constructor(scene: Scene);
  53406. /**
  53407. * Registers the component in a given scene
  53408. */
  53409. register(): void;
  53410. /**
  53411. * Rebuilds the elements related to this component in case of
  53412. * context lost for instance.
  53413. */
  53414. rebuild(): void;
  53415. /**
  53416. * Adds all the elements from the container to the scene
  53417. * @param container the container holding the elements
  53418. */
  53419. addFromContainer(container: AbstractScene): void;
  53420. /**
  53421. * Removes all the elements in the container from the scene
  53422. * @param container contains the elements to remove
  53423. * @param dispose if the removed element should be disposed (default: false)
  53424. */
  53425. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53426. /**
  53427. * Serializes the component data to the specified json object
  53428. * @param serializationObject The object to serialize to
  53429. */
  53430. serialize(serializationObject: any): void;
  53431. /**
  53432. * Disposes the component and the associated ressources.
  53433. */
  53434. dispose(): void;
  53435. private _draw;
  53436. }
  53437. }
  53438. declare module "babylonjs/LensFlares/index" {
  53439. export * from "babylonjs/LensFlares/lensFlare";
  53440. export * from "babylonjs/LensFlares/lensFlareSystem";
  53441. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  53442. }
  53443. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  53444. import { Scene } from "babylonjs/scene";
  53445. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  53446. import { AbstractScene } from "babylonjs/abstractScene";
  53447. /**
  53448. * Defines the shadow generator component responsible to manage any shadow generators
  53449. * in a given scene.
  53450. */
  53451. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  53452. /**
  53453. * The component name helpfull to identify the component in the list of scene components.
  53454. */
  53455. readonly name: string;
  53456. /**
  53457. * The scene the component belongs to.
  53458. */
  53459. scene: Scene;
  53460. /**
  53461. * Creates a new instance of the component for the given scene
  53462. * @param scene Defines the scene to register the component in
  53463. */
  53464. constructor(scene: Scene);
  53465. /**
  53466. * Registers the component in a given scene
  53467. */
  53468. register(): void;
  53469. /**
  53470. * Rebuilds the elements related to this component in case of
  53471. * context lost for instance.
  53472. */
  53473. rebuild(): void;
  53474. /**
  53475. * Serializes the component data to the specified json object
  53476. * @param serializationObject The object to serialize to
  53477. */
  53478. serialize(serializationObject: any): void;
  53479. /**
  53480. * Adds all the elements from the container to the scene
  53481. * @param container the container holding the elements
  53482. */
  53483. addFromContainer(container: AbstractScene): void;
  53484. /**
  53485. * Removes all the elements in the container from the scene
  53486. * @param container contains the elements to remove
  53487. * @param dispose if the removed element should be disposed (default: false)
  53488. */
  53489. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53490. /**
  53491. * Rebuilds the elements related to this component in case of
  53492. * context lost for instance.
  53493. */
  53494. dispose(): void;
  53495. private _gatherRenderTargets;
  53496. }
  53497. }
  53498. declare module "babylonjs/Lights/Shadows/index" {
  53499. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  53500. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  53501. }
  53502. declare module "babylonjs/Lights/pointLight" {
  53503. import { Scene } from "babylonjs/scene";
  53504. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  53505. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53506. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  53507. import { Effect } from "babylonjs/Materials/effect";
  53508. /**
  53509. * A point light is a light defined by an unique point in world space.
  53510. * The light is emitted in every direction from this point.
  53511. * A good example of a point light is a standard light bulb.
  53512. * Documentation: https://doc.babylonjs.com/babylon101/lights
  53513. */
  53514. export class PointLight extends ShadowLight {
  53515. private _shadowAngle;
  53516. /**
  53517. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53518. * This specifies what angle the shadow will use to be created.
  53519. *
  53520. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  53521. */
  53522. /**
  53523. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53524. * This specifies what angle the shadow will use to be created.
  53525. *
  53526. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  53527. */
  53528. shadowAngle: number;
  53529. /**
  53530. * Gets the direction if it has been set.
  53531. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53532. */
  53533. /**
  53534. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53535. */
  53536. direction: Vector3;
  53537. /**
  53538. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  53539. * A PointLight emits the light in every direction.
  53540. * It can cast shadows.
  53541. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  53542. * ```javascript
  53543. * var pointLight = new PointLight("pl", camera.position, scene);
  53544. * ```
  53545. * Documentation : https://doc.babylonjs.com/babylon101/lights
  53546. * @param name The light friendly name
  53547. * @param position The position of the point light in the scene
  53548. * @param scene The scene the lights belongs to
  53549. */
  53550. constructor(name: string, position: Vector3, scene: Scene);
  53551. /**
  53552. * Returns the string "PointLight"
  53553. * @returns the class name
  53554. */
  53555. getClassName(): string;
  53556. /**
  53557. * Returns the integer 0.
  53558. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  53559. */
  53560. getTypeID(): number;
  53561. /**
  53562. * Specifies wether or not the shadowmap should be a cube texture.
  53563. * @returns true if the shadowmap needs to be a cube texture.
  53564. */
  53565. needCube(): boolean;
  53566. /**
  53567. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  53568. * @param faceIndex The index of the face we are computed the direction to generate shadow
  53569. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  53570. */
  53571. getShadowDirection(faceIndex?: number): Vector3;
  53572. /**
  53573. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  53574. * - fov = PI / 2
  53575. * - aspect ratio : 1.0
  53576. * - z-near and far equal to the active camera minZ and maxZ.
  53577. * Returns the PointLight.
  53578. */
  53579. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  53580. protected _buildUniformLayout(): void;
  53581. /**
  53582. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  53583. * @param effect The effect to update
  53584. * @param lightIndex The index of the light in the effect to update
  53585. * @returns The point light
  53586. */
  53587. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  53588. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  53589. /**
  53590. * Prepares the list of defines specific to the light type.
  53591. * @param defines the list of defines
  53592. * @param lightIndex defines the index of the light for the effect
  53593. */
  53594. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  53595. }
  53596. }
  53597. declare module "babylonjs/Lights/index" {
  53598. export * from "babylonjs/Lights/light";
  53599. export * from "babylonjs/Lights/shadowLight";
  53600. export * from "babylonjs/Lights/Shadows/index";
  53601. export * from "babylonjs/Lights/directionalLight";
  53602. export * from "babylonjs/Lights/hemisphericLight";
  53603. export * from "babylonjs/Lights/pointLight";
  53604. export * from "babylonjs/Lights/spotLight";
  53605. }
  53606. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  53607. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  53608. /**
  53609. * Header information of HDR texture files.
  53610. */
  53611. export interface HDRInfo {
  53612. /**
  53613. * The height of the texture in pixels.
  53614. */
  53615. height: number;
  53616. /**
  53617. * The width of the texture in pixels.
  53618. */
  53619. width: number;
  53620. /**
  53621. * The index of the beginning of the data in the binary file.
  53622. */
  53623. dataPosition: number;
  53624. }
  53625. /**
  53626. * This groups tools to convert HDR texture to native colors array.
  53627. */
  53628. export class HDRTools {
  53629. private static Ldexp;
  53630. private static Rgbe2float;
  53631. private static readStringLine;
  53632. /**
  53633. * Reads header information from an RGBE texture stored in a native array.
  53634. * More information on this format are available here:
  53635. * https://en.wikipedia.org/wiki/RGBE_image_format
  53636. *
  53637. * @param uint8array The binary file stored in native array.
  53638. * @return The header information.
  53639. */
  53640. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  53641. /**
  53642. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  53643. * This RGBE texture needs to store the information as a panorama.
  53644. *
  53645. * More information on this format are available here:
  53646. * https://en.wikipedia.org/wiki/RGBE_image_format
  53647. *
  53648. * @param buffer The binary file stored in an array buffer.
  53649. * @param size The expected size of the extracted cubemap.
  53650. * @return The Cube Map information.
  53651. */
  53652. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  53653. /**
  53654. * Returns the pixels data extracted from an RGBE texture.
  53655. * This pixels will be stored left to right up to down in the R G B order in one array.
  53656. *
  53657. * More information on this format are available here:
  53658. * https://en.wikipedia.org/wiki/RGBE_image_format
  53659. *
  53660. * @param uint8array The binary file stored in an array buffer.
  53661. * @param hdrInfo The header information of the file.
  53662. * @return The pixels data in RGB right to left up to down order.
  53663. */
  53664. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  53665. private static RGBE_ReadPixels_RLE;
  53666. }
  53667. }
  53668. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  53669. import { Nullable } from "babylonjs/types";
  53670. import { Scene } from "babylonjs/scene";
  53671. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  53672. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53673. import "babylonjs/Engines/Extensions/engine.rawTexture";
  53674. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  53675. /**
  53676. * This represents a texture coming from an HDR input.
  53677. *
  53678. * The only supported format is currently panorama picture stored in RGBE format.
  53679. * Example of such files can be found on HDRLib: http://hdrlib.com/
  53680. */
  53681. export class HDRCubeTexture extends BaseTexture {
  53682. private static _facesMapping;
  53683. private _generateHarmonics;
  53684. private _noMipmap;
  53685. private _textureMatrix;
  53686. private _size;
  53687. private _onLoad;
  53688. private _onError;
  53689. /**
  53690. * The texture URL.
  53691. */
  53692. url: string;
  53693. /**
  53694. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  53695. */
  53696. coordinatesMode: number;
  53697. protected _isBlocking: boolean;
  53698. /**
  53699. * Sets wether or not the texture is blocking during loading.
  53700. */
  53701. /**
  53702. * Gets wether or not the texture is blocking during loading.
  53703. */
  53704. isBlocking: boolean;
  53705. protected _rotationY: number;
  53706. /**
  53707. * Sets texture matrix rotation angle around Y axis in radians.
  53708. */
  53709. /**
  53710. * Gets texture matrix rotation angle around Y axis radians.
  53711. */
  53712. rotationY: number;
  53713. /**
  53714. * Gets or sets the center of the bounding box associated with the cube texture
  53715. * It must define where the camera used to render the texture was set
  53716. */
  53717. boundingBoxPosition: Vector3;
  53718. private _boundingBoxSize;
  53719. /**
  53720. * Gets or sets the size of the bounding box associated with the cube texture
  53721. * When defined, the cubemap will switch to local mode
  53722. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  53723. * @example https://www.babylonjs-playground.com/#RNASML
  53724. */
  53725. boundingBoxSize: Vector3;
  53726. /**
  53727. * Instantiates an HDRTexture from the following parameters.
  53728. *
  53729. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  53730. * @param scene The scene the texture will be used in
  53731. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  53732. * @param noMipmap Forces to not generate the mipmap if true
  53733. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  53734. * @param gammaSpace Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  53735. * @param reserved Reserved flag for internal use.
  53736. */
  53737. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  53738. /**
  53739. * Get the current class name of the texture useful for serialization or dynamic coding.
  53740. * @returns "HDRCubeTexture"
  53741. */
  53742. getClassName(): string;
  53743. /**
  53744. * Occurs when the file is raw .hdr file.
  53745. */
  53746. private loadTexture;
  53747. clone(): HDRCubeTexture;
  53748. delayLoad(): void;
  53749. /**
  53750. * Get the texture reflection matrix used to rotate/transform the reflection.
  53751. * @returns the reflection matrix
  53752. */
  53753. getReflectionTextureMatrix(): Matrix;
  53754. /**
  53755. * Set the texture reflection matrix used to rotate/transform the reflection.
  53756. * @param value Define the reflection matrix to set
  53757. */
  53758. setReflectionTextureMatrix(value: Matrix): void;
  53759. /**
  53760. * Parses a JSON representation of an HDR Texture in order to create the texture
  53761. * @param parsedTexture Define the JSON representation
  53762. * @param scene Define the scene the texture should be created in
  53763. * @param rootUrl Define the root url in case we need to load relative dependencies
  53764. * @returns the newly created texture after parsing
  53765. */
  53766. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  53767. serialize(): any;
  53768. }
  53769. }
  53770. declare module "babylonjs/Physics/physicsEngine" {
  53771. import { Nullable } from "babylonjs/types";
  53772. import { Vector3 } from "babylonjs/Maths/math.vector";
  53773. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  53774. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  53775. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  53776. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53777. /**
  53778. * Class used to control physics engine
  53779. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  53780. */
  53781. export class PhysicsEngine implements IPhysicsEngine {
  53782. private _physicsPlugin;
  53783. /**
  53784. * Global value used to control the smallest number supported by the simulation
  53785. */
  53786. static Epsilon: number;
  53787. private _impostors;
  53788. private _joints;
  53789. /**
  53790. * Gets the gravity vector used by the simulation
  53791. */
  53792. gravity: Vector3;
  53793. /**
  53794. * Factory used to create the default physics plugin.
  53795. * @returns The default physics plugin
  53796. */
  53797. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  53798. /**
  53799. * Creates a new Physics Engine
  53800. * @param gravity defines the gravity vector used by the simulation
  53801. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  53802. */
  53803. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  53804. /**
  53805. * Sets the gravity vector used by the simulation
  53806. * @param gravity defines the gravity vector to use
  53807. */
  53808. setGravity(gravity: Vector3): void;
  53809. /**
  53810. * Set the time step of the physics engine.
  53811. * Default is 1/60.
  53812. * To slow it down, enter 1/600 for example.
  53813. * To speed it up, 1/30
  53814. * @param newTimeStep defines the new timestep to apply to this world.
  53815. */
  53816. setTimeStep(newTimeStep?: number): void;
  53817. /**
  53818. * Get the time step of the physics engine.
  53819. * @returns the current time step
  53820. */
  53821. getTimeStep(): number;
  53822. /**
  53823. * Release all resources
  53824. */
  53825. dispose(): void;
  53826. /**
  53827. * Gets the name of the current physics plugin
  53828. * @returns the name of the plugin
  53829. */
  53830. getPhysicsPluginName(): string;
  53831. /**
  53832. * Adding a new impostor for the impostor tracking.
  53833. * This will be done by the impostor itself.
  53834. * @param impostor the impostor to add
  53835. */
  53836. addImpostor(impostor: PhysicsImpostor): void;
  53837. /**
  53838. * Remove an impostor from the engine.
  53839. * This impostor and its mesh will not longer be updated by the physics engine.
  53840. * @param impostor the impostor to remove
  53841. */
  53842. removeImpostor(impostor: PhysicsImpostor): void;
  53843. /**
  53844. * Add a joint to the physics engine
  53845. * @param mainImpostor defines the main impostor to which the joint is added.
  53846. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  53847. * @param joint defines the joint that will connect both impostors.
  53848. */
  53849. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  53850. /**
  53851. * Removes a joint from the simulation
  53852. * @param mainImpostor defines the impostor used with the joint
  53853. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  53854. * @param joint defines the joint to remove
  53855. */
  53856. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  53857. /**
  53858. * Called by the scene. No need to call it.
  53859. * @param delta defines the timespam between frames
  53860. */
  53861. _step(delta: number): void;
  53862. /**
  53863. * Gets the current plugin used to run the simulation
  53864. * @returns current plugin
  53865. */
  53866. getPhysicsPlugin(): IPhysicsEnginePlugin;
  53867. /**
  53868. * Gets the list of physic impostors
  53869. * @returns an array of PhysicsImpostor
  53870. */
  53871. getImpostors(): Array<PhysicsImpostor>;
  53872. /**
  53873. * Gets the impostor for a physics enabled object
  53874. * @param object defines the object impersonated by the impostor
  53875. * @returns the PhysicsImpostor or null if not found
  53876. */
  53877. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  53878. /**
  53879. * Gets the impostor for a physics body object
  53880. * @param body defines physics body used by the impostor
  53881. * @returns the PhysicsImpostor or null if not found
  53882. */
  53883. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  53884. /**
  53885. * Does a raycast in the physics world
  53886. * @param from when should the ray start?
  53887. * @param to when should the ray end?
  53888. * @returns PhysicsRaycastResult
  53889. */
  53890. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  53891. }
  53892. }
  53893. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  53894. import { Nullable } from "babylonjs/types";
  53895. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  53896. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53897. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  53898. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  53899. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  53900. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53901. /** @hidden */
  53902. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  53903. private _useDeltaForWorldStep;
  53904. world: any;
  53905. name: string;
  53906. private _physicsMaterials;
  53907. private _fixedTimeStep;
  53908. private _cannonRaycastResult;
  53909. private _raycastResult;
  53910. private _physicsBodysToRemoveAfterStep;
  53911. BJSCANNON: any;
  53912. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  53913. setGravity(gravity: Vector3): void;
  53914. setTimeStep(timeStep: number): void;
  53915. getTimeStep(): number;
  53916. executeStep(delta: number): void;
  53917. private _removeMarkedPhysicsBodiesFromWorld;
  53918. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53919. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53920. generatePhysicsBody(impostor: PhysicsImpostor): void;
  53921. private _processChildMeshes;
  53922. removePhysicsBody(impostor: PhysicsImpostor): void;
  53923. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  53924. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  53925. private _addMaterial;
  53926. private _checkWithEpsilon;
  53927. private _createShape;
  53928. private _createHeightmap;
  53929. private _minus90X;
  53930. private _plus90X;
  53931. private _tmpPosition;
  53932. private _tmpDeltaPosition;
  53933. private _tmpUnityRotation;
  53934. private _updatePhysicsBodyTransformation;
  53935. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  53936. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  53937. isSupported(): boolean;
  53938. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53939. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53940. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53941. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  53942. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  53943. getBodyMass(impostor: PhysicsImpostor): number;
  53944. getBodyFriction(impostor: PhysicsImpostor): number;
  53945. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  53946. getBodyRestitution(impostor: PhysicsImpostor): number;
  53947. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  53948. sleepBody(impostor: PhysicsImpostor): void;
  53949. wakeUpBody(impostor: PhysicsImpostor): void;
  53950. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  53951. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  53952. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  53953. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  53954. getRadius(impostor: PhysicsImpostor): number;
  53955. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  53956. dispose(): void;
  53957. private _extendNamespace;
  53958. /**
  53959. * Does a raycast in the physics world
  53960. * @param from when should the ray start?
  53961. * @param to when should the ray end?
  53962. * @returns PhysicsRaycastResult
  53963. */
  53964. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  53965. }
  53966. }
  53967. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  53968. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  53969. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  53970. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  53971. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53972. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  53973. import { Nullable } from "babylonjs/types";
  53974. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53975. /** @hidden */
  53976. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  53977. world: any;
  53978. name: string;
  53979. BJSOIMO: any;
  53980. private _raycastResult;
  53981. constructor(iterations?: number, oimoInjection?: any);
  53982. setGravity(gravity: Vector3): void;
  53983. setTimeStep(timeStep: number): void;
  53984. getTimeStep(): number;
  53985. private _tmpImpostorsArray;
  53986. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  53987. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53988. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  53989. generatePhysicsBody(impostor: PhysicsImpostor): void;
  53990. private _tmpPositionVector;
  53991. removePhysicsBody(impostor: PhysicsImpostor): void;
  53992. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  53993. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  53994. isSupported(): boolean;
  53995. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  53996. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  53997. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53998. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  53999. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54000. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54001. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  54002. getBodyMass(impostor: PhysicsImpostor): number;
  54003. getBodyFriction(impostor: PhysicsImpostor): number;
  54004. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  54005. getBodyRestitution(impostor: PhysicsImpostor): number;
  54006. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  54007. sleepBody(impostor: PhysicsImpostor): void;
  54008. wakeUpBody(impostor: PhysicsImpostor): void;
  54009. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  54010. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  54011. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  54012. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  54013. getRadius(impostor: PhysicsImpostor): number;
  54014. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  54015. dispose(): void;
  54016. /**
  54017. * Does a raycast in the physics world
  54018. * @param from when should the ray start?
  54019. * @param to when should the ray end?
  54020. * @returns PhysicsRaycastResult
  54021. */
  54022. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54023. }
  54024. }
  54025. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  54026. import { Nullable } from "babylonjs/types";
  54027. import { Scene } from "babylonjs/scene";
  54028. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  54029. import { Color4 } from "babylonjs/Maths/math.color";
  54030. import { Mesh } from "babylonjs/Meshes/mesh";
  54031. /**
  54032. * Class containing static functions to help procedurally build meshes
  54033. */
  54034. export class RibbonBuilder {
  54035. /**
  54036. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  54037. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  54038. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  54039. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  54040. * * The parameter `offset` (positive integer, default : rounded half size of the pathArray length), is taken in account only if the `pathArray` is containing a single path
  54041. * * It's the offset to join the points from the same path. Ex : offset = 10 means the point 1 is joined to the point 11
  54042. * * The optional parameter `instance` is an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#ribbon
  54043. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54044. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54045. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  54046. * * The parameter `uvs` is an optional flat array of `Vector2` to update/set each ribbon vertex with its own custom UV values instead of the computed ones
  54047. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  54048. * * Note that if you use the parameters `uvs` or `colors`, the passed arrays must be populated with the right number of elements, it is to say the number of ribbon vertices. Remember that if you set `closePath` to `true`, there's one extra vertex per path in the geometry
  54049. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  54050. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54051. * @param name defines the name of the mesh
  54052. * @param options defines the options used to create the mesh
  54053. * @param scene defines the hosting scene
  54054. * @returns the ribbon mesh
  54055. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  54056. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  54057. */
  54058. static CreateRibbon(name: string, options: {
  54059. pathArray: Vector3[][];
  54060. closeArray?: boolean;
  54061. closePath?: boolean;
  54062. offset?: number;
  54063. updatable?: boolean;
  54064. sideOrientation?: number;
  54065. frontUVs?: Vector4;
  54066. backUVs?: Vector4;
  54067. instance?: Mesh;
  54068. invertUV?: boolean;
  54069. uvs?: Vector2[];
  54070. colors?: Color4[];
  54071. }, scene?: Nullable<Scene>): Mesh;
  54072. }
  54073. }
  54074. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  54075. import { Nullable } from "babylonjs/types";
  54076. import { Scene } from "babylonjs/scene";
  54077. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  54078. import { Mesh } from "babylonjs/Meshes/mesh";
  54079. /**
  54080. * Class containing static functions to help procedurally build meshes
  54081. */
  54082. export class ShapeBuilder {
  54083. /**
  54084. * Creates an extruded shape mesh. The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  54085. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis.
  54086. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  54087. * * The parameter `rotation` (float, default 0 radians) is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve.
  54088. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  54089. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  54090. * * The optional parameter `instance` is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape
  54091. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  54092. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54093. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54094. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  54095. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  54096. * @param name defines the name of the mesh
  54097. * @param options defines the options used to create the mesh
  54098. * @param scene defines the hosting scene
  54099. * @returns the extruded shape mesh
  54100. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  54101. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  54102. */
  54103. static ExtrudeShape(name: string, options: {
  54104. shape: Vector3[];
  54105. path: Vector3[];
  54106. scale?: number;
  54107. rotation?: number;
  54108. cap?: number;
  54109. updatable?: boolean;
  54110. sideOrientation?: number;
  54111. frontUVs?: Vector4;
  54112. backUVs?: Vector4;
  54113. instance?: Mesh;
  54114. invertUV?: boolean;
  54115. }, scene?: Nullable<Scene>): Mesh;
  54116. /**
  54117. * Creates an custom extruded shape mesh.
  54118. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  54119. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis.
  54120. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  54121. * * The parameter `rotationFunction` (JS function) is a custom Javascript function called on each path point. This function is passed the position i of the point in the path and the distance of this point from the begining of the path
  54122. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  54123. * * The parameter `scaleFunction` (JS function) is a custom Javascript function called on each path point. This function is passed the position i of the point in the path and the distance of this point from the begining of the path
  54124. * * It must returns a float value that will be the scale value applied to the shape on each path point
  54125. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  54126. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  54127. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  54128. * * The optional parameter `instance` is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape
  54129. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  54130. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54131. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54132. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  54133. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54134. * @param name defines the name of the mesh
  54135. * @param options defines the options used to create the mesh
  54136. * @param scene defines the hosting scene
  54137. * @returns the custom extruded shape mesh
  54138. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  54139. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  54140. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  54141. */
  54142. static ExtrudeShapeCustom(name: string, options: {
  54143. shape: Vector3[];
  54144. path: Vector3[];
  54145. scaleFunction?: any;
  54146. rotationFunction?: any;
  54147. ribbonCloseArray?: boolean;
  54148. ribbonClosePath?: boolean;
  54149. cap?: number;
  54150. updatable?: boolean;
  54151. sideOrientation?: number;
  54152. frontUVs?: Vector4;
  54153. backUVs?: Vector4;
  54154. instance?: Mesh;
  54155. invertUV?: boolean;
  54156. }, scene?: Nullable<Scene>): Mesh;
  54157. private static _ExtrudeShapeGeneric;
  54158. }
  54159. }
  54160. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  54161. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  54162. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  54163. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  54164. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  54165. import { Nullable } from "babylonjs/types";
  54166. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54167. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  54168. /**
  54169. * AmmoJS Physics plugin
  54170. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  54171. * @see https://github.com/kripken/ammo.js/
  54172. */
  54173. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  54174. private _useDeltaForWorldStep;
  54175. /**
  54176. * Reference to the Ammo library
  54177. */
  54178. bjsAMMO: any;
  54179. /**
  54180. * Created ammoJS world which physics bodies are added to
  54181. */
  54182. world: any;
  54183. /**
  54184. * Name of the plugin
  54185. */
  54186. name: string;
  54187. private _timeStep;
  54188. private _fixedTimeStep;
  54189. private _maxSteps;
  54190. private _tmpQuaternion;
  54191. private _tmpAmmoTransform;
  54192. private _tmpAmmoQuaternion;
  54193. private _tmpAmmoConcreteContactResultCallback;
  54194. private _collisionConfiguration;
  54195. private _dispatcher;
  54196. private _overlappingPairCache;
  54197. private _solver;
  54198. private _softBodySolver;
  54199. private _tmpAmmoVectorA;
  54200. private _tmpAmmoVectorB;
  54201. private _tmpAmmoVectorC;
  54202. private _tmpAmmoVectorD;
  54203. private _tmpContactCallbackResult;
  54204. private _tmpAmmoVectorRCA;
  54205. private _tmpAmmoVectorRCB;
  54206. private _raycastResult;
  54207. private static readonly DISABLE_COLLISION_FLAG;
  54208. private static readonly KINEMATIC_FLAG;
  54209. private static readonly DISABLE_DEACTIVATION_FLAG;
  54210. /**
  54211. * Initializes the ammoJS plugin
  54212. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  54213. * @param ammoInjection can be used to inject your own ammo reference
  54214. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  54215. */
  54216. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  54217. /**
  54218. * Sets the gravity of the physics world (m/(s^2))
  54219. * @param gravity Gravity to set
  54220. */
  54221. setGravity(gravity: Vector3): void;
  54222. /**
  54223. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  54224. * @param timeStep timestep to use in seconds
  54225. */
  54226. setTimeStep(timeStep: number): void;
  54227. /**
  54228. * Increment to step forward in the physics engine (If timeStep is set to 1/60 and fixedTimeStep is set to 1/120 the physics engine should run 2 steps per frame) (Default: 1/60)
  54229. * @param fixedTimeStep fixedTimeStep to use in seconds
  54230. */
  54231. setFixedTimeStep(fixedTimeStep: number): void;
  54232. /**
  54233. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  54234. * @param maxSteps the maximum number of steps by the physics engine per frame
  54235. */
  54236. setMaxSteps(maxSteps: number): void;
  54237. /**
  54238. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  54239. * @returns the current timestep in seconds
  54240. */
  54241. getTimeStep(): number;
  54242. private _isImpostorInContact;
  54243. private _isImpostorPairInContact;
  54244. private _stepSimulation;
  54245. /**
  54246. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  54247. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  54248. * After the step the babylon meshes are set to the position of the physics imposters
  54249. * @param delta amount of time to step forward
  54250. * @param impostors array of imposters to update before/after the step
  54251. */
  54252. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  54253. /**
  54254. * Update babylon mesh to match physics world object
  54255. * @param impostor imposter to match
  54256. */
  54257. private _afterSoftStep;
  54258. /**
  54259. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  54260. * @param impostor imposter to match
  54261. */
  54262. private _ropeStep;
  54263. /**
  54264. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  54265. * @param impostor imposter to match
  54266. */
  54267. private _softbodyOrClothStep;
  54268. private _tmpVector;
  54269. private _tmpMatrix;
  54270. /**
  54271. * Applies an impulse on the imposter
  54272. * @param impostor imposter to apply impulse to
  54273. * @param force amount of force to be applied to the imposter
  54274. * @param contactPoint the location to apply the impulse on the imposter
  54275. */
  54276. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54277. /**
  54278. * Applies a force on the imposter
  54279. * @param impostor imposter to apply force
  54280. * @param force amount of force to be applied to the imposter
  54281. * @param contactPoint the location to apply the force on the imposter
  54282. */
  54283. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54284. /**
  54285. * Creates a physics body using the plugin
  54286. * @param impostor the imposter to create the physics body on
  54287. */
  54288. generatePhysicsBody(impostor: PhysicsImpostor): void;
  54289. /**
  54290. * Removes the physics body from the imposter and disposes of the body's memory
  54291. * @param impostor imposter to remove the physics body from
  54292. */
  54293. removePhysicsBody(impostor: PhysicsImpostor): void;
  54294. /**
  54295. * Generates a joint
  54296. * @param impostorJoint the imposter joint to create the joint with
  54297. */
  54298. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  54299. /**
  54300. * Removes a joint
  54301. * @param impostorJoint the imposter joint to remove the joint from
  54302. */
  54303. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  54304. private _addMeshVerts;
  54305. /**
  54306. * Initialise the soft body vertices to match its object's (mesh) vertices
  54307. * Softbody vertices (nodes) are in world space and to match this
  54308. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  54309. * @param impostor to create the softbody for
  54310. */
  54311. private _softVertexData;
  54312. /**
  54313. * Create an impostor's soft body
  54314. * @param impostor to create the softbody for
  54315. */
  54316. private _createSoftbody;
  54317. /**
  54318. * Create cloth for an impostor
  54319. * @param impostor to create the softbody for
  54320. */
  54321. private _createCloth;
  54322. /**
  54323. * Create rope for an impostor
  54324. * @param impostor to create the softbody for
  54325. */
  54326. private _createRope;
  54327. private _addHullVerts;
  54328. private _createShape;
  54329. /**
  54330. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  54331. * @param impostor imposter containing the physics body and babylon object
  54332. */
  54333. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  54334. /**
  54335. * Sets the babylon object's position/rotation from the physics body's position/rotation
  54336. * @param impostor imposter containing the physics body and babylon object
  54337. * @param newPosition new position
  54338. * @param newRotation new rotation
  54339. */
  54340. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  54341. /**
  54342. * If this plugin is supported
  54343. * @returns true if its supported
  54344. */
  54345. isSupported(): boolean;
  54346. /**
  54347. * Sets the linear velocity of the physics body
  54348. * @param impostor imposter to set the velocity on
  54349. * @param velocity velocity to set
  54350. */
  54351. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54352. /**
  54353. * Sets the angular velocity of the physics body
  54354. * @param impostor imposter to set the velocity on
  54355. * @param velocity velocity to set
  54356. */
  54357. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54358. /**
  54359. * gets the linear velocity
  54360. * @param impostor imposter to get linear velocity from
  54361. * @returns linear velocity
  54362. */
  54363. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54364. /**
  54365. * gets the angular velocity
  54366. * @param impostor imposter to get angular velocity from
  54367. * @returns angular velocity
  54368. */
  54369. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54370. /**
  54371. * Sets the mass of physics body
  54372. * @param impostor imposter to set the mass on
  54373. * @param mass mass to set
  54374. */
  54375. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  54376. /**
  54377. * Gets the mass of the physics body
  54378. * @param impostor imposter to get the mass from
  54379. * @returns mass
  54380. */
  54381. getBodyMass(impostor: PhysicsImpostor): number;
  54382. /**
  54383. * Gets friction of the impostor
  54384. * @param impostor impostor to get friction from
  54385. * @returns friction value
  54386. */
  54387. getBodyFriction(impostor: PhysicsImpostor): number;
  54388. /**
  54389. * Sets friction of the impostor
  54390. * @param impostor impostor to set friction on
  54391. * @param friction friction value
  54392. */
  54393. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  54394. /**
  54395. * Gets restitution of the impostor
  54396. * @param impostor impostor to get restitution from
  54397. * @returns restitution value
  54398. */
  54399. getBodyRestitution(impostor: PhysicsImpostor): number;
  54400. /**
  54401. * Sets resitution of the impostor
  54402. * @param impostor impostor to set resitution on
  54403. * @param restitution resitution value
  54404. */
  54405. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  54406. /**
  54407. * Gets pressure inside the impostor
  54408. * @param impostor impostor to get pressure from
  54409. * @returns pressure value
  54410. */
  54411. getBodyPressure(impostor: PhysicsImpostor): number;
  54412. /**
  54413. * Sets pressure inside a soft body impostor
  54414. * Cloth and rope must remain 0 pressure
  54415. * @param impostor impostor to set pressure on
  54416. * @param pressure pressure value
  54417. */
  54418. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  54419. /**
  54420. * Gets stiffness of the impostor
  54421. * @param impostor impostor to get stiffness from
  54422. * @returns pressure value
  54423. */
  54424. getBodyStiffness(impostor: PhysicsImpostor): number;
  54425. /**
  54426. * Sets stiffness of the impostor
  54427. * @param impostor impostor to set stiffness on
  54428. * @param stiffness stiffness value from 0 to 1
  54429. */
  54430. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  54431. /**
  54432. * Gets velocityIterations of the impostor
  54433. * @param impostor impostor to get velocity iterations from
  54434. * @returns velocityIterations value
  54435. */
  54436. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  54437. /**
  54438. * Sets velocityIterations of the impostor
  54439. * @param impostor impostor to set velocity iterations on
  54440. * @param velocityIterations velocityIterations value
  54441. */
  54442. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  54443. /**
  54444. * Gets positionIterations of the impostor
  54445. * @param impostor impostor to get position iterations from
  54446. * @returns positionIterations value
  54447. */
  54448. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  54449. /**
  54450. * Sets positionIterations of the impostor
  54451. * @param impostor impostor to set position on
  54452. * @param positionIterations positionIterations value
  54453. */
  54454. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  54455. /**
  54456. * Append an anchor to a cloth object
  54457. * @param impostor is the cloth impostor to add anchor to
  54458. * @param otherImpostor is the rigid impostor to anchor to
  54459. * @param width ratio across width from 0 to 1
  54460. * @param height ratio up height from 0 to 1
  54461. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  54462. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  54463. */
  54464. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  54465. /**
  54466. * Append an hook to a rope object
  54467. * @param impostor is the rope impostor to add hook to
  54468. * @param otherImpostor is the rigid impostor to hook to
  54469. * @param length ratio along the rope from 0 to 1
  54470. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  54471. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  54472. */
  54473. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  54474. /**
  54475. * Sleeps the physics body and stops it from being active
  54476. * @param impostor impostor to sleep
  54477. */
  54478. sleepBody(impostor: PhysicsImpostor): void;
  54479. /**
  54480. * Activates the physics body
  54481. * @param impostor impostor to activate
  54482. */
  54483. wakeUpBody(impostor: PhysicsImpostor): void;
  54484. /**
  54485. * Updates the distance parameters of the joint
  54486. * @param joint joint to update
  54487. * @param maxDistance maximum distance of the joint
  54488. * @param minDistance minimum distance of the joint
  54489. */
  54490. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  54491. /**
  54492. * Sets a motor on the joint
  54493. * @param joint joint to set motor on
  54494. * @param speed speed of the motor
  54495. * @param maxForce maximum force of the motor
  54496. * @param motorIndex index of the motor
  54497. */
  54498. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  54499. /**
  54500. * Sets the motors limit
  54501. * @param joint joint to set limit on
  54502. * @param upperLimit upper limit
  54503. * @param lowerLimit lower limit
  54504. */
  54505. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  54506. /**
  54507. * Syncs the position and rotation of a mesh with the impostor
  54508. * @param mesh mesh to sync
  54509. * @param impostor impostor to update the mesh with
  54510. */
  54511. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  54512. /**
  54513. * Gets the radius of the impostor
  54514. * @param impostor impostor to get radius from
  54515. * @returns the radius
  54516. */
  54517. getRadius(impostor: PhysicsImpostor): number;
  54518. /**
  54519. * Gets the box size of the impostor
  54520. * @param impostor impostor to get box size from
  54521. * @param result the resulting box size
  54522. */
  54523. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  54524. /**
  54525. * Disposes of the impostor
  54526. */
  54527. dispose(): void;
  54528. /**
  54529. * Does a raycast in the physics world
  54530. * @param from when should the ray start?
  54531. * @param to when should the ray end?
  54532. * @returns PhysicsRaycastResult
  54533. */
  54534. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54535. }
  54536. }
  54537. declare module "babylonjs/Probes/reflectionProbe" {
  54538. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  54539. import { Vector3 } from "babylonjs/Maths/math.vector";
  54540. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54541. import { Nullable } from "babylonjs/types";
  54542. import { Scene } from "babylonjs/scene";
  54543. module "babylonjs/abstractScene" {
  54544. interface AbstractScene {
  54545. /**
  54546. * The list of reflection probes added to the scene
  54547. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  54548. */
  54549. reflectionProbes: Array<ReflectionProbe>;
  54550. /**
  54551. * Removes the given reflection probe from this scene.
  54552. * @param toRemove The reflection probe to remove
  54553. * @returns The index of the removed reflection probe
  54554. */
  54555. removeReflectionProbe(toRemove: ReflectionProbe): number;
  54556. /**
  54557. * Adds the given reflection probe to this scene.
  54558. * @param newReflectionProbe The reflection probe to add
  54559. */
  54560. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  54561. }
  54562. }
  54563. /**
  54564. * Class used to generate realtime reflection / refraction cube textures
  54565. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  54566. */
  54567. export class ReflectionProbe {
  54568. /** defines the name of the probe */
  54569. name: string;
  54570. private _scene;
  54571. private _renderTargetTexture;
  54572. private _projectionMatrix;
  54573. private _viewMatrix;
  54574. private _target;
  54575. private _add;
  54576. private _attachedMesh;
  54577. private _invertYAxis;
  54578. /** Gets or sets probe position (center of the cube map) */
  54579. position: Vector3;
  54580. /**
  54581. * Creates a new reflection probe
  54582. * @param name defines the name of the probe
  54583. * @param size defines the texture resolution (for each face)
  54584. * @param scene defines the hosting scene
  54585. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  54586. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  54587. */
  54588. constructor(
  54589. /** defines the name of the probe */
  54590. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  54591. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  54592. samples: number;
  54593. /** Gets or sets the refresh rate to use (on every frame by default) */
  54594. refreshRate: number;
  54595. /**
  54596. * Gets the hosting scene
  54597. * @returns a Scene
  54598. */
  54599. getScene(): Scene;
  54600. /** Gets the internal CubeTexture used to render to */
  54601. readonly cubeTexture: RenderTargetTexture;
  54602. /** Gets the list of meshes to render */
  54603. readonly renderList: Nullable<AbstractMesh[]>;
  54604. /**
  54605. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  54606. * @param mesh defines the mesh to attach to
  54607. */
  54608. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  54609. /**
  54610. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  54611. * @param renderingGroupId The rendering group id corresponding to its index
  54612. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  54613. */
  54614. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  54615. /**
  54616. * Clean all associated resources
  54617. */
  54618. dispose(): void;
  54619. /**
  54620. * Converts the reflection probe information to a readable string for debug purpose.
  54621. * @param fullDetails Supports for multiple levels of logging within scene loading
  54622. * @returns the human readable reflection probe info
  54623. */
  54624. toString(fullDetails?: boolean): string;
  54625. /**
  54626. * Get the class name of the relfection probe.
  54627. * @returns "ReflectionProbe"
  54628. */
  54629. getClassName(): string;
  54630. /**
  54631. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  54632. * @returns The JSON representation of the texture
  54633. */
  54634. serialize(): any;
  54635. /**
  54636. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  54637. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  54638. * @param scene Define the scene the parsed reflection probe should be instantiated in
  54639. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  54640. * @returns The parsed reflection probe if successful
  54641. */
  54642. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  54643. }
  54644. }
  54645. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  54646. /** @hidden */
  54647. export var _BabylonLoaderRegistered: boolean;
  54648. /**
  54649. * Helps setting up some configuration for the babylon file loader.
  54650. */
  54651. export class BabylonFileLoaderConfiguration {
  54652. /**
  54653. * The loader does not allow injecting custom physix engine into the plugins.
  54654. * Unfortunately in ES6, we need to manually inject them into the plugin.
  54655. * So you could set this variable to your engine import to make it work.
  54656. */
  54657. static LoaderInjectedPhysicsEngine: any;
  54658. }
  54659. }
  54660. declare module "babylonjs/Loading/Plugins/index" {
  54661. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  54662. }
  54663. declare module "babylonjs/Loading/index" {
  54664. export * from "babylonjs/Loading/loadingScreen";
  54665. export * from "babylonjs/Loading/Plugins/index";
  54666. export * from "babylonjs/Loading/sceneLoader";
  54667. export * from "babylonjs/Loading/sceneLoaderFlags";
  54668. }
  54669. declare module "babylonjs/Materials/Background/index" {
  54670. export * from "babylonjs/Materials/Background/backgroundMaterial";
  54671. }
  54672. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  54673. import { Scene } from "babylonjs/scene";
  54674. import { Color3 } from "babylonjs/Maths/math.color";
  54675. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  54676. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54677. /**
  54678. * The Physically based simple base material of BJS.
  54679. *
  54680. * This enables better naming and convention enforcements on top of the pbrMaterial.
  54681. * It is used as the base class for both the specGloss and metalRough conventions.
  54682. */
  54683. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  54684. /**
  54685. * Number of Simultaneous lights allowed on the material.
  54686. */
  54687. maxSimultaneousLights: number;
  54688. /**
  54689. * If sets to true, disables all the lights affecting the material.
  54690. */
  54691. disableLighting: boolean;
  54692. /**
  54693. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  54694. */
  54695. environmentTexture: BaseTexture;
  54696. /**
  54697. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  54698. */
  54699. invertNormalMapX: boolean;
  54700. /**
  54701. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  54702. */
  54703. invertNormalMapY: boolean;
  54704. /**
  54705. * Normal map used in the model.
  54706. */
  54707. normalTexture: BaseTexture;
  54708. /**
  54709. * Emissivie color used to self-illuminate the model.
  54710. */
  54711. emissiveColor: Color3;
  54712. /**
  54713. * Emissivie texture used to self-illuminate the model.
  54714. */
  54715. emissiveTexture: BaseTexture;
  54716. /**
  54717. * Occlusion Channel Strenght.
  54718. */
  54719. occlusionStrength: number;
  54720. /**
  54721. * Occlusion Texture of the material (adding extra occlusion effects).
  54722. */
  54723. occlusionTexture: BaseTexture;
  54724. /**
  54725. * Defines the alpha limits in alpha test mode.
  54726. */
  54727. alphaCutOff: number;
  54728. /**
  54729. * Gets the current double sided mode.
  54730. */
  54731. /**
  54732. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  54733. */
  54734. doubleSided: boolean;
  54735. /**
  54736. * Stores the pre-calculated light information of a mesh in a texture.
  54737. */
  54738. lightmapTexture: BaseTexture;
  54739. /**
  54740. * If true, the light map contains occlusion information instead of lighting info.
  54741. */
  54742. useLightmapAsShadowmap: boolean;
  54743. /**
  54744. * Instantiates a new PBRMaterial instance.
  54745. *
  54746. * @param name The material name
  54747. * @param scene The scene the material will be use in.
  54748. */
  54749. constructor(name: string, scene: Scene);
  54750. getClassName(): string;
  54751. }
  54752. }
  54753. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  54754. import { Scene } from "babylonjs/scene";
  54755. import { Color3 } from "babylonjs/Maths/math.color";
  54756. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54757. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54758. /**
  54759. * The PBR material of BJS following the metal roughness convention.
  54760. *
  54761. * This fits to the PBR convention in the GLTF definition:
  54762. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  54763. */
  54764. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  54765. /**
  54766. * The base color has two different interpretations depending on the value of metalness.
  54767. * When the material is a metal, the base color is the specific measured reflectance value
  54768. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  54769. * of the material.
  54770. */
  54771. baseColor: Color3;
  54772. /**
  54773. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  54774. * well as opacity information in the alpha channel.
  54775. */
  54776. baseTexture: BaseTexture;
  54777. /**
  54778. * Specifies the metallic scalar value of the material.
  54779. * Can also be used to scale the metalness values of the metallic texture.
  54780. */
  54781. metallic: number;
  54782. /**
  54783. * Specifies the roughness scalar value of the material.
  54784. * Can also be used to scale the roughness values of the metallic texture.
  54785. */
  54786. roughness: number;
  54787. /**
  54788. * Texture containing both the metallic value in the B channel and the
  54789. * roughness value in the G channel to keep better precision.
  54790. */
  54791. metallicRoughnessTexture: BaseTexture;
  54792. /**
  54793. * Instantiates a new PBRMetalRoughnessMaterial instance.
  54794. *
  54795. * @param name The material name
  54796. * @param scene The scene the material will be use in.
  54797. */
  54798. constructor(name: string, scene: Scene);
  54799. /**
  54800. * Return the currrent class name of the material.
  54801. */
  54802. getClassName(): string;
  54803. /**
  54804. * Makes a duplicate of the current material.
  54805. * @param name - name to use for the new material.
  54806. */
  54807. clone(name: string): PBRMetallicRoughnessMaterial;
  54808. /**
  54809. * Serialize the material to a parsable JSON object.
  54810. */
  54811. serialize(): any;
  54812. /**
  54813. * Parses a JSON object correponding to the serialize function.
  54814. */
  54815. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  54816. }
  54817. }
  54818. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  54819. import { Scene } from "babylonjs/scene";
  54820. import { Color3 } from "babylonjs/Maths/math.color";
  54821. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54822. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54823. /**
  54824. * The PBR material of BJS following the specular glossiness convention.
  54825. *
  54826. * This fits to the PBR convention in the GLTF definition:
  54827. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  54828. */
  54829. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  54830. /**
  54831. * Specifies the diffuse color of the material.
  54832. */
  54833. diffuseColor: Color3;
  54834. /**
  54835. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  54836. * channel.
  54837. */
  54838. diffuseTexture: BaseTexture;
  54839. /**
  54840. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  54841. */
  54842. specularColor: Color3;
  54843. /**
  54844. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  54845. */
  54846. glossiness: number;
  54847. /**
  54848. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  54849. */
  54850. specularGlossinessTexture: BaseTexture;
  54851. /**
  54852. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  54853. *
  54854. * @param name The material name
  54855. * @param scene The scene the material will be use in.
  54856. */
  54857. constructor(name: string, scene: Scene);
  54858. /**
  54859. * Return the currrent class name of the material.
  54860. */
  54861. getClassName(): string;
  54862. /**
  54863. * Makes a duplicate of the current material.
  54864. * @param name - name to use for the new material.
  54865. */
  54866. clone(name: string): PBRSpecularGlossinessMaterial;
  54867. /**
  54868. * Serialize the material to a parsable JSON object.
  54869. */
  54870. serialize(): any;
  54871. /**
  54872. * Parses a JSON object correponding to the serialize function.
  54873. */
  54874. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  54875. }
  54876. }
  54877. declare module "babylonjs/Materials/PBR/index" {
  54878. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  54879. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54880. export * from "babylonjs/Materials/PBR/pbrMaterial";
  54881. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  54882. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  54883. }
  54884. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  54885. import { Nullable } from "babylonjs/types";
  54886. import { Scene } from "babylonjs/scene";
  54887. import { Matrix } from "babylonjs/Maths/math.vector";
  54888. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54889. /**
  54890. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  54891. * It can help converting any input color in a desired output one. This can then be used to create effects
  54892. * from sepia, black and white to sixties or futuristic rendering...
  54893. *
  54894. * The only supported format is currently 3dl.
  54895. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  54896. */
  54897. export class ColorGradingTexture extends BaseTexture {
  54898. /**
  54899. * The current texture matrix. (will always be identity in color grading texture)
  54900. */
  54901. private _textureMatrix;
  54902. /**
  54903. * The texture URL.
  54904. */
  54905. url: string;
  54906. /**
  54907. * Empty line regex stored for GC.
  54908. */
  54909. private static _noneEmptyLineRegex;
  54910. private _engine;
  54911. /**
  54912. * Instantiates a ColorGradingTexture from the following parameters.
  54913. *
  54914. * @param url The location of the color gradind data (currently only supporting 3dl)
  54915. * @param scene The scene the texture will be used in
  54916. */
  54917. constructor(url: string, scene: Scene);
  54918. /**
  54919. * Returns the texture matrix used in most of the material.
  54920. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  54921. */
  54922. getTextureMatrix(): Matrix;
  54923. /**
  54924. * Occurs when the file being loaded is a .3dl LUT file.
  54925. */
  54926. private load3dlTexture;
  54927. /**
  54928. * Starts the loading process of the texture.
  54929. */
  54930. private loadTexture;
  54931. /**
  54932. * Clones the color gradind texture.
  54933. */
  54934. clone(): ColorGradingTexture;
  54935. /**
  54936. * Called during delayed load for textures.
  54937. */
  54938. delayLoad(): void;
  54939. /**
  54940. * Parses a color grading texture serialized by Babylon.
  54941. * @param parsedTexture The texture information being parsedTexture
  54942. * @param scene The scene to load the texture in
  54943. * @param rootUrl The root url of the data assets to load
  54944. * @return A color gradind texture
  54945. */
  54946. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  54947. /**
  54948. * Serializes the LUT texture to json format.
  54949. */
  54950. serialize(): any;
  54951. }
  54952. }
  54953. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  54954. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54955. import { Scene } from "babylonjs/scene";
  54956. import { Nullable } from "babylonjs/types";
  54957. import "babylonjs/Engines/Extensions/engine.rawTexture";
  54958. /**
  54959. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  54960. */
  54961. export class EquiRectangularCubeTexture extends BaseTexture {
  54962. /** The six faces of the cube. */
  54963. private static _FacesMapping;
  54964. private _noMipmap;
  54965. private _onLoad;
  54966. private _onError;
  54967. /** The size of the cubemap. */
  54968. private _size;
  54969. /** The buffer of the image. */
  54970. private _buffer;
  54971. /** The width of the input image. */
  54972. private _width;
  54973. /** The height of the input image. */
  54974. private _height;
  54975. /** The URL to the image. */
  54976. url: string;
  54977. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  54978. coordinatesMode: number;
  54979. /**
  54980. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  54981. * @param url The location of the image
  54982. * @param scene The scene the texture will be used in
  54983. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  54984. * @param noMipmap Forces to not generate the mipmap if true
  54985. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  54986. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  54987. * @param onLoad — defines a callback called when texture is loaded
  54988. * @param onError — defines a callback called if there is an error
  54989. */
  54990. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  54991. /**
  54992. * Load the image data, by putting the image on a canvas and extracting its buffer.
  54993. */
  54994. private loadImage;
  54995. /**
  54996. * Convert the image buffer into a cubemap and create a CubeTexture.
  54997. */
  54998. private loadTexture;
  54999. /**
  55000. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  55001. * @param buffer The ArrayBuffer that should be converted.
  55002. * @returns The buffer as Float32Array.
  55003. */
  55004. private getFloat32ArrayFromArrayBuffer;
  55005. /**
  55006. * Get the current class name of the texture useful for serialization or dynamic coding.
  55007. * @returns "EquiRectangularCubeTexture"
  55008. */
  55009. getClassName(): string;
  55010. /**
  55011. * Create a clone of the current EquiRectangularCubeTexture and return it.
  55012. * @returns A clone of the current EquiRectangularCubeTexture.
  55013. */
  55014. clone(): EquiRectangularCubeTexture;
  55015. }
  55016. }
  55017. declare module "babylonjs/Misc/tga" {
  55018. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55019. /**
  55020. * Based on jsTGALoader - Javascript loader for TGA file
  55021. * By Vincent Thibault
  55022. * @see http://blog.robrowser.com/javascript-tga-loader.html
  55023. */
  55024. export class TGATools {
  55025. private static _TYPE_INDEXED;
  55026. private static _TYPE_RGB;
  55027. private static _TYPE_GREY;
  55028. private static _TYPE_RLE_INDEXED;
  55029. private static _TYPE_RLE_RGB;
  55030. private static _TYPE_RLE_GREY;
  55031. private static _ORIGIN_MASK;
  55032. private static _ORIGIN_SHIFT;
  55033. private static _ORIGIN_BL;
  55034. private static _ORIGIN_BR;
  55035. private static _ORIGIN_UL;
  55036. private static _ORIGIN_UR;
  55037. /**
  55038. * Gets the header of a TGA file
  55039. * @param data defines the TGA data
  55040. * @returns the header
  55041. */
  55042. static GetTGAHeader(data: Uint8Array): any;
  55043. /**
  55044. * Uploads TGA content to a Babylon Texture
  55045. * @hidden
  55046. */
  55047. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  55048. /** @hidden */
  55049. static _getImageData8bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  55050. /** @hidden */
  55051. static _getImageData16bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  55052. /** @hidden */
  55053. static _getImageData24bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  55054. /** @hidden */
  55055. static _getImageData32bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  55056. /** @hidden */
  55057. static _getImageDataGrey8bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  55058. /** @hidden */
  55059. static _getImageDataGrey16bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  55060. }
  55061. }
  55062. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  55063. import { Nullable } from "babylonjs/types";
  55064. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55065. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  55066. /**
  55067. * Implementation of the TGA Texture Loader.
  55068. * @hidden
  55069. */
  55070. export class _TGATextureLoader implements IInternalTextureLoader {
  55071. /**
  55072. * Defines wether the loader supports cascade loading the different faces.
  55073. */
  55074. readonly supportCascades: boolean;
  55075. /**
  55076. * This returns if the loader support the current file information.
  55077. * @param extension defines the file extension of the file being loaded
  55078. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55079. * @param fallback defines the fallback internal texture if any
  55080. * @param isBase64 defines whether the texture is encoded as a base64
  55081. * @param isBuffer defines whether the texture data are stored as a buffer
  55082. * @returns true if the loader can load the specified file
  55083. */
  55084. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  55085. /**
  55086. * Transform the url before loading if required.
  55087. * @param rootUrl the url of the texture
  55088. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55089. * @returns the transformed texture
  55090. */
  55091. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  55092. /**
  55093. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  55094. * @param rootUrl the url of the texture
  55095. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55096. * @returns the fallback texture
  55097. */
  55098. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  55099. /**
  55100. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  55101. * @param data contains the texture data
  55102. * @param texture defines the BabylonJS internal texture
  55103. * @param createPolynomials will be true if polynomials have been requested
  55104. * @param onLoad defines the callback to trigger once the texture is ready
  55105. * @param onError defines the callback to trigger in case of error
  55106. */
  55107. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  55108. /**
  55109. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  55110. * @param data contains the texture data
  55111. * @param texture defines the BabylonJS internal texture
  55112. * @param callback defines the method to call once ready to upload
  55113. */
  55114. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  55115. }
  55116. }
  55117. declare module "babylonjs/Misc/basis" {
  55118. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55119. /**
  55120. * Info about the .basis files
  55121. */
  55122. class BasisFileInfo {
  55123. /**
  55124. * If the file has alpha
  55125. */
  55126. hasAlpha: boolean;
  55127. /**
  55128. * Info about each image of the basis file
  55129. */
  55130. images: Array<{
  55131. levels: Array<{
  55132. width: number;
  55133. height: number;
  55134. transcodedPixels: ArrayBufferView;
  55135. }>;
  55136. }>;
  55137. }
  55138. /**
  55139. * Result of transcoding a basis file
  55140. */
  55141. class TranscodeResult {
  55142. /**
  55143. * Info about the .basis file
  55144. */
  55145. fileInfo: BasisFileInfo;
  55146. /**
  55147. * Format to use when loading the file
  55148. */
  55149. format: number;
  55150. }
  55151. /**
  55152. * Configuration options for the Basis transcoder
  55153. */
  55154. export class BasisTranscodeConfiguration {
  55155. /**
  55156. * Supported compression formats used to determine the supported output format of the transcoder
  55157. */
  55158. supportedCompressionFormats?: {
  55159. /**
  55160. * etc1 compression format
  55161. */
  55162. etc1?: boolean;
  55163. /**
  55164. * s3tc compression format
  55165. */
  55166. s3tc?: boolean;
  55167. /**
  55168. * pvrtc compression format
  55169. */
  55170. pvrtc?: boolean;
  55171. /**
  55172. * etc2 compression format
  55173. */
  55174. etc2?: boolean;
  55175. };
  55176. /**
  55177. * If mipmap levels should be loaded for transcoded images (Default: true)
  55178. */
  55179. loadMipmapLevels?: boolean;
  55180. /**
  55181. * Index of a single image to load (Default: all images)
  55182. */
  55183. loadSingleImage?: number;
  55184. }
  55185. /**
  55186. * Used to load .Basis files
  55187. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  55188. */
  55189. export class BasisTools {
  55190. private static _IgnoreSupportedFormats;
  55191. /**
  55192. * URL to use when loading the basis transcoder
  55193. */
  55194. static JSModuleURL: string;
  55195. /**
  55196. * URL to use when loading the wasm module for the transcoder
  55197. */
  55198. static WasmModuleURL: string;
  55199. /**
  55200. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  55201. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  55202. * @returns internal format corresponding to the Basis format
  55203. */
  55204. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  55205. private static _WorkerPromise;
  55206. private static _Worker;
  55207. private static _actionId;
  55208. private static _CreateWorkerAsync;
  55209. /**
  55210. * Transcodes a loaded image file to compressed pixel data
  55211. * @param imageData image data to transcode
  55212. * @param config configuration options for the transcoding
  55213. * @returns a promise resulting in the transcoded image
  55214. */
  55215. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  55216. /**
  55217. * Loads a texture from the transcode result
  55218. * @param texture texture load to
  55219. * @param transcodeResult the result of transcoding the basis file to load from
  55220. */
  55221. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  55222. }
  55223. }
  55224. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  55225. import { Nullable } from "babylonjs/types";
  55226. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55227. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  55228. /**
  55229. * Loader for .basis file format
  55230. */
  55231. export class _BasisTextureLoader implements IInternalTextureLoader {
  55232. /**
  55233. * Defines whether the loader supports cascade loading the different faces.
  55234. */
  55235. readonly supportCascades: boolean;
  55236. /**
  55237. * This returns if the loader support the current file information.
  55238. * @param extension defines the file extension of the file being loaded
  55239. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55240. * @param fallback defines the fallback internal texture if any
  55241. * @param isBase64 defines whether the texture is encoded as a base64
  55242. * @param isBuffer defines whether the texture data are stored as a buffer
  55243. * @returns true if the loader can load the specified file
  55244. */
  55245. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  55246. /**
  55247. * Transform the url before loading if required.
  55248. * @param rootUrl the url of the texture
  55249. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55250. * @returns the transformed texture
  55251. */
  55252. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  55253. /**
  55254. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  55255. * @param rootUrl the url of the texture
  55256. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55257. * @returns the fallback texture
  55258. */
  55259. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  55260. /**
  55261. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  55262. * @param data contains the texture data
  55263. * @param texture defines the BabylonJS internal texture
  55264. * @param createPolynomials will be true if polynomials have been requested
  55265. * @param onLoad defines the callback to trigger once the texture is ready
  55266. * @param onError defines the callback to trigger in case of error
  55267. */
  55268. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  55269. /**
  55270. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  55271. * @param data contains the texture data
  55272. * @param texture defines the BabylonJS internal texture
  55273. * @param callback defines the method to call once ready to upload
  55274. */
  55275. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  55276. }
  55277. }
  55278. declare module "babylonjs/Materials/Textures/Loaders/index" {
  55279. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  55280. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  55281. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  55282. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  55283. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  55284. }
  55285. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  55286. import { Scene } from "babylonjs/scene";
  55287. import { Texture } from "babylonjs/Materials/Textures/texture";
  55288. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55289. /**
  55290. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  55291. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  55292. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  55293. */
  55294. export class CustomProceduralTexture extends ProceduralTexture {
  55295. private _animate;
  55296. private _time;
  55297. private _config;
  55298. private _texturePath;
  55299. /**
  55300. * Instantiates a new Custom Procedural Texture.
  55301. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  55302. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  55303. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  55304. * @param name Define the name of the texture
  55305. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  55306. * @param size Define the size of the texture to create
  55307. * @param scene Define the scene the texture belongs to
  55308. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  55309. * @param generateMipMaps Define if the texture should creates mip maps or not
  55310. */
  55311. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  55312. private _loadJson;
  55313. /**
  55314. * Is the texture ready to be used ? (rendered at least once)
  55315. * @returns true if ready, otherwise, false.
  55316. */
  55317. isReady(): boolean;
  55318. /**
  55319. * Render the texture to its associated render target.
  55320. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  55321. */
  55322. render(useCameraPostProcess?: boolean): void;
  55323. /**
  55324. * Update the list of dependant textures samplers in the shader.
  55325. */
  55326. updateTextures(): void;
  55327. /**
  55328. * Update the uniform values of the procedural texture in the shader.
  55329. */
  55330. updateShaderUniforms(): void;
  55331. /**
  55332. * Define if the texture animates or not.
  55333. */
  55334. animate: boolean;
  55335. }
  55336. }
  55337. declare module "babylonjs/Shaders/noise.fragment" {
  55338. /** @hidden */
  55339. export var noisePixelShader: {
  55340. name: string;
  55341. shader: string;
  55342. };
  55343. }
  55344. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  55345. import { Nullable } from "babylonjs/types";
  55346. import { Scene } from "babylonjs/scene";
  55347. import { Texture } from "babylonjs/Materials/Textures/texture";
  55348. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55349. import "babylonjs/Shaders/noise.fragment";
  55350. /**
  55351. * Class used to generate noise procedural textures
  55352. */
  55353. export class NoiseProceduralTexture extends ProceduralTexture {
  55354. private _time;
  55355. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  55356. brightness: number;
  55357. /** Defines the number of octaves to process */
  55358. octaves: number;
  55359. /** Defines the level of persistence (0.8 by default) */
  55360. persistence: number;
  55361. /** Gets or sets animation speed factor (default is 1) */
  55362. animationSpeedFactor: number;
  55363. /**
  55364. * Creates a new NoiseProceduralTexture
  55365. * @param name defines the name fo the texture
  55366. * @param size defines the size of the texture (default is 256)
  55367. * @param scene defines the hosting scene
  55368. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  55369. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  55370. */
  55371. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  55372. private _updateShaderUniforms;
  55373. protected _getDefines(): string;
  55374. /** Generate the current state of the procedural texture */
  55375. render(useCameraPostProcess?: boolean): void;
  55376. /**
  55377. * Serializes this noise procedural texture
  55378. * @returns a serialized noise procedural texture object
  55379. */
  55380. serialize(): any;
  55381. /**
  55382. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  55383. * @param parsedTexture defines parsed texture data
  55384. * @param scene defines the current scene
  55385. * @param rootUrl defines the root URL containing noise procedural texture information
  55386. * @returns a parsed NoiseProceduralTexture
  55387. */
  55388. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  55389. }
  55390. }
  55391. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  55392. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  55393. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  55394. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55395. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  55396. }
  55397. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  55398. import { Nullable } from "babylonjs/types";
  55399. import { Scene } from "babylonjs/scene";
  55400. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  55401. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55402. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  55403. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55404. /**
  55405. * Raw cube texture where the raw buffers are passed in
  55406. */
  55407. export class RawCubeTexture extends CubeTexture {
  55408. /**
  55409. * Creates a cube texture where the raw buffers are passed in.
  55410. * @param scene defines the scene the texture is attached to
  55411. * @param data defines the array of data to use to create each face
  55412. * @param size defines the size of the textures
  55413. * @param format defines the format of the data
  55414. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  55415. * @param generateMipMaps defines if the engine should generate the mip levels
  55416. * @param invertY defines if data must be stored with Y axis inverted
  55417. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  55418. * @param compression defines the compression used (null by default)
  55419. */
  55420. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  55421. /**
  55422. * Updates the raw cube texture.
  55423. * @param data defines the data to store
  55424. * @param format defines the data format
  55425. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  55426. * @param invertY defines if data must be stored with Y axis inverted
  55427. * @param compression defines the compression used (null by default)
  55428. * @param level defines which level of the texture to update
  55429. */
  55430. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  55431. /**
  55432. * Updates a raw cube texture with RGBD encoded data.
  55433. * @param data defines the array of data [mipmap][face] to use to create each face
  55434. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  55435. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  55436. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  55437. * @returns a promsie that resolves when the operation is complete
  55438. */
  55439. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  55440. /**
  55441. * Clones the raw cube texture.
  55442. * @return a new cube texture
  55443. */
  55444. clone(): CubeTexture;
  55445. /** @hidden */
  55446. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  55447. }
  55448. }
  55449. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  55450. import { Scene } from "babylonjs/scene";
  55451. import { Texture } from "babylonjs/Materials/Textures/texture";
  55452. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55453. /**
  55454. * Class used to store 3D textures containing user data
  55455. */
  55456. export class RawTexture3D extends Texture {
  55457. /** Gets or sets the texture format to use */
  55458. format: number;
  55459. private _engine;
  55460. /**
  55461. * Create a new RawTexture3D
  55462. * @param data defines the data of the texture
  55463. * @param width defines the width of the texture
  55464. * @param height defines the height of the texture
  55465. * @param depth defines the depth of the texture
  55466. * @param format defines the texture format to use
  55467. * @param scene defines the hosting scene
  55468. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  55469. * @param invertY defines if texture must be stored with Y axis inverted
  55470. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  55471. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  55472. */
  55473. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  55474. /** Gets or sets the texture format to use */
  55475. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  55476. /**
  55477. * Update the texture with new data
  55478. * @param data defines the data to store in the texture
  55479. */
  55480. update(data: ArrayBufferView): void;
  55481. }
  55482. }
  55483. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  55484. import { Scene } from "babylonjs/scene";
  55485. import { Texture } from "babylonjs/Materials/Textures/texture";
  55486. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55487. /**
  55488. * Class used to store 2D array textures containing user data
  55489. */
  55490. export class RawTexture2DArray extends Texture {
  55491. /** Gets or sets the texture format to use */
  55492. format: number;
  55493. private _engine;
  55494. /**
  55495. * Create a new RawTexture2DArray
  55496. * @param data defines the data of the texture
  55497. * @param width defines the width of the texture
  55498. * @param height defines the height of the texture
  55499. * @param depth defines the number of layers of the texture
  55500. * @param format defines the texture format to use
  55501. * @param scene defines the hosting scene
  55502. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  55503. * @param invertY defines if texture must be stored with Y axis inverted
  55504. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  55505. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  55506. */
  55507. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  55508. /** Gets or sets the texture format to use */
  55509. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  55510. /**
  55511. * Update the texture with new data
  55512. * @param data defines the data to store in the texture
  55513. */
  55514. update(data: ArrayBufferView): void;
  55515. }
  55516. }
  55517. declare module "babylonjs/Materials/Textures/refractionTexture" {
  55518. import { Scene } from "babylonjs/scene";
  55519. import { Plane } from "babylonjs/Maths/math.plane";
  55520. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  55521. /**
  55522. * Creates a refraction texture used by refraction channel of the standard material.
  55523. * It is like a mirror but to see through a material.
  55524. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55525. */
  55526. export class RefractionTexture extends RenderTargetTexture {
  55527. /**
  55528. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  55529. * It is possible to directly set the refractionPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the refractionPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the refractor as stated in the doc.
  55530. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55531. */
  55532. refractionPlane: Plane;
  55533. /**
  55534. * Define how deep under the surface we should see.
  55535. */
  55536. depth: number;
  55537. /**
  55538. * Creates a refraction texture used by refraction channel of the standard material.
  55539. * It is like a mirror but to see through a material.
  55540. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55541. * @param name Define the texture name
  55542. * @param size Define the size of the underlying texture
  55543. * @param scene Define the scene the refraction belongs to
  55544. * @param generateMipMaps Define if we need to generate mips level for the refraction
  55545. */
  55546. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  55547. /**
  55548. * Clone the refraction texture.
  55549. * @returns the cloned texture
  55550. */
  55551. clone(): RefractionTexture;
  55552. /**
  55553. * Serialize the texture to a JSON representation you could use in Parse later on
  55554. * @returns the serialized JSON representation
  55555. */
  55556. serialize(): any;
  55557. }
  55558. }
  55559. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  55560. import { Nullable } from "babylonjs/types";
  55561. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55562. import { Matrix } from "babylonjs/Maths/math.vector";
  55563. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  55564. import "babylonjs/Engines/Extensions/engine.videoTexture";
  55565. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  55566. import { Scene } from "babylonjs/scene";
  55567. /**
  55568. * Defines the options related to the creation of an HtmlElementTexture
  55569. */
  55570. export interface IHtmlElementTextureOptions {
  55571. /**
  55572. * Defines wether mip maps should be created or not.
  55573. */
  55574. generateMipMaps?: boolean;
  55575. /**
  55576. * Defines the sampling mode of the texture.
  55577. */
  55578. samplingMode?: number;
  55579. /**
  55580. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  55581. */
  55582. engine: Nullable<ThinEngine>;
  55583. /**
  55584. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  55585. */
  55586. scene: Nullable<Scene>;
  55587. }
  55588. /**
  55589. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  55590. * To be as efficient as possible depending on your constraints nothing aside the first upload
  55591. * is automatically managed.
  55592. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  55593. * in your application.
  55594. *
  55595. * As the update is not automatic, you need to call them manually.
  55596. */
  55597. export class HtmlElementTexture extends BaseTexture {
  55598. /**
  55599. * The texture URL.
  55600. */
  55601. element: HTMLVideoElement | HTMLCanvasElement;
  55602. private static readonly DefaultOptions;
  55603. private _textureMatrix;
  55604. private _engine;
  55605. private _isVideo;
  55606. private _generateMipMaps;
  55607. private _samplingMode;
  55608. /**
  55609. * Instantiates a HtmlElementTexture from the following parameters.
  55610. *
  55611. * @param name Defines the name of the texture
  55612. * @param element Defines the video or canvas the texture is filled with
  55613. * @param options Defines the other none mandatory texture creation options
  55614. */
  55615. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  55616. private _createInternalTexture;
  55617. /**
  55618. * Returns the texture matrix used in most of the material.
  55619. */
  55620. getTextureMatrix(): Matrix;
  55621. /**
  55622. * Updates the content of the texture.
  55623. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  55624. */
  55625. update(invertY?: Nullable<boolean>): void;
  55626. }
  55627. }
  55628. declare module "babylonjs/Materials/Textures/index" {
  55629. export * from "babylonjs/Materials/Textures/baseTexture";
  55630. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  55631. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  55632. export * from "babylonjs/Materials/Textures/cubeTexture";
  55633. export * from "babylonjs/Materials/Textures/dynamicTexture";
  55634. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  55635. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  55636. export * from "babylonjs/Materials/Textures/internalTexture";
  55637. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  55638. export * from "babylonjs/Materials/Textures/Loaders/index";
  55639. export * from "babylonjs/Materials/Textures/mirrorTexture";
  55640. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  55641. export * from "babylonjs/Materials/Textures/Procedurals/index";
  55642. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  55643. export * from "babylonjs/Materials/Textures/rawTexture";
  55644. export * from "babylonjs/Materials/Textures/rawTexture3D";
  55645. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  55646. export * from "babylonjs/Materials/Textures/refractionTexture";
  55647. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  55648. export * from "babylonjs/Materials/Textures/texture";
  55649. export * from "babylonjs/Materials/Textures/videoTexture";
  55650. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  55651. }
  55652. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  55653. /**
  55654. * Enum used to define the target of a block
  55655. */
  55656. export enum NodeMaterialBlockTargets {
  55657. /** Vertex shader */
  55658. Vertex = 1,
  55659. /** Fragment shader */
  55660. Fragment = 2,
  55661. /** Neutral */
  55662. Neutral = 4,
  55663. /** Vertex and Fragment */
  55664. VertexAndFragment = 3
  55665. }
  55666. }
  55667. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  55668. /**
  55669. * Defines the kind of connection point for node based material
  55670. */
  55671. export enum NodeMaterialBlockConnectionPointTypes {
  55672. /** Float */
  55673. Float = 1,
  55674. /** Int */
  55675. Int = 2,
  55676. /** Vector2 */
  55677. Vector2 = 4,
  55678. /** Vector3 */
  55679. Vector3 = 8,
  55680. /** Vector4 */
  55681. Vector4 = 16,
  55682. /** Color3 */
  55683. Color3 = 32,
  55684. /** Color4 */
  55685. Color4 = 64,
  55686. /** Matrix */
  55687. Matrix = 128,
  55688. /** Detect type based on connection */
  55689. AutoDetect = 1024,
  55690. /** Output type that will be defined by input type */
  55691. BasedOnInput = 2048
  55692. }
  55693. }
  55694. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  55695. /**
  55696. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  55697. */
  55698. export enum NodeMaterialBlockConnectionPointMode {
  55699. /** Value is an uniform */
  55700. Uniform = 0,
  55701. /** Value is a mesh attribute */
  55702. Attribute = 1,
  55703. /** Value is a varying between vertex and fragment shaders */
  55704. Varying = 2,
  55705. /** Mode is undefined */
  55706. Undefined = 3
  55707. }
  55708. }
  55709. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  55710. /**
  55711. * Enum used to define system values e.g. values automatically provided by the system
  55712. */
  55713. export enum NodeMaterialSystemValues {
  55714. /** World */
  55715. World = 1,
  55716. /** View */
  55717. View = 2,
  55718. /** Projection */
  55719. Projection = 3,
  55720. /** ViewProjection */
  55721. ViewProjection = 4,
  55722. /** WorldView */
  55723. WorldView = 5,
  55724. /** WorldViewProjection */
  55725. WorldViewProjection = 6,
  55726. /** CameraPosition */
  55727. CameraPosition = 7,
  55728. /** Fog Color */
  55729. FogColor = 8,
  55730. /** Delta time */
  55731. DeltaTime = 9
  55732. }
  55733. }
  55734. declare module "babylonjs/Materials/Node/Enums/index" {
  55735. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  55736. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  55737. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  55738. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  55739. }
  55740. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  55741. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55742. /**
  55743. * Root class for all node material optimizers
  55744. */
  55745. export class NodeMaterialOptimizer {
  55746. /**
  55747. * Function used to optimize a NodeMaterial graph
  55748. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  55749. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  55750. */
  55751. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  55752. }
  55753. }
  55754. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  55755. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55756. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55757. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55758. import { Scene } from "babylonjs/scene";
  55759. /**
  55760. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  55761. */
  55762. export class TransformBlock extends NodeMaterialBlock {
  55763. /**
  55764. * Defines the value to use to complement W value to transform it to a Vector4
  55765. */
  55766. complementW: number;
  55767. /**
  55768. * Defines the value to use to complement z value to transform it to a Vector4
  55769. */
  55770. complementZ: number;
  55771. /**
  55772. * Creates a new TransformBlock
  55773. * @param name defines the block name
  55774. */
  55775. constructor(name: string);
  55776. /**
  55777. * Gets the current class name
  55778. * @returns the class name
  55779. */
  55780. getClassName(): string;
  55781. /**
  55782. * Gets the vector input
  55783. */
  55784. readonly vector: NodeMaterialConnectionPoint;
  55785. /**
  55786. * Gets the output component
  55787. */
  55788. readonly output: NodeMaterialConnectionPoint;
  55789. /**
  55790. * Gets the matrix transform input
  55791. */
  55792. readonly transform: NodeMaterialConnectionPoint;
  55793. protected _buildBlock(state: NodeMaterialBuildState): this;
  55794. serialize(): any;
  55795. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55796. protected _dumpPropertiesCode(): string;
  55797. }
  55798. }
  55799. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  55800. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55801. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55802. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55803. /**
  55804. * Block used to output the vertex position
  55805. */
  55806. export class VertexOutputBlock extends NodeMaterialBlock {
  55807. /**
  55808. * Creates a new VertexOutputBlock
  55809. * @param name defines the block name
  55810. */
  55811. constructor(name: string);
  55812. /**
  55813. * Gets the current class name
  55814. * @returns the class name
  55815. */
  55816. getClassName(): string;
  55817. /**
  55818. * Gets the vector input component
  55819. */
  55820. readonly vector: NodeMaterialConnectionPoint;
  55821. protected _buildBlock(state: NodeMaterialBuildState): this;
  55822. }
  55823. }
  55824. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  55825. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55826. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55827. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55828. /**
  55829. * Block used to output the final color
  55830. */
  55831. export class FragmentOutputBlock extends NodeMaterialBlock {
  55832. /**
  55833. * Create a new FragmentOutputBlock
  55834. * @param name defines the block name
  55835. */
  55836. constructor(name: string);
  55837. /**
  55838. * Gets the current class name
  55839. * @returns the class name
  55840. */
  55841. getClassName(): string;
  55842. /**
  55843. * Gets the rgba input component
  55844. */
  55845. readonly rgba: NodeMaterialConnectionPoint;
  55846. /**
  55847. * Gets the rgb input component
  55848. */
  55849. readonly rgb: NodeMaterialConnectionPoint;
  55850. /**
  55851. * Gets the a input component
  55852. */
  55853. readonly a: NodeMaterialConnectionPoint;
  55854. protected _buildBlock(state: NodeMaterialBuildState): this;
  55855. }
  55856. }
  55857. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  55858. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55859. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55860. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55861. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55862. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55863. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  55864. import { Effect } from "babylonjs/Materials/effect";
  55865. import { Mesh } from "babylonjs/Meshes/mesh";
  55866. import { Nullable } from "babylonjs/types";
  55867. import { Scene } from "babylonjs/scene";
  55868. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  55869. /**
  55870. * Block used to read a reflection texture from a sampler
  55871. */
  55872. export class ReflectionTextureBlock extends NodeMaterialBlock {
  55873. private _define3DName;
  55874. private _defineCubicName;
  55875. private _defineExplicitName;
  55876. private _defineProjectionName;
  55877. private _defineLocalCubicName;
  55878. private _defineSphericalName;
  55879. private _definePlanarName;
  55880. private _defineEquirectangularName;
  55881. private _defineMirroredEquirectangularFixedName;
  55882. private _defineEquirectangularFixedName;
  55883. private _defineSkyboxName;
  55884. private _cubeSamplerName;
  55885. private _2DSamplerName;
  55886. private _positionUVWName;
  55887. private _directionWName;
  55888. private _reflectionCoordsName;
  55889. private _reflection2DCoordsName;
  55890. private _reflectionColorName;
  55891. private _reflectionMatrixName;
  55892. /**
  55893. * Gets or sets the texture associated with the node
  55894. */
  55895. texture: Nullable<BaseTexture>;
  55896. /**
  55897. * Create a new TextureBlock
  55898. * @param name defines the block name
  55899. */
  55900. constructor(name: string);
  55901. /**
  55902. * Gets the current class name
  55903. * @returns the class name
  55904. */
  55905. getClassName(): string;
  55906. /**
  55907. * Gets the world position input component
  55908. */
  55909. readonly position: NodeMaterialConnectionPoint;
  55910. /**
  55911. * Gets the world position input component
  55912. */
  55913. readonly worldPosition: NodeMaterialConnectionPoint;
  55914. /**
  55915. * Gets the world normal input component
  55916. */
  55917. readonly worldNormal: NodeMaterialConnectionPoint;
  55918. /**
  55919. * Gets the world input component
  55920. */
  55921. readonly world: NodeMaterialConnectionPoint;
  55922. /**
  55923. * Gets the camera (or eye) position component
  55924. */
  55925. readonly cameraPosition: NodeMaterialConnectionPoint;
  55926. /**
  55927. * Gets the view input component
  55928. */
  55929. readonly view: NodeMaterialConnectionPoint;
  55930. /**
  55931. * Gets the rgb output component
  55932. */
  55933. readonly rgb: NodeMaterialConnectionPoint;
  55934. /**
  55935. * Gets the r output component
  55936. */
  55937. readonly r: NodeMaterialConnectionPoint;
  55938. /**
  55939. * Gets the g output component
  55940. */
  55941. readonly g: NodeMaterialConnectionPoint;
  55942. /**
  55943. * Gets the b output component
  55944. */
  55945. readonly b: NodeMaterialConnectionPoint;
  55946. autoConfigure(material: NodeMaterial): void;
  55947. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  55948. isReady(): boolean;
  55949. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  55950. private _injectVertexCode;
  55951. private _writeOutput;
  55952. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  55953. protected _dumpPropertiesCode(): string;
  55954. serialize(): any;
  55955. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55956. }
  55957. }
  55958. declare module "babylonjs/Materials/Node/nodeMaterial" {
  55959. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55960. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  55961. import { Scene } from "babylonjs/scene";
  55962. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55963. import { Matrix } from "babylonjs/Maths/math.vector";
  55964. import { Mesh } from "babylonjs/Meshes/mesh";
  55965. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55966. import { Observable } from "babylonjs/Misc/observable";
  55967. import { SubMesh } from "babylonjs/Meshes/subMesh";
  55968. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  55969. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  55970. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  55971. import { Nullable } from "babylonjs/types";
  55972. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  55973. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  55974. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  55975. /**
  55976. * Interface used to configure the node material editor
  55977. */
  55978. export interface INodeMaterialEditorOptions {
  55979. /** Define the URl to load node editor script */
  55980. editorURL?: string;
  55981. }
  55982. /** @hidden */
  55983. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  55984. /** BONES */
  55985. NUM_BONE_INFLUENCERS: number;
  55986. BonesPerMesh: number;
  55987. BONETEXTURE: boolean;
  55988. /** MORPH TARGETS */
  55989. MORPHTARGETS: boolean;
  55990. MORPHTARGETS_NORMAL: boolean;
  55991. MORPHTARGETS_TANGENT: boolean;
  55992. MORPHTARGETS_UV: boolean;
  55993. NUM_MORPH_INFLUENCERS: number;
  55994. /** IMAGE PROCESSING */
  55995. IMAGEPROCESSING: boolean;
  55996. VIGNETTE: boolean;
  55997. VIGNETTEBLENDMODEMULTIPLY: boolean;
  55998. VIGNETTEBLENDMODEOPAQUE: boolean;
  55999. TONEMAPPING: boolean;
  56000. TONEMAPPING_ACES: boolean;
  56001. CONTRAST: boolean;
  56002. EXPOSURE: boolean;
  56003. COLORCURVES: boolean;
  56004. COLORGRADING: boolean;
  56005. COLORGRADING3D: boolean;
  56006. SAMPLER3DGREENDEPTH: boolean;
  56007. SAMPLER3DBGRMAP: boolean;
  56008. IMAGEPROCESSINGPOSTPROCESS: boolean;
  56009. /** MISC. */
  56010. BUMPDIRECTUV: number;
  56011. constructor();
  56012. setValue(name: string, value: boolean): void;
  56013. }
  56014. /**
  56015. * Class used to configure NodeMaterial
  56016. */
  56017. export interface INodeMaterialOptions {
  56018. /**
  56019. * Defines if blocks should emit comments
  56020. */
  56021. emitComments: boolean;
  56022. }
  56023. /**
  56024. * Class used to create a node based material built by assembling shader blocks
  56025. */
  56026. export class NodeMaterial extends PushMaterial {
  56027. private static _BuildIdGenerator;
  56028. private _options;
  56029. private _vertexCompilationState;
  56030. private _fragmentCompilationState;
  56031. private _sharedData;
  56032. private _buildId;
  56033. private _buildWasSuccessful;
  56034. private _cachedWorldViewMatrix;
  56035. private _cachedWorldViewProjectionMatrix;
  56036. private _optimizers;
  56037. private _animationFrame;
  56038. /** Define the URl to load node editor script */
  56039. static EditorURL: string;
  56040. private BJSNODEMATERIALEDITOR;
  56041. /** Get the inspector from bundle or global */
  56042. private _getGlobalNodeMaterialEditor;
  56043. /**
  56044. * Gets or sets a boolean indicating that alpha value must be ignored (This will turn alpha blending off even if an alpha value is produced by the material)
  56045. */
  56046. ignoreAlpha: boolean;
  56047. /**
  56048. * Defines the maximum number of lights that can be used in the material
  56049. */
  56050. maxSimultaneousLights: number;
  56051. /**
  56052. * Observable raised when the material is built
  56053. */
  56054. onBuildObservable: Observable<NodeMaterial>;
  56055. /**
  56056. * Gets or sets the root nodes of the material vertex shader
  56057. */
  56058. _vertexOutputNodes: NodeMaterialBlock[];
  56059. /**
  56060. * Gets or sets the root nodes of the material fragment (pixel) shader
  56061. */
  56062. _fragmentOutputNodes: NodeMaterialBlock[];
  56063. /** Gets or sets options to control the node material overall behavior */
  56064. options: INodeMaterialOptions;
  56065. /**
  56066. * Default configuration related to image processing available in the standard Material.
  56067. */
  56068. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56069. /**
  56070. * Gets the image processing configuration used either in this material.
  56071. */
  56072. /**
  56073. * Sets the Default image processing configuration used either in the this material.
  56074. *
  56075. * If sets to null, the scene one is in use.
  56076. */
  56077. imageProcessingConfiguration: ImageProcessingConfiguration;
  56078. /**
  56079. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  56080. */
  56081. attachedBlocks: NodeMaterialBlock[];
  56082. /**
  56083. * Create a new node based material
  56084. * @param name defines the material name
  56085. * @param scene defines the hosting scene
  56086. * @param options defines creation option
  56087. */
  56088. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  56089. /**
  56090. * Gets the current class name of the material e.g. "NodeMaterial"
  56091. * @returns the class name
  56092. */
  56093. getClassName(): string;
  56094. /**
  56095. * Keep track of the image processing observer to allow dispose and replace.
  56096. */
  56097. private _imageProcessingObserver;
  56098. /**
  56099. * Attaches a new image processing configuration to the Standard Material.
  56100. * @param configuration
  56101. */
  56102. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56103. /**
  56104. * Get a block by its name
  56105. * @param name defines the name of the block to retrieve
  56106. * @returns the required block or null if not found
  56107. */
  56108. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  56109. /**
  56110. * Get a block by its name
  56111. * @param predicate defines the predicate used to find the good candidate
  56112. * @returns the required block or null if not found
  56113. */
  56114. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  56115. /**
  56116. * Get an input block by its name
  56117. * @param predicate defines the predicate used to find the good candidate
  56118. * @returns the required input block or null if not found
  56119. */
  56120. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  56121. /**
  56122. * Gets the list of input blocks attached to this material
  56123. * @returns an array of InputBlocks
  56124. */
  56125. getInputBlocks(): InputBlock[];
  56126. /**
  56127. * Adds a new optimizer to the list of optimizers
  56128. * @param optimizer defines the optimizers to add
  56129. * @returns the current material
  56130. */
  56131. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  56132. /**
  56133. * Remove an optimizer from the list of optimizers
  56134. * @param optimizer defines the optimizers to remove
  56135. * @returns the current material
  56136. */
  56137. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  56138. /**
  56139. * Add a new block to the list of output nodes
  56140. * @param node defines the node to add
  56141. * @returns the current material
  56142. */
  56143. addOutputNode(node: NodeMaterialBlock): this;
  56144. /**
  56145. * Remove a block from the list of root nodes
  56146. * @param node defines the node to remove
  56147. * @returns the current material
  56148. */
  56149. removeOutputNode(node: NodeMaterialBlock): this;
  56150. private _addVertexOutputNode;
  56151. private _removeVertexOutputNode;
  56152. private _addFragmentOutputNode;
  56153. private _removeFragmentOutputNode;
  56154. /**
  56155. * Specifies if the material will require alpha blending
  56156. * @returns a boolean specifying if alpha blending is needed
  56157. */
  56158. needAlphaBlending(): boolean;
  56159. /**
  56160. * Specifies if this material should be rendered in alpha test mode
  56161. * @returns a boolean specifying if an alpha test is needed.
  56162. */
  56163. needAlphaTesting(): boolean;
  56164. private _initializeBlock;
  56165. private _resetDualBlocks;
  56166. /**
  56167. * Build the material and generates the inner effect
  56168. * @param verbose defines if the build should log activity
  56169. */
  56170. build(verbose?: boolean): void;
  56171. /**
  56172. * Runs an otpimization phase to try to improve the shader code
  56173. */
  56174. optimize(): void;
  56175. private _prepareDefinesForAttributes;
  56176. /**
  56177. * Get if the submesh is ready to be used and all its information available.
  56178. * Child classes can use it to update shaders
  56179. * @param mesh defines the mesh to check
  56180. * @param subMesh defines which submesh to check
  56181. * @param useInstances specifies that instances should be used
  56182. * @returns a boolean indicating that the submesh is ready or not
  56183. */
  56184. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56185. /**
  56186. * Get a string representing the shaders built by the current node graph
  56187. */
  56188. readonly compiledShaders: string;
  56189. /**
  56190. * Binds the world matrix to the material
  56191. * @param world defines the world transformation matrix
  56192. */
  56193. bindOnlyWorldMatrix(world: Matrix): void;
  56194. /**
  56195. * Binds the submesh to this material by preparing the effect and shader to draw
  56196. * @param world defines the world transformation matrix
  56197. * @param mesh defines the mesh containing the submesh
  56198. * @param subMesh defines the submesh to bind the material to
  56199. */
  56200. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56201. /**
  56202. * Gets the active textures from the material
  56203. * @returns an array of textures
  56204. */
  56205. getActiveTextures(): BaseTexture[];
  56206. /**
  56207. * Gets the list of texture blocks
  56208. * @returns an array of texture blocks
  56209. */
  56210. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  56211. /**
  56212. * Specifies if the material uses a texture
  56213. * @param texture defines the texture to check against the material
  56214. * @returns a boolean specifying if the material uses the texture
  56215. */
  56216. hasTexture(texture: BaseTexture): boolean;
  56217. /**
  56218. * Disposes the material
  56219. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  56220. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  56221. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  56222. */
  56223. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  56224. /** Creates the node editor window. */
  56225. private _createNodeEditor;
  56226. /**
  56227. * Launch the node material editor
  56228. * @param config Define the configuration of the editor
  56229. * @return a promise fulfilled when the node editor is visible
  56230. */
  56231. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  56232. /**
  56233. * Clear the current material
  56234. */
  56235. clear(): void;
  56236. /**
  56237. * Clear the current material and set it to a default state
  56238. */
  56239. setToDefault(): void;
  56240. /**
  56241. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  56242. * @param url defines the url to load from
  56243. * @returns a promise that will fullfil when the material is fully loaded
  56244. */
  56245. loadAsync(url: string): Promise<void>;
  56246. private _gatherBlocks;
  56247. /**
  56248. * Generate a string containing the code declaration required to create an equivalent of this material
  56249. * @returns a string
  56250. */
  56251. generateCode(): string;
  56252. /**
  56253. * Serializes this material in a JSON representation
  56254. * @returns the serialized material object
  56255. */
  56256. serialize(): any;
  56257. private _restoreConnections;
  56258. /**
  56259. * Clear the current graph and load a new one from a serialization object
  56260. * @param source defines the JSON representation of the material
  56261. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56262. */
  56263. loadFromSerialization(source: any, rootUrl?: string): void;
  56264. /**
  56265. * Creates a node material from parsed material data
  56266. * @param source defines the JSON representation of the material
  56267. * @param scene defines the hosting scene
  56268. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56269. * @returns a new node material
  56270. */
  56271. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  56272. /**
  56273. * Creates a new node material set to default basic configuration
  56274. * @param name defines the name of the material
  56275. * @param scene defines the hosting scene
  56276. * @returns a new NodeMaterial
  56277. */
  56278. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  56279. }
  56280. }
  56281. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  56282. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56283. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56284. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56285. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56286. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56287. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56288. import { Effect } from "babylonjs/Materials/effect";
  56289. import { Mesh } from "babylonjs/Meshes/mesh";
  56290. import { Nullable } from "babylonjs/types";
  56291. import { Texture } from "babylonjs/Materials/Textures/texture";
  56292. import { Scene } from "babylonjs/scene";
  56293. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56294. /**
  56295. * Block used to read a texture from a sampler
  56296. */
  56297. export class TextureBlock extends NodeMaterialBlock {
  56298. private _defineName;
  56299. private _linearDefineName;
  56300. private _samplerName;
  56301. private _transformedUVName;
  56302. private _textureTransformName;
  56303. private _textureInfoName;
  56304. private _mainUVName;
  56305. private _mainUVDefineName;
  56306. /**
  56307. * Gets or sets the texture associated with the node
  56308. */
  56309. texture: Nullable<Texture>;
  56310. /**
  56311. * Create a new TextureBlock
  56312. * @param name defines the block name
  56313. */
  56314. constructor(name: string);
  56315. /**
  56316. * Gets the current class name
  56317. * @returns the class name
  56318. */
  56319. getClassName(): string;
  56320. /**
  56321. * Gets the uv input component
  56322. */
  56323. readonly uv: NodeMaterialConnectionPoint;
  56324. /**
  56325. * Gets the rgba output component
  56326. */
  56327. readonly rgba: NodeMaterialConnectionPoint;
  56328. /**
  56329. * Gets the rgb output component
  56330. */
  56331. readonly rgb: NodeMaterialConnectionPoint;
  56332. /**
  56333. * Gets the r output component
  56334. */
  56335. readonly r: NodeMaterialConnectionPoint;
  56336. /**
  56337. * Gets the g output component
  56338. */
  56339. readonly g: NodeMaterialConnectionPoint;
  56340. /**
  56341. * Gets the b output component
  56342. */
  56343. readonly b: NodeMaterialConnectionPoint;
  56344. /**
  56345. * Gets the a output component
  56346. */
  56347. readonly a: NodeMaterialConnectionPoint;
  56348. readonly target: NodeMaterialBlockTargets;
  56349. autoConfigure(material: NodeMaterial): void;
  56350. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56351. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56352. isReady(): boolean;
  56353. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56354. private readonly _isMixed;
  56355. private _injectVertexCode;
  56356. private _writeOutput;
  56357. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  56358. protected _dumpPropertiesCode(): string;
  56359. serialize(): any;
  56360. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56361. }
  56362. }
  56363. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  56364. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56365. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56366. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56367. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  56368. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  56369. import { Scene } from "babylonjs/scene";
  56370. /**
  56371. * Class used to store shared data between 2 NodeMaterialBuildState
  56372. */
  56373. export class NodeMaterialBuildStateSharedData {
  56374. /**
  56375. * Gets the list of emitted varyings
  56376. */
  56377. temps: string[];
  56378. /**
  56379. * Gets the list of emitted varyings
  56380. */
  56381. varyings: string[];
  56382. /**
  56383. * Gets the varying declaration string
  56384. */
  56385. varyingDeclaration: string;
  56386. /**
  56387. * Input blocks
  56388. */
  56389. inputBlocks: InputBlock[];
  56390. /**
  56391. * Input blocks
  56392. */
  56393. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  56394. /**
  56395. * Bindable blocks (Blocks that need to set data to the effect)
  56396. */
  56397. bindableBlocks: NodeMaterialBlock[];
  56398. /**
  56399. * List of blocks that can provide a compilation fallback
  56400. */
  56401. blocksWithFallbacks: NodeMaterialBlock[];
  56402. /**
  56403. * List of blocks that can provide a define update
  56404. */
  56405. blocksWithDefines: NodeMaterialBlock[];
  56406. /**
  56407. * List of blocks that can provide a repeatable content
  56408. */
  56409. repeatableContentBlocks: NodeMaterialBlock[];
  56410. /**
  56411. * List of blocks that can provide a dynamic list of uniforms
  56412. */
  56413. dynamicUniformBlocks: NodeMaterialBlock[];
  56414. /**
  56415. * List of blocks that can block the isReady function for the material
  56416. */
  56417. blockingBlocks: NodeMaterialBlock[];
  56418. /**
  56419. * Gets the list of animated inputs
  56420. */
  56421. animatedInputs: InputBlock[];
  56422. /**
  56423. * Build Id used to avoid multiple recompilations
  56424. */
  56425. buildId: number;
  56426. /** List of emitted variables */
  56427. variableNames: {
  56428. [key: string]: number;
  56429. };
  56430. /** List of emitted defines */
  56431. defineNames: {
  56432. [key: string]: number;
  56433. };
  56434. /** Should emit comments? */
  56435. emitComments: boolean;
  56436. /** Emit build activity */
  56437. verbose: boolean;
  56438. /** Gets or sets the hosting scene */
  56439. scene: Scene;
  56440. /**
  56441. * Gets the compilation hints emitted at compilation time
  56442. */
  56443. hints: {
  56444. needWorldViewMatrix: boolean;
  56445. needWorldViewProjectionMatrix: boolean;
  56446. needAlphaBlending: boolean;
  56447. needAlphaTesting: boolean;
  56448. };
  56449. /**
  56450. * List of compilation checks
  56451. */
  56452. checks: {
  56453. emitVertex: boolean;
  56454. emitFragment: boolean;
  56455. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  56456. };
  56457. /** Creates a new shared data */
  56458. constructor();
  56459. /**
  56460. * Emits console errors and exceptions if there is a failing check
  56461. */
  56462. emitErrors(): void;
  56463. }
  56464. }
  56465. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  56466. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56467. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56468. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  56469. /**
  56470. * Class used to store node based material build state
  56471. */
  56472. export class NodeMaterialBuildState {
  56473. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  56474. supportUniformBuffers: boolean;
  56475. /**
  56476. * Gets the list of emitted attributes
  56477. */
  56478. attributes: string[];
  56479. /**
  56480. * Gets the list of emitted uniforms
  56481. */
  56482. uniforms: string[];
  56483. /**
  56484. * Gets the list of emitted constants
  56485. */
  56486. constants: string[];
  56487. /**
  56488. * Gets the list of emitted samplers
  56489. */
  56490. samplers: string[];
  56491. /**
  56492. * Gets the list of emitted functions
  56493. */
  56494. functions: {
  56495. [key: string]: string;
  56496. };
  56497. /**
  56498. * Gets the list of emitted extensions
  56499. */
  56500. extensions: {
  56501. [key: string]: string;
  56502. };
  56503. /**
  56504. * Gets the target of the compilation state
  56505. */
  56506. target: NodeMaterialBlockTargets;
  56507. /**
  56508. * Gets the list of emitted counters
  56509. */
  56510. counters: {
  56511. [key: string]: number;
  56512. };
  56513. /**
  56514. * Shared data between multiple NodeMaterialBuildState instances
  56515. */
  56516. sharedData: NodeMaterialBuildStateSharedData;
  56517. /** @hidden */
  56518. _vertexState: NodeMaterialBuildState;
  56519. /** @hidden */
  56520. _attributeDeclaration: string;
  56521. /** @hidden */
  56522. _uniformDeclaration: string;
  56523. /** @hidden */
  56524. _constantDeclaration: string;
  56525. /** @hidden */
  56526. _samplerDeclaration: string;
  56527. /** @hidden */
  56528. _varyingTransfer: string;
  56529. private _repeatableContentAnchorIndex;
  56530. /** @hidden */
  56531. _builtCompilationString: string;
  56532. /**
  56533. * Gets the emitted compilation strings
  56534. */
  56535. compilationString: string;
  56536. /**
  56537. * Finalize the compilation strings
  56538. * @param state defines the current compilation state
  56539. */
  56540. finalize(state: NodeMaterialBuildState): void;
  56541. /** @hidden */
  56542. readonly _repeatableContentAnchor: string;
  56543. /** @hidden */
  56544. _getFreeVariableName(prefix: string): string;
  56545. /** @hidden */
  56546. _getFreeDefineName(prefix: string): string;
  56547. /** @hidden */
  56548. _excludeVariableName(name: string): void;
  56549. /** @hidden */
  56550. _emit2DSampler(name: string): void;
  56551. /** @hidden */
  56552. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  56553. /** @hidden */
  56554. _emitExtension(name: string, extension: string): void;
  56555. /** @hidden */
  56556. _emitFunction(name: string, code: string, comments: string): void;
  56557. /** @hidden */
  56558. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  56559. replaceStrings?: {
  56560. search: RegExp;
  56561. replace: string;
  56562. }[];
  56563. repeatKey?: string;
  56564. }): string;
  56565. /** @hidden */
  56566. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  56567. repeatKey?: string;
  56568. removeAttributes?: boolean;
  56569. removeUniforms?: boolean;
  56570. removeVaryings?: boolean;
  56571. removeIfDef?: boolean;
  56572. replaceStrings?: {
  56573. search: RegExp;
  56574. replace: string;
  56575. }[];
  56576. }, storeKey?: string): void;
  56577. /** @hidden */
  56578. _registerTempVariable(name: string): boolean;
  56579. /** @hidden */
  56580. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  56581. /** @hidden */
  56582. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  56583. /** @hidden */
  56584. _emitFloat(value: number): string;
  56585. }
  56586. }
  56587. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  56588. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56589. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56590. import { Nullable } from "babylonjs/types";
  56591. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56592. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56593. import { Effect } from "babylonjs/Materials/effect";
  56594. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56595. import { Mesh } from "babylonjs/Meshes/mesh";
  56596. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56597. import { Scene } from "babylonjs/scene";
  56598. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56599. /**
  56600. * Defines a block that can be used inside a node based material
  56601. */
  56602. export class NodeMaterialBlock {
  56603. private _buildId;
  56604. private _buildTarget;
  56605. private _target;
  56606. private _isFinalMerger;
  56607. private _isInput;
  56608. protected _isUnique: boolean;
  56609. /** @hidden */
  56610. _codeVariableName: string;
  56611. /** @hidden */
  56612. _inputs: NodeMaterialConnectionPoint[];
  56613. /** @hidden */
  56614. _outputs: NodeMaterialConnectionPoint[];
  56615. /** @hidden */
  56616. _preparationId: number;
  56617. /**
  56618. * Gets or sets the name of the block
  56619. */
  56620. name: string;
  56621. /**
  56622. * Gets or sets the unique id of the node
  56623. */
  56624. uniqueId: number;
  56625. /**
  56626. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  56627. */
  56628. readonly isUnique: boolean;
  56629. /**
  56630. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  56631. */
  56632. readonly isFinalMerger: boolean;
  56633. /**
  56634. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  56635. */
  56636. readonly isInput: boolean;
  56637. /**
  56638. * Gets or sets the build Id
  56639. */
  56640. buildId: number;
  56641. /**
  56642. * Gets or sets the target of the block
  56643. */
  56644. target: NodeMaterialBlockTargets;
  56645. /**
  56646. * Gets the list of input points
  56647. */
  56648. readonly inputs: NodeMaterialConnectionPoint[];
  56649. /** Gets the list of output points */
  56650. readonly outputs: NodeMaterialConnectionPoint[];
  56651. /**
  56652. * Find an input by its name
  56653. * @param name defines the name of the input to look for
  56654. * @returns the input or null if not found
  56655. */
  56656. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  56657. /**
  56658. * Find an output by its name
  56659. * @param name defines the name of the outputto look for
  56660. * @returns the output or null if not found
  56661. */
  56662. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  56663. /**
  56664. * Creates a new NodeMaterialBlock
  56665. * @param name defines the block name
  56666. * @param target defines the target of that block (Vertex by default)
  56667. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  56668. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  56669. */
  56670. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  56671. /**
  56672. * Initialize the block and prepare the context for build
  56673. * @param state defines the state that will be used for the build
  56674. */
  56675. initialize(state: NodeMaterialBuildState): void;
  56676. /**
  56677. * Bind data to effect. Will only be called for blocks with isBindable === true
  56678. * @param effect defines the effect to bind data to
  56679. * @param nodeMaterial defines the hosting NodeMaterial
  56680. * @param mesh defines the mesh that will be rendered
  56681. */
  56682. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56683. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  56684. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  56685. protected _writeFloat(value: number): string;
  56686. /**
  56687. * Gets the current class name e.g. "NodeMaterialBlock"
  56688. * @returns the class name
  56689. */
  56690. getClassName(): string;
  56691. /**
  56692. * Register a new input. Must be called inside a block constructor
  56693. * @param name defines the connection point name
  56694. * @param type defines the connection point type
  56695. * @param isOptional defines a boolean indicating that this input can be omitted
  56696. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  56697. * @returns the current block
  56698. */
  56699. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  56700. /**
  56701. * Register a new output. Must be called inside a block constructor
  56702. * @param name defines the connection point name
  56703. * @param type defines the connection point type
  56704. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  56705. * @returns the current block
  56706. */
  56707. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  56708. /**
  56709. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  56710. * @param forOutput defines an optional connection point to check compatibility with
  56711. * @returns the first available input or null
  56712. */
  56713. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  56714. /**
  56715. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  56716. * @param forBlock defines an optional block to check compatibility with
  56717. * @returns the first available input or null
  56718. */
  56719. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  56720. /**
  56721. * Gets the sibling of the given output
  56722. * @param current defines the current output
  56723. * @returns the next output in the list or null
  56724. */
  56725. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  56726. /**
  56727. * Connect current block with another block
  56728. * @param other defines the block to connect with
  56729. * @param options define the various options to help pick the right connections
  56730. * @returns the current block
  56731. */
  56732. connectTo(other: NodeMaterialBlock, options?: {
  56733. input?: string;
  56734. output?: string;
  56735. outputSwizzle?: string;
  56736. }): this | undefined;
  56737. protected _buildBlock(state: NodeMaterialBuildState): void;
  56738. /**
  56739. * Add uniforms, samplers and uniform buffers at compilation time
  56740. * @param state defines the state to update
  56741. * @param nodeMaterial defines the node material requesting the update
  56742. * @param defines defines the material defines to update
  56743. * @param uniformBuffers defines the list of uniform buffer names
  56744. */
  56745. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  56746. /**
  56747. * Add potential fallbacks if shader compilation fails
  56748. * @param mesh defines the mesh to be rendered
  56749. * @param fallbacks defines the current prioritized list of fallbacks
  56750. */
  56751. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  56752. /**
  56753. * Initialize defines for shader compilation
  56754. * @param mesh defines the mesh to be rendered
  56755. * @param nodeMaterial defines the node material requesting the update
  56756. * @param defines defines the material defines to update
  56757. * @param useInstances specifies that instances should be used
  56758. */
  56759. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56760. /**
  56761. * Update defines for shader compilation
  56762. * @param mesh defines the mesh to be rendered
  56763. * @param nodeMaterial defines the node material requesting the update
  56764. * @param defines defines the material defines to update
  56765. * @param useInstances specifies that instances should be used
  56766. */
  56767. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56768. /**
  56769. * Lets the block try to connect some inputs automatically
  56770. * @param material defines the hosting NodeMaterial
  56771. */
  56772. autoConfigure(material: NodeMaterial): void;
  56773. /**
  56774. * Function called when a block is declared as repeatable content generator
  56775. * @param vertexShaderState defines the current compilation state for the vertex shader
  56776. * @param fragmentShaderState defines the current compilation state for the fragment shader
  56777. * @param mesh defines the mesh to be rendered
  56778. * @param defines defines the material defines to update
  56779. */
  56780. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  56781. /**
  56782. * Checks if the block is ready
  56783. * @param mesh defines the mesh to be rendered
  56784. * @param nodeMaterial defines the node material requesting the update
  56785. * @param defines defines the material defines to update
  56786. * @param useInstances specifies that instances should be used
  56787. * @returns true if the block is ready
  56788. */
  56789. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  56790. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  56791. private _processBuild;
  56792. /**
  56793. * Compile the current node and generate the shader code
  56794. * @param state defines the current compilation state (uniforms, samplers, current string)
  56795. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  56796. * @returns true if already built
  56797. */
  56798. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  56799. protected _inputRename(name: string): string;
  56800. protected _outputRename(name: string): string;
  56801. protected _dumpPropertiesCode(): string;
  56802. /** @hidden */
  56803. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  56804. /** @hidden */
  56805. _dumpCodeForOutputConnections(): string;
  56806. /**
  56807. * Clone the current block to a new identical block
  56808. * @param scene defines the hosting scene
  56809. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56810. * @returns a copy of the current block
  56811. */
  56812. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  56813. /**
  56814. * Serializes this block in a JSON representation
  56815. * @returns the serialized block object
  56816. */
  56817. serialize(): any;
  56818. /** @hidden */
  56819. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56820. /**
  56821. * Release resources
  56822. */
  56823. dispose(): void;
  56824. }
  56825. }
  56826. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  56827. /**
  56828. * Enum defining the type of animations supported by InputBlock
  56829. */
  56830. export enum AnimatedInputBlockTypes {
  56831. /** No animation */
  56832. None = 0,
  56833. /** Time based animation. Will only work for floats */
  56834. Time = 1
  56835. }
  56836. }
  56837. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  56838. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56839. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56840. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  56841. import { Nullable } from "babylonjs/types";
  56842. import { Effect } from "babylonjs/Materials/effect";
  56843. import { Matrix } from "babylonjs/Maths/math.vector";
  56844. import { Scene } from "babylonjs/scene";
  56845. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56846. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56847. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56848. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  56849. /**
  56850. * Block used to expose an input value
  56851. */
  56852. export class InputBlock extends NodeMaterialBlock {
  56853. private _mode;
  56854. private _associatedVariableName;
  56855. private _storedValue;
  56856. private _valueCallback;
  56857. private _type;
  56858. private _animationType;
  56859. /** Gets or set a value used to limit the range of float values */
  56860. min: number;
  56861. /** Gets or set a value used to limit the range of float values */
  56862. max: number;
  56863. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  56864. matrixMode: number;
  56865. /** @hidden */
  56866. _systemValue: Nullable<NodeMaterialSystemValues>;
  56867. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  56868. visibleInInspector: boolean;
  56869. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  56870. isConstant: boolean;
  56871. /**
  56872. * Gets or sets the connection point type (default is float)
  56873. */
  56874. readonly type: NodeMaterialBlockConnectionPointTypes;
  56875. /**
  56876. * Creates a new InputBlock
  56877. * @param name defines the block name
  56878. * @param target defines the target of that block (Vertex by default)
  56879. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  56880. */
  56881. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  56882. /**
  56883. * Gets the output component
  56884. */
  56885. readonly output: NodeMaterialConnectionPoint;
  56886. /**
  56887. * Set the source of this connection point to a vertex attribute
  56888. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  56889. * @returns the current connection point
  56890. */
  56891. setAsAttribute(attributeName?: string): InputBlock;
  56892. /**
  56893. * Set the source of this connection point to a system value
  56894. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  56895. * @returns the current connection point
  56896. */
  56897. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  56898. /**
  56899. * Gets or sets the value of that point.
  56900. * Please note that this value will be ignored if valueCallback is defined
  56901. */
  56902. value: any;
  56903. /**
  56904. * Gets or sets a callback used to get the value of that point.
  56905. * Please note that setting this value will force the connection point to ignore the value property
  56906. */
  56907. valueCallback: () => any;
  56908. /**
  56909. * Gets or sets the associated variable name in the shader
  56910. */
  56911. associatedVariableName: string;
  56912. /** Gets or sets the type of animation applied to the input */
  56913. animationType: AnimatedInputBlockTypes;
  56914. /**
  56915. * Gets a boolean indicating that this connection point not defined yet
  56916. */
  56917. readonly isUndefined: boolean;
  56918. /**
  56919. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  56920. * In this case the connection point name must be the name of the uniform to use.
  56921. * Can only be set on inputs
  56922. */
  56923. isUniform: boolean;
  56924. /**
  56925. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  56926. * In this case the connection point name must be the name of the attribute to use
  56927. * Can only be set on inputs
  56928. */
  56929. isAttribute: boolean;
  56930. /**
  56931. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  56932. * Can only be set on exit points
  56933. */
  56934. isVarying: boolean;
  56935. /**
  56936. * Gets a boolean indicating that the current connection point is a system value
  56937. */
  56938. readonly isSystemValue: boolean;
  56939. /**
  56940. * Gets or sets the current well known value or null if not defined as a system value
  56941. */
  56942. systemValue: Nullable<NodeMaterialSystemValues>;
  56943. /**
  56944. * Gets the current class name
  56945. * @returns the class name
  56946. */
  56947. getClassName(): string;
  56948. /**
  56949. * Animate the input if animationType !== None
  56950. * @param scene defines the rendering scene
  56951. */
  56952. animate(scene: Scene): void;
  56953. private _emitDefine;
  56954. initialize(state: NodeMaterialBuildState): void;
  56955. /**
  56956. * Set the input block to its default value (based on its type)
  56957. */
  56958. setDefaultValue(): void;
  56959. private _emitConstant;
  56960. private _emit;
  56961. /** @hidden */
  56962. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  56963. /** @hidden */
  56964. _transmit(effect: Effect, scene: Scene): void;
  56965. protected _buildBlock(state: NodeMaterialBuildState): void;
  56966. protected _dumpPropertiesCode(): string;
  56967. serialize(): any;
  56968. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56969. }
  56970. }
  56971. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  56972. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56973. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56974. import { Nullable } from "babylonjs/types";
  56975. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56976. import { Observable } from "babylonjs/Misc/observable";
  56977. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56978. /**
  56979. * Enum used to define the compatibility state between two connection points
  56980. */
  56981. export enum NodeMaterialConnectionPointCompatibilityStates {
  56982. /** Points are compatibles */
  56983. Compatible = 0,
  56984. /** Points are incompatible because of their types */
  56985. TypeIncompatible = 1,
  56986. /** Points are incompatible because of their targets (vertex vs fragment) */
  56987. TargetIncompatible = 2
  56988. }
  56989. /**
  56990. * Defines a connection point for a block
  56991. */
  56992. export class NodeMaterialConnectionPoint {
  56993. /** @hidden */
  56994. _ownerBlock: NodeMaterialBlock;
  56995. /** @hidden */
  56996. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  56997. private _endpoints;
  56998. private _associatedVariableName;
  56999. /** @hidden */
  57000. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  57001. /** @hidden */
  57002. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  57003. private _type;
  57004. /** @hidden */
  57005. _enforceAssociatedVariableName: boolean;
  57006. /**
  57007. * Gets or sets the additional types supported by this connection point
  57008. */
  57009. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  57010. /**
  57011. * Gets or sets the additional types excluded by this connection point
  57012. */
  57013. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  57014. /**
  57015. * Observable triggered when this point is connected
  57016. */
  57017. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  57018. /**
  57019. * Gets or sets the associated variable name in the shader
  57020. */
  57021. associatedVariableName: string;
  57022. /**
  57023. * Gets or sets the connection point type (default is float)
  57024. */
  57025. type: NodeMaterialBlockConnectionPointTypes;
  57026. /**
  57027. * Gets or sets the connection point name
  57028. */
  57029. name: string;
  57030. /**
  57031. * Gets or sets a boolean indicating that this connection point can be omitted
  57032. */
  57033. isOptional: boolean;
  57034. /**
  57035. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  57036. */
  57037. define: string;
  57038. /** @hidden */
  57039. _prioritizeVertex: boolean;
  57040. private _target;
  57041. /** Gets or sets the target of that connection point */
  57042. target: NodeMaterialBlockTargets;
  57043. /**
  57044. * Gets a boolean indicating that the current point is connected
  57045. */
  57046. readonly isConnected: boolean;
  57047. /**
  57048. * Gets a boolean indicating that the current point is connected to an input block
  57049. */
  57050. readonly isConnectedToInputBlock: boolean;
  57051. /**
  57052. * Gets a the connected input block (if any)
  57053. */
  57054. readonly connectInputBlock: Nullable<InputBlock>;
  57055. /** Get the other side of the connection (if any) */
  57056. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  57057. /** Get the block that owns this connection point */
  57058. readonly ownerBlock: NodeMaterialBlock;
  57059. /** Get the block connected on the other side of this connection (if any) */
  57060. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  57061. /** Get the block connected on the endpoints of this connection (if any) */
  57062. readonly connectedBlocks: Array<NodeMaterialBlock>;
  57063. /** Gets the list of connected endpoints */
  57064. readonly endpoints: NodeMaterialConnectionPoint[];
  57065. /** Gets a boolean indicating if that output point is connected to at least one input */
  57066. readonly hasEndpoints: boolean;
  57067. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  57068. readonly isConnectedInVertexShader: boolean;
  57069. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  57070. readonly isConnectedInFragmentShader: boolean;
  57071. /**
  57072. * Creates a new connection point
  57073. * @param name defines the connection point name
  57074. * @param ownerBlock defines the block hosting this connection point
  57075. */
  57076. constructor(name: string, ownerBlock: NodeMaterialBlock);
  57077. /**
  57078. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  57079. * @returns the class name
  57080. */
  57081. getClassName(): string;
  57082. /**
  57083. * Gets a boolean indicating if the current point can be connected to another point
  57084. * @param connectionPoint defines the other connection point
  57085. * @returns a boolean
  57086. */
  57087. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  57088. /**
  57089. * Gets a number indicating if the current point can be connected to another point
  57090. * @param connectionPoint defines the other connection point
  57091. * @returns a number defining the compatibility state
  57092. */
  57093. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  57094. /**
  57095. * Connect this point to another connection point
  57096. * @param connectionPoint defines the other connection point
  57097. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  57098. * @returns the current connection point
  57099. */
  57100. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  57101. /**
  57102. * Disconnect this point from one of his endpoint
  57103. * @param endpoint defines the other connection point
  57104. * @returns the current connection point
  57105. */
  57106. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  57107. /**
  57108. * Serializes this point in a JSON representation
  57109. * @returns the serialized point object
  57110. */
  57111. serialize(): any;
  57112. /**
  57113. * Release resources
  57114. */
  57115. dispose(): void;
  57116. }
  57117. }
  57118. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  57119. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57120. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57121. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57122. import { Mesh } from "babylonjs/Meshes/mesh";
  57123. import { Effect } from "babylonjs/Materials/effect";
  57124. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57125. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57126. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  57127. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  57128. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57129. /**
  57130. * Block used to add support for vertex skinning (bones)
  57131. */
  57132. export class BonesBlock extends NodeMaterialBlock {
  57133. /**
  57134. * Creates a new BonesBlock
  57135. * @param name defines the block name
  57136. */
  57137. constructor(name: string);
  57138. /**
  57139. * Initialize the block and prepare the context for build
  57140. * @param state defines the state that will be used for the build
  57141. */
  57142. initialize(state: NodeMaterialBuildState): void;
  57143. /**
  57144. * Gets the current class name
  57145. * @returns the class name
  57146. */
  57147. getClassName(): string;
  57148. /**
  57149. * Gets the matrix indices input component
  57150. */
  57151. readonly matricesIndices: NodeMaterialConnectionPoint;
  57152. /**
  57153. * Gets the matrix weights input component
  57154. */
  57155. readonly matricesWeights: NodeMaterialConnectionPoint;
  57156. /**
  57157. * Gets the extra matrix indices input component
  57158. */
  57159. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  57160. /**
  57161. * Gets the extra matrix weights input component
  57162. */
  57163. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  57164. /**
  57165. * Gets the world input component
  57166. */
  57167. readonly world: NodeMaterialConnectionPoint;
  57168. /**
  57169. * Gets the output component
  57170. */
  57171. readonly output: NodeMaterialConnectionPoint;
  57172. autoConfigure(material: NodeMaterial): void;
  57173. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  57174. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57175. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57176. protected _buildBlock(state: NodeMaterialBuildState): this;
  57177. }
  57178. }
  57179. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  57180. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57181. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57182. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57183. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57184. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57185. /**
  57186. * Block used to add support for instances
  57187. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  57188. */
  57189. export class InstancesBlock extends NodeMaterialBlock {
  57190. /**
  57191. * Creates a new InstancesBlock
  57192. * @param name defines the block name
  57193. */
  57194. constructor(name: string);
  57195. /**
  57196. * Gets the current class name
  57197. * @returns the class name
  57198. */
  57199. getClassName(): string;
  57200. /**
  57201. * Gets the first world row input component
  57202. */
  57203. readonly world0: NodeMaterialConnectionPoint;
  57204. /**
  57205. * Gets the second world row input component
  57206. */
  57207. readonly world1: NodeMaterialConnectionPoint;
  57208. /**
  57209. * Gets the third world row input component
  57210. */
  57211. readonly world2: NodeMaterialConnectionPoint;
  57212. /**
  57213. * Gets the forth world row input component
  57214. */
  57215. readonly world3: NodeMaterialConnectionPoint;
  57216. /**
  57217. * Gets the world input component
  57218. */
  57219. readonly world: NodeMaterialConnectionPoint;
  57220. /**
  57221. * Gets the output component
  57222. */
  57223. readonly output: NodeMaterialConnectionPoint;
  57224. autoConfigure(material: NodeMaterial): void;
  57225. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  57226. protected _buildBlock(state: NodeMaterialBuildState): this;
  57227. }
  57228. }
  57229. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  57230. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57231. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57232. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57233. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57234. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57235. import { Effect } from "babylonjs/Materials/effect";
  57236. import { Mesh } from "babylonjs/Meshes/mesh";
  57237. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  57238. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  57239. /**
  57240. * Block used to add morph targets support to vertex shader
  57241. */
  57242. export class MorphTargetsBlock extends NodeMaterialBlock {
  57243. private _repeatableContentAnchor;
  57244. private _repeatebleContentGenerated;
  57245. /**
  57246. * Create a new MorphTargetsBlock
  57247. * @param name defines the block name
  57248. */
  57249. constructor(name: string);
  57250. /**
  57251. * Gets the current class name
  57252. * @returns the class name
  57253. */
  57254. getClassName(): string;
  57255. /**
  57256. * Gets the position input component
  57257. */
  57258. readonly position: NodeMaterialConnectionPoint;
  57259. /**
  57260. * Gets the normal input component
  57261. */
  57262. readonly normal: NodeMaterialConnectionPoint;
  57263. /**
  57264. * Gets the tangent input component
  57265. */
  57266. readonly tangent: NodeMaterialConnectionPoint;
  57267. /**
  57268. * Gets the tangent input component
  57269. */
  57270. readonly uv: NodeMaterialConnectionPoint;
  57271. /**
  57272. * Gets the position output component
  57273. */
  57274. readonly positionOutput: NodeMaterialConnectionPoint;
  57275. /**
  57276. * Gets the normal output component
  57277. */
  57278. readonly normalOutput: NodeMaterialConnectionPoint;
  57279. /**
  57280. * Gets the tangent output component
  57281. */
  57282. readonly tangentOutput: NodeMaterialConnectionPoint;
  57283. /**
  57284. * Gets the tangent output component
  57285. */
  57286. readonly uvOutput: NodeMaterialConnectionPoint;
  57287. initialize(state: NodeMaterialBuildState): void;
  57288. autoConfigure(material: NodeMaterial): void;
  57289. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57290. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57291. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  57292. protected _buildBlock(state: NodeMaterialBuildState): this;
  57293. }
  57294. }
  57295. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  57296. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57297. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57298. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57299. import { Nullable } from "babylonjs/types";
  57300. import { Scene } from "babylonjs/scene";
  57301. import { Effect } from "babylonjs/Materials/effect";
  57302. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57303. import { Mesh } from "babylonjs/Meshes/mesh";
  57304. import { Light } from "babylonjs/Lights/light";
  57305. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57306. /**
  57307. * Block used to get data information from a light
  57308. */
  57309. export class LightInformationBlock extends NodeMaterialBlock {
  57310. private _lightDataUniformName;
  57311. private _lightColorUniformName;
  57312. private _lightTypeDefineName;
  57313. /**
  57314. * Gets or sets the light associated with this block
  57315. */
  57316. light: Nullable<Light>;
  57317. /**
  57318. * Creates a new LightInformationBlock
  57319. * @param name defines the block name
  57320. */
  57321. constructor(name: string);
  57322. /**
  57323. * Gets the current class name
  57324. * @returns the class name
  57325. */
  57326. getClassName(): string;
  57327. /**
  57328. * Gets the world position input component
  57329. */
  57330. readonly worldPosition: NodeMaterialConnectionPoint;
  57331. /**
  57332. * Gets the direction output component
  57333. */
  57334. readonly direction: NodeMaterialConnectionPoint;
  57335. /**
  57336. * Gets the direction output component
  57337. */
  57338. readonly color: NodeMaterialConnectionPoint;
  57339. /**
  57340. * Gets the direction output component
  57341. */
  57342. readonly intensity: NodeMaterialConnectionPoint;
  57343. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57344. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57345. protected _buildBlock(state: NodeMaterialBuildState): this;
  57346. serialize(): any;
  57347. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57348. }
  57349. }
  57350. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  57351. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  57352. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  57353. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  57354. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  57355. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  57356. }
  57357. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  57358. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57359. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57360. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57361. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57362. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57363. import { Effect } from "babylonjs/Materials/effect";
  57364. import { Mesh } from "babylonjs/Meshes/mesh";
  57365. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57366. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  57367. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  57368. /**
  57369. * Block used to add image processing support to fragment shader
  57370. */
  57371. export class ImageProcessingBlock extends NodeMaterialBlock {
  57372. /**
  57373. * Create a new ImageProcessingBlock
  57374. * @param name defines the block name
  57375. */
  57376. constructor(name: string);
  57377. /**
  57378. * Gets the current class name
  57379. * @returns the class name
  57380. */
  57381. getClassName(): string;
  57382. /**
  57383. * Gets the color input component
  57384. */
  57385. readonly color: NodeMaterialConnectionPoint;
  57386. /**
  57387. * Gets the output component
  57388. */
  57389. readonly output: NodeMaterialConnectionPoint;
  57390. /**
  57391. * Initialize the block and prepare the context for build
  57392. * @param state defines the state that will be used for the build
  57393. */
  57394. initialize(state: NodeMaterialBuildState): void;
  57395. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  57396. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57397. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57398. protected _buildBlock(state: NodeMaterialBuildState): this;
  57399. }
  57400. }
  57401. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  57402. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57403. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57404. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57405. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57406. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57407. import { Effect } from "babylonjs/Materials/effect";
  57408. import { Mesh } from "babylonjs/Meshes/mesh";
  57409. import { Scene } from "babylonjs/scene";
  57410. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  57411. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  57412. /**
  57413. * Block used to pertub normals based on a normal map
  57414. */
  57415. export class PerturbNormalBlock extends NodeMaterialBlock {
  57416. private _tangentSpaceParameterName;
  57417. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  57418. invertX: boolean;
  57419. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  57420. invertY: boolean;
  57421. /**
  57422. * Create a new PerturbNormalBlock
  57423. * @param name defines the block name
  57424. */
  57425. constructor(name: string);
  57426. /**
  57427. * Gets the current class name
  57428. * @returns the class name
  57429. */
  57430. getClassName(): string;
  57431. /**
  57432. * Gets the world position input component
  57433. */
  57434. readonly worldPosition: NodeMaterialConnectionPoint;
  57435. /**
  57436. * Gets the world normal input component
  57437. */
  57438. readonly worldNormal: NodeMaterialConnectionPoint;
  57439. /**
  57440. * Gets the uv input component
  57441. */
  57442. readonly uv: NodeMaterialConnectionPoint;
  57443. /**
  57444. * Gets the normal map color input component
  57445. */
  57446. readonly normalMapColor: NodeMaterialConnectionPoint;
  57447. /**
  57448. * Gets the strength input component
  57449. */
  57450. readonly strength: NodeMaterialConnectionPoint;
  57451. /**
  57452. * Gets the output component
  57453. */
  57454. readonly output: NodeMaterialConnectionPoint;
  57455. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57456. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57457. autoConfigure(material: NodeMaterial): void;
  57458. protected _buildBlock(state: NodeMaterialBuildState): this;
  57459. protected _dumpPropertiesCode(): string;
  57460. serialize(): any;
  57461. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57462. }
  57463. }
  57464. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  57465. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57466. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57467. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57468. /**
  57469. * Block used to discard a pixel if a value is smaller than a cutoff
  57470. */
  57471. export class DiscardBlock extends NodeMaterialBlock {
  57472. /**
  57473. * Create a new DiscardBlock
  57474. * @param name defines the block name
  57475. */
  57476. constructor(name: string);
  57477. /**
  57478. * Gets the current class name
  57479. * @returns the class name
  57480. */
  57481. getClassName(): string;
  57482. /**
  57483. * Gets the color input component
  57484. */
  57485. readonly value: NodeMaterialConnectionPoint;
  57486. /**
  57487. * Gets the cutoff input component
  57488. */
  57489. readonly cutoff: NodeMaterialConnectionPoint;
  57490. protected _buildBlock(state: NodeMaterialBuildState): this;
  57491. }
  57492. }
  57493. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  57494. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57495. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57496. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57497. /**
  57498. * Block used to test if the fragment shader is front facing
  57499. */
  57500. export class FrontFacingBlock extends NodeMaterialBlock {
  57501. /**
  57502. * Creates a new FrontFacingBlock
  57503. * @param name defines the block name
  57504. */
  57505. constructor(name: string);
  57506. /**
  57507. * Gets the current class name
  57508. * @returns the class name
  57509. */
  57510. getClassName(): string;
  57511. /**
  57512. * Gets the output component
  57513. */
  57514. readonly output: NodeMaterialConnectionPoint;
  57515. protected _buildBlock(state: NodeMaterialBuildState): this;
  57516. }
  57517. }
  57518. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  57519. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  57520. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  57521. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  57522. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  57523. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  57524. }
  57525. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  57526. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57527. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57528. import { Mesh } from "babylonjs/Meshes/mesh";
  57529. import { Effect } from "babylonjs/Materials/effect";
  57530. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57531. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57532. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57533. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  57534. /**
  57535. * Block used to add support for scene fog
  57536. */
  57537. export class FogBlock extends NodeMaterialBlock {
  57538. private _fogDistanceName;
  57539. private _fogParameters;
  57540. /**
  57541. * Create a new FogBlock
  57542. * @param name defines the block name
  57543. */
  57544. constructor(name: string);
  57545. /**
  57546. * Gets the current class name
  57547. * @returns the class name
  57548. */
  57549. getClassName(): string;
  57550. /**
  57551. * Gets the world position input component
  57552. */
  57553. readonly worldPosition: NodeMaterialConnectionPoint;
  57554. /**
  57555. * Gets the view input component
  57556. */
  57557. readonly view: NodeMaterialConnectionPoint;
  57558. /**
  57559. * Gets the color input component
  57560. */
  57561. readonly input: NodeMaterialConnectionPoint;
  57562. /**
  57563. * Gets the fog color input component
  57564. */
  57565. readonly fogColor: NodeMaterialConnectionPoint;
  57566. /**
  57567. * Gets the output component
  57568. */
  57569. readonly output: NodeMaterialConnectionPoint;
  57570. autoConfigure(material: NodeMaterial): void;
  57571. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57572. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57573. protected _buildBlock(state: NodeMaterialBuildState): this;
  57574. }
  57575. }
  57576. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  57577. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57578. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57579. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57580. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57581. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57582. import { Effect } from "babylonjs/Materials/effect";
  57583. import { Mesh } from "babylonjs/Meshes/mesh";
  57584. import { Light } from "babylonjs/Lights/light";
  57585. import { Nullable } from "babylonjs/types";
  57586. import { Scene } from "babylonjs/scene";
  57587. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  57588. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  57589. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  57590. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57591. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  57592. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  57593. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  57594. /**
  57595. * Block used to add light in the fragment shader
  57596. */
  57597. export class LightBlock extends NodeMaterialBlock {
  57598. private _lightId;
  57599. /**
  57600. * Gets or sets the light associated with this block
  57601. */
  57602. light: Nullable<Light>;
  57603. /**
  57604. * Create a new LightBlock
  57605. * @param name defines the block name
  57606. */
  57607. constructor(name: string);
  57608. /**
  57609. * Gets the current class name
  57610. * @returns the class name
  57611. */
  57612. getClassName(): string;
  57613. /**
  57614. * Gets the world position input component
  57615. */
  57616. readonly worldPosition: NodeMaterialConnectionPoint;
  57617. /**
  57618. * Gets the world normal input component
  57619. */
  57620. readonly worldNormal: NodeMaterialConnectionPoint;
  57621. /**
  57622. * Gets the camera (or eye) position component
  57623. */
  57624. readonly cameraPosition: NodeMaterialConnectionPoint;
  57625. /**
  57626. * Gets the glossiness component
  57627. */
  57628. readonly glossiness: NodeMaterialConnectionPoint;
  57629. /**
  57630. * Gets the glossinness power component
  57631. */
  57632. readonly glossPower: NodeMaterialConnectionPoint;
  57633. /**
  57634. * Gets the diffuse color component
  57635. */
  57636. readonly diffuseColor: NodeMaterialConnectionPoint;
  57637. /**
  57638. * Gets the specular color component
  57639. */
  57640. readonly specularColor: NodeMaterialConnectionPoint;
  57641. /**
  57642. * Gets the diffuse output component
  57643. */
  57644. readonly diffuseOutput: NodeMaterialConnectionPoint;
  57645. /**
  57646. * Gets the specular output component
  57647. */
  57648. readonly specularOutput: NodeMaterialConnectionPoint;
  57649. autoConfigure(material: NodeMaterial): void;
  57650. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57651. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  57652. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57653. private _injectVertexCode;
  57654. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  57655. serialize(): any;
  57656. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57657. }
  57658. }
  57659. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  57660. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  57661. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  57662. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  57663. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  57664. }
  57665. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  57666. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  57667. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  57668. }
  57669. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  57670. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57671. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57672. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57673. /**
  57674. * Block used to multiply 2 values
  57675. */
  57676. export class MultiplyBlock extends NodeMaterialBlock {
  57677. /**
  57678. * Creates a new MultiplyBlock
  57679. * @param name defines the block name
  57680. */
  57681. constructor(name: string);
  57682. /**
  57683. * Gets the current class name
  57684. * @returns the class name
  57685. */
  57686. getClassName(): string;
  57687. /**
  57688. * Gets the left operand input component
  57689. */
  57690. readonly left: NodeMaterialConnectionPoint;
  57691. /**
  57692. * Gets the right operand input component
  57693. */
  57694. readonly right: NodeMaterialConnectionPoint;
  57695. /**
  57696. * Gets the output component
  57697. */
  57698. readonly output: NodeMaterialConnectionPoint;
  57699. protected _buildBlock(state: NodeMaterialBuildState): this;
  57700. }
  57701. }
  57702. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  57703. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57704. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57705. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57706. /**
  57707. * Block used to add 2 vectors
  57708. */
  57709. export class AddBlock extends NodeMaterialBlock {
  57710. /**
  57711. * Creates a new AddBlock
  57712. * @param name defines the block name
  57713. */
  57714. constructor(name: string);
  57715. /**
  57716. * Gets the current class name
  57717. * @returns the class name
  57718. */
  57719. getClassName(): string;
  57720. /**
  57721. * Gets the left operand input component
  57722. */
  57723. readonly left: NodeMaterialConnectionPoint;
  57724. /**
  57725. * Gets the right operand input component
  57726. */
  57727. readonly right: NodeMaterialConnectionPoint;
  57728. /**
  57729. * Gets the output component
  57730. */
  57731. readonly output: NodeMaterialConnectionPoint;
  57732. protected _buildBlock(state: NodeMaterialBuildState): this;
  57733. }
  57734. }
  57735. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  57736. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57737. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57738. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57739. /**
  57740. * Block used to scale a vector by a float
  57741. */
  57742. export class ScaleBlock extends NodeMaterialBlock {
  57743. /**
  57744. * Creates a new ScaleBlock
  57745. * @param name defines the block name
  57746. */
  57747. constructor(name: string);
  57748. /**
  57749. * Gets the current class name
  57750. * @returns the class name
  57751. */
  57752. getClassName(): string;
  57753. /**
  57754. * Gets the input component
  57755. */
  57756. readonly input: NodeMaterialConnectionPoint;
  57757. /**
  57758. * Gets the factor input component
  57759. */
  57760. readonly factor: NodeMaterialConnectionPoint;
  57761. /**
  57762. * Gets the output component
  57763. */
  57764. readonly output: NodeMaterialConnectionPoint;
  57765. protected _buildBlock(state: NodeMaterialBuildState): this;
  57766. }
  57767. }
  57768. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  57769. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57770. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57771. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57772. import { Scene } from "babylonjs/scene";
  57773. /**
  57774. * Block used to clamp a float
  57775. */
  57776. export class ClampBlock extends NodeMaterialBlock {
  57777. /** Gets or sets the minimum range */
  57778. minimum: number;
  57779. /** Gets or sets the maximum range */
  57780. maximum: number;
  57781. /**
  57782. * Creates a new ClampBlock
  57783. * @param name defines the block name
  57784. */
  57785. constructor(name: string);
  57786. /**
  57787. * Gets the current class name
  57788. * @returns the class name
  57789. */
  57790. getClassName(): string;
  57791. /**
  57792. * Gets the value input component
  57793. */
  57794. readonly value: NodeMaterialConnectionPoint;
  57795. /**
  57796. * Gets the output component
  57797. */
  57798. readonly output: NodeMaterialConnectionPoint;
  57799. protected _buildBlock(state: NodeMaterialBuildState): this;
  57800. protected _dumpPropertiesCode(): string;
  57801. serialize(): any;
  57802. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57803. }
  57804. }
  57805. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  57806. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57807. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57808. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57809. /**
  57810. * Block used to apply a cross product between 2 vectors
  57811. */
  57812. export class CrossBlock extends NodeMaterialBlock {
  57813. /**
  57814. * Creates a new CrossBlock
  57815. * @param name defines the block name
  57816. */
  57817. constructor(name: string);
  57818. /**
  57819. * Gets the current class name
  57820. * @returns the class name
  57821. */
  57822. getClassName(): string;
  57823. /**
  57824. * Gets the left operand input component
  57825. */
  57826. readonly left: NodeMaterialConnectionPoint;
  57827. /**
  57828. * Gets the right operand input component
  57829. */
  57830. readonly right: NodeMaterialConnectionPoint;
  57831. /**
  57832. * Gets the output component
  57833. */
  57834. readonly output: NodeMaterialConnectionPoint;
  57835. protected _buildBlock(state: NodeMaterialBuildState): this;
  57836. }
  57837. }
  57838. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  57839. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57840. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57841. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57842. /**
  57843. * Block used to apply a dot product between 2 vectors
  57844. */
  57845. export class DotBlock extends NodeMaterialBlock {
  57846. /**
  57847. * Creates a new DotBlock
  57848. * @param name defines the block name
  57849. */
  57850. constructor(name: string);
  57851. /**
  57852. * Gets the current class name
  57853. * @returns the class name
  57854. */
  57855. getClassName(): string;
  57856. /**
  57857. * Gets the left operand input component
  57858. */
  57859. readonly left: NodeMaterialConnectionPoint;
  57860. /**
  57861. * Gets the right operand input component
  57862. */
  57863. readonly right: NodeMaterialConnectionPoint;
  57864. /**
  57865. * Gets the output component
  57866. */
  57867. readonly output: NodeMaterialConnectionPoint;
  57868. protected _buildBlock(state: NodeMaterialBuildState): this;
  57869. }
  57870. }
  57871. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  57872. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57873. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57874. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57875. import { Vector2 } from "babylonjs/Maths/math.vector";
  57876. import { Scene } from "babylonjs/scene";
  57877. /**
  57878. * Block used to remap a float from a range to a new one
  57879. */
  57880. export class RemapBlock extends NodeMaterialBlock {
  57881. /**
  57882. * Gets or sets the source range
  57883. */
  57884. sourceRange: Vector2;
  57885. /**
  57886. * Gets or sets the target range
  57887. */
  57888. targetRange: Vector2;
  57889. /**
  57890. * Creates a new RemapBlock
  57891. * @param name defines the block name
  57892. */
  57893. constructor(name: string);
  57894. /**
  57895. * Gets the current class name
  57896. * @returns the class name
  57897. */
  57898. getClassName(): string;
  57899. /**
  57900. * Gets the input component
  57901. */
  57902. readonly input: NodeMaterialConnectionPoint;
  57903. /**
  57904. * Gets the source min input component
  57905. */
  57906. readonly sourceMin: NodeMaterialConnectionPoint;
  57907. /**
  57908. * Gets the source max input component
  57909. */
  57910. readonly sourceMax: NodeMaterialConnectionPoint;
  57911. /**
  57912. * Gets the target min input component
  57913. */
  57914. readonly targetMin: NodeMaterialConnectionPoint;
  57915. /**
  57916. * Gets the target max input component
  57917. */
  57918. readonly targetMax: NodeMaterialConnectionPoint;
  57919. /**
  57920. * Gets the output component
  57921. */
  57922. readonly output: NodeMaterialConnectionPoint;
  57923. protected _buildBlock(state: NodeMaterialBuildState): this;
  57924. protected _dumpPropertiesCode(): string;
  57925. serialize(): any;
  57926. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57927. }
  57928. }
  57929. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  57930. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57931. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57932. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57933. /**
  57934. * Block used to normalize a vector
  57935. */
  57936. export class NormalizeBlock extends NodeMaterialBlock {
  57937. /**
  57938. * Creates a new NormalizeBlock
  57939. * @param name defines the block name
  57940. */
  57941. constructor(name: string);
  57942. /**
  57943. * Gets the current class name
  57944. * @returns the class name
  57945. */
  57946. getClassName(): string;
  57947. /**
  57948. * Gets the input component
  57949. */
  57950. readonly input: NodeMaterialConnectionPoint;
  57951. /**
  57952. * Gets the output component
  57953. */
  57954. readonly output: NodeMaterialConnectionPoint;
  57955. protected _buildBlock(state: NodeMaterialBuildState): this;
  57956. }
  57957. }
  57958. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  57959. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57960. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57961. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57962. import { Scene } from "babylonjs/scene";
  57963. /**
  57964. * Operations supported by the Trigonometry block
  57965. */
  57966. export enum TrigonometryBlockOperations {
  57967. /** Cos */
  57968. Cos = 0,
  57969. /** Sin */
  57970. Sin = 1,
  57971. /** Abs */
  57972. Abs = 2,
  57973. /** Exp */
  57974. Exp = 3,
  57975. /** Exp2 */
  57976. Exp2 = 4,
  57977. /** Round */
  57978. Round = 5,
  57979. /** Floor */
  57980. Floor = 6,
  57981. /** Ceiling */
  57982. Ceiling = 7,
  57983. /** Square root */
  57984. Sqrt = 8,
  57985. /** Log */
  57986. Log = 9,
  57987. /** Tangent */
  57988. Tan = 10,
  57989. /** Arc tangent */
  57990. ArcTan = 11,
  57991. /** Arc cosinus */
  57992. ArcCos = 12,
  57993. /** Arc sinus */
  57994. ArcSin = 13,
  57995. /** Fraction */
  57996. Fract = 14,
  57997. /** Sign */
  57998. Sign = 15,
  57999. /** To radians (from degrees) */
  58000. Radians = 16,
  58001. /** To degrees (from radians) */
  58002. Degrees = 17
  58003. }
  58004. /**
  58005. * Block used to apply trigonometry operation to floats
  58006. */
  58007. export class TrigonometryBlock extends NodeMaterialBlock {
  58008. /**
  58009. * Gets or sets the operation applied by the block
  58010. */
  58011. operation: TrigonometryBlockOperations;
  58012. /**
  58013. * Creates a new TrigonometryBlock
  58014. * @param name defines the block name
  58015. */
  58016. constructor(name: string);
  58017. /**
  58018. * Gets the current class name
  58019. * @returns the class name
  58020. */
  58021. getClassName(): string;
  58022. /**
  58023. * Gets the input component
  58024. */
  58025. readonly input: NodeMaterialConnectionPoint;
  58026. /**
  58027. * Gets the output component
  58028. */
  58029. readonly output: NodeMaterialConnectionPoint;
  58030. protected _buildBlock(state: NodeMaterialBuildState): this;
  58031. serialize(): any;
  58032. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58033. }
  58034. }
  58035. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  58036. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58037. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58038. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58039. /**
  58040. * Block used to create a Color3/4 out of individual inputs (one for each component)
  58041. */
  58042. export class ColorMergerBlock extends NodeMaterialBlock {
  58043. /**
  58044. * Create a new ColorMergerBlock
  58045. * @param name defines the block name
  58046. */
  58047. constructor(name: string);
  58048. /**
  58049. * Gets the current class name
  58050. * @returns the class name
  58051. */
  58052. getClassName(): string;
  58053. /**
  58054. * Gets the r component (input)
  58055. */
  58056. readonly r: NodeMaterialConnectionPoint;
  58057. /**
  58058. * Gets the g component (input)
  58059. */
  58060. readonly g: NodeMaterialConnectionPoint;
  58061. /**
  58062. * Gets the b component (input)
  58063. */
  58064. readonly b: NodeMaterialConnectionPoint;
  58065. /**
  58066. * Gets the a component (input)
  58067. */
  58068. readonly a: NodeMaterialConnectionPoint;
  58069. /**
  58070. * Gets the rgba component (output)
  58071. */
  58072. readonly rgba: NodeMaterialConnectionPoint;
  58073. /**
  58074. * Gets the rgb component (output)
  58075. */
  58076. readonly rgb: NodeMaterialConnectionPoint;
  58077. protected _buildBlock(state: NodeMaterialBuildState): this;
  58078. }
  58079. }
  58080. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  58081. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58082. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58083. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58084. /**
  58085. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  58086. */
  58087. export class VectorMergerBlock extends NodeMaterialBlock {
  58088. /**
  58089. * Create a new VectorMergerBlock
  58090. * @param name defines the block name
  58091. */
  58092. constructor(name: string);
  58093. /**
  58094. * Gets the current class name
  58095. * @returns the class name
  58096. */
  58097. getClassName(): string;
  58098. /**
  58099. * Gets the x component (input)
  58100. */
  58101. readonly x: NodeMaterialConnectionPoint;
  58102. /**
  58103. * Gets the y component (input)
  58104. */
  58105. readonly y: NodeMaterialConnectionPoint;
  58106. /**
  58107. * Gets the z component (input)
  58108. */
  58109. readonly z: NodeMaterialConnectionPoint;
  58110. /**
  58111. * Gets the w component (input)
  58112. */
  58113. readonly w: NodeMaterialConnectionPoint;
  58114. /**
  58115. * Gets the xyzw component (output)
  58116. */
  58117. readonly xyzw: NodeMaterialConnectionPoint;
  58118. /**
  58119. * Gets the xyz component (output)
  58120. */
  58121. readonly xyz: NodeMaterialConnectionPoint;
  58122. /**
  58123. * Gets the xy component (output)
  58124. */
  58125. readonly xy: NodeMaterialConnectionPoint;
  58126. protected _buildBlock(state: NodeMaterialBuildState): this;
  58127. }
  58128. }
  58129. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  58130. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58131. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58132. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58133. /**
  58134. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  58135. */
  58136. export class ColorSplitterBlock extends NodeMaterialBlock {
  58137. /**
  58138. * Create a new ColorSplitterBlock
  58139. * @param name defines the block name
  58140. */
  58141. constructor(name: string);
  58142. /**
  58143. * Gets the current class name
  58144. * @returns the class name
  58145. */
  58146. getClassName(): string;
  58147. /**
  58148. * Gets the rgba component (input)
  58149. */
  58150. readonly rgba: NodeMaterialConnectionPoint;
  58151. /**
  58152. * Gets the rgb component (input)
  58153. */
  58154. readonly rgbIn: NodeMaterialConnectionPoint;
  58155. /**
  58156. * Gets the rgb component (output)
  58157. */
  58158. readonly rgbOut: NodeMaterialConnectionPoint;
  58159. /**
  58160. * Gets the r component (output)
  58161. */
  58162. readonly r: NodeMaterialConnectionPoint;
  58163. /**
  58164. * Gets the g component (output)
  58165. */
  58166. readonly g: NodeMaterialConnectionPoint;
  58167. /**
  58168. * Gets the b component (output)
  58169. */
  58170. readonly b: NodeMaterialConnectionPoint;
  58171. /**
  58172. * Gets the a component (output)
  58173. */
  58174. readonly a: NodeMaterialConnectionPoint;
  58175. protected _inputRename(name: string): string;
  58176. protected _outputRename(name: string): string;
  58177. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  58178. }
  58179. }
  58180. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  58181. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58182. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58183. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58184. /**
  58185. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  58186. */
  58187. export class VectorSplitterBlock extends NodeMaterialBlock {
  58188. /**
  58189. * Create a new VectorSplitterBlock
  58190. * @param name defines the block name
  58191. */
  58192. constructor(name: string);
  58193. /**
  58194. * Gets the current class name
  58195. * @returns the class name
  58196. */
  58197. getClassName(): string;
  58198. /**
  58199. * Gets the xyzw component (input)
  58200. */
  58201. readonly xyzw: NodeMaterialConnectionPoint;
  58202. /**
  58203. * Gets the xyz component (input)
  58204. */
  58205. readonly xyzIn: NodeMaterialConnectionPoint;
  58206. /**
  58207. * Gets the xy component (input)
  58208. */
  58209. readonly xyIn: NodeMaterialConnectionPoint;
  58210. /**
  58211. * Gets the xyz component (output)
  58212. */
  58213. readonly xyzOut: NodeMaterialConnectionPoint;
  58214. /**
  58215. * Gets the xy component (output)
  58216. */
  58217. readonly xyOut: NodeMaterialConnectionPoint;
  58218. /**
  58219. * Gets the x component (output)
  58220. */
  58221. readonly x: NodeMaterialConnectionPoint;
  58222. /**
  58223. * Gets the y component (output)
  58224. */
  58225. readonly y: NodeMaterialConnectionPoint;
  58226. /**
  58227. * Gets the z component (output)
  58228. */
  58229. readonly z: NodeMaterialConnectionPoint;
  58230. /**
  58231. * Gets the w component (output)
  58232. */
  58233. readonly w: NodeMaterialConnectionPoint;
  58234. protected _inputRename(name: string): string;
  58235. protected _outputRename(name: string): string;
  58236. protected _buildBlock(state: NodeMaterialBuildState): this;
  58237. }
  58238. }
  58239. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  58240. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58241. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58242. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58243. /**
  58244. * Block used to lerp between 2 values
  58245. */
  58246. export class LerpBlock extends NodeMaterialBlock {
  58247. /**
  58248. * Creates a new LerpBlock
  58249. * @param name defines the block name
  58250. */
  58251. constructor(name: string);
  58252. /**
  58253. * Gets the current class name
  58254. * @returns the class name
  58255. */
  58256. getClassName(): string;
  58257. /**
  58258. * Gets the left operand input component
  58259. */
  58260. readonly left: NodeMaterialConnectionPoint;
  58261. /**
  58262. * Gets the right operand input component
  58263. */
  58264. readonly right: NodeMaterialConnectionPoint;
  58265. /**
  58266. * Gets the gradient operand input component
  58267. */
  58268. readonly gradient: NodeMaterialConnectionPoint;
  58269. /**
  58270. * Gets the output component
  58271. */
  58272. readonly output: NodeMaterialConnectionPoint;
  58273. protected _buildBlock(state: NodeMaterialBuildState): this;
  58274. }
  58275. }
  58276. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  58277. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58278. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58279. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58280. /**
  58281. * Block used to divide 2 vectors
  58282. */
  58283. export class DivideBlock extends NodeMaterialBlock {
  58284. /**
  58285. * Creates a new DivideBlock
  58286. * @param name defines the block name
  58287. */
  58288. constructor(name: string);
  58289. /**
  58290. * Gets the current class name
  58291. * @returns the class name
  58292. */
  58293. getClassName(): string;
  58294. /**
  58295. * Gets the left operand input component
  58296. */
  58297. readonly left: NodeMaterialConnectionPoint;
  58298. /**
  58299. * Gets the right operand input component
  58300. */
  58301. readonly right: NodeMaterialConnectionPoint;
  58302. /**
  58303. * Gets the output component
  58304. */
  58305. readonly output: NodeMaterialConnectionPoint;
  58306. protected _buildBlock(state: NodeMaterialBuildState): this;
  58307. }
  58308. }
  58309. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  58310. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58311. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58312. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58313. /**
  58314. * Block used to subtract 2 vectors
  58315. */
  58316. export class SubtractBlock extends NodeMaterialBlock {
  58317. /**
  58318. * Creates a new SubtractBlock
  58319. * @param name defines the block name
  58320. */
  58321. constructor(name: string);
  58322. /**
  58323. * Gets the current class name
  58324. * @returns the class name
  58325. */
  58326. getClassName(): string;
  58327. /**
  58328. * Gets the left operand input component
  58329. */
  58330. readonly left: NodeMaterialConnectionPoint;
  58331. /**
  58332. * Gets the right operand input component
  58333. */
  58334. readonly right: NodeMaterialConnectionPoint;
  58335. /**
  58336. * Gets the output component
  58337. */
  58338. readonly output: NodeMaterialConnectionPoint;
  58339. protected _buildBlock(state: NodeMaterialBuildState): this;
  58340. }
  58341. }
  58342. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  58343. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58344. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58345. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58346. /**
  58347. * Block used to step a value
  58348. */
  58349. export class StepBlock extends NodeMaterialBlock {
  58350. /**
  58351. * Creates a new StepBlock
  58352. * @param name defines the block name
  58353. */
  58354. constructor(name: string);
  58355. /**
  58356. * Gets the current class name
  58357. * @returns the class name
  58358. */
  58359. getClassName(): string;
  58360. /**
  58361. * Gets the value operand input component
  58362. */
  58363. readonly value: NodeMaterialConnectionPoint;
  58364. /**
  58365. * Gets the edge operand input component
  58366. */
  58367. readonly edge: NodeMaterialConnectionPoint;
  58368. /**
  58369. * Gets the output component
  58370. */
  58371. readonly output: NodeMaterialConnectionPoint;
  58372. protected _buildBlock(state: NodeMaterialBuildState): this;
  58373. }
  58374. }
  58375. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  58376. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58377. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58378. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58379. /**
  58380. * Block used to get the opposite (1 - x) of a value
  58381. */
  58382. export class OneMinusBlock extends NodeMaterialBlock {
  58383. /**
  58384. * Creates a new OneMinusBlock
  58385. * @param name defines the block name
  58386. */
  58387. constructor(name: string);
  58388. /**
  58389. * Gets the current class name
  58390. * @returns the class name
  58391. */
  58392. getClassName(): string;
  58393. /**
  58394. * Gets the input component
  58395. */
  58396. readonly input: NodeMaterialConnectionPoint;
  58397. /**
  58398. * Gets the output component
  58399. */
  58400. readonly output: NodeMaterialConnectionPoint;
  58401. protected _buildBlock(state: NodeMaterialBuildState): this;
  58402. }
  58403. }
  58404. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  58405. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58406. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58407. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58408. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58409. /**
  58410. * Block used to get the view direction
  58411. */
  58412. export class ViewDirectionBlock extends NodeMaterialBlock {
  58413. /**
  58414. * Creates a new ViewDirectionBlock
  58415. * @param name defines the block name
  58416. */
  58417. constructor(name: string);
  58418. /**
  58419. * Gets the current class name
  58420. * @returns the class name
  58421. */
  58422. getClassName(): string;
  58423. /**
  58424. * Gets the world position component
  58425. */
  58426. readonly worldPosition: NodeMaterialConnectionPoint;
  58427. /**
  58428. * Gets the camera position component
  58429. */
  58430. readonly cameraPosition: NodeMaterialConnectionPoint;
  58431. /**
  58432. * Gets the output component
  58433. */
  58434. readonly output: NodeMaterialConnectionPoint;
  58435. autoConfigure(material: NodeMaterial): void;
  58436. protected _buildBlock(state: NodeMaterialBuildState): this;
  58437. }
  58438. }
  58439. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  58440. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58441. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58442. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58443. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58444. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  58445. /**
  58446. * Block used to compute fresnel value
  58447. */
  58448. export class FresnelBlock extends NodeMaterialBlock {
  58449. /**
  58450. * Create a new FresnelBlock
  58451. * @param name defines the block name
  58452. */
  58453. constructor(name: string);
  58454. /**
  58455. * Gets the current class name
  58456. * @returns the class name
  58457. */
  58458. getClassName(): string;
  58459. /**
  58460. * Gets the world normal input component
  58461. */
  58462. readonly worldNormal: NodeMaterialConnectionPoint;
  58463. /**
  58464. * Gets the view direction input component
  58465. */
  58466. readonly viewDirection: NodeMaterialConnectionPoint;
  58467. /**
  58468. * Gets the bias input component
  58469. */
  58470. readonly bias: NodeMaterialConnectionPoint;
  58471. /**
  58472. * Gets the camera (or eye) position component
  58473. */
  58474. readonly power: NodeMaterialConnectionPoint;
  58475. /**
  58476. * Gets the fresnel output component
  58477. */
  58478. readonly fresnel: NodeMaterialConnectionPoint;
  58479. autoConfigure(material: NodeMaterial): void;
  58480. protected _buildBlock(state: NodeMaterialBuildState): this;
  58481. }
  58482. }
  58483. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  58484. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58485. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58486. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58487. /**
  58488. * Block used to get the max of 2 values
  58489. */
  58490. export class MaxBlock extends NodeMaterialBlock {
  58491. /**
  58492. * Creates a new MaxBlock
  58493. * @param name defines the block name
  58494. */
  58495. constructor(name: string);
  58496. /**
  58497. * Gets the current class name
  58498. * @returns the class name
  58499. */
  58500. getClassName(): string;
  58501. /**
  58502. * Gets the left operand input component
  58503. */
  58504. readonly left: NodeMaterialConnectionPoint;
  58505. /**
  58506. * Gets the right operand input component
  58507. */
  58508. readonly right: NodeMaterialConnectionPoint;
  58509. /**
  58510. * Gets the output component
  58511. */
  58512. readonly output: NodeMaterialConnectionPoint;
  58513. protected _buildBlock(state: NodeMaterialBuildState): this;
  58514. }
  58515. }
  58516. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  58517. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58518. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58519. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58520. /**
  58521. * Block used to get the min of 2 values
  58522. */
  58523. export class MinBlock extends NodeMaterialBlock {
  58524. /**
  58525. * Creates a new MinBlock
  58526. * @param name defines the block name
  58527. */
  58528. constructor(name: string);
  58529. /**
  58530. * Gets the current class name
  58531. * @returns the class name
  58532. */
  58533. getClassName(): string;
  58534. /**
  58535. * Gets the left operand input component
  58536. */
  58537. readonly left: NodeMaterialConnectionPoint;
  58538. /**
  58539. * Gets the right operand input component
  58540. */
  58541. readonly right: NodeMaterialConnectionPoint;
  58542. /**
  58543. * Gets the output component
  58544. */
  58545. readonly output: NodeMaterialConnectionPoint;
  58546. protected _buildBlock(state: NodeMaterialBuildState): this;
  58547. }
  58548. }
  58549. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  58550. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58551. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58552. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58553. /**
  58554. * Block used to get the distance between 2 values
  58555. */
  58556. export class DistanceBlock extends NodeMaterialBlock {
  58557. /**
  58558. * Creates a new DistanceBlock
  58559. * @param name defines the block name
  58560. */
  58561. constructor(name: string);
  58562. /**
  58563. * Gets the current class name
  58564. * @returns the class name
  58565. */
  58566. getClassName(): string;
  58567. /**
  58568. * Gets the left operand input component
  58569. */
  58570. readonly left: NodeMaterialConnectionPoint;
  58571. /**
  58572. * Gets the right operand input component
  58573. */
  58574. readonly right: NodeMaterialConnectionPoint;
  58575. /**
  58576. * Gets the output component
  58577. */
  58578. readonly output: NodeMaterialConnectionPoint;
  58579. protected _buildBlock(state: NodeMaterialBuildState): this;
  58580. }
  58581. }
  58582. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  58583. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58584. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58585. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58586. /**
  58587. * Block used to get the length of a vector
  58588. */
  58589. export class LengthBlock extends NodeMaterialBlock {
  58590. /**
  58591. * Creates a new LengthBlock
  58592. * @param name defines the block name
  58593. */
  58594. constructor(name: string);
  58595. /**
  58596. * Gets the current class name
  58597. * @returns the class name
  58598. */
  58599. getClassName(): string;
  58600. /**
  58601. * Gets the value input component
  58602. */
  58603. readonly value: NodeMaterialConnectionPoint;
  58604. /**
  58605. * Gets the output component
  58606. */
  58607. readonly output: NodeMaterialConnectionPoint;
  58608. protected _buildBlock(state: NodeMaterialBuildState): this;
  58609. }
  58610. }
  58611. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  58612. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58613. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58614. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58615. /**
  58616. * Block used to get negative version of a value (i.e. x * -1)
  58617. */
  58618. export class NegateBlock extends NodeMaterialBlock {
  58619. /**
  58620. * Creates a new NegateBlock
  58621. * @param name defines the block name
  58622. */
  58623. constructor(name: string);
  58624. /**
  58625. * Gets the current class name
  58626. * @returns the class name
  58627. */
  58628. getClassName(): string;
  58629. /**
  58630. * Gets the value input component
  58631. */
  58632. readonly value: NodeMaterialConnectionPoint;
  58633. /**
  58634. * Gets the output component
  58635. */
  58636. readonly output: NodeMaterialConnectionPoint;
  58637. protected _buildBlock(state: NodeMaterialBuildState): this;
  58638. }
  58639. }
  58640. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  58641. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58642. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58643. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58644. /**
  58645. * Block used to get the value of the first parameter raised to the power of the second
  58646. */
  58647. export class PowBlock extends NodeMaterialBlock {
  58648. /**
  58649. * Creates a new PowBlock
  58650. * @param name defines the block name
  58651. */
  58652. constructor(name: string);
  58653. /**
  58654. * Gets the current class name
  58655. * @returns the class name
  58656. */
  58657. getClassName(): string;
  58658. /**
  58659. * Gets the value operand input component
  58660. */
  58661. readonly value: NodeMaterialConnectionPoint;
  58662. /**
  58663. * Gets the power operand input component
  58664. */
  58665. readonly power: NodeMaterialConnectionPoint;
  58666. /**
  58667. * Gets the output component
  58668. */
  58669. readonly output: NodeMaterialConnectionPoint;
  58670. protected _buildBlock(state: NodeMaterialBuildState): this;
  58671. }
  58672. }
  58673. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  58674. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58675. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58676. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58677. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58678. /**
  58679. * Block used to get a random number
  58680. */
  58681. export class RandomNumberBlock extends NodeMaterialBlock {
  58682. /**
  58683. * Creates a new RandomNumberBlock
  58684. * @param name defines the block name
  58685. */
  58686. constructor(name: string);
  58687. /**
  58688. * Gets the current class name
  58689. * @returns the class name
  58690. */
  58691. getClassName(): string;
  58692. /**
  58693. * Gets the seed input component
  58694. */
  58695. readonly seed: NodeMaterialConnectionPoint;
  58696. /**
  58697. * Gets the output component
  58698. */
  58699. readonly output: NodeMaterialConnectionPoint;
  58700. protected _buildBlock(state: NodeMaterialBuildState): this;
  58701. }
  58702. }
  58703. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  58704. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58705. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58706. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58707. /**
  58708. * Block used to compute arc tangent of 2 values
  58709. */
  58710. export class ArcTan2Block extends NodeMaterialBlock {
  58711. /**
  58712. * Creates a new ArcTan2Block
  58713. * @param name defines the block name
  58714. */
  58715. constructor(name: string);
  58716. /**
  58717. * Gets the current class name
  58718. * @returns the class name
  58719. */
  58720. getClassName(): string;
  58721. /**
  58722. * Gets the x operand input component
  58723. */
  58724. readonly x: NodeMaterialConnectionPoint;
  58725. /**
  58726. * Gets the y operand input component
  58727. */
  58728. readonly y: NodeMaterialConnectionPoint;
  58729. /**
  58730. * Gets the output component
  58731. */
  58732. readonly output: NodeMaterialConnectionPoint;
  58733. protected _buildBlock(state: NodeMaterialBuildState): this;
  58734. }
  58735. }
  58736. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  58737. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58738. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58739. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58740. /**
  58741. * Block used to smooth step a value
  58742. */
  58743. export class SmoothStepBlock extends NodeMaterialBlock {
  58744. /**
  58745. * Creates a new SmoothStepBlock
  58746. * @param name defines the block name
  58747. */
  58748. constructor(name: string);
  58749. /**
  58750. * Gets the current class name
  58751. * @returns the class name
  58752. */
  58753. getClassName(): string;
  58754. /**
  58755. * Gets the value operand input component
  58756. */
  58757. readonly value: NodeMaterialConnectionPoint;
  58758. /**
  58759. * Gets the first edge operand input component
  58760. */
  58761. readonly edge0: NodeMaterialConnectionPoint;
  58762. /**
  58763. * Gets the second edge operand input component
  58764. */
  58765. readonly edge1: NodeMaterialConnectionPoint;
  58766. /**
  58767. * Gets the output component
  58768. */
  58769. readonly output: NodeMaterialConnectionPoint;
  58770. protected _buildBlock(state: NodeMaterialBuildState): this;
  58771. }
  58772. }
  58773. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  58774. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58775. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58776. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58777. /**
  58778. * Block used to get the reciprocal (1 / x) of a value
  58779. */
  58780. export class ReciprocalBlock extends NodeMaterialBlock {
  58781. /**
  58782. * Creates a new ReciprocalBlock
  58783. * @param name defines the block name
  58784. */
  58785. constructor(name: string);
  58786. /**
  58787. * Gets the current class name
  58788. * @returns the class name
  58789. */
  58790. getClassName(): string;
  58791. /**
  58792. * Gets the input component
  58793. */
  58794. readonly input: NodeMaterialConnectionPoint;
  58795. /**
  58796. * Gets the output component
  58797. */
  58798. readonly output: NodeMaterialConnectionPoint;
  58799. protected _buildBlock(state: NodeMaterialBuildState): this;
  58800. }
  58801. }
  58802. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  58803. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58804. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58805. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58806. /**
  58807. * Block used to replace a color by another one
  58808. */
  58809. export class ReplaceColorBlock extends NodeMaterialBlock {
  58810. /**
  58811. * Creates a new ReplaceColorBlock
  58812. * @param name defines the block name
  58813. */
  58814. constructor(name: string);
  58815. /**
  58816. * Gets the current class name
  58817. * @returns the class name
  58818. */
  58819. getClassName(): string;
  58820. /**
  58821. * Gets the value input component
  58822. */
  58823. readonly value: NodeMaterialConnectionPoint;
  58824. /**
  58825. * Gets the reference input component
  58826. */
  58827. readonly reference: NodeMaterialConnectionPoint;
  58828. /**
  58829. * Gets the distance input component
  58830. */
  58831. readonly distance: NodeMaterialConnectionPoint;
  58832. /**
  58833. * Gets the replacement input component
  58834. */
  58835. readonly replacement: NodeMaterialConnectionPoint;
  58836. /**
  58837. * Gets the output component
  58838. */
  58839. readonly output: NodeMaterialConnectionPoint;
  58840. protected _buildBlock(state: NodeMaterialBuildState): this;
  58841. }
  58842. }
  58843. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  58844. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58845. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58846. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58847. /**
  58848. * Block used to posterize a value
  58849. * @see https://en.wikipedia.org/wiki/Posterization
  58850. */
  58851. export class PosterizeBlock extends NodeMaterialBlock {
  58852. /**
  58853. * Creates a new PosterizeBlock
  58854. * @param name defines the block name
  58855. */
  58856. constructor(name: string);
  58857. /**
  58858. * Gets the current class name
  58859. * @returns the class name
  58860. */
  58861. getClassName(): string;
  58862. /**
  58863. * Gets the value input component
  58864. */
  58865. readonly value: NodeMaterialConnectionPoint;
  58866. /**
  58867. * Gets the steps input component
  58868. */
  58869. readonly steps: NodeMaterialConnectionPoint;
  58870. /**
  58871. * Gets the output component
  58872. */
  58873. readonly output: NodeMaterialConnectionPoint;
  58874. protected _buildBlock(state: NodeMaterialBuildState): this;
  58875. }
  58876. }
  58877. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  58878. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58879. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58880. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58881. import { Scene } from "babylonjs/scene";
  58882. /**
  58883. * Operations supported by the Wave block
  58884. */
  58885. export enum WaveBlockKind {
  58886. /** SawTooth */
  58887. SawTooth = 0,
  58888. /** Square */
  58889. Square = 1,
  58890. /** Triangle */
  58891. Triangle = 2
  58892. }
  58893. /**
  58894. * Block used to apply wave operation to floats
  58895. */
  58896. export class WaveBlock extends NodeMaterialBlock {
  58897. /**
  58898. * Gets or sets the kibnd of wave to be applied by the block
  58899. */
  58900. kind: WaveBlockKind;
  58901. /**
  58902. * Creates a new WaveBlock
  58903. * @param name defines the block name
  58904. */
  58905. constructor(name: string);
  58906. /**
  58907. * Gets the current class name
  58908. * @returns the class name
  58909. */
  58910. getClassName(): string;
  58911. /**
  58912. * Gets the input component
  58913. */
  58914. readonly input: NodeMaterialConnectionPoint;
  58915. /**
  58916. * Gets the output component
  58917. */
  58918. readonly output: NodeMaterialConnectionPoint;
  58919. protected _buildBlock(state: NodeMaterialBuildState): this;
  58920. serialize(): any;
  58921. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58922. }
  58923. }
  58924. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  58925. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58926. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58927. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58928. import { Color3 } from "babylonjs/Maths/math.color";
  58929. import { Scene } from "babylonjs/scene";
  58930. /**
  58931. * Class used to store a color step for the GradientBlock
  58932. */
  58933. export class GradientBlockColorStep {
  58934. /**
  58935. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  58936. */
  58937. step: number;
  58938. /**
  58939. * Gets or sets the color associated with this step
  58940. */
  58941. color: Color3;
  58942. /**
  58943. * Creates a new GradientBlockColorStep
  58944. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  58945. * @param color defines the color associated with this step
  58946. */
  58947. constructor(
  58948. /**
  58949. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  58950. */
  58951. step: number,
  58952. /**
  58953. * Gets or sets the color associated with this step
  58954. */
  58955. color: Color3);
  58956. }
  58957. /**
  58958. * Block used to return a color from a gradient based on an input value between 0 and 1
  58959. */
  58960. export class GradientBlock extends NodeMaterialBlock {
  58961. /**
  58962. * Gets or sets the list of color steps
  58963. */
  58964. colorSteps: GradientBlockColorStep[];
  58965. /**
  58966. * Creates a new GradientBlock
  58967. * @param name defines the block name
  58968. */
  58969. constructor(name: string);
  58970. /**
  58971. * Gets the current class name
  58972. * @returns the class name
  58973. */
  58974. getClassName(): string;
  58975. /**
  58976. * Gets the gradient input component
  58977. */
  58978. readonly gradient: NodeMaterialConnectionPoint;
  58979. /**
  58980. * Gets the output component
  58981. */
  58982. readonly output: NodeMaterialConnectionPoint;
  58983. private _writeColorConstant;
  58984. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  58985. serialize(): any;
  58986. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58987. protected _dumpPropertiesCode(): string;
  58988. }
  58989. }
  58990. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  58991. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58992. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58993. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58994. /**
  58995. * Block used to normalize lerp between 2 values
  58996. */
  58997. export class NLerpBlock extends NodeMaterialBlock {
  58998. /**
  58999. * Creates a new NLerpBlock
  59000. * @param name defines the block name
  59001. */
  59002. constructor(name: string);
  59003. /**
  59004. * Gets the current class name
  59005. * @returns the class name
  59006. */
  59007. getClassName(): string;
  59008. /**
  59009. * Gets the left operand input component
  59010. */
  59011. readonly left: NodeMaterialConnectionPoint;
  59012. /**
  59013. * Gets the right operand input component
  59014. */
  59015. readonly right: NodeMaterialConnectionPoint;
  59016. /**
  59017. * Gets the gradient operand input component
  59018. */
  59019. readonly gradient: NodeMaterialConnectionPoint;
  59020. /**
  59021. * Gets the output component
  59022. */
  59023. readonly output: NodeMaterialConnectionPoint;
  59024. protected _buildBlock(state: NodeMaterialBuildState): this;
  59025. }
  59026. }
  59027. declare module "babylonjs/Materials/Node/Blocks/index" {
  59028. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  59029. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  59030. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  59031. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  59032. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  59033. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  59034. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  59035. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  59036. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  59037. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  59038. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  59039. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  59040. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  59041. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  59042. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  59043. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  59044. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  59045. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  59046. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  59047. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  59048. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  59049. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  59050. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  59051. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  59052. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  59053. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  59054. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  59055. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  59056. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  59057. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  59058. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  59059. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  59060. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  59061. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  59062. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  59063. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  59064. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  59065. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  59066. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  59067. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  59068. }
  59069. declare module "babylonjs/Materials/Node/Optimizers/index" {
  59070. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  59071. }
  59072. declare module "babylonjs/Materials/Node/index" {
  59073. export * from "babylonjs/Materials/Node/Enums/index";
  59074. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59075. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  59076. export * from "babylonjs/Materials/Node/nodeMaterial";
  59077. export * from "babylonjs/Materials/Node/Blocks/index";
  59078. export * from "babylonjs/Materials/Node/Optimizers/index";
  59079. }
  59080. declare module "babylonjs/Materials/effectRenderer" {
  59081. import { Nullable } from "babylonjs/types";
  59082. import { Texture } from "babylonjs/Materials/Textures/texture";
  59083. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59084. import { Viewport } from "babylonjs/Maths/math.viewport";
  59085. import { Observable } from "babylonjs/Misc/observable";
  59086. import { Effect } from "babylonjs/Materials/effect";
  59087. import "babylonjs/Engines/Extensions/engine.renderTarget";
  59088. import "babylonjs/Shaders/postprocess.vertex";
  59089. /**
  59090. * Effect Render Options
  59091. */
  59092. export interface IEffectRendererOptions {
  59093. /**
  59094. * Defines the vertices positions.
  59095. */
  59096. positions?: number[];
  59097. /**
  59098. * Defines the indices.
  59099. */
  59100. indices?: number[];
  59101. }
  59102. /**
  59103. * Helper class to render one or more effects
  59104. */
  59105. export class EffectRenderer {
  59106. private engine;
  59107. private static _DefaultOptions;
  59108. private _vertexBuffers;
  59109. private _indexBuffer;
  59110. private _ringBufferIndex;
  59111. private _ringScreenBuffer;
  59112. private _fullscreenViewport;
  59113. private _getNextFrameBuffer;
  59114. /**
  59115. * Creates an effect renderer
  59116. * @param engine the engine to use for rendering
  59117. * @param options defines the options of the effect renderer
  59118. */
  59119. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  59120. /**
  59121. * Sets the current viewport in normalized coordinates 0-1
  59122. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  59123. */
  59124. setViewport(viewport?: Viewport): void;
  59125. /**
  59126. * Binds the embedded attributes buffer to the effect.
  59127. * @param effect Defines the effect to bind the attributes for
  59128. */
  59129. bindBuffers(effect: Effect): void;
  59130. /**
  59131. * Sets the current effect wrapper to use during draw.
  59132. * The effect needs to be ready before calling this api.
  59133. * This also sets the default full screen position attribute.
  59134. * @param effectWrapper Defines the effect to draw with
  59135. */
  59136. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  59137. /**
  59138. * Draws a full screen quad.
  59139. */
  59140. draw(): void;
  59141. /**
  59142. * renders one or more effects to a specified texture
  59143. * @param effectWrappers list of effects to renderer
  59144. * @param outputTexture texture to draw to, if null it will render to the screen
  59145. */
  59146. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  59147. /**
  59148. * Disposes of the effect renderer
  59149. */
  59150. dispose(): void;
  59151. }
  59152. /**
  59153. * Options to create an EffectWrapper
  59154. */
  59155. interface EffectWrapperCreationOptions {
  59156. /**
  59157. * Engine to use to create the effect
  59158. */
  59159. engine: ThinEngine;
  59160. /**
  59161. * Fragment shader for the effect
  59162. */
  59163. fragmentShader: string;
  59164. /**
  59165. * Vertex shader for the effect
  59166. */
  59167. vertexShader?: string;
  59168. /**
  59169. * Attributes to use in the shader
  59170. */
  59171. attributeNames?: Array<string>;
  59172. /**
  59173. * Uniforms to use in the shader
  59174. */
  59175. uniformNames?: Array<string>;
  59176. /**
  59177. * Texture sampler names to use in the shader
  59178. */
  59179. samplerNames?: Array<string>;
  59180. /**
  59181. * The friendly name of the effect displayed in Spector.
  59182. */
  59183. name?: string;
  59184. }
  59185. /**
  59186. * Wraps an effect to be used for rendering
  59187. */
  59188. export class EffectWrapper {
  59189. /**
  59190. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  59191. */
  59192. onApplyObservable: Observable<{}>;
  59193. /**
  59194. * The underlying effect
  59195. */
  59196. effect: Effect;
  59197. /**
  59198. * Creates an effect to be renderer
  59199. * @param creationOptions options to create the effect
  59200. */
  59201. constructor(creationOptions: EffectWrapperCreationOptions);
  59202. /**
  59203. * Disposes of the effect wrapper
  59204. */
  59205. dispose(): void;
  59206. }
  59207. }
  59208. declare module "babylonjs/Materials/index" {
  59209. export * from "babylonjs/Materials/Background/index";
  59210. export * from "babylonjs/Materials/colorCurves";
  59211. export * from "babylonjs/Materials/iEffectFallbacks";
  59212. export * from "babylonjs/Materials/effectFallbacks";
  59213. export * from "babylonjs/Materials/effect";
  59214. export * from "babylonjs/Materials/fresnelParameters";
  59215. export * from "babylonjs/Materials/imageProcessingConfiguration";
  59216. export * from "babylonjs/Materials/material";
  59217. export * from "babylonjs/Materials/materialDefines";
  59218. export * from "babylonjs/Materials/materialHelper";
  59219. export * from "babylonjs/Materials/multiMaterial";
  59220. export * from "babylonjs/Materials/PBR/index";
  59221. export * from "babylonjs/Materials/pushMaterial";
  59222. export * from "babylonjs/Materials/shaderMaterial";
  59223. export * from "babylonjs/Materials/standardMaterial";
  59224. export * from "babylonjs/Materials/Textures/index";
  59225. export * from "babylonjs/Materials/uniformBuffer";
  59226. export * from "babylonjs/Materials/materialFlags";
  59227. export * from "babylonjs/Materials/Node/index";
  59228. export * from "babylonjs/Materials/effectRenderer";
  59229. }
  59230. declare module "babylonjs/Maths/index" {
  59231. export * from "babylonjs/Maths/math.scalar";
  59232. export * from "babylonjs/Maths/math";
  59233. export * from "babylonjs/Maths/sphericalPolynomial";
  59234. }
  59235. declare module "babylonjs/Misc/workerPool" {
  59236. import { IDisposable } from "babylonjs/scene";
  59237. /**
  59238. * Helper class to push actions to a pool of workers.
  59239. */
  59240. export class WorkerPool implements IDisposable {
  59241. private _workerInfos;
  59242. private _pendingActions;
  59243. /**
  59244. * Constructor
  59245. * @param workers Array of workers to use for actions
  59246. */
  59247. constructor(workers: Array<Worker>);
  59248. /**
  59249. * Terminates all workers and clears any pending actions.
  59250. */
  59251. dispose(): void;
  59252. /**
  59253. * Pushes an action to the worker pool. If all the workers are active, the action will be
  59254. * pended until a worker has completed its action.
  59255. * @param action The action to perform. Call onComplete when the action is complete.
  59256. */
  59257. push(action: (worker: Worker, onComplete: () => void) => void): void;
  59258. private _execute;
  59259. }
  59260. }
  59261. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  59262. import { IDisposable } from "babylonjs/scene";
  59263. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  59264. /**
  59265. * Configuration for Draco compression
  59266. */
  59267. export interface IDracoCompressionConfiguration {
  59268. /**
  59269. * Configuration for the decoder.
  59270. */
  59271. decoder: {
  59272. /**
  59273. * The url to the WebAssembly module.
  59274. */
  59275. wasmUrl?: string;
  59276. /**
  59277. * The url to the WebAssembly binary.
  59278. */
  59279. wasmBinaryUrl?: string;
  59280. /**
  59281. * The url to the fallback JavaScript module.
  59282. */
  59283. fallbackUrl?: string;
  59284. };
  59285. }
  59286. /**
  59287. * Draco compression (https://google.github.io/draco/)
  59288. *
  59289. * This class wraps the Draco module.
  59290. *
  59291. * **Encoder**
  59292. *
  59293. * The encoder is not currently implemented.
  59294. *
  59295. * **Decoder**
  59296. *
  59297. * By default, the configuration points to a copy of the Draco decoder files for glTF from the babylon.js preview cdn https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js.
  59298. *
  59299. * To update the configuration, use the following code:
  59300. * ```javascript
  59301. * DracoCompression.Configuration = {
  59302. * decoder: {
  59303. * wasmUrl: "<url to the WebAssembly library>",
  59304. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  59305. * fallbackUrl: "<url to the fallback JavaScript library>",
  59306. * }
  59307. * };
  59308. * ```
  59309. *
  59310. * Draco has two versions, one for WebAssembly and one for JavaScript. The decoder configuration can be set to only support Webssembly or only support the JavaScript version.
  59311. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  59312. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  59313. *
  59314. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  59315. * ```javascript
  59316. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  59317. * ```
  59318. *
  59319. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  59320. */
  59321. export class DracoCompression implements IDisposable {
  59322. private _workerPoolPromise?;
  59323. private _decoderModulePromise?;
  59324. /**
  59325. * The configuration. Defaults to the following urls:
  59326. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  59327. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  59328. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  59329. */
  59330. static Configuration: IDracoCompressionConfiguration;
  59331. /**
  59332. * Returns true if the decoder configuration is available.
  59333. */
  59334. static readonly DecoderAvailable: boolean;
  59335. /**
  59336. * Default number of workers to create when creating the draco compression object.
  59337. */
  59338. static DefaultNumWorkers: number;
  59339. private static GetDefaultNumWorkers;
  59340. private static _Default;
  59341. /**
  59342. * Default instance for the draco compression object.
  59343. */
  59344. static readonly Default: DracoCompression;
  59345. /**
  59346. * Constructor
  59347. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  59348. */
  59349. constructor(numWorkers?: number);
  59350. /**
  59351. * Stop all async operations and release resources.
  59352. */
  59353. dispose(): void;
  59354. /**
  59355. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  59356. * @returns a promise that resolves when ready
  59357. */
  59358. whenReadyAsync(): Promise<void>;
  59359. /**
  59360. * Decode Draco compressed mesh data to vertex data.
  59361. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  59362. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  59363. * @returns A promise that resolves with the decoded vertex data
  59364. */
  59365. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  59366. [kind: string]: number;
  59367. }): Promise<VertexData>;
  59368. }
  59369. }
  59370. declare module "babylonjs/Meshes/Compression/index" {
  59371. export * from "babylonjs/Meshes/Compression/dracoCompression";
  59372. }
  59373. declare module "babylonjs/Meshes/csg" {
  59374. import { Nullable } from "babylonjs/types";
  59375. import { Scene } from "babylonjs/scene";
  59376. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  59377. import { Mesh } from "babylonjs/Meshes/mesh";
  59378. import { Material } from "babylonjs/Materials/material";
  59379. /**
  59380. * Class for building Constructive Solid Geometry
  59381. */
  59382. export class CSG {
  59383. private polygons;
  59384. /**
  59385. * The world matrix
  59386. */
  59387. matrix: Matrix;
  59388. /**
  59389. * Stores the position
  59390. */
  59391. position: Vector3;
  59392. /**
  59393. * Stores the rotation
  59394. */
  59395. rotation: Vector3;
  59396. /**
  59397. * Stores the rotation quaternion
  59398. */
  59399. rotationQuaternion: Nullable<Quaternion>;
  59400. /**
  59401. * Stores the scaling vector
  59402. */
  59403. scaling: Vector3;
  59404. /**
  59405. * Convert the Mesh to CSG
  59406. * @param mesh The Mesh to convert to CSG
  59407. * @returns A new CSG from the Mesh
  59408. */
  59409. static FromMesh(mesh: Mesh): CSG;
  59410. /**
  59411. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  59412. * @param polygons Polygons used to construct a CSG solid
  59413. */
  59414. private static FromPolygons;
  59415. /**
  59416. * Clones, or makes a deep copy, of the CSG
  59417. * @returns A new CSG
  59418. */
  59419. clone(): CSG;
  59420. /**
  59421. * Unions this CSG with another CSG
  59422. * @param csg The CSG to union against this CSG
  59423. * @returns The unioned CSG
  59424. */
  59425. union(csg: CSG): CSG;
  59426. /**
  59427. * Unions this CSG with another CSG in place
  59428. * @param csg The CSG to union against this CSG
  59429. */
  59430. unionInPlace(csg: CSG): void;
  59431. /**
  59432. * Subtracts this CSG with another CSG
  59433. * @param csg The CSG to subtract against this CSG
  59434. * @returns A new CSG
  59435. */
  59436. subtract(csg: CSG): CSG;
  59437. /**
  59438. * Subtracts this CSG with another CSG in place
  59439. * @param csg The CSG to subtact against this CSG
  59440. */
  59441. subtractInPlace(csg: CSG): void;
  59442. /**
  59443. * Intersect this CSG with another CSG
  59444. * @param csg The CSG to intersect against this CSG
  59445. * @returns A new CSG
  59446. */
  59447. intersect(csg: CSG): CSG;
  59448. /**
  59449. * Intersects this CSG with another CSG in place
  59450. * @param csg The CSG to intersect against this CSG
  59451. */
  59452. intersectInPlace(csg: CSG): void;
  59453. /**
  59454. * Return a new CSG solid with solid and empty space switched. This solid is
  59455. * not modified.
  59456. * @returns A new CSG solid with solid and empty space switched
  59457. */
  59458. inverse(): CSG;
  59459. /**
  59460. * Inverses the CSG in place
  59461. */
  59462. inverseInPlace(): void;
  59463. /**
  59464. * This is used to keep meshes transformations so they can be restored
  59465. * when we build back a Babylon Mesh
  59466. * NB : All CSG operations are performed in world coordinates
  59467. * @param csg The CSG to copy the transform attributes from
  59468. * @returns This CSG
  59469. */
  59470. copyTransformAttributes(csg: CSG): CSG;
  59471. /**
  59472. * Build Raw mesh from CSG
  59473. * Coordinates here are in world space
  59474. * @param name The name of the mesh geometry
  59475. * @param scene The Scene
  59476. * @param keepSubMeshes Specifies if the submeshes should be kept
  59477. * @returns A new Mesh
  59478. */
  59479. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  59480. /**
  59481. * Build Mesh from CSG taking material and transforms into account
  59482. * @param name The name of the Mesh
  59483. * @param material The material of the Mesh
  59484. * @param scene The Scene
  59485. * @param keepSubMeshes Specifies if submeshes should be kept
  59486. * @returns The new Mesh
  59487. */
  59488. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  59489. }
  59490. }
  59491. declare module "babylonjs/Meshes/trailMesh" {
  59492. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59493. import { Mesh } from "babylonjs/Meshes/mesh";
  59494. import { Scene } from "babylonjs/scene";
  59495. /**
  59496. * Class used to create a trail following a mesh
  59497. */
  59498. export class TrailMesh extends Mesh {
  59499. private _generator;
  59500. private _autoStart;
  59501. private _running;
  59502. private _diameter;
  59503. private _length;
  59504. private _sectionPolygonPointsCount;
  59505. private _sectionVectors;
  59506. private _sectionNormalVectors;
  59507. private _beforeRenderObserver;
  59508. /**
  59509. * @constructor
  59510. * @param name The value used by scene.getMeshByName() to do a lookup.
  59511. * @param generator The mesh to generate a trail.
  59512. * @param scene The scene to add this mesh to.
  59513. * @param diameter Diameter of trailing mesh. Default is 1.
  59514. * @param length Length of trailing mesh. Default is 60.
  59515. * @param autoStart Automatically start trailing mesh. Default true.
  59516. */
  59517. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  59518. /**
  59519. * "TrailMesh"
  59520. * @returns "TrailMesh"
  59521. */
  59522. getClassName(): string;
  59523. private _createMesh;
  59524. /**
  59525. * Start trailing mesh.
  59526. */
  59527. start(): void;
  59528. /**
  59529. * Stop trailing mesh.
  59530. */
  59531. stop(): void;
  59532. /**
  59533. * Update trailing mesh geometry.
  59534. */
  59535. update(): void;
  59536. /**
  59537. * Returns a new TrailMesh object.
  59538. * @param name is a string, the name given to the new mesh
  59539. * @param newGenerator use new generator object for cloned trail mesh
  59540. * @returns a new mesh
  59541. */
  59542. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  59543. /**
  59544. * Serializes this trail mesh
  59545. * @param serializationObject object to write serialization to
  59546. */
  59547. serialize(serializationObject: any): void;
  59548. /**
  59549. * Parses a serialized trail mesh
  59550. * @param parsedMesh the serialized mesh
  59551. * @param scene the scene to create the trail mesh in
  59552. * @returns the created trail mesh
  59553. */
  59554. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  59555. }
  59556. }
  59557. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  59558. import { Nullable } from "babylonjs/types";
  59559. import { Scene } from "babylonjs/scene";
  59560. import { Vector4 } from "babylonjs/Maths/math.vector";
  59561. import { Color4 } from "babylonjs/Maths/math.color";
  59562. import { Mesh } from "babylonjs/Meshes/mesh";
  59563. /**
  59564. * Class containing static functions to help procedurally build meshes
  59565. */
  59566. export class TiledBoxBuilder {
  59567. /**
  59568. * Creates a box mesh
  59569. * faceTiles sets the pattern, tile size and number of tiles for a face * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of 6 Color3 elements) and `faceUV` (an array of 6 Vector4 elements)
  59570. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  59571. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59572. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59573. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59574. * @param name defines the name of the mesh
  59575. * @param options defines the options used to create the mesh
  59576. * @param scene defines the hosting scene
  59577. * @returns the box mesh
  59578. */
  59579. static CreateTiledBox(name: string, options: {
  59580. pattern?: number;
  59581. width?: number;
  59582. height?: number;
  59583. depth?: number;
  59584. tileSize?: number;
  59585. tileWidth?: number;
  59586. tileHeight?: number;
  59587. alignHorizontal?: number;
  59588. alignVertical?: number;
  59589. faceUV?: Vector4[];
  59590. faceColors?: Color4[];
  59591. sideOrientation?: number;
  59592. updatable?: boolean;
  59593. }, scene?: Nullable<Scene>): Mesh;
  59594. }
  59595. }
  59596. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  59597. import { Vector4 } from "babylonjs/Maths/math.vector";
  59598. import { Mesh } from "babylonjs/Meshes/mesh";
  59599. /**
  59600. * Class containing static functions to help procedurally build meshes
  59601. */
  59602. export class TorusKnotBuilder {
  59603. /**
  59604. * Creates a torus knot mesh
  59605. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  59606. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  59607. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  59608. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  59609. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59610. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59611. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59612. * @param name defines the name of the mesh
  59613. * @param options defines the options used to create the mesh
  59614. * @param scene defines the hosting scene
  59615. * @returns the torus knot mesh
  59616. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  59617. */
  59618. static CreateTorusKnot(name: string, options: {
  59619. radius?: number;
  59620. tube?: number;
  59621. radialSegments?: number;
  59622. tubularSegments?: number;
  59623. p?: number;
  59624. q?: number;
  59625. updatable?: boolean;
  59626. sideOrientation?: number;
  59627. frontUVs?: Vector4;
  59628. backUVs?: Vector4;
  59629. }, scene: any): Mesh;
  59630. }
  59631. }
  59632. declare module "babylonjs/Meshes/polygonMesh" {
  59633. import { Scene } from "babylonjs/scene";
  59634. import { Vector2 } from "babylonjs/Maths/math.vector";
  59635. import { Mesh } from "babylonjs/Meshes/mesh";
  59636. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  59637. import { Path2 } from "babylonjs/Maths/math.path";
  59638. /**
  59639. * Polygon
  59640. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  59641. */
  59642. export class Polygon {
  59643. /**
  59644. * Creates a rectangle
  59645. * @param xmin bottom X coord
  59646. * @param ymin bottom Y coord
  59647. * @param xmax top X coord
  59648. * @param ymax top Y coord
  59649. * @returns points that make the resulting rectation
  59650. */
  59651. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  59652. /**
  59653. * Creates a circle
  59654. * @param radius radius of circle
  59655. * @param cx scale in x
  59656. * @param cy scale in y
  59657. * @param numberOfSides number of sides that make up the circle
  59658. * @returns points that make the resulting circle
  59659. */
  59660. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  59661. /**
  59662. * Creates a polygon from input string
  59663. * @param input Input polygon data
  59664. * @returns the parsed points
  59665. */
  59666. static Parse(input: string): Vector2[];
  59667. /**
  59668. * Starts building a polygon from x and y coordinates
  59669. * @param x x coordinate
  59670. * @param y y coordinate
  59671. * @returns the started path2
  59672. */
  59673. static StartingAt(x: number, y: number): Path2;
  59674. }
  59675. /**
  59676. * Builds a polygon
  59677. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  59678. */
  59679. export class PolygonMeshBuilder {
  59680. private _points;
  59681. private _outlinepoints;
  59682. private _holes;
  59683. private _name;
  59684. private _scene;
  59685. private _epoints;
  59686. private _eholes;
  59687. private _addToepoint;
  59688. /**
  59689. * Babylon reference to the earcut plugin.
  59690. */
  59691. bjsEarcut: any;
  59692. /**
  59693. * Creates a PolygonMeshBuilder
  59694. * @param name name of the builder
  59695. * @param contours Path of the polygon
  59696. * @param scene scene to add to when creating the mesh
  59697. * @param earcutInjection can be used to inject your own earcut reference
  59698. */
  59699. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  59700. /**
  59701. * Adds a whole within the polygon
  59702. * @param hole Array of points defining the hole
  59703. * @returns this
  59704. */
  59705. addHole(hole: Vector2[]): PolygonMeshBuilder;
  59706. /**
  59707. * Creates the polygon
  59708. * @param updatable If the mesh should be updatable
  59709. * @param depth The depth of the mesh created
  59710. * @returns the created mesh
  59711. */
  59712. build(updatable?: boolean, depth?: number): Mesh;
  59713. /**
  59714. * Creates the polygon
  59715. * @param depth The depth of the mesh created
  59716. * @returns the created VertexData
  59717. */
  59718. buildVertexData(depth?: number): VertexData;
  59719. /**
  59720. * Adds a side to the polygon
  59721. * @param positions points that make the polygon
  59722. * @param normals normals of the polygon
  59723. * @param uvs uvs of the polygon
  59724. * @param indices indices of the polygon
  59725. * @param bounds bounds of the polygon
  59726. * @param points points of the polygon
  59727. * @param depth depth of the polygon
  59728. * @param flip flip of the polygon
  59729. */
  59730. private addSide;
  59731. }
  59732. }
  59733. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  59734. import { Scene } from "babylonjs/scene";
  59735. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  59736. import { Color4 } from "babylonjs/Maths/math.color";
  59737. import { Mesh } from "babylonjs/Meshes/mesh";
  59738. import { Nullable } from "babylonjs/types";
  59739. /**
  59740. * Class containing static functions to help procedurally build meshes
  59741. */
  59742. export class PolygonBuilder {
  59743. /**
  59744. * Creates a polygon mesh
  59745. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  59746. * * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  59747. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  59748. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59749. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  59750. * * Remember you can only change the shape positions, not their number when updating a polygon
  59751. * @param name defines the name of the mesh
  59752. * @param options defines the options used to create the mesh
  59753. * @param scene defines the hosting scene
  59754. * @param earcutInjection can be used to inject your own earcut reference
  59755. * @returns the polygon mesh
  59756. */
  59757. static CreatePolygon(name: string, options: {
  59758. shape: Vector3[];
  59759. holes?: Vector3[][];
  59760. depth?: number;
  59761. faceUV?: Vector4[];
  59762. faceColors?: Color4[];
  59763. updatable?: boolean;
  59764. sideOrientation?: number;
  59765. frontUVs?: Vector4;
  59766. backUVs?: Vector4;
  59767. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  59768. /**
  59769. * Creates an extruded polygon mesh, with depth in the Y direction.
  59770. * * You can set different colors and different images to the top, bottom and extruded side by using the parameters `faceColors` (an array of 3 Color3 elements) and `faceUV` (an array of 3 Vector4 elements)
  59771. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  59772. * @param name defines the name of the mesh
  59773. * @param options defines the options used to create the mesh
  59774. * @param scene defines the hosting scene
  59775. * @param earcutInjection can be used to inject your own earcut reference
  59776. * @returns the polygon mesh
  59777. */
  59778. static ExtrudePolygon(name: string, options: {
  59779. shape: Vector3[];
  59780. holes?: Vector3[][];
  59781. depth?: number;
  59782. faceUV?: Vector4[];
  59783. faceColors?: Color4[];
  59784. updatable?: boolean;
  59785. sideOrientation?: number;
  59786. frontUVs?: Vector4;
  59787. backUVs?: Vector4;
  59788. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  59789. }
  59790. }
  59791. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  59792. import { Scene } from "babylonjs/scene";
  59793. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  59794. import { Mesh } from "babylonjs/Meshes/mesh";
  59795. import { Nullable } from "babylonjs/types";
  59796. /**
  59797. * Class containing static functions to help procedurally build meshes
  59798. */
  59799. export class LatheBuilder {
  59800. /**
  59801. * Creates lathe mesh.
  59802. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  59803. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  59804. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  59805. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  59806. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  59807. * * The parameter `arc` (positive float, default 1) is the ratio of the lathe. 0.5 builds for instance half a lathe, so an opened shape
  59808. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  59809. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  59810. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59811. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59812. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  59813. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59814. * @param name defines the name of the mesh
  59815. * @param options defines the options used to create the mesh
  59816. * @param scene defines the hosting scene
  59817. * @returns the lathe mesh
  59818. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  59819. */
  59820. static CreateLathe(name: string, options: {
  59821. shape: Vector3[];
  59822. radius?: number;
  59823. tessellation?: number;
  59824. clip?: number;
  59825. arc?: number;
  59826. closed?: boolean;
  59827. updatable?: boolean;
  59828. sideOrientation?: number;
  59829. frontUVs?: Vector4;
  59830. backUVs?: Vector4;
  59831. cap?: number;
  59832. invertUV?: boolean;
  59833. }, scene?: Nullable<Scene>): Mesh;
  59834. }
  59835. }
  59836. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  59837. import { Nullable } from "babylonjs/types";
  59838. import { Scene } from "babylonjs/scene";
  59839. import { Vector4 } from "babylonjs/Maths/math.vector";
  59840. import { Mesh } from "babylonjs/Meshes/mesh";
  59841. /**
  59842. * Class containing static functions to help procedurally build meshes
  59843. */
  59844. export class TiledPlaneBuilder {
  59845. /**
  59846. * Creates a tiled plane mesh
  59847. * * The parameter `pattern` will, depending on value, do nothing or
  59848. * * * flip (reflect about central vertical) alternate tiles across and up
  59849. * * * flip every tile on alternate rows
  59850. * * * rotate (180 degs) alternate tiles across and up
  59851. * * * rotate every tile on alternate rows
  59852. * * * flip and rotate alternate tiles across and up
  59853. * * * flip and rotate every tile on alternate rows
  59854. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  59855. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  59856. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59857. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  59858. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  59859. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  59860. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  59861. * @param name defines the name of the mesh
  59862. * @param options defines the options used to create the mesh
  59863. * @param scene defines the hosting scene
  59864. * @returns the box mesh
  59865. */
  59866. static CreateTiledPlane(name: string, options: {
  59867. pattern?: number;
  59868. tileSize?: number;
  59869. tileWidth?: number;
  59870. tileHeight?: number;
  59871. size?: number;
  59872. width?: number;
  59873. height?: number;
  59874. alignHorizontal?: number;
  59875. alignVertical?: number;
  59876. sideOrientation?: number;
  59877. frontUVs?: Vector4;
  59878. backUVs?: Vector4;
  59879. updatable?: boolean;
  59880. }, scene?: Nullable<Scene>): Mesh;
  59881. }
  59882. }
  59883. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  59884. import { Nullable } from "babylonjs/types";
  59885. import { Scene } from "babylonjs/scene";
  59886. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  59887. import { Mesh } from "babylonjs/Meshes/mesh";
  59888. /**
  59889. * Class containing static functions to help procedurally build meshes
  59890. */
  59891. export class TubeBuilder {
  59892. /**
  59893. * Creates a tube mesh.
  59894. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  59895. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  59896. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  59897. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  59898. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  59899. * * This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path. It must return a radius value (positive float)
  59900. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  59901. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  59902. * * The optional parameter `instance` is an instance of an existing Tube object to be updated with the passed `pathArray` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#tube
  59903. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59904. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59905. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  59906. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59907. * @param name defines the name of the mesh
  59908. * @param options defines the options used to create the mesh
  59909. * @param scene defines the hosting scene
  59910. * @returns the tube mesh
  59911. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  59912. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  59913. */
  59914. static CreateTube(name: string, options: {
  59915. path: Vector3[];
  59916. radius?: number;
  59917. tessellation?: number;
  59918. radiusFunction?: {
  59919. (i: number, distance: number): number;
  59920. };
  59921. cap?: number;
  59922. arc?: number;
  59923. updatable?: boolean;
  59924. sideOrientation?: number;
  59925. frontUVs?: Vector4;
  59926. backUVs?: Vector4;
  59927. instance?: Mesh;
  59928. invertUV?: boolean;
  59929. }, scene?: Nullable<Scene>): Mesh;
  59930. }
  59931. }
  59932. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  59933. import { Scene } from "babylonjs/scene";
  59934. import { Vector4 } from "babylonjs/Maths/math.vector";
  59935. import { Mesh } from "babylonjs/Meshes/mesh";
  59936. import { Nullable } from "babylonjs/types";
  59937. /**
  59938. * Class containing static functions to help procedurally build meshes
  59939. */
  59940. export class IcoSphereBuilder {
  59941. /**
  59942. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  59943. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  59944. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value of `radius`)
  59945. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  59946. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  59947. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59948. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59949. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59950. * @param name defines the name of the mesh
  59951. * @param options defines the options used to create the mesh
  59952. * @param scene defines the hosting scene
  59953. * @returns the icosahedron mesh
  59954. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  59955. */
  59956. static CreateIcoSphere(name: string, options: {
  59957. radius?: number;
  59958. radiusX?: number;
  59959. radiusY?: number;
  59960. radiusZ?: number;
  59961. flat?: boolean;
  59962. subdivisions?: number;
  59963. sideOrientation?: number;
  59964. frontUVs?: Vector4;
  59965. backUVs?: Vector4;
  59966. updatable?: boolean;
  59967. }, scene?: Nullable<Scene>): Mesh;
  59968. }
  59969. }
  59970. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  59971. import { Vector3 } from "babylonjs/Maths/math.vector";
  59972. import { Mesh } from "babylonjs/Meshes/mesh";
  59973. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59974. /**
  59975. * Class containing static functions to help procedurally build meshes
  59976. */
  59977. export class DecalBuilder {
  59978. /**
  59979. * Creates a decal mesh.
  59980. * A decal is a mesh usually applied as a model onto the surface of another mesh. So don't forget the parameter `sourceMesh` depicting the decal
  59981. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  59982. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  59983. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  59984. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  59985. * @param name defines the name of the mesh
  59986. * @param sourceMesh defines the mesh where the decal must be applied
  59987. * @param options defines the options used to create the mesh
  59988. * @param scene defines the hosting scene
  59989. * @returns the decal mesh
  59990. * @see https://doc.babylonjs.com/how_to/decals
  59991. */
  59992. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  59993. position?: Vector3;
  59994. normal?: Vector3;
  59995. size?: Vector3;
  59996. angle?: number;
  59997. }): Mesh;
  59998. }
  59999. }
  60000. declare module "babylonjs/Meshes/meshBuilder" {
  60001. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  60002. import { Nullable } from "babylonjs/types";
  60003. import { Scene } from "babylonjs/scene";
  60004. import { Mesh } from "babylonjs/Meshes/mesh";
  60005. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  60006. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  60007. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60008. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  60009. import { Plane } from "babylonjs/Maths/math.plane";
  60010. /**
  60011. * Class containing static functions to help procedurally build meshes
  60012. */
  60013. export class MeshBuilder {
  60014. /**
  60015. * Creates a box mesh
  60016. * * The parameter `size` sets the size (float) of each box side (default 1)
  60017. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  60018. * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of 6 Color3 elements) and `faceUV` (an array of 6 Vector4 elements)
  60019. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60020. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60021. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60022. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60023. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  60024. * @param name defines the name of the mesh
  60025. * @param options defines the options used to create the mesh
  60026. * @param scene defines the hosting scene
  60027. * @returns the box mesh
  60028. */
  60029. static CreateBox(name: string, options: {
  60030. size?: number;
  60031. width?: number;
  60032. height?: number;
  60033. depth?: number;
  60034. faceUV?: Vector4[];
  60035. faceColors?: Color4[];
  60036. sideOrientation?: number;
  60037. frontUVs?: Vector4;
  60038. backUVs?: Vector4;
  60039. updatable?: boolean;
  60040. }, scene?: Nullable<Scene>): Mesh;
  60041. /**
  60042. * Creates a tiled box mesh
  60043. * * faceTiles sets the pattern, tile size and number of tiles for a face
  60044. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60045. * @param name defines the name of the mesh
  60046. * @param options defines the options used to create the mesh
  60047. * @param scene defines the hosting scene
  60048. * @returns the tiled box mesh
  60049. */
  60050. static CreateTiledBox(name: string, options: {
  60051. pattern?: number;
  60052. size?: number;
  60053. width?: number;
  60054. height?: number;
  60055. depth: number;
  60056. tileSize?: number;
  60057. tileWidth?: number;
  60058. tileHeight?: number;
  60059. faceUV?: Vector4[];
  60060. faceColors?: Color4[];
  60061. alignHorizontal?: number;
  60062. alignVertical?: number;
  60063. sideOrientation?: number;
  60064. updatable?: boolean;
  60065. }, scene?: Nullable<Scene>): Mesh;
  60066. /**
  60067. * Creates a sphere mesh
  60068. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  60069. * * You can set some different sphere dimensions, for instance to build an ellipsoid, by using the parameters `diameterX`, `diameterY` and `diameterZ` (all by default have the same value of `diameter`)
  60070. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  60071. * * You can create an unclosed sphere with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference (latitude) : 2 x PI x ratio
  60072. * * You can create an unclosed sphere on its height with the parameter `slice` (positive float, default1), valued between 0 and 1, what is the height ratio (longitude)
  60073. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60074. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60075. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60076. * @param name defines the name of the mesh
  60077. * @param options defines the options used to create the mesh
  60078. * @param scene defines the hosting scene
  60079. * @returns the sphere mesh
  60080. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  60081. */
  60082. static CreateSphere(name: string, options: {
  60083. segments?: number;
  60084. diameter?: number;
  60085. diameterX?: number;
  60086. diameterY?: number;
  60087. diameterZ?: number;
  60088. arc?: number;
  60089. slice?: number;
  60090. sideOrientation?: number;
  60091. frontUVs?: Vector4;
  60092. backUVs?: Vector4;
  60093. updatable?: boolean;
  60094. }, scene?: Nullable<Scene>): Mesh;
  60095. /**
  60096. * Creates a plane polygonal mesh. By default, this is a disc
  60097. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  60098. * * The parameter `tessellation` sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  60099. * * You can create an unclosed polygon with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference : 2 x PI x ratio
  60100. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60101. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60102. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60103. * @param name defines the name of the mesh
  60104. * @param options defines the options used to create the mesh
  60105. * @param scene defines the hosting scene
  60106. * @returns the plane polygonal mesh
  60107. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  60108. */
  60109. static CreateDisc(name: string, options: {
  60110. radius?: number;
  60111. tessellation?: number;
  60112. arc?: number;
  60113. updatable?: boolean;
  60114. sideOrientation?: number;
  60115. frontUVs?: Vector4;
  60116. backUVs?: Vector4;
  60117. }, scene?: Nullable<Scene>): Mesh;
  60118. /**
  60119. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  60120. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  60121. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value of `radius`)
  60122. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  60123. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  60124. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60125. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60126. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60127. * @param name defines the name of the mesh
  60128. * @param options defines the options used to create the mesh
  60129. * @param scene defines the hosting scene
  60130. * @returns the icosahedron mesh
  60131. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  60132. */
  60133. static CreateIcoSphere(name: string, options: {
  60134. radius?: number;
  60135. radiusX?: number;
  60136. radiusY?: number;
  60137. radiusZ?: number;
  60138. flat?: boolean;
  60139. subdivisions?: number;
  60140. sideOrientation?: number;
  60141. frontUVs?: Vector4;
  60142. backUVs?: Vector4;
  60143. updatable?: boolean;
  60144. }, scene?: Nullable<Scene>): Mesh;
  60145. /**
  60146. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  60147. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  60148. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  60149. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  60150. * * The parameter `offset` (positive integer, default : rounded half size of the pathArray length), is taken in account only if the `pathArray` is containing a single path
  60151. * * It's the offset to join the points from the same path. Ex : offset = 10 means the point 1 is joined to the point 11
  60152. * * The optional parameter `instance` is an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#ribbon
  60153. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60154. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60155. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60156. * * The parameter `uvs` is an optional flat array of `Vector2` to update/set each ribbon vertex with its own custom UV values instead of the computed ones
  60157. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  60158. * * Note that if you use the parameters `uvs` or `colors`, the passed arrays must be populated with the right number of elements, it is to say the number of ribbon vertices. Remember that if you set `closePath` to `true`, there's one extra vertex per path in the geometry
  60159. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  60160. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60161. * @param name defines the name of the mesh
  60162. * @param options defines the options used to create the mesh
  60163. * @param scene defines the hosting scene
  60164. * @returns the ribbon mesh
  60165. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  60166. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60167. */
  60168. static CreateRibbon(name: string, options: {
  60169. pathArray: Vector3[][];
  60170. closeArray?: boolean;
  60171. closePath?: boolean;
  60172. offset?: number;
  60173. updatable?: boolean;
  60174. sideOrientation?: number;
  60175. frontUVs?: Vector4;
  60176. backUVs?: Vector4;
  60177. instance?: Mesh;
  60178. invertUV?: boolean;
  60179. uvs?: Vector2[];
  60180. colors?: Color4[];
  60181. }, scene?: Nullable<Scene>): Mesh;
  60182. /**
  60183. * Creates a cylinder or a cone mesh
  60184. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  60185. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  60186. * * The parameters `diameterTop` and `diameterBottom` overwrite the parameter `diameter` and set respectively the top cap and bottom cap diameter (floats, default 1). The parameter "diameterBottom" can't be zero.
  60187. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  60188. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  60189. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  60190. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  60191. * * The parameter `cap` sets the way the cylinder is capped. Possible values : BABYLON.Mesh.NO_CAP, BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL (default).
  60192. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  60193. * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of n Color3 elements) and `faceUV` (an array of n Vector4 elements).
  60194. * * The value of n is the number of cylinder faces. If the cylinder has only 1 subdivisions, n equals : top face + cylinder surface + bottom face = 3
  60195. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  60196. * * Finally, if the cylinder has 5 independent subdivisions and is enclose, n equals : top face + 5 x (stripe surface + 2 closing faces) + bottom face = 2 + 5 * 3 = 17
  60197. * * Each array (color or UVs) is always ordered the same way : the first element is the bottom cap, the last element is the top cap. The other elements are each a ring surface.
  60198. * * If `enclose` is false, a ring surface is one element.
  60199. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  60200. * * Example how to set colors and textures on a sliced cylinder : https://www.html5gamedevs.com/topic/17945-creating-a-closed-slice-of-a-cylinder/#comment-106379
  60201. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60202. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60203. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60204. * @param name defines the name of the mesh
  60205. * @param options defines the options used to create the mesh
  60206. * @param scene defines the hosting scene
  60207. * @returns the cylinder mesh
  60208. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  60209. */
  60210. static CreateCylinder(name: string, options: {
  60211. height?: number;
  60212. diameterTop?: number;
  60213. diameterBottom?: number;
  60214. diameter?: number;
  60215. tessellation?: number;
  60216. subdivisions?: number;
  60217. arc?: number;
  60218. faceColors?: Color4[];
  60219. faceUV?: Vector4[];
  60220. updatable?: boolean;
  60221. hasRings?: boolean;
  60222. enclose?: boolean;
  60223. cap?: number;
  60224. sideOrientation?: number;
  60225. frontUVs?: Vector4;
  60226. backUVs?: Vector4;
  60227. }, scene?: Nullable<Scene>): Mesh;
  60228. /**
  60229. * Creates a torus mesh
  60230. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  60231. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  60232. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  60233. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60234. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60235. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60236. * @param name defines the name of the mesh
  60237. * @param options defines the options used to create the mesh
  60238. * @param scene defines the hosting scene
  60239. * @returns the torus mesh
  60240. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  60241. */
  60242. static CreateTorus(name: string, options: {
  60243. diameter?: number;
  60244. thickness?: number;
  60245. tessellation?: number;
  60246. updatable?: boolean;
  60247. sideOrientation?: number;
  60248. frontUVs?: Vector4;
  60249. backUVs?: Vector4;
  60250. }, scene?: Nullable<Scene>): Mesh;
  60251. /**
  60252. * Creates a torus knot mesh
  60253. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  60254. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  60255. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  60256. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  60257. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60258. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60259. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60260. * @param name defines the name of the mesh
  60261. * @param options defines the options used to create the mesh
  60262. * @param scene defines the hosting scene
  60263. * @returns the torus knot mesh
  60264. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  60265. */
  60266. static CreateTorusKnot(name: string, options: {
  60267. radius?: number;
  60268. tube?: number;
  60269. radialSegments?: number;
  60270. tubularSegments?: number;
  60271. p?: number;
  60272. q?: number;
  60273. updatable?: boolean;
  60274. sideOrientation?: number;
  60275. frontUVs?: Vector4;
  60276. backUVs?: Vector4;
  60277. }, scene?: Nullable<Scene>): Mesh;
  60278. /**
  60279. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  60280. * * A line system mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of lines as an input parameter
  60281. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  60282. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  60283. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  60284. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  60285. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  60286. * * Updating a simple Line mesh, you just need to update every line in the `lines` array : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  60287. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  60288. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60289. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  60290. * @param name defines the name of the new line system
  60291. * @param options defines the options used to create the line system
  60292. * @param scene defines the hosting scene
  60293. * @returns a new line system mesh
  60294. */
  60295. static CreateLineSystem(name: string, options: {
  60296. lines: Vector3[][];
  60297. updatable?: boolean;
  60298. instance?: Nullable<LinesMesh>;
  60299. colors?: Nullable<Color4[][]>;
  60300. useVertexAlpha?: boolean;
  60301. }, scene: Nullable<Scene>): LinesMesh;
  60302. /**
  60303. * Creates a line mesh
  60304. * A line mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of points as an input parameter
  60305. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  60306. * * The parameter `points` is an array successive Vector3
  60307. * * The optional parameter `instance` is an instance of an existing LineMesh object to be updated with the passed `points` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  60308. * * The optional parameter `colors` is an array of successive Color4, one per line point
  60309. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  60310. * * When updating an instance, remember that only point positions can change, not the number of points
  60311. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60312. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  60313. * @param name defines the name of the new line system
  60314. * @param options defines the options used to create the line system
  60315. * @param scene defines the hosting scene
  60316. * @returns a new line mesh
  60317. */
  60318. static CreateLines(name: string, options: {
  60319. points: Vector3[];
  60320. updatable?: boolean;
  60321. instance?: Nullable<LinesMesh>;
  60322. colors?: Color4[];
  60323. useVertexAlpha?: boolean;
  60324. }, scene?: Nullable<Scene>): LinesMesh;
  60325. /**
  60326. * Creates a dashed line mesh
  60327. * * A dashed line mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of points as an input parameter
  60328. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  60329. * * The parameter `points` is an array successive Vector3
  60330. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  60331. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  60332. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  60333. * * The optional parameter `instance` is an instance of an existing LineMesh object to be updated with the passed `points` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  60334. * * When updating an instance, remember that only point positions can change, not the number of points
  60335. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60336. * @param name defines the name of the mesh
  60337. * @param options defines the options used to create the mesh
  60338. * @param scene defines the hosting scene
  60339. * @returns the dashed line mesh
  60340. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  60341. */
  60342. static CreateDashedLines(name: string, options: {
  60343. points: Vector3[];
  60344. dashSize?: number;
  60345. gapSize?: number;
  60346. dashNb?: number;
  60347. updatable?: boolean;
  60348. instance?: LinesMesh;
  60349. }, scene?: Nullable<Scene>): LinesMesh;
  60350. /**
  60351. * Creates an extruded shape mesh. The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  60352. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis.
  60353. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  60354. * * The parameter `rotation` (float, default 0 radians) is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve.
  60355. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  60356. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  60357. * * The optional parameter `instance` is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape
  60358. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  60359. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60360. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60361. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  60362. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60363. * @param name defines the name of the mesh
  60364. * @param options defines the options used to create the mesh
  60365. * @param scene defines the hosting scene
  60366. * @returns the extruded shape mesh
  60367. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60368. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  60369. */
  60370. static ExtrudeShape(name: string, options: {
  60371. shape: Vector3[];
  60372. path: Vector3[];
  60373. scale?: number;
  60374. rotation?: number;
  60375. cap?: number;
  60376. updatable?: boolean;
  60377. sideOrientation?: number;
  60378. frontUVs?: Vector4;
  60379. backUVs?: Vector4;
  60380. instance?: Mesh;
  60381. invertUV?: boolean;
  60382. }, scene?: Nullable<Scene>): Mesh;
  60383. /**
  60384. * Creates an custom extruded shape mesh.
  60385. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  60386. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis.
  60387. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  60388. * * The parameter `rotationFunction` (JS function) is a custom Javascript function called on each path point. This function is passed the position i of the point in the path and the distance of this point from the begining of the path
  60389. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  60390. * * The parameter `scaleFunction` (JS function) is a custom Javascript function called on each path point. This function is passed the position i of the point in the path and the distance of this point from the begining of the path
  60391. * * It must returns a float value that will be the scale value applied to the shape on each path point
  60392. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  60393. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  60394. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  60395. * * The optional parameter `instance` is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape
  60396. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  60397. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60398. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60399. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60400. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60401. * @param name defines the name of the mesh
  60402. * @param options defines the options used to create the mesh
  60403. * @param scene defines the hosting scene
  60404. * @returns the custom extruded shape mesh
  60405. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  60406. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60407. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  60408. */
  60409. static ExtrudeShapeCustom(name: string, options: {
  60410. shape: Vector3[];
  60411. path: Vector3[];
  60412. scaleFunction?: any;
  60413. rotationFunction?: any;
  60414. ribbonCloseArray?: boolean;
  60415. ribbonClosePath?: boolean;
  60416. cap?: number;
  60417. updatable?: boolean;
  60418. sideOrientation?: number;
  60419. frontUVs?: Vector4;
  60420. backUVs?: Vector4;
  60421. instance?: Mesh;
  60422. invertUV?: boolean;
  60423. }, scene?: Nullable<Scene>): Mesh;
  60424. /**
  60425. * Creates lathe mesh.
  60426. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  60427. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  60428. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  60429. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  60430. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  60431. * * The parameter `arc` (positive float, default 1) is the ratio of the lathe. 0.5 builds for instance half a lathe, so an opened shape
  60432. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  60433. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  60434. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60435. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60436. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60437. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60438. * @param name defines the name of the mesh
  60439. * @param options defines the options used to create the mesh
  60440. * @param scene defines the hosting scene
  60441. * @returns the lathe mesh
  60442. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  60443. */
  60444. static CreateLathe(name: string, options: {
  60445. shape: Vector3[];
  60446. radius?: number;
  60447. tessellation?: number;
  60448. clip?: number;
  60449. arc?: number;
  60450. closed?: boolean;
  60451. updatable?: boolean;
  60452. sideOrientation?: number;
  60453. frontUVs?: Vector4;
  60454. backUVs?: Vector4;
  60455. cap?: number;
  60456. invertUV?: boolean;
  60457. }, scene?: Nullable<Scene>): Mesh;
  60458. /**
  60459. * Creates a tiled plane mesh
  60460. * * You can set a limited pattern arrangement with the tiles
  60461. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60462. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60463. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60464. * @param name defines the name of the mesh
  60465. * @param options defines the options used to create the mesh
  60466. * @param scene defines the hosting scene
  60467. * @returns the plane mesh
  60468. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  60469. */
  60470. static CreateTiledPlane(name: string, options: {
  60471. pattern?: number;
  60472. tileSize?: number;
  60473. tileWidth?: number;
  60474. tileHeight?: number;
  60475. size?: number;
  60476. width?: number;
  60477. height?: number;
  60478. alignHorizontal?: number;
  60479. alignVertical?: number;
  60480. sideOrientation?: number;
  60481. frontUVs?: Vector4;
  60482. backUVs?: Vector4;
  60483. updatable?: boolean;
  60484. }, scene?: Nullable<Scene>): Mesh;
  60485. /**
  60486. * Creates a plane mesh
  60487. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  60488. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  60489. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  60490. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60491. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60492. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60493. * @param name defines the name of the mesh
  60494. * @param options defines the options used to create the mesh
  60495. * @param scene defines the hosting scene
  60496. * @returns the plane mesh
  60497. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  60498. */
  60499. static CreatePlane(name: string, options: {
  60500. size?: number;
  60501. width?: number;
  60502. height?: number;
  60503. sideOrientation?: number;
  60504. frontUVs?: Vector4;
  60505. backUVs?: Vector4;
  60506. updatable?: boolean;
  60507. sourcePlane?: Plane;
  60508. }, scene?: Nullable<Scene>): Mesh;
  60509. /**
  60510. * Creates a ground mesh
  60511. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  60512. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  60513. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60514. * @param name defines the name of the mesh
  60515. * @param options defines the options used to create the mesh
  60516. * @param scene defines the hosting scene
  60517. * @returns the ground mesh
  60518. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  60519. */
  60520. static CreateGround(name: string, options: {
  60521. width?: number;
  60522. height?: number;
  60523. subdivisions?: number;
  60524. subdivisionsX?: number;
  60525. subdivisionsY?: number;
  60526. updatable?: boolean;
  60527. }, scene?: Nullable<Scene>): Mesh;
  60528. /**
  60529. * Creates a tiled ground mesh
  60530. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  60531. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  60532. * * The parameter `subdivisions` is a javascript object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  60533. * * The parameter `precision` is a javascript object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  60534. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60535. * @param name defines the name of the mesh
  60536. * @param options defines the options used to create the mesh
  60537. * @param scene defines the hosting scene
  60538. * @returns the tiled ground mesh
  60539. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  60540. */
  60541. static CreateTiledGround(name: string, options: {
  60542. xmin: number;
  60543. zmin: number;
  60544. xmax: number;
  60545. zmax: number;
  60546. subdivisions?: {
  60547. w: number;
  60548. h: number;
  60549. };
  60550. precision?: {
  60551. w: number;
  60552. h: number;
  60553. };
  60554. updatable?: boolean;
  60555. }, scene?: Nullable<Scene>): Mesh;
  60556. /**
  60557. * Creates a ground mesh from a height map
  60558. * * The parameter `url` sets the URL of the height map image resource.
  60559. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  60560. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  60561. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  60562. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  60563. * * The parameter `colorFilter` (optional Color3, default (0.3, 0.59, 0.11) ) is the filter to apply to the image pixel colors to compute the height.
  60564. * * The parameter `onReady` is a javascript callback function that will be called once the mesh is just built (the height map download can last some time).
  60565. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  60566. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60567. * @param name defines the name of the mesh
  60568. * @param url defines the url to the height map
  60569. * @param options defines the options used to create the mesh
  60570. * @param scene defines the hosting scene
  60571. * @returns the ground mesh
  60572. * @see https://doc.babylonjs.com/babylon101/height_map
  60573. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  60574. */
  60575. static CreateGroundFromHeightMap(name: string, url: string, options: {
  60576. width?: number;
  60577. height?: number;
  60578. subdivisions?: number;
  60579. minHeight?: number;
  60580. maxHeight?: number;
  60581. colorFilter?: Color3;
  60582. alphaFilter?: number;
  60583. updatable?: boolean;
  60584. onReady?: (mesh: GroundMesh) => void;
  60585. }, scene?: Nullable<Scene>): GroundMesh;
  60586. /**
  60587. * Creates a polygon mesh
  60588. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  60589. * * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  60590. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  60591. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60592. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  60593. * * Remember you can only change the shape positions, not their number when updating a polygon
  60594. * @param name defines the name of the mesh
  60595. * @param options defines the options used to create the mesh
  60596. * @param scene defines the hosting scene
  60597. * @param earcutInjection can be used to inject your own earcut reference
  60598. * @returns the polygon mesh
  60599. */
  60600. static CreatePolygon(name: string, options: {
  60601. shape: Vector3[];
  60602. holes?: Vector3[][];
  60603. depth?: number;
  60604. faceUV?: Vector4[];
  60605. faceColors?: Color4[];
  60606. updatable?: boolean;
  60607. sideOrientation?: number;
  60608. frontUVs?: Vector4;
  60609. backUVs?: Vector4;
  60610. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60611. /**
  60612. * Creates an extruded polygon mesh, with depth in the Y direction.
  60613. * * You can set different colors and different images to the top, bottom and extruded side by using the parameters `faceColors` (an array of 3 Color3 elements) and `faceUV` (an array of 3 Vector4 elements)
  60614. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60615. * @param name defines the name of the mesh
  60616. * @param options defines the options used to create the mesh
  60617. * @param scene defines the hosting scene
  60618. * @param earcutInjection can be used to inject your own earcut reference
  60619. * @returns the polygon mesh
  60620. */
  60621. static ExtrudePolygon(name: string, options: {
  60622. shape: Vector3[];
  60623. holes?: Vector3[][];
  60624. depth?: number;
  60625. faceUV?: Vector4[];
  60626. faceColors?: Color4[];
  60627. updatable?: boolean;
  60628. sideOrientation?: number;
  60629. frontUVs?: Vector4;
  60630. backUVs?: Vector4;
  60631. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60632. /**
  60633. * Creates a tube mesh.
  60634. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  60635. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  60636. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  60637. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  60638. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  60639. * * This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path. It must return a radius value (positive float)
  60640. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  60641. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  60642. * * The optional parameter `instance` is an instance of an existing Tube object to be updated with the passed `pathArray` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#tube
  60643. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60644. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60645. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60646. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60647. * @param name defines the name of the mesh
  60648. * @param options defines the options used to create the mesh
  60649. * @param scene defines the hosting scene
  60650. * @returns the tube mesh
  60651. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60652. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  60653. */
  60654. static CreateTube(name: string, options: {
  60655. path: Vector3[];
  60656. radius?: number;
  60657. tessellation?: number;
  60658. radiusFunction?: {
  60659. (i: number, distance: number): number;
  60660. };
  60661. cap?: number;
  60662. arc?: number;
  60663. updatable?: boolean;
  60664. sideOrientation?: number;
  60665. frontUVs?: Vector4;
  60666. backUVs?: Vector4;
  60667. instance?: Mesh;
  60668. invertUV?: boolean;
  60669. }, scene?: Nullable<Scene>): Mesh;
  60670. /**
  60671. * Creates a polyhedron mesh
  60672. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  60673. * * The parameter `size` (positive float, default 1) sets the polygon size
  60674. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  60675. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  60676. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  60677. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  60678. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60679. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  60680. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60681. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60682. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60683. * @param name defines the name of the mesh
  60684. * @param options defines the options used to create the mesh
  60685. * @param scene defines the hosting scene
  60686. * @returns the polyhedron mesh
  60687. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  60688. */
  60689. static CreatePolyhedron(name: string, options: {
  60690. type?: number;
  60691. size?: number;
  60692. sizeX?: number;
  60693. sizeY?: number;
  60694. sizeZ?: number;
  60695. custom?: any;
  60696. faceUV?: Vector4[];
  60697. faceColors?: Color4[];
  60698. flat?: boolean;
  60699. updatable?: boolean;
  60700. sideOrientation?: number;
  60701. frontUVs?: Vector4;
  60702. backUVs?: Vector4;
  60703. }, scene?: Nullable<Scene>): Mesh;
  60704. /**
  60705. * Creates a decal mesh.
  60706. * A decal is a mesh usually applied as a model onto the surface of another mesh. So don't forget the parameter `sourceMesh` depicting the decal
  60707. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  60708. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  60709. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  60710. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  60711. * @param name defines the name of the mesh
  60712. * @param sourceMesh defines the mesh where the decal must be applied
  60713. * @param options defines the options used to create the mesh
  60714. * @param scene defines the hosting scene
  60715. * @returns the decal mesh
  60716. * @see https://doc.babylonjs.com/how_to/decals
  60717. */
  60718. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  60719. position?: Vector3;
  60720. normal?: Vector3;
  60721. size?: Vector3;
  60722. angle?: number;
  60723. }): Mesh;
  60724. }
  60725. }
  60726. declare module "babylonjs/Meshes/meshSimplification" {
  60727. import { Mesh } from "babylonjs/Meshes/mesh";
  60728. /**
  60729. * A simplifier interface for future simplification implementations
  60730. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60731. */
  60732. export interface ISimplifier {
  60733. /**
  60734. * Simplification of a given mesh according to the given settings.
  60735. * Since this requires computation, it is assumed that the function runs async.
  60736. * @param settings The settings of the simplification, including quality and distance
  60737. * @param successCallback A callback that will be called after the mesh was simplified.
  60738. * @param errorCallback in case of an error, this callback will be called. optional.
  60739. */
  60740. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  60741. }
  60742. /**
  60743. * Expected simplification settings.
  60744. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  60745. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60746. */
  60747. export interface ISimplificationSettings {
  60748. /**
  60749. * Gets or sets the expected quality
  60750. */
  60751. quality: number;
  60752. /**
  60753. * Gets or sets the distance when this optimized version should be used
  60754. */
  60755. distance: number;
  60756. /**
  60757. * Gets an already optimized mesh
  60758. */
  60759. optimizeMesh?: boolean;
  60760. }
  60761. /**
  60762. * Class used to specify simplification options
  60763. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60764. */
  60765. export class SimplificationSettings implements ISimplificationSettings {
  60766. /** expected quality */
  60767. quality: number;
  60768. /** distance when this optimized version should be used */
  60769. distance: number;
  60770. /** already optimized mesh */
  60771. optimizeMesh?: boolean | undefined;
  60772. /**
  60773. * Creates a SimplificationSettings
  60774. * @param quality expected quality
  60775. * @param distance distance when this optimized version should be used
  60776. * @param optimizeMesh already optimized mesh
  60777. */
  60778. constructor(
  60779. /** expected quality */
  60780. quality: number,
  60781. /** distance when this optimized version should be used */
  60782. distance: number,
  60783. /** already optimized mesh */
  60784. optimizeMesh?: boolean | undefined);
  60785. }
  60786. /**
  60787. * Interface used to define a simplification task
  60788. */
  60789. export interface ISimplificationTask {
  60790. /**
  60791. * Array of settings
  60792. */
  60793. settings: Array<ISimplificationSettings>;
  60794. /**
  60795. * Simplification type
  60796. */
  60797. simplificationType: SimplificationType;
  60798. /**
  60799. * Mesh to simplify
  60800. */
  60801. mesh: Mesh;
  60802. /**
  60803. * Callback called on success
  60804. */
  60805. successCallback?: () => void;
  60806. /**
  60807. * Defines if parallel processing can be used
  60808. */
  60809. parallelProcessing: boolean;
  60810. }
  60811. /**
  60812. * Queue used to order the simplification tasks
  60813. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60814. */
  60815. export class SimplificationQueue {
  60816. private _simplificationArray;
  60817. /**
  60818. * Gets a boolean indicating that the process is still running
  60819. */
  60820. running: boolean;
  60821. /**
  60822. * Creates a new queue
  60823. */
  60824. constructor();
  60825. /**
  60826. * Adds a new simplification task
  60827. * @param task defines a task to add
  60828. */
  60829. addTask(task: ISimplificationTask): void;
  60830. /**
  60831. * Execute next task
  60832. */
  60833. executeNext(): void;
  60834. /**
  60835. * Execute a simplification task
  60836. * @param task defines the task to run
  60837. */
  60838. runSimplification(task: ISimplificationTask): void;
  60839. private getSimplifier;
  60840. }
  60841. /**
  60842. * The implemented types of simplification
  60843. * At the moment only Quadratic Error Decimation is implemented
  60844. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60845. */
  60846. export enum SimplificationType {
  60847. /** Quadratic error decimation */
  60848. QUADRATIC = 0
  60849. }
  60850. }
  60851. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  60852. import { Scene } from "babylonjs/scene";
  60853. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  60854. import { ISceneComponent } from "babylonjs/sceneComponent";
  60855. module "babylonjs/scene" {
  60856. interface Scene {
  60857. /** @hidden (Backing field) */
  60858. _simplificationQueue: SimplificationQueue;
  60859. /**
  60860. * Gets or sets the simplification queue attached to the scene
  60861. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  60862. */
  60863. simplificationQueue: SimplificationQueue;
  60864. }
  60865. }
  60866. module "babylonjs/Meshes/mesh" {
  60867. interface Mesh {
  60868. /**
  60869. * Simplify the mesh according to the given array of settings.
  60870. * Function will return immediately and will simplify async
  60871. * @param settings a collection of simplification settings
  60872. * @param parallelProcessing should all levels calculate parallel or one after the other
  60873. * @param simplificationType the type of simplification to run
  60874. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  60875. * @returns the current mesh
  60876. */
  60877. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  60878. }
  60879. }
  60880. /**
  60881. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  60882. * created in a scene
  60883. */
  60884. export class SimplicationQueueSceneComponent implements ISceneComponent {
  60885. /**
  60886. * The component name helpfull to identify the component in the list of scene components.
  60887. */
  60888. readonly name: string;
  60889. /**
  60890. * The scene the component belongs to.
  60891. */
  60892. scene: Scene;
  60893. /**
  60894. * Creates a new instance of the component for the given scene
  60895. * @param scene Defines the scene to register the component in
  60896. */
  60897. constructor(scene: Scene);
  60898. /**
  60899. * Registers the component in a given scene
  60900. */
  60901. register(): void;
  60902. /**
  60903. * Rebuilds the elements related to this component in case of
  60904. * context lost for instance.
  60905. */
  60906. rebuild(): void;
  60907. /**
  60908. * Disposes the component and the associated ressources
  60909. */
  60910. dispose(): void;
  60911. private _beforeCameraUpdate;
  60912. }
  60913. }
  60914. declare module "babylonjs/Meshes/Builders/index" {
  60915. export * from "babylonjs/Meshes/Builders/boxBuilder";
  60916. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  60917. export * from "babylonjs/Meshes/Builders/discBuilder";
  60918. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  60919. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  60920. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  60921. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  60922. export * from "babylonjs/Meshes/Builders/torusBuilder";
  60923. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  60924. export * from "babylonjs/Meshes/Builders/linesBuilder";
  60925. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  60926. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  60927. export * from "babylonjs/Meshes/Builders/latheBuilder";
  60928. export * from "babylonjs/Meshes/Builders/planeBuilder";
  60929. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  60930. export * from "babylonjs/Meshes/Builders/groundBuilder";
  60931. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  60932. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  60933. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  60934. export * from "babylonjs/Meshes/Builders/decalBuilder";
  60935. }
  60936. declare module "babylonjs/Meshes/index" {
  60937. export * from "babylonjs/Meshes/abstractMesh";
  60938. export * from "babylonjs/Meshes/buffer";
  60939. export * from "babylonjs/Meshes/Compression/index";
  60940. export * from "babylonjs/Meshes/csg";
  60941. export * from "babylonjs/Meshes/geometry";
  60942. export * from "babylonjs/Meshes/groundMesh";
  60943. export * from "babylonjs/Meshes/trailMesh";
  60944. export * from "babylonjs/Meshes/instancedMesh";
  60945. export * from "babylonjs/Meshes/linesMesh";
  60946. export * from "babylonjs/Meshes/mesh";
  60947. export * from "babylonjs/Meshes/mesh.vertexData";
  60948. export * from "babylonjs/Meshes/meshBuilder";
  60949. export * from "babylonjs/Meshes/meshSimplification";
  60950. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  60951. export * from "babylonjs/Meshes/polygonMesh";
  60952. export * from "babylonjs/Meshes/subMesh";
  60953. export * from "babylonjs/Meshes/meshLODLevel";
  60954. export * from "babylonjs/Meshes/transformNode";
  60955. export * from "babylonjs/Meshes/Builders/index";
  60956. export * from "babylonjs/Meshes/dataBuffer";
  60957. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  60958. }
  60959. declare module "babylonjs/Morph/index" {
  60960. export * from "babylonjs/Morph/morphTarget";
  60961. export * from "babylonjs/Morph/morphTargetManager";
  60962. }
  60963. declare module "babylonjs/Navigation/INavigationEngine" {
  60964. import { TransformNode } from "babylonjs/Meshes/transformNode";
  60965. import { Vector3 } from "babylonjs/Maths/math";
  60966. import { Mesh } from "babylonjs/Meshes/mesh";
  60967. import { Scene } from "babylonjs/scene";
  60968. /**
  60969. * Navigation plugin interface to add navigation constrained by a navigation mesh
  60970. */
  60971. export interface INavigationEnginePlugin {
  60972. /**
  60973. * plugin name
  60974. */
  60975. name: string;
  60976. /**
  60977. * Creates a navigation mesh
  60978. * @param meshes array of all the geometry used to compute the navigatio mesh
  60979. * @param parameters bunch of parameters used to filter geometry
  60980. */
  60981. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  60982. /**
  60983. * Create a navigation mesh debug mesh
  60984. * @param scene is where the mesh will be added
  60985. * @returns debug display mesh
  60986. */
  60987. createDebugNavMesh(scene: Scene): Mesh;
  60988. /**
  60989. * Get a navigation mesh constrained position, closest to the parameter position
  60990. * @param position world position
  60991. * @returns the closest point to position constrained by the navigation mesh
  60992. */
  60993. getClosestPoint(position: Vector3): Vector3;
  60994. /**
  60995. * Get a navigation mesh constrained position, within a particular radius
  60996. * @param position world position
  60997. * @param maxRadius the maximum distance to the constrained world position
  60998. * @returns the closest point to position constrained by the navigation mesh
  60999. */
  61000. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  61001. /**
  61002. * Compute the final position from a segment made of destination-position
  61003. * @param position world position
  61004. * @param destination world position
  61005. * @returns the resulting point along the navmesh
  61006. */
  61007. moveAlong(position: Vector3, destination: Vector3): Vector3;
  61008. /**
  61009. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  61010. * @param start world position
  61011. * @param end world position
  61012. * @returns array containing world position composing the path
  61013. */
  61014. computePath(start: Vector3, end: Vector3): Vector3[];
  61015. /**
  61016. * If this plugin is supported
  61017. * @returns true if plugin is supported
  61018. */
  61019. isSupported(): boolean;
  61020. /**
  61021. * Create a new Crowd so you can add agents
  61022. * @param maxAgents the maximum agent count in the crowd
  61023. * @param maxAgentRadius the maximum radius an agent can have
  61024. * @param scene to attach the crowd to
  61025. * @returns the crowd you can add agents to
  61026. */
  61027. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  61028. /**
  61029. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61030. * The queries will try to find a solution within those bounds
  61031. * default is (1,1,1)
  61032. * @param extent x,y,z value that define the extent around the queries point of reference
  61033. */
  61034. setDefaultQueryExtent(extent: Vector3): void;
  61035. /**
  61036. * Get the Bounding box extent specified by setDefaultQueryExtent
  61037. * @returns the box extent values
  61038. */
  61039. getDefaultQueryExtent(): Vector3;
  61040. /**
  61041. * Release all resources
  61042. */
  61043. dispose(): void;
  61044. }
  61045. /**
  61046. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  61047. */
  61048. export interface ICrowd {
  61049. /**
  61050. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  61051. * You can attach anything to that node. The node position is updated in the scene update tick.
  61052. * @param pos world position that will be constrained by the navigation mesh
  61053. * @param parameters agent parameters
  61054. * @param transform hooked to the agent that will be update by the scene
  61055. * @returns agent index
  61056. */
  61057. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  61058. /**
  61059. * Returns the agent position in world space
  61060. * @param index agent index returned by addAgent
  61061. * @returns world space position
  61062. */
  61063. getAgentPosition(index: number): Vector3;
  61064. /**
  61065. * Gets the agent velocity in world space
  61066. * @param index agent index returned by addAgent
  61067. * @returns world space velocity
  61068. */
  61069. getAgentVelocity(index: number): Vector3;
  61070. /**
  61071. * remove a particular agent previously created
  61072. * @param index agent index returned by addAgent
  61073. */
  61074. removeAgent(index: number): void;
  61075. /**
  61076. * get the list of all agents attached to this crowd
  61077. * @returns list of agent indices
  61078. */
  61079. getAgents(): number[];
  61080. /**
  61081. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  61082. * @param deltaTime in seconds
  61083. */
  61084. update(deltaTime: number): void;
  61085. /**
  61086. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  61087. * @param index agent index returned by addAgent
  61088. * @param destination targeted world position
  61089. */
  61090. agentGoto(index: number, destination: Vector3): void;
  61091. /**
  61092. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61093. * The queries will try to find a solution within those bounds
  61094. * default is (1,1,1)
  61095. * @param extent x,y,z value that define the extent around the queries point of reference
  61096. */
  61097. setDefaultQueryExtent(extent: Vector3): void;
  61098. /**
  61099. * Get the Bounding box extent specified by setDefaultQueryExtent
  61100. * @returns the box extent values
  61101. */
  61102. getDefaultQueryExtent(): Vector3;
  61103. /**
  61104. * Release all resources
  61105. */
  61106. dispose(): void;
  61107. }
  61108. /**
  61109. * Configures an agent
  61110. */
  61111. export interface IAgentParameters {
  61112. /**
  61113. * Agent radius. [Limit: >= 0]
  61114. */
  61115. radius: number;
  61116. /**
  61117. * Agent height. [Limit: > 0]
  61118. */
  61119. height: number;
  61120. /**
  61121. * Maximum allowed acceleration. [Limit: >= 0]
  61122. */
  61123. maxAcceleration: number;
  61124. /**
  61125. * Maximum allowed speed. [Limit: >= 0]
  61126. */
  61127. maxSpeed: number;
  61128. /**
  61129. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  61130. */
  61131. collisionQueryRange: number;
  61132. /**
  61133. * The path visibility optimization range. [Limit: > 0]
  61134. */
  61135. pathOptimizationRange: number;
  61136. /**
  61137. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  61138. */
  61139. separationWeight: number;
  61140. }
  61141. /**
  61142. * Configures the navigation mesh creation
  61143. */
  61144. export interface INavMeshParameters {
  61145. /**
  61146. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  61147. */
  61148. cs: number;
  61149. /**
  61150. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  61151. */
  61152. ch: number;
  61153. /**
  61154. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  61155. */
  61156. walkableSlopeAngle: number;
  61157. /**
  61158. * Minimum floor to 'ceiling' height that will still allow the floor area to
  61159. * be considered walkable. [Limit: >= 3] [Units: vx]
  61160. */
  61161. walkableHeight: number;
  61162. /**
  61163. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  61164. */
  61165. walkableClimb: number;
  61166. /**
  61167. * The distance to erode/shrink the walkable area of the heightfield away from
  61168. * obstructions. [Limit: >=0] [Units: vx]
  61169. */
  61170. walkableRadius: number;
  61171. /**
  61172. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  61173. */
  61174. maxEdgeLen: number;
  61175. /**
  61176. * The maximum distance a simplfied contour's border edges should deviate
  61177. * the original raw contour. [Limit: >=0] [Units: vx]
  61178. */
  61179. maxSimplificationError: number;
  61180. /**
  61181. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  61182. */
  61183. minRegionArea: number;
  61184. /**
  61185. * Any regions with a span count smaller than this value will, if possible,
  61186. * be merged with larger regions. [Limit: >=0] [Units: vx]
  61187. */
  61188. mergeRegionArea: number;
  61189. /**
  61190. * The maximum number of vertices allowed for polygons generated during the
  61191. * contour to polygon conversion process. [Limit: >= 3]
  61192. */
  61193. maxVertsPerPoly: number;
  61194. /**
  61195. * Sets the sampling distance to use when generating the detail mesh.
  61196. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  61197. */
  61198. detailSampleDist: number;
  61199. /**
  61200. * The maximum distance the detail mesh surface should deviate from heightfield
  61201. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  61202. */
  61203. detailSampleMaxError: number;
  61204. }
  61205. }
  61206. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  61207. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  61208. import { Mesh } from "babylonjs/Meshes/mesh";
  61209. import { Scene } from "babylonjs/scene";
  61210. import { Vector3 } from "babylonjs/Maths/math";
  61211. import { TransformNode } from "babylonjs/Meshes/transformNode";
  61212. /**
  61213. * RecastJS navigation plugin
  61214. */
  61215. export class RecastJSPlugin implements INavigationEnginePlugin {
  61216. /**
  61217. * Reference to the Recast library
  61218. */
  61219. bjsRECAST: any;
  61220. /**
  61221. * plugin name
  61222. */
  61223. name: string;
  61224. /**
  61225. * the first navmesh created. We might extend this to support multiple navmeshes
  61226. */
  61227. navMesh: any;
  61228. /**
  61229. * Initializes the recastJS plugin
  61230. * @param recastInjection can be used to inject your own recast reference
  61231. */
  61232. constructor(recastInjection?: any);
  61233. /**
  61234. * Creates a navigation mesh
  61235. * @param meshes array of all the geometry used to compute the navigatio mesh
  61236. * @param parameters bunch of parameters used to filter geometry
  61237. */
  61238. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  61239. /**
  61240. * Create a navigation mesh debug mesh
  61241. * @param scene is where the mesh will be added
  61242. * @returns debug display mesh
  61243. */
  61244. createDebugNavMesh(scene: Scene): Mesh;
  61245. /**
  61246. * Get a navigation mesh constrained position, closest to the parameter position
  61247. * @param position world position
  61248. * @returns the closest point to position constrained by the navigation mesh
  61249. */
  61250. getClosestPoint(position: Vector3): Vector3;
  61251. /**
  61252. * Get a navigation mesh constrained position, within a particular radius
  61253. * @param position world position
  61254. * @param maxRadius the maximum distance to the constrained world position
  61255. * @returns the closest point to position constrained by the navigation mesh
  61256. */
  61257. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  61258. /**
  61259. * Compute the final position from a segment made of destination-position
  61260. * @param position world position
  61261. * @param destination world position
  61262. * @returns the resulting point along the navmesh
  61263. */
  61264. moveAlong(position: Vector3, destination: Vector3): Vector3;
  61265. /**
  61266. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  61267. * @param start world position
  61268. * @param end world position
  61269. * @returns array containing world position composing the path
  61270. */
  61271. computePath(start: Vector3, end: Vector3): Vector3[];
  61272. /**
  61273. * Create a new Crowd so you can add agents
  61274. * @param maxAgents the maximum agent count in the crowd
  61275. * @param maxAgentRadius the maximum radius an agent can have
  61276. * @param scene to attach the crowd to
  61277. * @returns the crowd you can add agents to
  61278. */
  61279. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  61280. /**
  61281. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61282. * The queries will try to find a solution within those bounds
  61283. * default is (1,1,1)
  61284. * @param extent x,y,z value that define the extent around the queries point of reference
  61285. */
  61286. setDefaultQueryExtent(extent: Vector3): void;
  61287. /**
  61288. * Get the Bounding box extent specified by setDefaultQueryExtent
  61289. * @returns the box extent values
  61290. */
  61291. getDefaultQueryExtent(): Vector3;
  61292. /**
  61293. * Disposes
  61294. */
  61295. dispose(): void;
  61296. /**
  61297. * If this plugin is supported
  61298. * @returns true if plugin is supported
  61299. */
  61300. isSupported(): boolean;
  61301. }
  61302. /**
  61303. * Recast detour crowd implementation
  61304. */
  61305. export class RecastJSCrowd implements ICrowd {
  61306. /**
  61307. * Recast/detour plugin
  61308. */
  61309. bjsRECASTPlugin: RecastJSPlugin;
  61310. /**
  61311. * Link to the detour crowd
  61312. */
  61313. recastCrowd: any;
  61314. /**
  61315. * One transform per agent
  61316. */
  61317. transforms: TransformNode[];
  61318. /**
  61319. * All agents created
  61320. */
  61321. agents: number[];
  61322. /**
  61323. * Link to the scene is kept to unregister the crowd from the scene
  61324. */
  61325. private _scene;
  61326. /**
  61327. * Observer for crowd updates
  61328. */
  61329. private _onBeforeAnimationsObserver;
  61330. /**
  61331. * Constructor
  61332. * @param plugin recastJS plugin
  61333. * @param maxAgents the maximum agent count in the crowd
  61334. * @param maxAgentRadius the maximum radius an agent can have
  61335. * @param scene to attach the crowd to
  61336. * @returns the crowd you can add agents to
  61337. */
  61338. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  61339. /**
  61340. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  61341. * You can attach anything to that node. The node position is updated in the scene update tick.
  61342. * @param pos world position that will be constrained by the navigation mesh
  61343. * @param parameters agent parameters
  61344. * @param transform hooked to the agent that will be update by the scene
  61345. * @returns agent index
  61346. */
  61347. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  61348. /**
  61349. * Returns the agent position in world space
  61350. * @param index agent index returned by addAgent
  61351. * @returns world space position
  61352. */
  61353. getAgentPosition(index: number): Vector3;
  61354. /**
  61355. * Returns the agent velocity in world space
  61356. * @param index agent index returned by addAgent
  61357. * @returns world space velocity
  61358. */
  61359. getAgentVelocity(index: number): Vector3;
  61360. /**
  61361. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  61362. * @param index agent index returned by addAgent
  61363. * @param destination targeted world position
  61364. */
  61365. agentGoto(index: number, destination: Vector3): void;
  61366. /**
  61367. * remove a particular agent previously created
  61368. * @param index agent index returned by addAgent
  61369. */
  61370. removeAgent(index: number): void;
  61371. /**
  61372. * get the list of all agents attached to this crowd
  61373. * @returns list of agent indices
  61374. */
  61375. getAgents(): number[];
  61376. /**
  61377. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  61378. * @param deltaTime in seconds
  61379. */
  61380. update(deltaTime: number): void;
  61381. /**
  61382. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61383. * The queries will try to find a solution within those bounds
  61384. * default is (1,1,1)
  61385. * @param extent x,y,z value that define the extent around the queries point of reference
  61386. */
  61387. setDefaultQueryExtent(extent: Vector3): void;
  61388. /**
  61389. * Get the Bounding box extent specified by setDefaultQueryExtent
  61390. * @returns the box extent values
  61391. */
  61392. getDefaultQueryExtent(): Vector3;
  61393. /**
  61394. * Release all resources
  61395. */
  61396. dispose(): void;
  61397. }
  61398. }
  61399. declare module "babylonjs/Navigation/Plugins/index" {
  61400. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  61401. }
  61402. declare module "babylonjs/Navigation/index" {
  61403. export * from "babylonjs/Navigation/INavigationEngine";
  61404. export * from "babylonjs/Navigation/Plugins/index";
  61405. }
  61406. declare module "babylonjs/Offline/database" {
  61407. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  61408. /**
  61409. * Class used to enable access to IndexedDB
  61410. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  61411. */
  61412. export class Database implements IOfflineProvider {
  61413. private _callbackManifestChecked;
  61414. private _currentSceneUrl;
  61415. private _db;
  61416. private _enableSceneOffline;
  61417. private _enableTexturesOffline;
  61418. private _manifestVersionFound;
  61419. private _mustUpdateRessources;
  61420. private _hasReachedQuota;
  61421. private _isSupported;
  61422. private _idbFactory;
  61423. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  61424. private static IsUASupportingBlobStorage;
  61425. /**
  61426. * Gets a boolean indicating if Database storate is enabled (off by default)
  61427. */
  61428. static IDBStorageEnabled: boolean;
  61429. /**
  61430. * Gets a boolean indicating if scene must be saved in the database
  61431. */
  61432. readonly enableSceneOffline: boolean;
  61433. /**
  61434. * Gets a boolean indicating if textures must be saved in the database
  61435. */
  61436. readonly enableTexturesOffline: boolean;
  61437. /**
  61438. * Creates a new Database
  61439. * @param urlToScene defines the url to load the scene
  61440. * @param callbackManifestChecked defines the callback to use when manifest is checked
  61441. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  61442. */
  61443. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  61444. private static _ParseURL;
  61445. private static _ReturnFullUrlLocation;
  61446. private _checkManifestFile;
  61447. /**
  61448. * Open the database and make it available
  61449. * @param successCallback defines the callback to call on success
  61450. * @param errorCallback defines the callback to call on error
  61451. */
  61452. open(successCallback: () => void, errorCallback: () => void): void;
  61453. /**
  61454. * Loads an image from the database
  61455. * @param url defines the url to load from
  61456. * @param image defines the target DOM image
  61457. */
  61458. loadImage(url: string, image: HTMLImageElement): void;
  61459. private _loadImageFromDBAsync;
  61460. private _saveImageIntoDBAsync;
  61461. private _checkVersionFromDB;
  61462. private _loadVersionFromDBAsync;
  61463. private _saveVersionIntoDBAsync;
  61464. /**
  61465. * Loads a file from database
  61466. * @param url defines the URL to load from
  61467. * @param sceneLoaded defines a callback to call on success
  61468. * @param progressCallBack defines a callback to call when progress changed
  61469. * @param errorCallback defines a callback to call on error
  61470. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  61471. */
  61472. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  61473. private _loadFileAsync;
  61474. private _saveFileAsync;
  61475. /**
  61476. * Validates if xhr data is correct
  61477. * @param xhr defines the request to validate
  61478. * @param dataType defines the expected data type
  61479. * @returns true if data is correct
  61480. */
  61481. private static _ValidateXHRData;
  61482. }
  61483. }
  61484. declare module "babylonjs/Offline/index" {
  61485. export * from "babylonjs/Offline/database";
  61486. export * from "babylonjs/Offline/IOfflineProvider";
  61487. }
  61488. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  61489. /** @hidden */
  61490. export var gpuUpdateParticlesPixelShader: {
  61491. name: string;
  61492. shader: string;
  61493. };
  61494. }
  61495. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  61496. /** @hidden */
  61497. export var gpuUpdateParticlesVertexShader: {
  61498. name: string;
  61499. shader: string;
  61500. };
  61501. }
  61502. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  61503. /** @hidden */
  61504. export var clipPlaneFragmentDeclaration2: {
  61505. name: string;
  61506. shader: string;
  61507. };
  61508. }
  61509. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  61510. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  61511. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  61512. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61513. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  61514. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  61515. /** @hidden */
  61516. export var gpuRenderParticlesPixelShader: {
  61517. name: string;
  61518. shader: string;
  61519. };
  61520. }
  61521. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  61522. /** @hidden */
  61523. export var clipPlaneVertexDeclaration2: {
  61524. name: string;
  61525. shader: string;
  61526. };
  61527. }
  61528. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  61529. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  61530. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  61531. /** @hidden */
  61532. export var gpuRenderParticlesVertexShader: {
  61533. name: string;
  61534. shader: string;
  61535. };
  61536. }
  61537. declare module "babylonjs/Particles/gpuParticleSystem" {
  61538. import { Nullable } from "babylonjs/types";
  61539. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  61540. import { Observable } from "babylonjs/Misc/observable";
  61541. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61542. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61543. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  61544. import { Scene, IDisposable } from "babylonjs/scene";
  61545. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  61546. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  61547. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  61548. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  61549. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  61550. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  61551. /**
  61552. * This represents a GPU particle system in Babylon
  61553. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  61554. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  61555. */
  61556. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  61557. /**
  61558. * The layer mask we are rendering the particles through.
  61559. */
  61560. layerMask: number;
  61561. private _capacity;
  61562. private _activeCount;
  61563. private _currentActiveCount;
  61564. private _accumulatedCount;
  61565. private _renderEffect;
  61566. private _updateEffect;
  61567. private _buffer0;
  61568. private _buffer1;
  61569. private _spriteBuffer;
  61570. private _updateVAO;
  61571. private _renderVAO;
  61572. private _targetIndex;
  61573. private _sourceBuffer;
  61574. private _targetBuffer;
  61575. private _engine;
  61576. private _currentRenderId;
  61577. private _started;
  61578. private _stopped;
  61579. private _timeDelta;
  61580. private _randomTexture;
  61581. private _randomTexture2;
  61582. private _attributesStrideSize;
  61583. private _updateEffectOptions;
  61584. private _randomTextureSize;
  61585. private _actualFrame;
  61586. private readonly _rawTextureWidth;
  61587. /**
  61588. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  61589. */
  61590. static readonly IsSupported: boolean;
  61591. /**
  61592. * An event triggered when the system is disposed.
  61593. */
  61594. onDisposeObservable: Observable<GPUParticleSystem>;
  61595. /**
  61596. * Gets the maximum number of particles active at the same time.
  61597. * @returns The max number of active particles.
  61598. */
  61599. getCapacity(): number;
  61600. /**
  61601. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  61602. * to override the particles.
  61603. */
  61604. forceDepthWrite: boolean;
  61605. /**
  61606. * Gets or set the number of active particles
  61607. */
  61608. activeParticleCount: number;
  61609. private _preWarmDone;
  61610. /**
  61611. * Is this system ready to be used/rendered
  61612. * @return true if the system is ready
  61613. */
  61614. isReady(): boolean;
  61615. /**
  61616. * Gets if the system has been started. (Note: this will still be true after stop is called)
  61617. * @returns True if it has been started, otherwise false.
  61618. */
  61619. isStarted(): boolean;
  61620. /**
  61621. * Starts the particle system and begins to emit
  61622. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  61623. */
  61624. start(delay?: number): void;
  61625. /**
  61626. * Stops the particle system.
  61627. */
  61628. stop(): void;
  61629. /**
  61630. * Remove all active particles
  61631. */
  61632. reset(): void;
  61633. /**
  61634. * Returns the string "GPUParticleSystem"
  61635. * @returns a string containing the class name
  61636. */
  61637. getClassName(): string;
  61638. private _colorGradientsTexture;
  61639. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  61640. /**
  61641. * Adds a new color gradient
  61642. * @param gradient defines the gradient to use (between 0 and 1)
  61643. * @param color1 defines the color to affect to the specified gradient
  61644. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  61645. * @returns the current particle system
  61646. */
  61647. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  61648. /**
  61649. * Remove a specific color gradient
  61650. * @param gradient defines the gradient to remove
  61651. * @returns the current particle system
  61652. */
  61653. removeColorGradient(gradient: number): GPUParticleSystem;
  61654. private _angularSpeedGradientsTexture;
  61655. private _sizeGradientsTexture;
  61656. private _velocityGradientsTexture;
  61657. private _limitVelocityGradientsTexture;
  61658. private _dragGradientsTexture;
  61659. private _addFactorGradient;
  61660. /**
  61661. * Adds a new size gradient
  61662. * @param gradient defines the gradient to use (between 0 and 1)
  61663. * @param factor defines the size factor to affect to the specified gradient
  61664. * @returns the current particle system
  61665. */
  61666. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  61667. /**
  61668. * Remove a specific size gradient
  61669. * @param gradient defines the gradient to remove
  61670. * @returns the current particle system
  61671. */
  61672. removeSizeGradient(gradient: number): GPUParticleSystem;
  61673. /**
  61674. * Adds a new angular speed gradient
  61675. * @param gradient defines the gradient to use (between 0 and 1)
  61676. * @param factor defines the angular speed to affect to the specified gradient
  61677. * @returns the current particle system
  61678. */
  61679. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  61680. /**
  61681. * Remove a specific angular speed gradient
  61682. * @param gradient defines the gradient to remove
  61683. * @returns the current particle system
  61684. */
  61685. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  61686. /**
  61687. * Adds a new velocity gradient
  61688. * @param gradient defines the gradient to use (between 0 and 1)
  61689. * @param factor defines the velocity to affect to the specified gradient
  61690. * @returns the current particle system
  61691. */
  61692. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  61693. /**
  61694. * Remove a specific velocity gradient
  61695. * @param gradient defines the gradient to remove
  61696. * @returns the current particle system
  61697. */
  61698. removeVelocityGradient(gradient: number): GPUParticleSystem;
  61699. /**
  61700. * Adds a new limit velocity gradient
  61701. * @param gradient defines the gradient to use (between 0 and 1)
  61702. * @param factor defines the limit velocity value to affect to the specified gradient
  61703. * @returns the current particle system
  61704. */
  61705. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  61706. /**
  61707. * Remove a specific limit velocity gradient
  61708. * @param gradient defines the gradient to remove
  61709. * @returns the current particle system
  61710. */
  61711. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  61712. /**
  61713. * Adds a new drag gradient
  61714. * @param gradient defines the gradient to use (between 0 and 1)
  61715. * @param factor defines the drag value to affect to the specified gradient
  61716. * @returns the current particle system
  61717. */
  61718. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  61719. /**
  61720. * Remove a specific drag gradient
  61721. * @param gradient defines the gradient to remove
  61722. * @returns the current particle system
  61723. */
  61724. removeDragGradient(gradient: number): GPUParticleSystem;
  61725. /**
  61726. * Not supported by GPUParticleSystem
  61727. * @param gradient defines the gradient to use (between 0 and 1)
  61728. * @param factor defines the emit rate value to affect to the specified gradient
  61729. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  61730. * @returns the current particle system
  61731. */
  61732. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  61733. /**
  61734. * Not supported by GPUParticleSystem
  61735. * @param gradient defines the gradient to remove
  61736. * @returns the current particle system
  61737. */
  61738. removeEmitRateGradient(gradient: number): IParticleSystem;
  61739. /**
  61740. * Not supported by GPUParticleSystem
  61741. * @param gradient defines the gradient to use (between 0 and 1)
  61742. * @param factor defines the start size value to affect to the specified gradient
  61743. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  61744. * @returns the current particle system
  61745. */
  61746. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  61747. /**
  61748. * Not supported by GPUParticleSystem
  61749. * @param gradient defines the gradient to remove
  61750. * @returns the current particle system
  61751. */
  61752. removeStartSizeGradient(gradient: number): IParticleSystem;
  61753. /**
  61754. * Not supported by GPUParticleSystem
  61755. * @param gradient defines the gradient to use (between 0 and 1)
  61756. * @param min defines the color remap minimal range
  61757. * @param max defines the color remap maximal range
  61758. * @returns the current particle system
  61759. */
  61760. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  61761. /**
  61762. * Not supported by GPUParticleSystem
  61763. * @param gradient defines the gradient to remove
  61764. * @returns the current particle system
  61765. */
  61766. removeColorRemapGradient(): IParticleSystem;
  61767. /**
  61768. * Not supported by GPUParticleSystem
  61769. * @param gradient defines the gradient to use (between 0 and 1)
  61770. * @param min defines the alpha remap minimal range
  61771. * @param max defines the alpha remap maximal range
  61772. * @returns the current particle system
  61773. */
  61774. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  61775. /**
  61776. * Not supported by GPUParticleSystem
  61777. * @param gradient defines the gradient to remove
  61778. * @returns the current particle system
  61779. */
  61780. removeAlphaRemapGradient(): IParticleSystem;
  61781. /**
  61782. * Not supported by GPUParticleSystem
  61783. * @param gradient defines the gradient to use (between 0 and 1)
  61784. * @param color defines the color to affect to the specified gradient
  61785. * @returns the current particle system
  61786. */
  61787. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  61788. /**
  61789. * Not supported by GPUParticleSystem
  61790. * @param gradient defines the gradient to remove
  61791. * @returns the current particle system
  61792. */
  61793. removeRampGradient(): IParticleSystem;
  61794. /**
  61795. * Not supported by GPUParticleSystem
  61796. * @returns the list of ramp gradients
  61797. */
  61798. getRampGradients(): Nullable<Array<Color3Gradient>>;
  61799. /**
  61800. * Not supported by GPUParticleSystem
  61801. * Gets or sets a boolean indicating that ramp gradients must be used
  61802. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  61803. */
  61804. useRampGradients: boolean;
  61805. /**
  61806. * Not supported by GPUParticleSystem
  61807. * @param gradient defines the gradient to use (between 0 and 1)
  61808. * @param factor defines the life time factor to affect to the specified gradient
  61809. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  61810. * @returns the current particle system
  61811. */
  61812. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  61813. /**
  61814. * Not supported by GPUParticleSystem
  61815. * @param gradient defines the gradient to remove
  61816. * @returns the current particle system
  61817. */
  61818. removeLifeTimeGradient(gradient: number): IParticleSystem;
  61819. /**
  61820. * Instantiates a GPU particle system.
  61821. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  61822. * @param name The name of the particle system
  61823. * @param options The options used to create the system
  61824. * @param scene The scene the particle system belongs to
  61825. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  61826. */
  61827. constructor(name: string, options: Partial<{
  61828. capacity: number;
  61829. randomTextureSize: number;
  61830. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  61831. protected _reset(): void;
  61832. private _createUpdateVAO;
  61833. private _createRenderVAO;
  61834. private _initialize;
  61835. /** @hidden */
  61836. _recreateUpdateEffect(): void;
  61837. /** @hidden */
  61838. _recreateRenderEffect(): void;
  61839. /**
  61840. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  61841. * @param preWarm defines if we are in the pre-warmimg phase
  61842. */
  61843. animate(preWarm?: boolean): void;
  61844. private _createFactorGradientTexture;
  61845. private _createSizeGradientTexture;
  61846. private _createAngularSpeedGradientTexture;
  61847. private _createVelocityGradientTexture;
  61848. private _createLimitVelocityGradientTexture;
  61849. private _createDragGradientTexture;
  61850. private _createColorGradientTexture;
  61851. /**
  61852. * Renders the particle system in its current state
  61853. * @param preWarm defines if the system should only update the particles but not render them
  61854. * @returns the current number of particles
  61855. */
  61856. render(preWarm?: boolean): number;
  61857. /**
  61858. * Rebuilds the particle system
  61859. */
  61860. rebuild(): void;
  61861. private _releaseBuffers;
  61862. private _releaseVAOs;
  61863. /**
  61864. * Disposes the particle system and free the associated resources
  61865. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  61866. */
  61867. dispose(disposeTexture?: boolean): void;
  61868. /**
  61869. * Clones the particle system.
  61870. * @param name The name of the cloned object
  61871. * @param newEmitter The new emitter to use
  61872. * @returns the cloned particle system
  61873. */
  61874. clone(name: string, newEmitter: any): GPUParticleSystem;
  61875. /**
  61876. * Serializes the particle system to a JSON object.
  61877. * @returns the JSON object
  61878. */
  61879. serialize(): any;
  61880. /**
  61881. * Parses a JSON object to create a GPU particle system.
  61882. * @param parsedParticleSystem The JSON object to parse
  61883. * @param scene The scene to create the particle system in
  61884. * @param rootUrl The root url to use to load external dependencies like texture
  61885. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  61886. * @returns the parsed GPU particle system
  61887. */
  61888. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  61889. }
  61890. }
  61891. declare module "babylonjs/Particles/particleSystemSet" {
  61892. import { Nullable } from "babylonjs/types";
  61893. import { Color3 } from "babylonjs/Maths/math.color";
  61894. import { TransformNode } from "babylonjs/Meshes/transformNode";
  61895. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61896. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61897. import { Scene, IDisposable } from "babylonjs/scene";
  61898. /**
  61899. * Represents a set of particle systems working together to create a specific effect
  61900. */
  61901. export class ParticleSystemSet implements IDisposable {
  61902. /**
  61903. * Gets or sets base Assets URL
  61904. */
  61905. static BaseAssetsUrl: string;
  61906. private _emitterCreationOptions;
  61907. private _emitterNode;
  61908. /**
  61909. * Gets the particle system list
  61910. */
  61911. systems: IParticleSystem[];
  61912. /**
  61913. * Gets the emitter node used with this set
  61914. */
  61915. readonly emitterNode: Nullable<TransformNode>;
  61916. /**
  61917. * Creates a new emitter mesh as a sphere
  61918. * @param options defines the options used to create the sphere
  61919. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  61920. * @param scene defines the hosting scene
  61921. */
  61922. setEmitterAsSphere(options: {
  61923. diameter: number;
  61924. segments: number;
  61925. color: Color3;
  61926. }, renderingGroupId: number, scene: Scene): void;
  61927. /**
  61928. * Starts all particle systems of the set
  61929. * @param emitter defines an optional mesh to use as emitter for the particle systems
  61930. */
  61931. start(emitter?: AbstractMesh): void;
  61932. /**
  61933. * Release all associated resources
  61934. */
  61935. dispose(): void;
  61936. /**
  61937. * Serialize the set into a JSON compatible object
  61938. * @returns a JSON compatible representation of the set
  61939. */
  61940. serialize(): any;
  61941. /**
  61942. * Parse a new ParticleSystemSet from a serialized source
  61943. * @param data defines a JSON compatible representation of the set
  61944. * @param scene defines the hosting scene
  61945. * @param gpu defines if we want GPU particles or CPU particles
  61946. * @returns a new ParticleSystemSet
  61947. */
  61948. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  61949. }
  61950. }
  61951. declare module "babylonjs/Particles/particleHelper" {
  61952. import { Nullable } from "babylonjs/types";
  61953. import { Scene } from "babylonjs/scene";
  61954. import { Vector3 } from "babylonjs/Maths/math.vector";
  61955. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61956. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61957. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  61958. /**
  61959. * This class is made for on one-liner static method to help creating particle system set.
  61960. */
  61961. export class ParticleHelper {
  61962. /**
  61963. * Gets or sets base Assets URL
  61964. */
  61965. static BaseAssetsUrl: string;
  61966. /**
  61967. * Create a default particle system that you can tweak
  61968. * @param emitter defines the emitter to use
  61969. * @param capacity defines the system capacity (default is 500 particles)
  61970. * @param scene defines the hosting scene
  61971. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  61972. * @returns the new Particle system
  61973. */
  61974. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  61975. /**
  61976. * This is the main static method (one-liner) of this helper to create different particle systems
  61977. * @param type This string represents the type to the particle system to create
  61978. * @param scene The scene where the particle system should live
  61979. * @param gpu If the system will use gpu
  61980. * @returns the ParticleSystemSet created
  61981. */
  61982. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  61983. /**
  61984. * Static function used to export a particle system to a ParticleSystemSet variable.
  61985. * Please note that the emitter shape is not exported
  61986. * @param systems defines the particle systems to export
  61987. * @returns the created particle system set
  61988. */
  61989. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  61990. }
  61991. }
  61992. declare module "babylonjs/Particles/particleSystemComponent" {
  61993. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61994. import { Effect } from "babylonjs/Materials/effect";
  61995. import "babylonjs/Shaders/particles.vertex";
  61996. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  61997. module "babylonjs/Engines/engine" {
  61998. interface Engine {
  61999. /**
  62000. * Create an effect to use with particle systems.
  62001. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  62002. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  62003. * @param uniformsNames defines a list of attribute names
  62004. * @param samplers defines an array of string used to represent textures
  62005. * @param defines defines the string containing the defines to use to compile the shaders
  62006. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  62007. * @param onCompiled defines a function to call when the effect creation is successful
  62008. * @param onError defines a function to call when the effect creation has failed
  62009. * @returns the new Effect
  62010. */
  62011. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  62012. }
  62013. }
  62014. module "babylonjs/Meshes/mesh" {
  62015. interface Mesh {
  62016. /**
  62017. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  62018. * @returns an array of IParticleSystem
  62019. */
  62020. getEmittedParticleSystems(): IParticleSystem[];
  62021. /**
  62022. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  62023. * @returns an array of IParticleSystem
  62024. */
  62025. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  62026. }
  62027. }
  62028. /**
  62029. * @hidden
  62030. */
  62031. export var _IDoNeedToBeInTheBuild: number;
  62032. }
  62033. declare module "babylonjs/Particles/pointsCloudSystem" {
  62034. import { Color4 } from "babylonjs/Maths/math";
  62035. import { Mesh } from "babylonjs/Meshes/mesh";
  62036. import { Scene, IDisposable } from "babylonjs/scene";
  62037. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  62038. /** Defines the 4 color options */
  62039. export enum PointColor {
  62040. /** color value */
  62041. Color = 2,
  62042. /** uv value */
  62043. UV = 1,
  62044. /** random value */
  62045. Random = 0,
  62046. /** stated value */
  62047. Stated = 3
  62048. }
  62049. /**
  62050. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  62051. * As it is just a mesh, the PointCloudSystem has all the same properties as any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  62052. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  62053. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  62054. *
  62055. * Full documentation here : TO BE ENTERED
  62056. */
  62057. export class PointsCloudSystem implements IDisposable {
  62058. /**
  62059. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  62060. * Example : var p = SPS.particles[i];
  62061. */
  62062. particles: CloudPoint[];
  62063. /**
  62064. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  62065. */
  62066. nbParticles: number;
  62067. /**
  62068. * This a counter for your own usage. It's not set by any SPS functions.
  62069. */
  62070. counter: number;
  62071. /**
  62072. * The PCS name. This name is also given to the underlying mesh.
  62073. */
  62074. name: string;
  62075. /**
  62076. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  62077. */
  62078. mesh: Mesh;
  62079. /**
  62080. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  62081. * Please read :
  62082. */
  62083. vars: any;
  62084. /**
  62085. * @hidden
  62086. */
  62087. _size: number;
  62088. private _scene;
  62089. private _promises;
  62090. private _positions;
  62091. private _indices;
  62092. private _normals;
  62093. private _colors;
  62094. private _uvs;
  62095. private _indices32;
  62096. private _positions32;
  62097. private _colors32;
  62098. private _uvs32;
  62099. private _updatable;
  62100. private _isVisibilityBoxLocked;
  62101. private _alwaysVisible;
  62102. private _groups;
  62103. private _groupCounter;
  62104. private _computeParticleColor;
  62105. private _computeParticleTexture;
  62106. private _computeParticleRotation;
  62107. private _computeBoundingBox;
  62108. private _isReady;
  62109. /**
  62110. * Creates a PCS (Points Cloud System) object
  62111. * @param name (String) is the PCS name, this will be the underlying mesh name
  62112. * @param pointSize (number) is the size for each point
  62113. * @param scene (Scene) is the scene in which the PCS is added
  62114. * @param options defines the options of the PCS e.g.
  62115. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  62116. */
  62117. constructor(name: string, pointSize: number, scene: Scene, options?: {
  62118. updatable?: boolean;
  62119. });
  62120. /**
  62121. * Builds the PCS underlying mesh. Returns a standard Mesh.
  62122. * If no points were added to the PCS, the returned mesh is just a single point.
  62123. * @returns a promise for the created mesh
  62124. */
  62125. buildMeshAsync(): Promise<Mesh>;
  62126. /**
  62127. * @hidden
  62128. */
  62129. private _buildMesh;
  62130. private _addParticle;
  62131. private _randomUnitVector;
  62132. private _getColorIndicesForCoord;
  62133. private _setPointsColorOrUV;
  62134. private _colorFromTexture;
  62135. private _calculateDensity;
  62136. /**
  62137. * Adds points to the PCS in random positions within a unit sphere
  62138. * @param nb (positive integer) the number of particles to be created from this model
  62139. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  62140. * @returns the number of groups in the system
  62141. */
  62142. addPoints(nb: number, pointFunction?: any): number;
  62143. /**
  62144. * Adds points to the PCS from the surface of the model shape
  62145. * @param mesh is any Mesh object that will be used as a surface model for the points
  62146. * @param nb (positive integer) the number of particles to be created from this model
  62147. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  62148. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  62149. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  62150. * @returns the number of groups in the system
  62151. */
  62152. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  62153. /**
  62154. * Adds points to the PCS inside the model shape
  62155. * @param mesh is any Mesh object that will be used as a surface model for the points
  62156. * @param nb (positive integer) the number of particles to be created from this model
  62157. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  62158. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  62159. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  62160. * @returns the number of groups in the system
  62161. */
  62162. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  62163. /**
  62164. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  62165. * This method calls `updateParticle()` for each particle of the SPS.
  62166. * For an animated SPS, it is usually called within the render loop.
  62167. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  62168. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  62169. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  62170. * @returns the PCS.
  62171. */
  62172. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  62173. /**
  62174. * Disposes the PCS.
  62175. */
  62176. dispose(): void;
  62177. /**
  62178. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  62179. * doc :
  62180. * @returns the PCS.
  62181. */
  62182. refreshVisibleSize(): PointsCloudSystem;
  62183. /**
  62184. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  62185. * @param size the size (float) of the visibility box
  62186. * note : this doesn't lock the PCS mesh bounding box.
  62187. * doc :
  62188. */
  62189. setVisibilityBox(size: number): void;
  62190. /**
  62191. * Gets whether the PCS is always visible or not
  62192. * doc :
  62193. */
  62194. /**
  62195. * Sets the PCS as always visible or not
  62196. * doc :
  62197. */
  62198. isAlwaysVisible: boolean;
  62199. /**
  62200. * Tells to `setParticles()` to compute the particle rotations or not
  62201. * Default value : false. The PCS is faster when it's set to false
  62202. * Note : particle rotations are only applied to parent particles
  62203. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  62204. */
  62205. computeParticleRotation: boolean;
  62206. /**
  62207. * Tells to `setParticles()` to compute the particle colors or not.
  62208. * Default value : true. The PCS is faster when it's set to false.
  62209. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  62210. */
  62211. /**
  62212. * Gets if `setParticles()` computes the particle colors or not.
  62213. * Default value : false. The PCS is faster when it's set to false.
  62214. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  62215. */
  62216. computeParticleColor: boolean;
  62217. /**
  62218. * Gets if `setParticles()` computes the particle textures or not.
  62219. * Default value : false. The PCS is faster when it's set to false.
  62220. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  62221. */
  62222. computeParticleTexture: boolean;
  62223. /**
  62224. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  62225. */
  62226. /**
  62227. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  62228. */
  62229. computeBoundingBox: boolean;
  62230. /**
  62231. * This function does nothing. It may be overwritten to set all the particle first values.
  62232. * The PCS doesn't call this function, you may have to call it by your own.
  62233. * doc :
  62234. */
  62235. initParticles(): void;
  62236. /**
  62237. * This function does nothing. It may be overwritten to recycle a particle
  62238. * The PCS doesn't call this function, you can to call it
  62239. * doc :
  62240. * @param particle The particle to recycle
  62241. * @returns the recycled particle
  62242. */
  62243. recycleParticle(particle: CloudPoint): CloudPoint;
  62244. /**
  62245. * Updates a particle : this function should be overwritten by the user.
  62246. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  62247. * doc :
  62248. * @example : just set a particle position or velocity and recycle conditions
  62249. * @param particle The particle to update
  62250. * @returns the updated particle
  62251. */
  62252. updateParticle(particle: CloudPoint): CloudPoint;
  62253. /**
  62254. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  62255. * This does nothing and may be overwritten by the user.
  62256. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  62257. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  62258. * @param update the boolean update value actually passed to setParticles()
  62259. */
  62260. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  62261. /**
  62262. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  62263. * This will be passed three parameters.
  62264. * This does nothing and may be overwritten by the user.
  62265. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  62266. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  62267. * @param update the boolean update value actually passed to setParticles()
  62268. */
  62269. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  62270. }
  62271. }
  62272. declare module "babylonjs/Particles/cloudPoint" {
  62273. import { Nullable } from "babylonjs/types";
  62274. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  62275. import { Mesh } from "babylonjs/Meshes/mesh";
  62276. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62277. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  62278. /**
  62279. * Represents one particle of a points cloud system.
  62280. */
  62281. export class CloudPoint {
  62282. /**
  62283. * particle global index
  62284. */
  62285. idx: number;
  62286. /**
  62287. * The color of the particle
  62288. */
  62289. color: Nullable<Color4>;
  62290. /**
  62291. * The world space position of the particle.
  62292. */
  62293. position: Vector3;
  62294. /**
  62295. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  62296. */
  62297. rotation: Vector3;
  62298. /**
  62299. * The world space rotation quaternion of the particle.
  62300. */
  62301. rotationQuaternion: Nullable<Quaternion>;
  62302. /**
  62303. * The uv of the particle.
  62304. */
  62305. uv: Nullable<Vector2>;
  62306. /**
  62307. * The current speed of the particle.
  62308. */
  62309. velocity: Vector3;
  62310. /**
  62311. * The pivot point in the particle local space.
  62312. */
  62313. pivot: Vector3;
  62314. /**
  62315. * Must the particle be translated from its pivot point in its local space ?
  62316. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  62317. * Default : false
  62318. */
  62319. translateFromPivot: boolean;
  62320. /**
  62321. * Index of this particle in the global "positions" array (Internal use)
  62322. * @hidden
  62323. */
  62324. _pos: number;
  62325. /**
  62326. * @hidden Index of this particle in the global "indices" array (Internal use)
  62327. */
  62328. _ind: number;
  62329. /**
  62330. * Group this particle belongs to
  62331. */
  62332. _group: PointsGroup;
  62333. /**
  62334. * Group id of this particle
  62335. */
  62336. groupId: number;
  62337. /**
  62338. * Index of the particle in its group id (Internal use)
  62339. */
  62340. idxInGroup: number;
  62341. /**
  62342. * @hidden Particle BoundingInfo object (Internal use)
  62343. */
  62344. _boundingInfo: BoundingInfo;
  62345. /**
  62346. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  62347. */
  62348. _pcs: PointsCloudSystem;
  62349. /**
  62350. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  62351. */
  62352. _stillInvisible: boolean;
  62353. /**
  62354. * @hidden Last computed particle rotation matrix
  62355. */
  62356. _rotationMatrix: number[];
  62357. /**
  62358. * Parent particle Id, if any.
  62359. * Default null.
  62360. */
  62361. parentId: Nullable<number>;
  62362. /**
  62363. * @hidden Internal global position in the PCS.
  62364. */
  62365. _globalPosition: Vector3;
  62366. /**
  62367. * Creates a Point Cloud object.
  62368. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  62369. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  62370. * @param group (PointsGroup) is the group the particle belongs to
  62371. * @param groupId (integer) is the group identifier in the PCS.
  62372. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  62373. * @param pcs defines the PCS it is associated to
  62374. */
  62375. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  62376. /**
  62377. * get point size
  62378. */
  62379. /**
  62380. * Set point size
  62381. */
  62382. size: Vector3;
  62383. /**
  62384. * Legacy support, changed quaternion to rotationQuaternion
  62385. */
  62386. /**
  62387. * Legacy support, changed quaternion to rotationQuaternion
  62388. */
  62389. quaternion: Nullable<Quaternion>;
  62390. /**
  62391. * Returns a boolean. True if the particle intersects a mesh, else false
  62392. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  62393. * @param target is the object (point or mesh) what the intersection is computed against
  62394. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  62395. * @returns true if it intersects
  62396. */
  62397. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  62398. /**
  62399. * get the rotation matrix of the particle
  62400. * @hidden
  62401. */
  62402. getRotationMatrix(m: Matrix): void;
  62403. }
  62404. /**
  62405. * Represents a group of points in a points cloud system
  62406. * * PCS internal tool, don't use it manually.
  62407. */
  62408. export class PointsGroup {
  62409. /**
  62410. * The group id
  62411. * @hidden
  62412. */
  62413. groupID: number;
  62414. /**
  62415. * image data for group (internal use)
  62416. * @hidden
  62417. */
  62418. _groupImageData: Nullable<ArrayBufferView>;
  62419. /**
  62420. * Image Width (internal use)
  62421. * @hidden
  62422. */
  62423. _groupImgWidth: number;
  62424. /**
  62425. * Image Height (internal use)
  62426. * @hidden
  62427. */
  62428. _groupImgHeight: number;
  62429. /**
  62430. * Custom position function (internal use)
  62431. * @hidden
  62432. */
  62433. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  62434. /**
  62435. * density per facet for surface points
  62436. * @hidden
  62437. */
  62438. _groupDensity: number[];
  62439. /**
  62440. * Only when points are colored by texture carries pointer to texture list array
  62441. * @hidden
  62442. */
  62443. _textureNb: number;
  62444. /**
  62445. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  62446. * PCS internal tool, don't use it manually.
  62447. * @hidden
  62448. */
  62449. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  62450. }
  62451. }
  62452. declare module "babylonjs/Particles/index" {
  62453. export * from "babylonjs/Particles/baseParticleSystem";
  62454. export * from "babylonjs/Particles/EmitterTypes/index";
  62455. export * from "babylonjs/Particles/gpuParticleSystem";
  62456. export * from "babylonjs/Particles/IParticleSystem";
  62457. export * from "babylonjs/Particles/particle";
  62458. export * from "babylonjs/Particles/particleHelper";
  62459. export * from "babylonjs/Particles/particleSystem";
  62460. export * from "babylonjs/Particles/particleSystemComponent";
  62461. export * from "babylonjs/Particles/particleSystemSet";
  62462. export * from "babylonjs/Particles/solidParticle";
  62463. export * from "babylonjs/Particles/solidParticleSystem";
  62464. export * from "babylonjs/Particles/cloudPoint";
  62465. export * from "babylonjs/Particles/pointsCloudSystem";
  62466. export * from "babylonjs/Particles/subEmitter";
  62467. }
  62468. declare module "babylonjs/Physics/physicsEngineComponent" {
  62469. import { Nullable } from "babylonjs/types";
  62470. import { Observable, Observer } from "babylonjs/Misc/observable";
  62471. import { Vector3 } from "babylonjs/Maths/math.vector";
  62472. import { Mesh } from "babylonjs/Meshes/mesh";
  62473. import { ISceneComponent } from "babylonjs/sceneComponent";
  62474. import { Scene } from "babylonjs/scene";
  62475. import { Node } from "babylonjs/node";
  62476. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  62477. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62478. module "babylonjs/scene" {
  62479. interface Scene {
  62480. /** @hidden (Backing field) */
  62481. _physicsEngine: Nullable<IPhysicsEngine>;
  62482. /**
  62483. * Gets the current physics engine
  62484. * @returns a IPhysicsEngine or null if none attached
  62485. */
  62486. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  62487. /**
  62488. * Enables physics to the current scene
  62489. * @param gravity defines the scene's gravity for the physics engine
  62490. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  62491. * @return a boolean indicating if the physics engine was initialized
  62492. */
  62493. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  62494. /**
  62495. * Disables and disposes the physics engine associated with the scene
  62496. */
  62497. disablePhysicsEngine(): void;
  62498. /**
  62499. * Gets a boolean indicating if there is an active physics engine
  62500. * @returns a boolean indicating if there is an active physics engine
  62501. */
  62502. isPhysicsEnabled(): boolean;
  62503. /**
  62504. * Deletes a physics compound impostor
  62505. * @param compound defines the compound to delete
  62506. */
  62507. deleteCompoundImpostor(compound: any): void;
  62508. /**
  62509. * An event triggered when physic simulation is about to be run
  62510. */
  62511. onBeforePhysicsObservable: Observable<Scene>;
  62512. /**
  62513. * An event triggered when physic simulation has been done
  62514. */
  62515. onAfterPhysicsObservable: Observable<Scene>;
  62516. }
  62517. }
  62518. module "babylonjs/Meshes/abstractMesh" {
  62519. interface AbstractMesh {
  62520. /** @hidden */
  62521. _physicsImpostor: Nullable<PhysicsImpostor>;
  62522. /**
  62523. * Gets or sets impostor used for physic simulation
  62524. * @see http://doc.babylonjs.com/features/physics_engine
  62525. */
  62526. physicsImpostor: Nullable<PhysicsImpostor>;
  62527. /**
  62528. * Gets the current physics impostor
  62529. * @see http://doc.babylonjs.com/features/physics_engine
  62530. * @returns a physics impostor or null
  62531. */
  62532. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  62533. /** Apply a physic impulse to the mesh
  62534. * @param force defines the force to apply
  62535. * @param contactPoint defines where to apply the force
  62536. * @returns the current mesh
  62537. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  62538. */
  62539. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  62540. /**
  62541. * Creates a physic joint between two meshes
  62542. * @param otherMesh defines the other mesh to use
  62543. * @param pivot1 defines the pivot to use on this mesh
  62544. * @param pivot2 defines the pivot to use on the other mesh
  62545. * @param options defines additional options (can be plugin dependent)
  62546. * @returns the current mesh
  62547. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  62548. */
  62549. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  62550. /** @hidden */
  62551. _disposePhysicsObserver: Nullable<Observer<Node>>;
  62552. }
  62553. }
  62554. /**
  62555. * Defines the physics engine scene component responsible to manage a physics engine
  62556. */
  62557. export class PhysicsEngineSceneComponent implements ISceneComponent {
  62558. /**
  62559. * The component name helpful to identify the component in the list of scene components.
  62560. */
  62561. readonly name: string;
  62562. /**
  62563. * The scene the component belongs to.
  62564. */
  62565. scene: Scene;
  62566. /**
  62567. * Creates a new instance of the component for the given scene
  62568. * @param scene Defines the scene to register the component in
  62569. */
  62570. constructor(scene: Scene);
  62571. /**
  62572. * Registers the component in a given scene
  62573. */
  62574. register(): void;
  62575. /**
  62576. * Rebuilds the elements related to this component in case of
  62577. * context lost for instance.
  62578. */
  62579. rebuild(): void;
  62580. /**
  62581. * Disposes the component and the associated ressources
  62582. */
  62583. dispose(): void;
  62584. }
  62585. }
  62586. declare module "babylonjs/Physics/physicsHelper" {
  62587. import { Nullable } from "babylonjs/types";
  62588. import { Vector3 } from "babylonjs/Maths/math.vector";
  62589. import { Mesh } from "babylonjs/Meshes/mesh";
  62590. import { Scene } from "babylonjs/scene";
  62591. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62592. /**
  62593. * A helper for physics simulations
  62594. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62595. */
  62596. export class PhysicsHelper {
  62597. private _scene;
  62598. private _physicsEngine;
  62599. /**
  62600. * Initializes the Physics helper
  62601. * @param scene Babylon.js scene
  62602. */
  62603. constructor(scene: Scene);
  62604. /**
  62605. * Applies a radial explosion impulse
  62606. * @param origin the origin of the explosion
  62607. * @param radiusOrEventOptions the radius or the options of radial explosion
  62608. * @param strength the explosion strength
  62609. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62610. * @returns A physics radial explosion event, or null
  62611. */
  62612. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  62613. /**
  62614. * Applies a radial explosion force
  62615. * @param origin the origin of the explosion
  62616. * @param radiusOrEventOptions the radius or the options of radial explosion
  62617. * @param strength the explosion strength
  62618. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62619. * @returns A physics radial explosion event, or null
  62620. */
  62621. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  62622. /**
  62623. * Creates a gravitational field
  62624. * @param origin the origin of the explosion
  62625. * @param radiusOrEventOptions the radius or the options of radial explosion
  62626. * @param strength the explosion strength
  62627. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62628. * @returns A physics gravitational field event, or null
  62629. */
  62630. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  62631. /**
  62632. * Creates a physics updraft event
  62633. * @param origin the origin of the updraft
  62634. * @param radiusOrEventOptions the radius or the options of the updraft
  62635. * @param strength the strength of the updraft
  62636. * @param height the height of the updraft
  62637. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  62638. * @returns A physics updraft event, or null
  62639. */
  62640. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  62641. /**
  62642. * Creates a physics vortex event
  62643. * @param origin the of the vortex
  62644. * @param radiusOrEventOptions the radius or the options of the vortex
  62645. * @param strength the strength of the vortex
  62646. * @param height the height of the vortex
  62647. * @returns a Physics vortex event, or null
  62648. * A physics vortex event or null
  62649. */
  62650. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  62651. }
  62652. /**
  62653. * Represents a physics radial explosion event
  62654. */
  62655. class PhysicsRadialExplosionEvent {
  62656. private _scene;
  62657. private _options;
  62658. private _sphere;
  62659. private _dataFetched;
  62660. /**
  62661. * Initializes a radial explosioin event
  62662. * @param _scene BabylonJS scene
  62663. * @param _options The options for the vortex event
  62664. */
  62665. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  62666. /**
  62667. * Returns the data related to the radial explosion event (sphere).
  62668. * @returns The radial explosion event data
  62669. */
  62670. getData(): PhysicsRadialExplosionEventData;
  62671. /**
  62672. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  62673. * @param impostor A physics imposter
  62674. * @param origin the origin of the explosion
  62675. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  62676. */
  62677. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  62678. /**
  62679. * Triggers affecterd impostors callbacks
  62680. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  62681. */
  62682. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  62683. /**
  62684. * Disposes the sphere.
  62685. * @param force Specifies if the sphere should be disposed by force
  62686. */
  62687. dispose(force?: boolean): void;
  62688. /*** Helpers ***/
  62689. private _prepareSphere;
  62690. private _intersectsWithSphere;
  62691. }
  62692. /**
  62693. * Represents a gravitational field event
  62694. */
  62695. class PhysicsGravitationalFieldEvent {
  62696. private _physicsHelper;
  62697. private _scene;
  62698. private _origin;
  62699. private _options;
  62700. private _tickCallback;
  62701. private _sphere;
  62702. private _dataFetched;
  62703. /**
  62704. * Initializes the physics gravitational field event
  62705. * @param _physicsHelper A physics helper
  62706. * @param _scene BabylonJS scene
  62707. * @param _origin The origin position of the gravitational field event
  62708. * @param _options The options for the vortex event
  62709. */
  62710. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  62711. /**
  62712. * Returns the data related to the gravitational field event (sphere).
  62713. * @returns A gravitational field event
  62714. */
  62715. getData(): PhysicsGravitationalFieldEventData;
  62716. /**
  62717. * Enables the gravitational field.
  62718. */
  62719. enable(): void;
  62720. /**
  62721. * Disables the gravitational field.
  62722. */
  62723. disable(): void;
  62724. /**
  62725. * Disposes the sphere.
  62726. * @param force The force to dispose from the gravitational field event
  62727. */
  62728. dispose(force?: boolean): void;
  62729. private _tick;
  62730. }
  62731. /**
  62732. * Represents a physics updraft event
  62733. */
  62734. class PhysicsUpdraftEvent {
  62735. private _scene;
  62736. private _origin;
  62737. private _options;
  62738. private _physicsEngine;
  62739. private _originTop;
  62740. private _originDirection;
  62741. private _tickCallback;
  62742. private _cylinder;
  62743. private _cylinderPosition;
  62744. private _dataFetched;
  62745. /**
  62746. * Initializes the physics updraft event
  62747. * @param _scene BabylonJS scene
  62748. * @param _origin The origin position of the updraft
  62749. * @param _options The options for the updraft event
  62750. */
  62751. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  62752. /**
  62753. * Returns the data related to the updraft event (cylinder).
  62754. * @returns A physics updraft event
  62755. */
  62756. getData(): PhysicsUpdraftEventData;
  62757. /**
  62758. * Enables the updraft.
  62759. */
  62760. enable(): void;
  62761. /**
  62762. * Disables the updraft.
  62763. */
  62764. disable(): void;
  62765. /**
  62766. * Disposes the cylinder.
  62767. * @param force Specifies if the updraft should be disposed by force
  62768. */
  62769. dispose(force?: boolean): void;
  62770. private getImpostorHitData;
  62771. private _tick;
  62772. /*** Helpers ***/
  62773. private _prepareCylinder;
  62774. private _intersectsWithCylinder;
  62775. }
  62776. /**
  62777. * Represents a physics vortex event
  62778. */
  62779. class PhysicsVortexEvent {
  62780. private _scene;
  62781. private _origin;
  62782. private _options;
  62783. private _physicsEngine;
  62784. private _originTop;
  62785. private _tickCallback;
  62786. private _cylinder;
  62787. private _cylinderPosition;
  62788. private _dataFetched;
  62789. /**
  62790. * Initializes the physics vortex event
  62791. * @param _scene The BabylonJS scene
  62792. * @param _origin The origin position of the vortex
  62793. * @param _options The options for the vortex event
  62794. */
  62795. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  62796. /**
  62797. * Returns the data related to the vortex event (cylinder).
  62798. * @returns The physics vortex event data
  62799. */
  62800. getData(): PhysicsVortexEventData;
  62801. /**
  62802. * Enables the vortex.
  62803. */
  62804. enable(): void;
  62805. /**
  62806. * Disables the cortex.
  62807. */
  62808. disable(): void;
  62809. /**
  62810. * Disposes the sphere.
  62811. * @param force
  62812. */
  62813. dispose(force?: boolean): void;
  62814. private getImpostorHitData;
  62815. private _tick;
  62816. /*** Helpers ***/
  62817. private _prepareCylinder;
  62818. private _intersectsWithCylinder;
  62819. }
  62820. /**
  62821. * Options fot the radial explosion event
  62822. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62823. */
  62824. export class PhysicsRadialExplosionEventOptions {
  62825. /**
  62826. * The radius of the sphere for the radial explosion.
  62827. */
  62828. radius: number;
  62829. /**
  62830. * The strenth of the explosion.
  62831. */
  62832. strength: number;
  62833. /**
  62834. * The strenght of the force in correspondence to the distance of the affected object
  62835. */
  62836. falloff: PhysicsRadialImpulseFalloff;
  62837. /**
  62838. * Sphere options for the radial explosion.
  62839. */
  62840. sphere: {
  62841. segments: number;
  62842. diameter: number;
  62843. };
  62844. /**
  62845. * Sphere options for the radial explosion.
  62846. */
  62847. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  62848. }
  62849. /**
  62850. * Options fot the updraft event
  62851. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62852. */
  62853. export class PhysicsUpdraftEventOptions {
  62854. /**
  62855. * The radius of the cylinder for the vortex
  62856. */
  62857. radius: number;
  62858. /**
  62859. * The strenth of the updraft.
  62860. */
  62861. strength: number;
  62862. /**
  62863. * The height of the cylinder for the updraft.
  62864. */
  62865. height: number;
  62866. /**
  62867. * The mode for the the updraft.
  62868. */
  62869. updraftMode: PhysicsUpdraftMode;
  62870. }
  62871. /**
  62872. * Options fot the vortex event
  62873. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62874. */
  62875. export class PhysicsVortexEventOptions {
  62876. /**
  62877. * The radius of the cylinder for the vortex
  62878. */
  62879. radius: number;
  62880. /**
  62881. * The strenth of the vortex.
  62882. */
  62883. strength: number;
  62884. /**
  62885. * The height of the cylinder for the vortex.
  62886. */
  62887. height: number;
  62888. /**
  62889. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  62890. */
  62891. centripetalForceThreshold: number;
  62892. /**
  62893. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  62894. */
  62895. centripetalForceMultiplier: number;
  62896. /**
  62897. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  62898. */
  62899. centrifugalForceMultiplier: number;
  62900. /**
  62901. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  62902. */
  62903. updraftForceMultiplier: number;
  62904. }
  62905. /**
  62906. * The strenght of the force in correspondence to the distance of the affected object
  62907. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62908. */
  62909. export enum PhysicsRadialImpulseFalloff {
  62910. /** Defines that impulse is constant in strength across it's whole radius */
  62911. Constant = 0,
  62912. /** Defines that impulse gets weaker if it's further from the origin */
  62913. Linear = 1
  62914. }
  62915. /**
  62916. * The strength of the force in correspondence to the distance of the affected object
  62917. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62918. */
  62919. export enum PhysicsUpdraftMode {
  62920. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  62921. Center = 0,
  62922. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  62923. Perpendicular = 1
  62924. }
  62925. /**
  62926. * Interface for a physics hit data
  62927. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62928. */
  62929. export interface PhysicsHitData {
  62930. /**
  62931. * The force applied at the contact point
  62932. */
  62933. force: Vector3;
  62934. /**
  62935. * The contact point
  62936. */
  62937. contactPoint: Vector3;
  62938. /**
  62939. * The distance from the origin to the contact point
  62940. */
  62941. distanceFromOrigin: number;
  62942. }
  62943. /**
  62944. * Interface for radial explosion event data
  62945. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62946. */
  62947. export interface PhysicsRadialExplosionEventData {
  62948. /**
  62949. * A sphere used for the radial explosion event
  62950. */
  62951. sphere: Mesh;
  62952. }
  62953. /**
  62954. * Interface for gravitational field event data
  62955. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62956. */
  62957. export interface PhysicsGravitationalFieldEventData {
  62958. /**
  62959. * A sphere mesh used for the gravitational field event
  62960. */
  62961. sphere: Mesh;
  62962. }
  62963. /**
  62964. * Interface for updraft event data
  62965. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62966. */
  62967. export interface PhysicsUpdraftEventData {
  62968. /**
  62969. * A cylinder used for the updraft event
  62970. */
  62971. cylinder: Mesh;
  62972. }
  62973. /**
  62974. * Interface for vortex event data
  62975. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62976. */
  62977. export interface PhysicsVortexEventData {
  62978. /**
  62979. * A cylinder used for the vortex event
  62980. */
  62981. cylinder: Mesh;
  62982. }
  62983. /**
  62984. * Interface for an affected physics impostor
  62985. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62986. */
  62987. export interface PhysicsAffectedImpostorWithData {
  62988. /**
  62989. * The impostor affected by the effect
  62990. */
  62991. impostor: PhysicsImpostor;
  62992. /**
  62993. * The data about the hit/horce from the explosion
  62994. */
  62995. hitData: PhysicsHitData;
  62996. }
  62997. }
  62998. declare module "babylonjs/Physics/Plugins/index" {
  62999. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  63000. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  63001. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  63002. }
  63003. declare module "babylonjs/Physics/index" {
  63004. export * from "babylonjs/Physics/IPhysicsEngine";
  63005. export * from "babylonjs/Physics/physicsEngine";
  63006. export * from "babylonjs/Physics/physicsEngineComponent";
  63007. export * from "babylonjs/Physics/physicsHelper";
  63008. export * from "babylonjs/Physics/physicsImpostor";
  63009. export * from "babylonjs/Physics/physicsJoint";
  63010. export * from "babylonjs/Physics/Plugins/index";
  63011. }
  63012. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  63013. /** @hidden */
  63014. export var blackAndWhitePixelShader: {
  63015. name: string;
  63016. shader: string;
  63017. };
  63018. }
  63019. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  63020. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63021. import { Camera } from "babylonjs/Cameras/camera";
  63022. import { Engine } from "babylonjs/Engines/engine";
  63023. import "babylonjs/Shaders/blackAndWhite.fragment";
  63024. /**
  63025. * Post process used to render in black and white
  63026. */
  63027. export class BlackAndWhitePostProcess extends PostProcess {
  63028. /**
  63029. * Linear about to convert he result to black and white (default: 1)
  63030. */
  63031. degree: number;
  63032. /**
  63033. * Creates a black and white post process
  63034. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  63035. * @param name The name of the effect.
  63036. * @param options The required width/height ratio to downsize to before computing the render pass.
  63037. * @param camera The camera to apply the render pass to.
  63038. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63039. * @param engine The engine which the post process will be applied. (default: current engine)
  63040. * @param reusable If the post process can be reused on the same frame. (default: false)
  63041. */
  63042. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63043. }
  63044. }
  63045. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  63046. import { Nullable } from "babylonjs/types";
  63047. import { Camera } from "babylonjs/Cameras/camera";
  63048. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63049. import { Engine } from "babylonjs/Engines/engine";
  63050. /**
  63051. * This represents a set of one or more post processes in Babylon.
  63052. * A post process can be used to apply a shader to a texture after it is rendered.
  63053. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  63054. */
  63055. export class PostProcessRenderEffect {
  63056. private _postProcesses;
  63057. private _getPostProcesses;
  63058. private _singleInstance;
  63059. private _cameras;
  63060. private _indicesForCamera;
  63061. /**
  63062. * Name of the effect
  63063. * @hidden
  63064. */
  63065. _name: string;
  63066. /**
  63067. * Instantiates a post process render effect.
  63068. * A post process can be used to apply a shader to a texture after it is rendered.
  63069. * @param engine The engine the effect is tied to
  63070. * @param name The name of the effect
  63071. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  63072. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  63073. */
  63074. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  63075. /**
  63076. * Checks if all the post processes in the effect are supported.
  63077. */
  63078. readonly isSupported: boolean;
  63079. /**
  63080. * Updates the current state of the effect
  63081. * @hidden
  63082. */
  63083. _update(): void;
  63084. /**
  63085. * Attaches the effect on cameras
  63086. * @param cameras The camera to attach to.
  63087. * @hidden
  63088. */
  63089. _attachCameras(cameras: Camera): void;
  63090. /**
  63091. * Attaches the effect on cameras
  63092. * @param cameras The camera to attach to.
  63093. * @hidden
  63094. */
  63095. _attachCameras(cameras: Camera[]): void;
  63096. /**
  63097. * Detaches the effect on cameras
  63098. * @param cameras The camera to detatch from.
  63099. * @hidden
  63100. */
  63101. _detachCameras(cameras: Camera): void;
  63102. /**
  63103. * Detatches the effect on cameras
  63104. * @param cameras The camera to detatch from.
  63105. * @hidden
  63106. */
  63107. _detachCameras(cameras: Camera[]): void;
  63108. /**
  63109. * Enables the effect on given cameras
  63110. * @param cameras The camera to enable.
  63111. * @hidden
  63112. */
  63113. _enable(cameras: Camera): void;
  63114. /**
  63115. * Enables the effect on given cameras
  63116. * @param cameras The camera to enable.
  63117. * @hidden
  63118. */
  63119. _enable(cameras: Nullable<Camera[]>): void;
  63120. /**
  63121. * Disables the effect on the given cameras
  63122. * @param cameras The camera to disable.
  63123. * @hidden
  63124. */
  63125. _disable(cameras: Camera): void;
  63126. /**
  63127. * Disables the effect on the given cameras
  63128. * @param cameras The camera to disable.
  63129. * @hidden
  63130. */
  63131. _disable(cameras: Nullable<Camera[]>): void;
  63132. /**
  63133. * Gets a list of the post processes contained in the effect.
  63134. * @param camera The camera to get the post processes on.
  63135. * @returns The list of the post processes in the effect.
  63136. */
  63137. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  63138. }
  63139. }
  63140. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  63141. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63142. /** @hidden */
  63143. export var extractHighlightsPixelShader: {
  63144. name: string;
  63145. shader: string;
  63146. };
  63147. }
  63148. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  63149. import { Nullable } from "babylonjs/types";
  63150. import { Camera } from "babylonjs/Cameras/camera";
  63151. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63152. import { Engine } from "babylonjs/Engines/engine";
  63153. import "babylonjs/Shaders/extractHighlights.fragment";
  63154. /**
  63155. * The extract highlights post process sets all pixels to black except pixels above the specified luminance threshold. Used as the first step for a bloom effect.
  63156. */
  63157. export class ExtractHighlightsPostProcess extends PostProcess {
  63158. /**
  63159. * The luminance threshold, pixels below this value will be set to black.
  63160. */
  63161. threshold: number;
  63162. /** @hidden */
  63163. _exposure: number;
  63164. /**
  63165. * Post process which has the input texture to be used when performing highlight extraction
  63166. * @hidden
  63167. */
  63168. _inputPostProcess: Nullable<PostProcess>;
  63169. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63170. }
  63171. }
  63172. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  63173. /** @hidden */
  63174. export var bloomMergePixelShader: {
  63175. name: string;
  63176. shader: string;
  63177. };
  63178. }
  63179. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  63180. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63181. import { Nullable } from "babylonjs/types";
  63182. import { Engine } from "babylonjs/Engines/engine";
  63183. import { Camera } from "babylonjs/Cameras/camera";
  63184. import "babylonjs/Shaders/bloomMerge.fragment";
  63185. /**
  63186. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  63187. */
  63188. export class BloomMergePostProcess extends PostProcess {
  63189. /** Weight of the bloom to be added to the original input. */
  63190. weight: number;
  63191. /**
  63192. * Creates a new instance of @see BloomMergePostProcess
  63193. * @param name The name of the effect.
  63194. * @param originalFromInput Post process which's input will be used for the merge.
  63195. * @param blurred Blurred highlights post process which's output will be used.
  63196. * @param weight Weight of the bloom to be added to the original input.
  63197. * @param options The required width/height ratio to downsize to before computing the render pass.
  63198. * @param camera The camera to apply the render pass to.
  63199. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63200. * @param engine The engine which the post process will be applied. (default: current engine)
  63201. * @param reusable If the post process can be reused on the same frame. (default: false)
  63202. * @param textureType Type of textures used when performing the post process. (default: 0)
  63203. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  63204. */
  63205. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  63206. /** Weight of the bloom to be added to the original input. */
  63207. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63208. }
  63209. }
  63210. declare module "babylonjs/PostProcesses/bloomEffect" {
  63211. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63212. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63213. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  63214. import { Camera } from "babylonjs/Cameras/camera";
  63215. import { Scene } from "babylonjs/scene";
  63216. /**
  63217. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  63218. */
  63219. export class BloomEffect extends PostProcessRenderEffect {
  63220. private bloomScale;
  63221. /**
  63222. * @hidden Internal
  63223. */
  63224. _effects: Array<PostProcess>;
  63225. /**
  63226. * @hidden Internal
  63227. */
  63228. _downscale: ExtractHighlightsPostProcess;
  63229. private _blurX;
  63230. private _blurY;
  63231. private _merge;
  63232. /**
  63233. * The luminance threshold to find bright areas of the image to bloom.
  63234. */
  63235. threshold: number;
  63236. /**
  63237. * The strength of the bloom.
  63238. */
  63239. weight: number;
  63240. /**
  63241. * Specifies the size of the bloom blur kernel, relative to the final output size
  63242. */
  63243. kernel: number;
  63244. /**
  63245. * Creates a new instance of @see BloomEffect
  63246. * @param scene The scene the effect belongs to.
  63247. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  63248. * @param bloomKernel The size of the kernel to be used when applying the blur.
  63249. * @param bloomWeight The the strength of bloom.
  63250. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  63251. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  63252. */
  63253. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  63254. /**
  63255. * Disposes each of the internal effects for a given camera.
  63256. * @param camera The camera to dispose the effect on.
  63257. */
  63258. disposeEffects(camera: Camera): void;
  63259. /**
  63260. * @hidden Internal
  63261. */
  63262. _updateEffects(): void;
  63263. /**
  63264. * Internal
  63265. * @returns if all the contained post processes are ready.
  63266. * @hidden
  63267. */
  63268. _isReady(): boolean;
  63269. }
  63270. }
  63271. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  63272. /** @hidden */
  63273. export var chromaticAberrationPixelShader: {
  63274. name: string;
  63275. shader: string;
  63276. };
  63277. }
  63278. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  63279. import { Vector2 } from "babylonjs/Maths/math.vector";
  63280. import { Nullable } from "babylonjs/types";
  63281. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63282. import { Camera } from "babylonjs/Cameras/camera";
  63283. import { Engine } from "babylonjs/Engines/engine";
  63284. import "babylonjs/Shaders/chromaticAberration.fragment";
  63285. /**
  63286. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  63287. */
  63288. export class ChromaticAberrationPostProcess extends PostProcess {
  63289. /**
  63290. * The amount of seperation of rgb channels (default: 30)
  63291. */
  63292. aberrationAmount: number;
  63293. /**
  63294. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  63295. */
  63296. radialIntensity: number;
  63297. /**
  63298. * The normilized direction in which the rgb channels should be seperated. If set to 0,0 radial direction will be used. (default: Vector2(0.707,0.707))
  63299. */
  63300. direction: Vector2;
  63301. /**
  63302. * The center position where the radialIntensity should be around. [0.5,0.5 is center of screen, 1,1 is top right corder] (default: Vector2(0.5 ,0.5))
  63303. */
  63304. centerPosition: Vector2;
  63305. /**
  63306. * Creates a new instance ChromaticAberrationPostProcess
  63307. * @param name The name of the effect.
  63308. * @param screenWidth The width of the screen to apply the effect on.
  63309. * @param screenHeight The height of the screen to apply the effect on.
  63310. * @param options The required width/height ratio to downsize to before computing the render pass.
  63311. * @param camera The camera to apply the render pass to.
  63312. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63313. * @param engine The engine which the post process will be applied. (default: current engine)
  63314. * @param reusable If the post process can be reused on the same frame. (default: false)
  63315. * @param textureType Type of textures used when performing the post process. (default: 0)
  63316. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  63317. */
  63318. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63319. }
  63320. }
  63321. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  63322. /** @hidden */
  63323. export var circleOfConfusionPixelShader: {
  63324. name: string;
  63325. shader: string;
  63326. };
  63327. }
  63328. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  63329. import { Nullable } from "babylonjs/types";
  63330. import { Engine } from "babylonjs/Engines/engine";
  63331. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63332. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63333. import { Camera } from "babylonjs/Cameras/camera";
  63334. import "babylonjs/Shaders/circleOfConfusion.fragment";
  63335. /**
  63336. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  63337. */
  63338. export class CircleOfConfusionPostProcess extends PostProcess {
  63339. /**
  63340. * Max lens size in scene units/1000 (eg. millimeter). Standard cameras are 50mm. (default: 50) The diamater of the resulting aperture can be computed by lensSize/fStop.
  63341. */
  63342. lensSize: number;
  63343. /**
  63344. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  63345. */
  63346. fStop: number;
  63347. /**
  63348. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  63349. */
  63350. focusDistance: number;
  63351. /**
  63352. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  63353. */
  63354. focalLength: number;
  63355. private _depthTexture;
  63356. /**
  63357. * Creates a new instance CircleOfConfusionPostProcess
  63358. * @param name The name of the effect.
  63359. * @param depthTexture The depth texture of the scene to compute the circle of confusion. This must be set in order for this to function but may be set after initialization if needed.
  63360. * @param options The required width/height ratio to downsize to before computing the render pass.
  63361. * @param camera The camera to apply the render pass to.
  63362. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63363. * @param engine The engine which the post process will be applied. (default: current engine)
  63364. * @param reusable If the post process can be reused on the same frame. (default: false)
  63365. * @param textureType Type of textures used when performing the post process. (default: 0)
  63366. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  63367. */
  63368. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63369. /**
  63370. * Depth texture to be used to compute the circle of confusion. This must be set here or in the constructor in order for the post process to function.
  63371. */
  63372. depthTexture: RenderTargetTexture;
  63373. }
  63374. }
  63375. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  63376. /** @hidden */
  63377. export var colorCorrectionPixelShader: {
  63378. name: string;
  63379. shader: string;
  63380. };
  63381. }
  63382. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  63383. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63384. import { Engine } from "babylonjs/Engines/engine";
  63385. import { Camera } from "babylonjs/Cameras/camera";
  63386. import "babylonjs/Shaders/colorCorrection.fragment";
  63387. /**
  63388. *
  63389. * This post-process allows the modification of rendered colors by using
  63390. * a 'look-up table' (LUT). This effect is also called Color Grading.
  63391. *
  63392. * The object needs to be provided an url to a texture containing the color
  63393. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  63394. * Use an image editing software to tweak the LUT to match your needs.
  63395. *
  63396. * For an example of a color LUT, see here:
  63397. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  63398. * For explanations on color grading, see here:
  63399. * @see http://udn.epicgames.com/Three/ColorGrading.html
  63400. *
  63401. */
  63402. export class ColorCorrectionPostProcess extends PostProcess {
  63403. private _colorTableTexture;
  63404. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63405. }
  63406. }
  63407. declare module "babylonjs/Shaders/convolution.fragment" {
  63408. /** @hidden */
  63409. export var convolutionPixelShader: {
  63410. name: string;
  63411. shader: string;
  63412. };
  63413. }
  63414. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  63415. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63416. import { Nullable } from "babylonjs/types";
  63417. import { Camera } from "babylonjs/Cameras/camera";
  63418. import { Engine } from "babylonjs/Engines/engine";
  63419. import "babylonjs/Shaders/convolution.fragment";
  63420. /**
  63421. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  63422. * input texture to perform effects such as edge detection or sharpening
  63423. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  63424. */
  63425. export class ConvolutionPostProcess extends PostProcess {
  63426. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  63427. kernel: number[];
  63428. /**
  63429. * Creates a new instance ConvolutionPostProcess
  63430. * @param name The name of the effect.
  63431. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  63432. * @param options The required width/height ratio to downsize to before computing the render pass.
  63433. * @param camera The camera to apply the render pass to.
  63434. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63435. * @param engine The engine which the post process will be applied. (default: current engine)
  63436. * @param reusable If the post process can be reused on the same frame. (default: false)
  63437. * @param textureType Type of textures used when performing the post process. (default: 0)
  63438. */
  63439. constructor(name: string,
  63440. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  63441. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63442. /**
  63443. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63444. */
  63445. static EdgeDetect0Kernel: number[];
  63446. /**
  63447. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63448. */
  63449. static EdgeDetect1Kernel: number[];
  63450. /**
  63451. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63452. */
  63453. static EdgeDetect2Kernel: number[];
  63454. /**
  63455. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63456. */
  63457. static SharpenKernel: number[];
  63458. /**
  63459. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63460. */
  63461. static EmbossKernel: number[];
  63462. /**
  63463. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63464. */
  63465. static GaussianKernel: number[];
  63466. }
  63467. }
  63468. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  63469. import { Nullable } from "babylonjs/types";
  63470. import { Vector2 } from "babylonjs/Maths/math.vector";
  63471. import { Camera } from "babylonjs/Cameras/camera";
  63472. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63473. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  63474. import { Engine } from "babylonjs/Engines/engine";
  63475. import { Scene } from "babylonjs/scene";
  63476. /**
  63477. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  63478. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  63479. * based on samples that have a large difference in distance than the center pixel.
  63480. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  63481. */
  63482. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  63483. direction: Vector2;
  63484. /**
  63485. * Creates a new instance CircleOfConfusionPostProcess
  63486. * @param name The name of the effect.
  63487. * @param scene The scene the effect belongs to.
  63488. * @param direction The direction the blur should be applied.
  63489. * @param kernel The size of the kernel used to blur.
  63490. * @param options The required width/height ratio to downsize to before computing the render pass.
  63491. * @param camera The camera to apply the render pass to.
  63492. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  63493. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  63494. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63495. * @param engine The engine which the post process will be applied. (default: current engine)
  63496. * @param reusable If the post process can be reused on the same frame. (default: false)
  63497. * @param textureType Type of textures used when performing the post process. (default: 0)
  63498. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  63499. */
  63500. constructor(name: string, scene: Scene, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, circleOfConfusion: PostProcess, imageToBlur?: Nullable<PostProcess>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63501. }
  63502. }
  63503. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  63504. /** @hidden */
  63505. export var depthOfFieldMergePixelShader: {
  63506. name: string;
  63507. shader: string;
  63508. };
  63509. }
  63510. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  63511. import { Nullable } from "babylonjs/types";
  63512. import { Camera } from "babylonjs/Cameras/camera";
  63513. import { Effect } from "babylonjs/Materials/effect";
  63514. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63515. import { Engine } from "babylonjs/Engines/engine";
  63516. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  63517. /**
  63518. * Options to be set when merging outputs from the default pipeline.
  63519. */
  63520. export class DepthOfFieldMergePostProcessOptions {
  63521. /**
  63522. * The original image to merge on top of
  63523. */
  63524. originalFromInput: PostProcess;
  63525. /**
  63526. * Parameters to perform the merge of the depth of field effect
  63527. */
  63528. depthOfField?: {
  63529. circleOfConfusion: PostProcess;
  63530. blurSteps: Array<PostProcess>;
  63531. };
  63532. /**
  63533. * Parameters to perform the merge of bloom effect
  63534. */
  63535. bloom?: {
  63536. blurred: PostProcess;
  63537. weight: number;
  63538. };
  63539. }
  63540. /**
  63541. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  63542. */
  63543. export class DepthOfFieldMergePostProcess extends PostProcess {
  63544. private blurSteps;
  63545. /**
  63546. * Creates a new instance of DepthOfFieldMergePostProcess
  63547. * @param name The name of the effect.
  63548. * @param originalFromInput Post process which's input will be used for the merge.
  63549. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  63550. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  63551. * @param options The required width/height ratio to downsize to before computing the render pass.
  63552. * @param camera The camera to apply the render pass to.
  63553. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63554. * @param engine The engine which the post process will be applied. (default: current engine)
  63555. * @param reusable If the post process can be reused on the same frame. (default: false)
  63556. * @param textureType Type of textures used when performing the post process. (default: 0)
  63557. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  63558. */
  63559. constructor(name: string, originalFromInput: PostProcess, circleOfConfusion: PostProcess, blurSteps: Array<PostProcess>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63560. /**
  63561. * Updates the effect with the current post process compile time values and recompiles the shader.
  63562. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  63563. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  63564. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  63565. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  63566. * @param onCompiled Called when the shader has been compiled.
  63567. * @param onError Called if there is an error when compiling a shader.
  63568. */
  63569. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  63570. }
  63571. }
  63572. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  63573. import { Nullable } from "babylonjs/types";
  63574. import { Camera } from "babylonjs/Cameras/camera";
  63575. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63576. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63577. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63578. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  63579. import { Scene } from "babylonjs/scene";
  63580. /**
  63581. * Specifies the level of max blur that should be applied when using the depth of field effect
  63582. */
  63583. export enum DepthOfFieldEffectBlurLevel {
  63584. /**
  63585. * Subtle blur
  63586. */
  63587. Low = 0,
  63588. /**
  63589. * Medium blur
  63590. */
  63591. Medium = 1,
  63592. /**
  63593. * Large blur
  63594. */
  63595. High = 2
  63596. }
  63597. /**
  63598. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  63599. */
  63600. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  63601. private _circleOfConfusion;
  63602. /**
  63603. * @hidden Internal, blurs from high to low
  63604. */
  63605. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  63606. private _depthOfFieldBlurY;
  63607. private _dofMerge;
  63608. /**
  63609. * @hidden Internal post processes in depth of field effect
  63610. */
  63611. _effects: Array<PostProcess>;
  63612. /**
  63613. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  63614. */
  63615. focalLength: number;
  63616. /**
  63617. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  63618. */
  63619. fStop: number;
  63620. /**
  63621. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  63622. */
  63623. focusDistance: number;
  63624. /**
  63625. * Max lens size in scene units/1000 (eg. millimeter). Standard cameras are 50mm. (default: 50) The diamater of the resulting aperture can be computed by lensSize/fStop.
  63626. */
  63627. lensSize: number;
  63628. /**
  63629. * Creates a new instance DepthOfFieldEffect
  63630. * @param scene The scene the effect belongs to.
  63631. * @param depthTexture The depth texture of the scene to compute the circle of confusion.This must be set in order for this to function but may be set after initialization if needed.
  63632. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  63633. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  63634. */
  63635. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  63636. /**
  63637. * Get the current class name of the current effet
  63638. * @returns "DepthOfFieldEffect"
  63639. */
  63640. getClassName(): string;
  63641. /**
  63642. * Depth texture to be used to compute the circle of confusion. This must be set here or in the constructor in order for the post process to function.
  63643. */
  63644. depthTexture: RenderTargetTexture;
  63645. /**
  63646. * Disposes each of the internal effects for a given camera.
  63647. * @param camera The camera to dispose the effect on.
  63648. */
  63649. disposeEffects(camera: Camera): void;
  63650. /**
  63651. * @hidden Internal
  63652. */
  63653. _updateEffects(): void;
  63654. /**
  63655. * Internal
  63656. * @returns if all the contained post processes are ready.
  63657. * @hidden
  63658. */
  63659. _isReady(): boolean;
  63660. }
  63661. }
  63662. declare module "babylonjs/Shaders/displayPass.fragment" {
  63663. /** @hidden */
  63664. export var displayPassPixelShader: {
  63665. name: string;
  63666. shader: string;
  63667. };
  63668. }
  63669. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  63670. import { Nullable } from "babylonjs/types";
  63671. import { Camera } from "babylonjs/Cameras/camera";
  63672. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63673. import { Engine } from "babylonjs/Engines/engine";
  63674. import "babylonjs/Shaders/displayPass.fragment";
  63675. /**
  63676. * DisplayPassPostProcess which produces an output the same as it's input
  63677. */
  63678. export class DisplayPassPostProcess extends PostProcess {
  63679. /**
  63680. * Creates the DisplayPassPostProcess
  63681. * @param name The name of the effect.
  63682. * @param options The required width/height ratio to downsize to before computing the render pass.
  63683. * @param camera The camera to apply the render pass to.
  63684. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63685. * @param engine The engine which the post process will be applied. (default: current engine)
  63686. * @param reusable If the post process can be reused on the same frame. (default: false)
  63687. */
  63688. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63689. }
  63690. }
  63691. declare module "babylonjs/Shaders/filter.fragment" {
  63692. /** @hidden */
  63693. export var filterPixelShader: {
  63694. name: string;
  63695. shader: string;
  63696. };
  63697. }
  63698. declare module "babylonjs/PostProcesses/filterPostProcess" {
  63699. import { Nullable } from "babylonjs/types";
  63700. import { Matrix } from "babylonjs/Maths/math.vector";
  63701. import { Camera } from "babylonjs/Cameras/camera";
  63702. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63703. import { Engine } from "babylonjs/Engines/engine";
  63704. import "babylonjs/Shaders/filter.fragment";
  63705. /**
  63706. * Applies a kernel filter to the image
  63707. */
  63708. export class FilterPostProcess extends PostProcess {
  63709. /** The matrix to be applied to the image */
  63710. kernelMatrix: Matrix;
  63711. /**
  63712. *
  63713. * @param name The name of the effect.
  63714. * @param kernelMatrix The matrix to be applied to the image
  63715. * @param options The required width/height ratio to downsize to before computing the render pass.
  63716. * @param camera The camera to apply the render pass to.
  63717. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63718. * @param engine The engine which the post process will be applied. (default: current engine)
  63719. * @param reusable If the post process can be reused on the same frame. (default: false)
  63720. */
  63721. constructor(name: string,
  63722. /** The matrix to be applied to the image */
  63723. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63724. }
  63725. }
  63726. declare module "babylonjs/Shaders/fxaa.fragment" {
  63727. /** @hidden */
  63728. export var fxaaPixelShader: {
  63729. name: string;
  63730. shader: string;
  63731. };
  63732. }
  63733. declare module "babylonjs/Shaders/fxaa.vertex" {
  63734. /** @hidden */
  63735. export var fxaaVertexShader: {
  63736. name: string;
  63737. shader: string;
  63738. };
  63739. }
  63740. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  63741. import { Nullable } from "babylonjs/types";
  63742. import { Camera } from "babylonjs/Cameras/camera";
  63743. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63744. import { Engine } from "babylonjs/Engines/engine";
  63745. import "babylonjs/Shaders/fxaa.fragment";
  63746. import "babylonjs/Shaders/fxaa.vertex";
  63747. /**
  63748. * Fxaa post process
  63749. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  63750. */
  63751. export class FxaaPostProcess extends PostProcess {
  63752. /** @hidden */
  63753. texelWidth: number;
  63754. /** @hidden */
  63755. texelHeight: number;
  63756. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63757. private _getDefines;
  63758. }
  63759. }
  63760. declare module "babylonjs/Shaders/grain.fragment" {
  63761. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63762. /** @hidden */
  63763. export var grainPixelShader: {
  63764. name: string;
  63765. shader: string;
  63766. };
  63767. }
  63768. declare module "babylonjs/PostProcesses/grainPostProcess" {
  63769. import { Nullable } from "babylonjs/types";
  63770. import { Camera } from "babylonjs/Cameras/camera";
  63771. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63772. import { Engine } from "babylonjs/Engines/engine";
  63773. import "babylonjs/Shaders/grain.fragment";
  63774. /**
  63775. * The GrainPostProcess adds noise to the image at mid luminance levels
  63776. */
  63777. export class GrainPostProcess extends PostProcess {
  63778. /**
  63779. * The intensity of the grain added (default: 30)
  63780. */
  63781. intensity: number;
  63782. /**
  63783. * If the grain should be randomized on every frame
  63784. */
  63785. animated: boolean;
  63786. /**
  63787. * Creates a new instance of @see GrainPostProcess
  63788. * @param name The name of the effect.
  63789. * @param options The required width/height ratio to downsize to before computing the render pass.
  63790. * @param camera The camera to apply the render pass to.
  63791. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63792. * @param engine The engine which the post process will be applied. (default: current engine)
  63793. * @param reusable If the post process can be reused on the same frame. (default: false)
  63794. * @param textureType Type of textures used when performing the post process. (default: 0)
  63795. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  63796. */
  63797. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63798. }
  63799. }
  63800. declare module "babylonjs/Shaders/highlights.fragment" {
  63801. /** @hidden */
  63802. export var highlightsPixelShader: {
  63803. name: string;
  63804. shader: string;
  63805. };
  63806. }
  63807. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  63808. import { Nullable } from "babylonjs/types";
  63809. import { Camera } from "babylonjs/Cameras/camera";
  63810. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63811. import { Engine } from "babylonjs/Engines/engine";
  63812. import "babylonjs/Shaders/highlights.fragment";
  63813. /**
  63814. * Extracts highlights from the image
  63815. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  63816. */
  63817. export class HighlightsPostProcess extends PostProcess {
  63818. /**
  63819. * Extracts highlights from the image
  63820. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  63821. * @param name The name of the effect.
  63822. * @param options The required width/height ratio to downsize to before computing the render pass.
  63823. * @param camera The camera to apply the render pass to.
  63824. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63825. * @param engine The engine which the post process will be applied. (default: current engine)
  63826. * @param reusable If the post process can be reused on the same frame. (default: false)
  63827. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  63828. */
  63829. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63830. }
  63831. }
  63832. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  63833. /** @hidden */
  63834. export var mrtFragmentDeclaration: {
  63835. name: string;
  63836. shader: string;
  63837. };
  63838. }
  63839. declare module "babylonjs/Shaders/geometry.fragment" {
  63840. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  63841. /** @hidden */
  63842. export var geometryPixelShader: {
  63843. name: string;
  63844. shader: string;
  63845. };
  63846. }
  63847. declare module "babylonjs/Shaders/geometry.vertex" {
  63848. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  63849. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  63850. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  63851. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  63852. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  63853. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  63854. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  63855. /** @hidden */
  63856. export var geometryVertexShader: {
  63857. name: string;
  63858. shader: string;
  63859. };
  63860. }
  63861. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  63862. import { Matrix } from "babylonjs/Maths/math.vector";
  63863. import { SubMesh } from "babylonjs/Meshes/subMesh";
  63864. import { Mesh } from "babylonjs/Meshes/mesh";
  63865. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  63866. import { Effect } from "babylonjs/Materials/effect";
  63867. import { Scene } from "babylonjs/scene";
  63868. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63869. import "babylonjs/Shaders/geometry.fragment";
  63870. import "babylonjs/Shaders/geometry.vertex";
  63871. /** @hidden */
  63872. interface ISavedTransformationMatrix {
  63873. world: Matrix;
  63874. viewProjection: Matrix;
  63875. }
  63876. /**
  63877. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  63878. */
  63879. export class GeometryBufferRenderer {
  63880. /**
  63881. * Constant used to retrieve the position texture index in the G-Buffer textures array
  63882. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  63883. */
  63884. static readonly POSITION_TEXTURE_TYPE: number;
  63885. /**
  63886. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  63887. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  63888. */
  63889. static readonly VELOCITY_TEXTURE_TYPE: number;
  63890. /**
  63891. * Dictionary used to store the previous transformation matrices of each rendered mesh
  63892. * in order to compute objects velocities when enableVelocity is set to "true"
  63893. * @hidden
  63894. */
  63895. _previousTransformationMatrices: {
  63896. [index: number]: ISavedTransformationMatrix;
  63897. };
  63898. /**
  63899. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  63900. * in order to compute objects velocities when enableVelocity is set to "true"
  63901. * @hidden
  63902. */
  63903. _previousBonesTransformationMatrices: {
  63904. [index: number]: Float32Array;
  63905. };
  63906. /**
  63907. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  63908. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  63909. */
  63910. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  63911. private _scene;
  63912. private _multiRenderTarget;
  63913. private _ratio;
  63914. private _enablePosition;
  63915. private _enableVelocity;
  63916. private _positionIndex;
  63917. private _velocityIndex;
  63918. protected _effect: Effect;
  63919. protected _cachedDefines: string;
  63920. /**
  63921. * Set the render list (meshes to be rendered) used in the G buffer.
  63922. */
  63923. renderList: Mesh[];
  63924. /**
  63925. * Gets wether or not G buffer are supported by the running hardware.
  63926. * This requires draw buffer supports
  63927. */
  63928. readonly isSupported: boolean;
  63929. /**
  63930. * Returns the index of the given texture type in the G-Buffer textures array
  63931. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  63932. * @returns the index of the given texture type in the G-Buffer textures array
  63933. */
  63934. getTextureIndex(textureType: number): number;
  63935. /**
  63936. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  63937. */
  63938. /**
  63939. * Sets whether or not objects positions are enabled for the G buffer.
  63940. */
  63941. enablePosition: boolean;
  63942. /**
  63943. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  63944. */
  63945. /**
  63946. * Sets wether or not objects velocities are enabled for the G buffer.
  63947. */
  63948. enableVelocity: boolean;
  63949. /**
  63950. * Gets the scene associated with the buffer.
  63951. */
  63952. readonly scene: Scene;
  63953. /**
  63954. * Gets the ratio used by the buffer during its creation.
  63955. * How big is the buffer related to the main canvas.
  63956. */
  63957. readonly ratio: number;
  63958. /** @hidden */
  63959. static _SceneComponentInitialization: (scene: Scene) => void;
  63960. /**
  63961. * Creates a new G Buffer for the scene
  63962. * @param scene The scene the buffer belongs to
  63963. * @param ratio How big is the buffer related to the main canvas.
  63964. */
  63965. constructor(scene: Scene, ratio?: number);
  63966. /**
  63967. * Checks wether everything is ready to render a submesh to the G buffer.
  63968. * @param subMesh the submesh to check readiness for
  63969. * @param useInstances is the mesh drawn using instance or not
  63970. * @returns true if ready otherwise false
  63971. */
  63972. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  63973. /**
  63974. * Gets the current underlying G Buffer.
  63975. * @returns the buffer
  63976. */
  63977. getGBuffer(): MultiRenderTarget;
  63978. /**
  63979. * Gets the number of samples used to render the buffer (anti aliasing).
  63980. */
  63981. /**
  63982. * Sets the number of samples used to render the buffer (anti aliasing).
  63983. */
  63984. samples: number;
  63985. /**
  63986. * Disposes the renderer and frees up associated resources.
  63987. */
  63988. dispose(): void;
  63989. protected _createRenderTargets(): void;
  63990. private _copyBonesTransformationMatrices;
  63991. }
  63992. }
  63993. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  63994. import { Nullable } from "babylonjs/types";
  63995. import { Scene } from "babylonjs/scene";
  63996. import { ISceneComponent } from "babylonjs/sceneComponent";
  63997. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  63998. module "babylonjs/scene" {
  63999. interface Scene {
  64000. /** @hidden (Backing field) */
  64001. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  64002. /**
  64003. * Gets or Sets the current geometry buffer associated to the scene.
  64004. */
  64005. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  64006. /**
  64007. * Enables a GeometryBufferRender and associates it with the scene
  64008. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  64009. * @returns the GeometryBufferRenderer
  64010. */
  64011. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  64012. /**
  64013. * Disables the GeometryBufferRender associated with the scene
  64014. */
  64015. disableGeometryBufferRenderer(): void;
  64016. }
  64017. }
  64018. /**
  64019. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  64020. * in several rendering techniques.
  64021. */
  64022. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  64023. /**
  64024. * The component name helpful to identify the component in the list of scene components.
  64025. */
  64026. readonly name: string;
  64027. /**
  64028. * The scene the component belongs to.
  64029. */
  64030. scene: Scene;
  64031. /**
  64032. * Creates a new instance of the component for the given scene
  64033. * @param scene Defines the scene to register the component in
  64034. */
  64035. constructor(scene: Scene);
  64036. /**
  64037. * Registers the component in a given scene
  64038. */
  64039. register(): void;
  64040. /**
  64041. * Rebuilds the elements related to this component in case of
  64042. * context lost for instance.
  64043. */
  64044. rebuild(): void;
  64045. /**
  64046. * Disposes the component and the associated ressources
  64047. */
  64048. dispose(): void;
  64049. private _gatherRenderTargets;
  64050. }
  64051. }
  64052. declare module "babylonjs/Shaders/motionBlur.fragment" {
  64053. /** @hidden */
  64054. export var motionBlurPixelShader: {
  64055. name: string;
  64056. shader: string;
  64057. };
  64058. }
  64059. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  64060. import { Nullable } from "babylonjs/types";
  64061. import { Camera } from "babylonjs/Cameras/camera";
  64062. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64063. import { Scene } from "babylonjs/scene";
  64064. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64065. import "babylonjs/Animations/animatable";
  64066. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  64067. import "babylonjs/Shaders/motionBlur.fragment";
  64068. import { Engine } from "babylonjs/Engines/engine";
  64069. /**
  64070. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  64071. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  64072. * As an example, all you have to do is to create the post-process:
  64073. * var mb = new BABYLON.MotionBlurPostProcess(
  64074. * 'mb', // The name of the effect.
  64075. * scene, // The scene containing the objects to blur according to their velocity.
  64076. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  64077. * camera // The camera to apply the render pass to.
  64078. * );
  64079. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  64080. */
  64081. export class MotionBlurPostProcess extends PostProcess {
  64082. /**
  64083. * Defines how much the image is blurred by the movement. Default value is equal to 1
  64084. */
  64085. motionStrength: number;
  64086. /**
  64087. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  64088. */
  64089. /**
  64090. * Sets the number of iterations to be used for motion blur quality
  64091. */
  64092. motionBlurSamples: number;
  64093. private _motionBlurSamples;
  64094. private _geometryBufferRenderer;
  64095. /**
  64096. * Creates a new instance MotionBlurPostProcess
  64097. * @param name The name of the effect.
  64098. * @param scene The scene containing the objects to blur according to their velocity.
  64099. * @param options The required width/height ratio to downsize to before computing the render pass.
  64100. * @param camera The camera to apply the render pass to.
  64101. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64102. * @param engine The engine which the post process will be applied. (default: current engine)
  64103. * @param reusable If the post process can be reused on the same frame. (default: false)
  64104. * @param textureType Type of textures used when performing the post process. (default: 0)
  64105. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  64106. */
  64107. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  64108. /**
  64109. * Excludes the given skinned mesh from computing bones velocities.
  64110. * Computing bones velocities can have a cost and that cost. The cost can be saved by calling this function and by passing the skinned mesh reference to ignore.
  64111. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  64112. */
  64113. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  64114. /**
  64115. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  64116. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  64117. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  64118. */
  64119. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  64120. /**
  64121. * Disposes the post process.
  64122. * @param camera The camera to dispose the post process on.
  64123. */
  64124. dispose(camera?: Camera): void;
  64125. }
  64126. }
  64127. declare module "babylonjs/Shaders/refraction.fragment" {
  64128. /** @hidden */
  64129. export var refractionPixelShader: {
  64130. name: string;
  64131. shader: string;
  64132. };
  64133. }
  64134. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  64135. import { Color3 } from "babylonjs/Maths/math.color";
  64136. import { Camera } from "babylonjs/Cameras/camera";
  64137. import { Texture } from "babylonjs/Materials/Textures/texture";
  64138. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64139. import { Engine } from "babylonjs/Engines/engine";
  64140. import "babylonjs/Shaders/refraction.fragment";
  64141. /**
  64142. * Post process which applies a refractin texture
  64143. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  64144. */
  64145. export class RefractionPostProcess extends PostProcess {
  64146. /** the base color of the refraction (used to taint the rendering) */
  64147. color: Color3;
  64148. /** simulated refraction depth */
  64149. depth: number;
  64150. /** the coefficient of the base color (0 to remove base color tainting) */
  64151. colorLevel: number;
  64152. private _refTexture;
  64153. private _ownRefractionTexture;
  64154. /**
  64155. * Gets or sets the refraction texture
  64156. * Please note that you are responsible for disposing the texture if you set it manually
  64157. */
  64158. refractionTexture: Texture;
  64159. /**
  64160. * Initializes the RefractionPostProcess
  64161. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  64162. * @param name The name of the effect.
  64163. * @param refractionTextureUrl Url of the refraction texture to use
  64164. * @param color the base color of the refraction (used to taint the rendering)
  64165. * @param depth simulated refraction depth
  64166. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  64167. * @param camera The camera to apply the render pass to.
  64168. * @param options The required width/height ratio to downsize to before computing the render pass.
  64169. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64170. * @param engine The engine which the post process will be applied. (default: current engine)
  64171. * @param reusable If the post process can be reused on the same frame. (default: false)
  64172. */
  64173. constructor(name: string, refractionTextureUrl: string,
  64174. /** the base color of the refraction (used to taint the rendering) */
  64175. color: Color3,
  64176. /** simulated refraction depth */
  64177. depth: number,
  64178. /** the coefficient of the base color (0 to remove base color tainting) */
  64179. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  64180. /**
  64181. * Disposes of the post process
  64182. * @param camera Camera to dispose post process on
  64183. */
  64184. dispose(camera: Camera): void;
  64185. }
  64186. }
  64187. declare module "babylonjs/Shaders/sharpen.fragment" {
  64188. /** @hidden */
  64189. export var sharpenPixelShader: {
  64190. name: string;
  64191. shader: string;
  64192. };
  64193. }
  64194. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  64195. import { Nullable } from "babylonjs/types";
  64196. import { Camera } from "babylonjs/Cameras/camera";
  64197. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64198. import "babylonjs/Shaders/sharpen.fragment";
  64199. import { Engine } from "babylonjs/Engines/engine";
  64200. /**
  64201. * The SharpenPostProcess applies a sharpen kernel to every pixel
  64202. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  64203. */
  64204. export class SharpenPostProcess extends PostProcess {
  64205. /**
  64206. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  64207. */
  64208. colorAmount: number;
  64209. /**
  64210. * How much sharpness should be applied (default: 0.3)
  64211. */
  64212. edgeAmount: number;
  64213. /**
  64214. * Creates a new instance ConvolutionPostProcess
  64215. * @param name The name of the effect.
  64216. * @param options The required width/height ratio to downsize to before computing the render pass.
  64217. * @param camera The camera to apply the render pass to.
  64218. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64219. * @param engine The engine which the post process will be applied. (default: current engine)
  64220. * @param reusable If the post process can be reused on the same frame. (default: false)
  64221. * @param textureType Type of textures used when performing the post process. (default: 0)
  64222. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  64223. */
  64224. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  64225. }
  64226. }
  64227. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  64228. import { Nullable } from "babylonjs/types";
  64229. import { Camera } from "babylonjs/Cameras/camera";
  64230. import { Engine } from "babylonjs/Engines/engine";
  64231. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  64232. import { IInspectable } from "babylonjs/Misc/iInspectable";
  64233. /**
  64234. * PostProcessRenderPipeline
  64235. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64236. */
  64237. export class PostProcessRenderPipeline {
  64238. private engine;
  64239. private _renderEffects;
  64240. private _renderEffectsForIsolatedPass;
  64241. /**
  64242. * List of inspectable custom properties (used by the Inspector)
  64243. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  64244. */
  64245. inspectableCustomProperties: IInspectable[];
  64246. /**
  64247. * @hidden
  64248. */
  64249. protected _cameras: Camera[];
  64250. /** @hidden */
  64251. _name: string;
  64252. /**
  64253. * Gets pipeline name
  64254. */
  64255. readonly name: string;
  64256. /** Gets the list of attached cameras */
  64257. readonly cameras: Camera[];
  64258. /**
  64259. * Initializes a PostProcessRenderPipeline
  64260. * @param engine engine to add the pipeline to
  64261. * @param name name of the pipeline
  64262. */
  64263. constructor(engine: Engine, name: string);
  64264. /**
  64265. * Gets the class name
  64266. * @returns "PostProcessRenderPipeline"
  64267. */
  64268. getClassName(): string;
  64269. /**
  64270. * If all the render effects in the pipeline are supported
  64271. */
  64272. readonly isSupported: boolean;
  64273. /**
  64274. * Adds an effect to the pipeline
  64275. * @param renderEffect the effect to add
  64276. */
  64277. addEffect(renderEffect: PostProcessRenderEffect): void;
  64278. /** @hidden */
  64279. _rebuild(): void;
  64280. /** @hidden */
  64281. _enableEffect(renderEffectName: string, cameras: Camera): void;
  64282. /** @hidden */
  64283. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  64284. /** @hidden */
  64285. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  64286. /** @hidden */
  64287. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  64288. /** @hidden */
  64289. _attachCameras(cameras: Camera, unique: boolean): void;
  64290. /** @hidden */
  64291. _attachCameras(cameras: Camera[], unique: boolean): void;
  64292. /** @hidden */
  64293. _detachCameras(cameras: Camera): void;
  64294. /** @hidden */
  64295. _detachCameras(cameras: Nullable<Camera[]>): void;
  64296. /** @hidden */
  64297. _update(): void;
  64298. /** @hidden */
  64299. _reset(): void;
  64300. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  64301. /**
  64302. * Disposes of the pipeline
  64303. */
  64304. dispose(): void;
  64305. }
  64306. }
  64307. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  64308. import { Camera } from "babylonjs/Cameras/camera";
  64309. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64310. /**
  64311. * PostProcessRenderPipelineManager class
  64312. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64313. */
  64314. export class PostProcessRenderPipelineManager {
  64315. private _renderPipelines;
  64316. /**
  64317. * Initializes a PostProcessRenderPipelineManager
  64318. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64319. */
  64320. constructor();
  64321. /**
  64322. * Gets the list of supported render pipelines
  64323. */
  64324. readonly supportedPipelines: PostProcessRenderPipeline[];
  64325. /**
  64326. * Adds a pipeline to the manager
  64327. * @param renderPipeline The pipeline to add
  64328. */
  64329. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  64330. /**
  64331. * Attaches a camera to the pipeline
  64332. * @param renderPipelineName The name of the pipeline to attach to
  64333. * @param cameras the camera to attach
  64334. * @param unique if the camera can be attached multiple times to the pipeline
  64335. */
  64336. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  64337. /**
  64338. * Detaches a camera from the pipeline
  64339. * @param renderPipelineName The name of the pipeline to detach from
  64340. * @param cameras the camera to detach
  64341. */
  64342. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  64343. /**
  64344. * Enables an effect by name on a pipeline
  64345. * @param renderPipelineName the name of the pipeline to enable the effect in
  64346. * @param renderEffectName the name of the effect to enable
  64347. * @param cameras the cameras that the effect should be enabled on
  64348. */
  64349. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  64350. /**
  64351. * Disables an effect by name on a pipeline
  64352. * @param renderPipelineName the name of the pipeline to disable the effect in
  64353. * @param renderEffectName the name of the effect to disable
  64354. * @param cameras the cameras that the effect should be disabled on
  64355. */
  64356. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  64357. /**
  64358. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  64359. */
  64360. update(): void;
  64361. /** @hidden */
  64362. _rebuild(): void;
  64363. /**
  64364. * Disposes of the manager and pipelines
  64365. */
  64366. dispose(): void;
  64367. }
  64368. }
  64369. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  64370. import { ISceneComponent } from "babylonjs/sceneComponent";
  64371. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  64372. import { Scene } from "babylonjs/scene";
  64373. module "babylonjs/scene" {
  64374. interface Scene {
  64375. /** @hidden (Backing field) */
  64376. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  64377. /**
  64378. * Gets the postprocess render pipeline manager
  64379. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64380. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  64381. */
  64382. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  64383. }
  64384. }
  64385. /**
  64386. * Defines the Render Pipeline scene component responsible to rendering pipelines
  64387. */
  64388. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  64389. /**
  64390. * The component name helpfull to identify the component in the list of scene components.
  64391. */
  64392. readonly name: string;
  64393. /**
  64394. * The scene the component belongs to.
  64395. */
  64396. scene: Scene;
  64397. /**
  64398. * Creates a new instance of the component for the given scene
  64399. * @param scene Defines the scene to register the component in
  64400. */
  64401. constructor(scene: Scene);
  64402. /**
  64403. * Registers the component in a given scene
  64404. */
  64405. register(): void;
  64406. /**
  64407. * Rebuilds the elements related to this component in case of
  64408. * context lost for instance.
  64409. */
  64410. rebuild(): void;
  64411. /**
  64412. * Disposes the component and the associated ressources
  64413. */
  64414. dispose(): void;
  64415. private _gatherRenderTargets;
  64416. }
  64417. }
  64418. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  64419. import { Nullable } from "babylonjs/types";
  64420. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  64421. import { Camera } from "babylonjs/Cameras/camera";
  64422. import { IDisposable } from "babylonjs/scene";
  64423. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  64424. import { Scene } from "babylonjs/scene";
  64425. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  64426. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  64427. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  64428. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  64429. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  64430. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64431. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  64432. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64433. import { Animation } from "babylonjs/Animations/animation";
  64434. /**
  64435. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  64436. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  64437. */
  64438. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  64439. private _scene;
  64440. private _camerasToBeAttached;
  64441. /**
  64442. * ID of the sharpen post process,
  64443. */
  64444. private readonly SharpenPostProcessId;
  64445. /**
  64446. * @ignore
  64447. * ID of the image processing post process;
  64448. */
  64449. readonly ImageProcessingPostProcessId: string;
  64450. /**
  64451. * @ignore
  64452. * ID of the Fast Approximate Anti-Aliasing post process;
  64453. */
  64454. readonly FxaaPostProcessId: string;
  64455. /**
  64456. * ID of the chromatic aberration post process,
  64457. */
  64458. private readonly ChromaticAberrationPostProcessId;
  64459. /**
  64460. * ID of the grain post process
  64461. */
  64462. private readonly GrainPostProcessId;
  64463. /**
  64464. * Sharpen post process which will apply a sharpen convolution to enhance edges
  64465. */
  64466. sharpen: SharpenPostProcess;
  64467. private _sharpenEffect;
  64468. private bloom;
  64469. /**
  64470. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  64471. */
  64472. depthOfField: DepthOfFieldEffect;
  64473. /**
  64474. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  64475. */
  64476. fxaa: FxaaPostProcess;
  64477. /**
  64478. * Image post processing pass used to perform operations such as tone mapping or color grading.
  64479. */
  64480. imageProcessing: ImageProcessingPostProcess;
  64481. /**
  64482. * Chromatic aberration post process which will shift rgb colors in the image
  64483. */
  64484. chromaticAberration: ChromaticAberrationPostProcess;
  64485. private _chromaticAberrationEffect;
  64486. /**
  64487. * Grain post process which add noise to the image
  64488. */
  64489. grain: GrainPostProcess;
  64490. private _grainEffect;
  64491. /**
  64492. * Glow post process which adds a glow to emissive areas of the image
  64493. */
  64494. private _glowLayer;
  64495. /**
  64496. * Animations which can be used to tweak settings over a period of time
  64497. */
  64498. animations: Animation[];
  64499. private _imageProcessingConfigurationObserver;
  64500. private _sharpenEnabled;
  64501. private _bloomEnabled;
  64502. private _depthOfFieldEnabled;
  64503. private _depthOfFieldBlurLevel;
  64504. private _fxaaEnabled;
  64505. private _imageProcessingEnabled;
  64506. private _defaultPipelineTextureType;
  64507. private _bloomScale;
  64508. private _chromaticAberrationEnabled;
  64509. private _grainEnabled;
  64510. private _buildAllowed;
  64511. /**
  64512. * Gets active scene
  64513. */
  64514. readonly scene: Scene;
  64515. /**
  64516. * Enable or disable the sharpen process from the pipeline
  64517. */
  64518. sharpenEnabled: boolean;
  64519. private _resizeObserver;
  64520. private _hardwareScaleLevel;
  64521. private _bloomKernel;
  64522. /**
  64523. * Specifies the size of the bloom blur kernel, relative to the final output size
  64524. */
  64525. bloomKernel: number;
  64526. /**
  64527. * Specifies the weight of the bloom in the final rendering
  64528. */
  64529. private _bloomWeight;
  64530. /**
  64531. * Specifies the luma threshold for the area that will be blurred by the bloom
  64532. */
  64533. private _bloomThreshold;
  64534. private _hdr;
  64535. /**
  64536. * The strength of the bloom.
  64537. */
  64538. bloomWeight: number;
  64539. /**
  64540. * The strength of the bloom.
  64541. */
  64542. bloomThreshold: number;
  64543. /**
  64544. * The scale of the bloom, lower value will provide better performance.
  64545. */
  64546. bloomScale: number;
  64547. /**
  64548. * Enable or disable the bloom from the pipeline
  64549. */
  64550. bloomEnabled: boolean;
  64551. private _rebuildBloom;
  64552. /**
  64553. * If the depth of field is enabled.
  64554. */
  64555. depthOfFieldEnabled: boolean;
  64556. /**
  64557. * Blur level of the depth of field effect. (Higher blur will effect performance)
  64558. */
  64559. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  64560. /**
  64561. * If the anti aliasing is enabled.
  64562. */
  64563. fxaaEnabled: boolean;
  64564. private _samples;
  64565. /**
  64566. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  64567. */
  64568. samples: number;
  64569. /**
  64570. * If image processing is enabled.
  64571. */
  64572. imageProcessingEnabled: boolean;
  64573. /**
  64574. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  64575. */
  64576. glowLayerEnabled: boolean;
  64577. /**
  64578. * Gets the glow layer (or null if not defined)
  64579. */
  64580. readonly glowLayer: Nullable<GlowLayer>;
  64581. /**
  64582. * Enable or disable the chromaticAberration process from the pipeline
  64583. */
  64584. chromaticAberrationEnabled: boolean;
  64585. /**
  64586. * Enable or disable the grain process from the pipeline
  64587. */
  64588. grainEnabled: boolean;
  64589. /**
  64590. * @constructor
  64591. * @param name - The rendering pipeline name (default: "")
  64592. * @param hdr - If high dynamic range textures should be used (default: true)
  64593. * @param scene - The scene linked to this pipeline (default: the last created scene)
  64594. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  64595. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  64596. */
  64597. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  64598. /**
  64599. * Get the class name
  64600. * @returns "DefaultRenderingPipeline"
  64601. */
  64602. getClassName(): string;
  64603. /**
  64604. * Force the compilation of the entire pipeline.
  64605. */
  64606. prepare(): void;
  64607. private _hasCleared;
  64608. private _prevPostProcess;
  64609. private _prevPrevPostProcess;
  64610. private _setAutoClearAndTextureSharing;
  64611. private _depthOfFieldSceneObserver;
  64612. private _buildPipeline;
  64613. private _disposePostProcesses;
  64614. /**
  64615. * Adds a camera to the pipeline
  64616. * @param camera the camera to be added
  64617. */
  64618. addCamera(camera: Camera): void;
  64619. /**
  64620. * Removes a camera from the pipeline
  64621. * @param camera the camera to remove
  64622. */
  64623. removeCamera(camera: Camera): void;
  64624. /**
  64625. * Dispose of the pipeline and stop all post processes
  64626. */
  64627. dispose(): void;
  64628. /**
  64629. * Serialize the rendering pipeline (Used when exporting)
  64630. * @returns the serialized object
  64631. */
  64632. serialize(): any;
  64633. /**
  64634. * Parse the serialized pipeline
  64635. * @param source Source pipeline.
  64636. * @param scene The scene to load the pipeline to.
  64637. * @param rootUrl The URL of the serialized pipeline.
  64638. * @returns An instantiated pipeline from the serialized object.
  64639. */
  64640. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  64641. }
  64642. }
  64643. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  64644. /** @hidden */
  64645. export var lensHighlightsPixelShader: {
  64646. name: string;
  64647. shader: string;
  64648. };
  64649. }
  64650. declare module "babylonjs/Shaders/depthOfField.fragment" {
  64651. /** @hidden */
  64652. export var depthOfFieldPixelShader: {
  64653. name: string;
  64654. shader: string;
  64655. };
  64656. }
  64657. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  64658. import { Camera } from "babylonjs/Cameras/camera";
  64659. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64660. import { Scene } from "babylonjs/scene";
  64661. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64662. import "babylonjs/Shaders/chromaticAberration.fragment";
  64663. import "babylonjs/Shaders/lensHighlights.fragment";
  64664. import "babylonjs/Shaders/depthOfField.fragment";
  64665. /**
  64666. * BABYLON.JS Chromatic Aberration GLSL Shader
  64667. * Author: Olivier Guyot
  64668. * Separates very slightly R, G and B colors on the edges of the screen
  64669. * Inspired by Francois Tarlier & Martins Upitis
  64670. */
  64671. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  64672. /**
  64673. * @ignore
  64674. * The chromatic aberration PostProcess id in the pipeline
  64675. */
  64676. LensChromaticAberrationEffect: string;
  64677. /**
  64678. * @ignore
  64679. * The highlights enhancing PostProcess id in the pipeline
  64680. */
  64681. HighlightsEnhancingEffect: string;
  64682. /**
  64683. * @ignore
  64684. * The depth-of-field PostProcess id in the pipeline
  64685. */
  64686. LensDepthOfFieldEffect: string;
  64687. private _scene;
  64688. private _depthTexture;
  64689. private _grainTexture;
  64690. private _chromaticAberrationPostProcess;
  64691. private _highlightsPostProcess;
  64692. private _depthOfFieldPostProcess;
  64693. private _edgeBlur;
  64694. private _grainAmount;
  64695. private _chromaticAberration;
  64696. private _distortion;
  64697. private _highlightsGain;
  64698. private _highlightsThreshold;
  64699. private _dofDistance;
  64700. private _dofAperture;
  64701. private _dofDarken;
  64702. private _dofPentagon;
  64703. private _blurNoise;
  64704. /**
  64705. * @constructor
  64706. *
  64707. * Effect parameters are as follow:
  64708. * {
  64709. * chromatic_aberration: number; // from 0 to x (1 for realism)
  64710. * edge_blur: number; // from 0 to x (1 for realism)
  64711. * distortion: number; // from 0 to x (1 for realism)
  64712. * grain_amount: number; // from 0 to 1
  64713. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  64714. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  64715. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  64716. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  64717. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  64718. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  64719. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  64720. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  64721. * }
  64722. * Note: if an effect parameter is unset, effect is disabled
  64723. *
  64724. * @param name The rendering pipeline name
  64725. * @param parameters - An object containing all parameters (see above)
  64726. * @param scene The scene linked to this pipeline
  64727. * @param ratio The size of the postprocesses (0.5 means that your postprocess will have a width = canvas.width 0.5 and a height = canvas.height 0.5)
  64728. * @param cameras The array of cameras that the rendering pipeline will be attached to
  64729. */
  64730. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  64731. /**
  64732. * Get the class name
  64733. * @returns "LensRenderingPipeline"
  64734. */
  64735. getClassName(): string;
  64736. /**
  64737. * Gets associated scene
  64738. */
  64739. readonly scene: Scene;
  64740. /**
  64741. * Gets or sets the edge blur
  64742. */
  64743. edgeBlur: number;
  64744. /**
  64745. * Gets or sets the grain amount
  64746. */
  64747. grainAmount: number;
  64748. /**
  64749. * Gets or sets the chromatic aberration amount
  64750. */
  64751. chromaticAberration: number;
  64752. /**
  64753. * Gets or sets the depth of field aperture
  64754. */
  64755. dofAperture: number;
  64756. /**
  64757. * Gets or sets the edge distortion
  64758. */
  64759. edgeDistortion: number;
  64760. /**
  64761. * Gets or sets the depth of field distortion
  64762. */
  64763. dofDistortion: number;
  64764. /**
  64765. * Gets or sets the darken out of focus amount
  64766. */
  64767. darkenOutOfFocus: number;
  64768. /**
  64769. * Gets or sets a boolean indicating if blur noise is enabled
  64770. */
  64771. blurNoise: boolean;
  64772. /**
  64773. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  64774. */
  64775. pentagonBokeh: boolean;
  64776. /**
  64777. * Gets or sets the highlight grain amount
  64778. */
  64779. highlightsGain: number;
  64780. /**
  64781. * Gets or sets the highlight threshold
  64782. */
  64783. highlightsThreshold: number;
  64784. /**
  64785. * Sets the amount of blur at the edges
  64786. * @param amount blur amount
  64787. */
  64788. setEdgeBlur(amount: number): void;
  64789. /**
  64790. * Sets edge blur to 0
  64791. */
  64792. disableEdgeBlur(): void;
  64793. /**
  64794. * Sets the amout of grain
  64795. * @param amount Amount of grain
  64796. */
  64797. setGrainAmount(amount: number): void;
  64798. /**
  64799. * Set grain amount to 0
  64800. */
  64801. disableGrain(): void;
  64802. /**
  64803. * Sets the chromatic aberration amount
  64804. * @param amount amount of chromatic aberration
  64805. */
  64806. setChromaticAberration(amount: number): void;
  64807. /**
  64808. * Sets chromatic aberration amount to 0
  64809. */
  64810. disableChromaticAberration(): void;
  64811. /**
  64812. * Sets the EdgeDistortion amount
  64813. * @param amount amount of EdgeDistortion
  64814. */
  64815. setEdgeDistortion(amount: number): void;
  64816. /**
  64817. * Sets edge distortion to 0
  64818. */
  64819. disableEdgeDistortion(): void;
  64820. /**
  64821. * Sets the FocusDistance amount
  64822. * @param amount amount of FocusDistance
  64823. */
  64824. setFocusDistance(amount: number): void;
  64825. /**
  64826. * Disables depth of field
  64827. */
  64828. disableDepthOfField(): void;
  64829. /**
  64830. * Sets the Aperture amount
  64831. * @param amount amount of Aperture
  64832. */
  64833. setAperture(amount: number): void;
  64834. /**
  64835. * Sets the DarkenOutOfFocus amount
  64836. * @param amount amount of DarkenOutOfFocus
  64837. */
  64838. setDarkenOutOfFocus(amount: number): void;
  64839. private _pentagonBokehIsEnabled;
  64840. /**
  64841. * Creates a pentagon bokeh effect
  64842. */
  64843. enablePentagonBokeh(): void;
  64844. /**
  64845. * Disables the pentagon bokeh effect
  64846. */
  64847. disablePentagonBokeh(): void;
  64848. /**
  64849. * Enables noise blur
  64850. */
  64851. enableNoiseBlur(): void;
  64852. /**
  64853. * Disables noise blur
  64854. */
  64855. disableNoiseBlur(): void;
  64856. /**
  64857. * Sets the HighlightsGain amount
  64858. * @param amount amount of HighlightsGain
  64859. */
  64860. setHighlightsGain(amount: number): void;
  64861. /**
  64862. * Sets the HighlightsThreshold amount
  64863. * @param amount amount of HighlightsThreshold
  64864. */
  64865. setHighlightsThreshold(amount: number): void;
  64866. /**
  64867. * Disables highlights
  64868. */
  64869. disableHighlights(): void;
  64870. /**
  64871. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  64872. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  64873. */
  64874. dispose(disableDepthRender?: boolean): void;
  64875. private _createChromaticAberrationPostProcess;
  64876. private _createHighlightsPostProcess;
  64877. private _createDepthOfFieldPostProcess;
  64878. private _createGrainTexture;
  64879. }
  64880. }
  64881. declare module "babylonjs/Shaders/ssao2.fragment" {
  64882. /** @hidden */
  64883. export var ssao2PixelShader: {
  64884. name: string;
  64885. shader: string;
  64886. };
  64887. }
  64888. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  64889. /** @hidden */
  64890. export var ssaoCombinePixelShader: {
  64891. name: string;
  64892. shader: string;
  64893. };
  64894. }
  64895. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  64896. import { Camera } from "babylonjs/Cameras/camera";
  64897. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64898. import { Scene } from "babylonjs/scene";
  64899. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64900. import "babylonjs/Shaders/ssao2.fragment";
  64901. import "babylonjs/Shaders/ssaoCombine.fragment";
  64902. /**
  64903. * Render pipeline to produce ssao effect
  64904. */
  64905. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  64906. /**
  64907. * @ignore
  64908. * The PassPostProcess id in the pipeline that contains the original scene color
  64909. */
  64910. SSAOOriginalSceneColorEffect: string;
  64911. /**
  64912. * @ignore
  64913. * The SSAO PostProcess id in the pipeline
  64914. */
  64915. SSAORenderEffect: string;
  64916. /**
  64917. * @ignore
  64918. * The horizontal blur PostProcess id in the pipeline
  64919. */
  64920. SSAOBlurHRenderEffect: string;
  64921. /**
  64922. * @ignore
  64923. * The vertical blur PostProcess id in the pipeline
  64924. */
  64925. SSAOBlurVRenderEffect: string;
  64926. /**
  64927. * @ignore
  64928. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  64929. */
  64930. SSAOCombineRenderEffect: string;
  64931. /**
  64932. * The output strength of the SSAO post-process. Default value is 1.0.
  64933. */
  64934. totalStrength: number;
  64935. /**
  64936. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  64937. */
  64938. maxZ: number;
  64939. /**
  64940. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  64941. */
  64942. minZAspect: number;
  64943. private _samples;
  64944. /**
  64945. * Number of samples used for the SSAO calculations. Default value is 8
  64946. */
  64947. samples: number;
  64948. private _textureSamples;
  64949. /**
  64950. * Number of samples to use for antialiasing
  64951. */
  64952. textureSamples: number;
  64953. /**
  64954. * Ratio object used for SSAO ratio and blur ratio
  64955. */
  64956. private _ratio;
  64957. /**
  64958. * Dynamically generated sphere sampler.
  64959. */
  64960. private _sampleSphere;
  64961. /**
  64962. * Blur filter offsets
  64963. */
  64964. private _samplerOffsets;
  64965. private _expensiveBlur;
  64966. /**
  64967. * If bilateral blur should be used
  64968. */
  64969. expensiveBlur: boolean;
  64970. /**
  64971. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  64972. */
  64973. radius: number;
  64974. /**
  64975. * The base color of the SSAO post-process
  64976. * The final result is "base + ssao" between [0, 1]
  64977. */
  64978. base: number;
  64979. /**
  64980. * Support test.
  64981. */
  64982. static readonly IsSupported: boolean;
  64983. private _scene;
  64984. private _depthTexture;
  64985. private _normalTexture;
  64986. private _randomTexture;
  64987. private _originalColorPostProcess;
  64988. private _ssaoPostProcess;
  64989. private _blurHPostProcess;
  64990. private _blurVPostProcess;
  64991. private _ssaoCombinePostProcess;
  64992. private _firstUpdate;
  64993. /**
  64994. * Gets active scene
  64995. */
  64996. readonly scene: Scene;
  64997. /**
  64998. * @constructor
  64999. * @param name The rendering pipeline name
  65000. * @param scene The scene linked to this pipeline
  65001. * @param ratio The size of the postprocesses. Can be a number shared between passes or an object for more precision: { ssaoRatio: 0.5, blurRatio: 1.0 }
  65002. * @param cameras The array of cameras that the rendering pipeline will be attached to
  65003. */
  65004. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  65005. /**
  65006. * Get the class name
  65007. * @returns "SSAO2RenderingPipeline"
  65008. */
  65009. getClassName(): string;
  65010. /**
  65011. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  65012. */
  65013. dispose(disableGeometryBufferRenderer?: boolean): void;
  65014. private _createBlurPostProcess;
  65015. /** @hidden */
  65016. _rebuild(): void;
  65017. private _bits;
  65018. private _radicalInverse_VdC;
  65019. private _hammersley;
  65020. private _hemisphereSample_uniform;
  65021. private _generateHemisphere;
  65022. private _createSSAOPostProcess;
  65023. private _createSSAOCombinePostProcess;
  65024. private _createRandomTexture;
  65025. /**
  65026. * Serialize the rendering pipeline (Used when exporting)
  65027. * @returns the serialized object
  65028. */
  65029. serialize(): any;
  65030. /**
  65031. * Parse the serialized pipeline
  65032. * @param source Source pipeline.
  65033. * @param scene The scene to load the pipeline to.
  65034. * @param rootUrl The URL of the serialized pipeline.
  65035. * @returns An instantiated pipeline from the serialized object.
  65036. */
  65037. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  65038. }
  65039. }
  65040. declare module "babylonjs/Shaders/ssao.fragment" {
  65041. /** @hidden */
  65042. export var ssaoPixelShader: {
  65043. name: string;
  65044. shader: string;
  65045. };
  65046. }
  65047. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  65048. import { Camera } from "babylonjs/Cameras/camera";
  65049. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65050. import { Scene } from "babylonjs/scene";
  65051. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65052. import "babylonjs/Shaders/ssao.fragment";
  65053. import "babylonjs/Shaders/ssaoCombine.fragment";
  65054. /**
  65055. * Render pipeline to produce ssao effect
  65056. */
  65057. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  65058. /**
  65059. * @ignore
  65060. * The PassPostProcess id in the pipeline that contains the original scene color
  65061. */
  65062. SSAOOriginalSceneColorEffect: string;
  65063. /**
  65064. * @ignore
  65065. * The SSAO PostProcess id in the pipeline
  65066. */
  65067. SSAORenderEffect: string;
  65068. /**
  65069. * @ignore
  65070. * The horizontal blur PostProcess id in the pipeline
  65071. */
  65072. SSAOBlurHRenderEffect: string;
  65073. /**
  65074. * @ignore
  65075. * The vertical blur PostProcess id in the pipeline
  65076. */
  65077. SSAOBlurVRenderEffect: string;
  65078. /**
  65079. * @ignore
  65080. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  65081. */
  65082. SSAOCombineRenderEffect: string;
  65083. /**
  65084. * The output strength of the SSAO post-process. Default value is 1.0.
  65085. */
  65086. totalStrength: number;
  65087. /**
  65088. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  65089. */
  65090. radius: number;
  65091. /**
  65092. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  65093. * Must not be equal to fallOff and superior to fallOff.
  65094. * Default value is 0.0075
  65095. */
  65096. area: number;
  65097. /**
  65098. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  65099. * Must not be equal to area and inferior to area.
  65100. * Default value is 0.000001
  65101. */
  65102. fallOff: number;
  65103. /**
  65104. * The base color of the SSAO post-process
  65105. * The final result is "base + ssao" between [0, 1]
  65106. */
  65107. base: number;
  65108. private _scene;
  65109. private _depthTexture;
  65110. private _randomTexture;
  65111. private _originalColorPostProcess;
  65112. private _ssaoPostProcess;
  65113. private _blurHPostProcess;
  65114. private _blurVPostProcess;
  65115. private _ssaoCombinePostProcess;
  65116. private _firstUpdate;
  65117. /**
  65118. * Gets active scene
  65119. */
  65120. readonly scene: Scene;
  65121. /**
  65122. * @constructor
  65123. * @param name - The rendering pipeline name
  65124. * @param scene - The scene linked to this pipeline
  65125. * @param ratio - The size of the postprocesses. Can be a number shared between passes or an object for more precision: { ssaoRatio: 0.5, combineRatio: 1.0 }
  65126. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  65127. */
  65128. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  65129. /**
  65130. * Get the class name
  65131. * @returns "SSAORenderingPipeline"
  65132. */
  65133. getClassName(): string;
  65134. /**
  65135. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  65136. */
  65137. dispose(disableDepthRender?: boolean): void;
  65138. private _createBlurPostProcess;
  65139. /** @hidden */
  65140. _rebuild(): void;
  65141. private _createSSAOPostProcess;
  65142. private _createSSAOCombinePostProcess;
  65143. private _createRandomTexture;
  65144. }
  65145. }
  65146. declare module "babylonjs/Shaders/standard.fragment" {
  65147. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  65148. /** @hidden */
  65149. export var standardPixelShader: {
  65150. name: string;
  65151. shader: string;
  65152. };
  65153. }
  65154. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  65155. import { Nullable } from "babylonjs/types";
  65156. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  65157. import { Camera } from "babylonjs/Cameras/camera";
  65158. import { Texture } from "babylonjs/Materials/Textures/texture";
  65159. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65160. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65161. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  65162. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  65163. import { IDisposable } from "babylonjs/scene";
  65164. import { SpotLight } from "babylonjs/Lights/spotLight";
  65165. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  65166. import { Scene } from "babylonjs/scene";
  65167. import { Animation } from "babylonjs/Animations/animation";
  65168. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65169. import "babylonjs/Shaders/standard.fragment";
  65170. /**
  65171. * Standard rendering pipeline
  65172. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  65173. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  65174. */
  65175. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  65176. /**
  65177. * Public members
  65178. */
  65179. /**
  65180. * Post-process which contains the original scene color before the pipeline applies all the effects
  65181. */
  65182. originalPostProcess: Nullable<PostProcess>;
  65183. /**
  65184. * Post-process used to down scale an image x4
  65185. */
  65186. downSampleX4PostProcess: Nullable<PostProcess>;
  65187. /**
  65188. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  65189. */
  65190. brightPassPostProcess: Nullable<PostProcess>;
  65191. /**
  65192. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  65193. */
  65194. blurHPostProcesses: PostProcess[];
  65195. /**
  65196. * Post-process array storing all the vertical blur post-processes used by the pipeline
  65197. */
  65198. blurVPostProcesses: PostProcess[];
  65199. /**
  65200. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  65201. */
  65202. textureAdderPostProcess: Nullable<PostProcess>;
  65203. /**
  65204. * Post-process used to create volumetric lighting effect
  65205. */
  65206. volumetricLightPostProcess: Nullable<PostProcess>;
  65207. /**
  65208. * Post-process used to smooth the previous volumetric light post-process on the X axis
  65209. */
  65210. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  65211. /**
  65212. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  65213. */
  65214. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  65215. /**
  65216. * Post-process used to merge the volumetric light effect and the real scene color
  65217. */
  65218. volumetricLightMergePostProces: Nullable<PostProcess>;
  65219. /**
  65220. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  65221. */
  65222. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  65223. /**
  65224. * Base post-process used to calculate the average luminance of the final image for HDR
  65225. */
  65226. luminancePostProcess: Nullable<PostProcess>;
  65227. /**
  65228. * Post-processes used to create down sample post-processes in order to get
  65229. * the average luminance of the final image for HDR
  65230. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  65231. */
  65232. luminanceDownSamplePostProcesses: PostProcess[];
  65233. /**
  65234. * Post-process used to create a HDR effect (light adaptation)
  65235. */
  65236. hdrPostProcess: Nullable<PostProcess>;
  65237. /**
  65238. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  65239. */
  65240. textureAdderFinalPostProcess: Nullable<PostProcess>;
  65241. /**
  65242. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  65243. */
  65244. lensFlareFinalPostProcess: Nullable<PostProcess>;
  65245. /**
  65246. * Post-process used to merge the final HDR post-process and the real scene color
  65247. */
  65248. hdrFinalPostProcess: Nullable<PostProcess>;
  65249. /**
  65250. * Post-process used to create a lens flare effect
  65251. */
  65252. lensFlarePostProcess: Nullable<PostProcess>;
  65253. /**
  65254. * Post-process that merges the result of the lens flare post-process and the real scene color
  65255. */
  65256. lensFlareComposePostProcess: Nullable<PostProcess>;
  65257. /**
  65258. * Post-process used to create a motion blur effect
  65259. */
  65260. motionBlurPostProcess: Nullable<PostProcess>;
  65261. /**
  65262. * Post-process used to create a depth of field effect
  65263. */
  65264. depthOfFieldPostProcess: Nullable<PostProcess>;
  65265. /**
  65266. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  65267. */
  65268. fxaaPostProcess: Nullable<FxaaPostProcess>;
  65269. /**
  65270. * Represents the brightness threshold in order to configure the illuminated surfaces
  65271. */
  65272. brightThreshold: number;
  65273. /**
  65274. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  65275. */
  65276. blurWidth: number;
  65277. /**
  65278. * Sets if the blur for highlighted surfaces must be only horizontal
  65279. */
  65280. horizontalBlur: boolean;
  65281. /**
  65282. * Gets the overall exposure used by the pipeline
  65283. */
  65284. /**
  65285. * Sets the overall exposure used by the pipeline
  65286. */
  65287. exposure: number;
  65288. /**
  65289. * Texture used typically to simulate "dirty" on camera lens
  65290. */
  65291. lensTexture: Nullable<Texture>;
  65292. /**
  65293. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  65294. */
  65295. volumetricLightCoefficient: number;
  65296. /**
  65297. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  65298. */
  65299. volumetricLightPower: number;
  65300. /**
  65301. * Used the set the blur intensity to smooth the volumetric lights
  65302. */
  65303. volumetricLightBlurScale: number;
  65304. /**
  65305. * Light (spot or directional) used to generate the volumetric lights rays
  65306. * The source light must have a shadow generate so the pipeline can get its
  65307. * depth map
  65308. */
  65309. sourceLight: Nullable<SpotLight | DirectionalLight>;
  65310. /**
  65311. * For eye adaptation, represents the minimum luminance the eye can see
  65312. */
  65313. hdrMinimumLuminance: number;
  65314. /**
  65315. * For eye adaptation, represents the decrease luminance speed
  65316. */
  65317. hdrDecreaseRate: number;
  65318. /**
  65319. * For eye adaptation, represents the increase luminance speed
  65320. */
  65321. hdrIncreaseRate: number;
  65322. /**
  65323. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  65324. */
  65325. /**
  65326. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  65327. */
  65328. hdrAutoExposure: boolean;
  65329. /**
  65330. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  65331. */
  65332. lensColorTexture: Nullable<Texture>;
  65333. /**
  65334. * The overall strengh for the lens flare effect
  65335. */
  65336. lensFlareStrength: number;
  65337. /**
  65338. * Dispersion coefficient for lens flare ghosts
  65339. */
  65340. lensFlareGhostDispersal: number;
  65341. /**
  65342. * Main lens flare halo width
  65343. */
  65344. lensFlareHaloWidth: number;
  65345. /**
  65346. * Based on the lens distortion effect, defines how much the lens flare result
  65347. * is distorted
  65348. */
  65349. lensFlareDistortionStrength: number;
  65350. /**
  65351. * Configures the blur intensity used for for lens flare (halo)
  65352. */
  65353. lensFlareBlurWidth: number;
  65354. /**
  65355. * Lens star texture must be used to simulate rays on the flares and is available
  65356. * in the documentation
  65357. */
  65358. lensStarTexture: Nullable<Texture>;
  65359. /**
  65360. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  65361. * flare effect by taking account of the dirt texture
  65362. */
  65363. lensFlareDirtTexture: Nullable<Texture>;
  65364. /**
  65365. * Represents the focal length for the depth of field effect
  65366. */
  65367. depthOfFieldDistance: number;
  65368. /**
  65369. * Represents the blur intensity for the blurred part of the depth of field effect
  65370. */
  65371. depthOfFieldBlurWidth: number;
  65372. /**
  65373. * Gets how much the image is blurred by the movement while using the motion blur post-process
  65374. */
  65375. /**
  65376. * Sets how much the image is blurred by the movement while using the motion blur post-process
  65377. */
  65378. motionStrength: number;
  65379. /**
  65380. * Gets wether or not the motion blur post-process is object based or screen based.
  65381. */
  65382. /**
  65383. * Sets wether or not the motion blur post-process should be object based or screen based
  65384. */
  65385. objectBasedMotionBlur: boolean;
  65386. /**
  65387. * List of animations for the pipeline (IAnimatable implementation)
  65388. */
  65389. animations: Animation[];
  65390. /**
  65391. * Private members
  65392. */
  65393. private _scene;
  65394. private _currentDepthOfFieldSource;
  65395. private _basePostProcess;
  65396. private _fixedExposure;
  65397. private _currentExposure;
  65398. private _hdrAutoExposure;
  65399. private _hdrCurrentLuminance;
  65400. private _motionStrength;
  65401. private _isObjectBasedMotionBlur;
  65402. private _floatTextureType;
  65403. private _camerasToBeAttached;
  65404. private _ratio;
  65405. private _bloomEnabled;
  65406. private _depthOfFieldEnabled;
  65407. private _vlsEnabled;
  65408. private _lensFlareEnabled;
  65409. private _hdrEnabled;
  65410. private _motionBlurEnabled;
  65411. private _fxaaEnabled;
  65412. private _motionBlurSamples;
  65413. private _volumetricLightStepsCount;
  65414. private _samples;
  65415. /**
  65416. * @ignore
  65417. * Specifies if the bloom pipeline is enabled
  65418. */
  65419. BloomEnabled: boolean;
  65420. /**
  65421. * @ignore
  65422. * Specifies if the depth of field pipeline is enabed
  65423. */
  65424. DepthOfFieldEnabled: boolean;
  65425. /**
  65426. * @ignore
  65427. * Specifies if the lens flare pipeline is enabed
  65428. */
  65429. LensFlareEnabled: boolean;
  65430. /**
  65431. * @ignore
  65432. * Specifies if the HDR pipeline is enabled
  65433. */
  65434. HDREnabled: boolean;
  65435. /**
  65436. * @ignore
  65437. * Specifies if the volumetric lights scattering effect is enabled
  65438. */
  65439. VLSEnabled: boolean;
  65440. /**
  65441. * @ignore
  65442. * Specifies if the motion blur effect is enabled
  65443. */
  65444. MotionBlurEnabled: boolean;
  65445. /**
  65446. * Specifies if anti-aliasing is enabled
  65447. */
  65448. fxaaEnabled: boolean;
  65449. /**
  65450. * Specifies the number of steps used to calculate the volumetric lights
  65451. * Typically in interval [50, 200]
  65452. */
  65453. volumetricLightStepsCount: number;
  65454. /**
  65455. * Specifies the number of samples used for the motion blur effect
  65456. * Typically in interval [16, 64]
  65457. */
  65458. motionBlurSamples: number;
  65459. /**
  65460. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  65461. */
  65462. samples: number;
  65463. /**
  65464. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  65465. * @constructor
  65466. * @param name The rendering pipeline name
  65467. * @param scene The scene linked to this pipeline
  65468. * @param ratio The size of the postprocesses (0.5 means that your postprocess will have a width = canvas.width 0.5 and a height = canvas.height 0.5)
  65469. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  65470. * @param cameras The array of cameras that the rendering pipeline will be attached to
  65471. */
  65472. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  65473. private _buildPipeline;
  65474. private _createDownSampleX4PostProcess;
  65475. private _createBrightPassPostProcess;
  65476. private _createBlurPostProcesses;
  65477. private _createTextureAdderPostProcess;
  65478. private _createVolumetricLightPostProcess;
  65479. private _createLuminancePostProcesses;
  65480. private _createHdrPostProcess;
  65481. private _createLensFlarePostProcess;
  65482. private _createDepthOfFieldPostProcess;
  65483. private _createMotionBlurPostProcess;
  65484. private _getDepthTexture;
  65485. private _disposePostProcesses;
  65486. /**
  65487. * Dispose of the pipeline and stop all post processes
  65488. */
  65489. dispose(): void;
  65490. /**
  65491. * Serialize the rendering pipeline (Used when exporting)
  65492. * @returns the serialized object
  65493. */
  65494. serialize(): any;
  65495. /**
  65496. * Parse the serialized pipeline
  65497. * @param source Source pipeline.
  65498. * @param scene The scene to load the pipeline to.
  65499. * @param rootUrl The URL of the serialized pipeline.
  65500. * @returns An instantiated pipeline from the serialized object.
  65501. */
  65502. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  65503. /**
  65504. * Luminance steps
  65505. */
  65506. static LuminanceSteps: number;
  65507. }
  65508. }
  65509. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  65510. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  65511. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  65512. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  65513. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  65514. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  65515. }
  65516. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  65517. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  65518. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  65519. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65520. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  65521. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65522. }
  65523. declare module "babylonjs/Shaders/tonemap.fragment" {
  65524. /** @hidden */
  65525. export var tonemapPixelShader: {
  65526. name: string;
  65527. shader: string;
  65528. };
  65529. }
  65530. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  65531. import { Camera } from "babylonjs/Cameras/camera";
  65532. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65533. import "babylonjs/Shaders/tonemap.fragment";
  65534. import { Engine } from "babylonjs/Engines/engine";
  65535. /** Defines operator used for tonemapping */
  65536. export enum TonemappingOperator {
  65537. /** Hable */
  65538. Hable = 0,
  65539. /** Reinhard */
  65540. Reinhard = 1,
  65541. /** HejiDawson */
  65542. HejiDawson = 2,
  65543. /** Photographic */
  65544. Photographic = 3
  65545. }
  65546. /**
  65547. * Defines a post process to apply tone mapping
  65548. */
  65549. export class TonemapPostProcess extends PostProcess {
  65550. private _operator;
  65551. /** Defines the required exposure adjustement */
  65552. exposureAdjustment: number;
  65553. /**
  65554. * Creates a new TonemapPostProcess
  65555. * @param name defines the name of the postprocess
  65556. * @param _operator defines the operator to use
  65557. * @param exposureAdjustment defines the required exposure adjustement
  65558. * @param camera defines the camera to use (can be null)
  65559. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  65560. * @param engine defines the hosting engine (can be ignore if camera is set)
  65561. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  65562. */
  65563. constructor(name: string, _operator: TonemappingOperator,
  65564. /** Defines the required exposure adjustement */
  65565. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  65566. }
  65567. }
  65568. declare module "babylonjs/Shaders/depth.vertex" {
  65569. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65570. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65571. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65572. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65573. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65574. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65575. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65576. /** @hidden */
  65577. export var depthVertexShader: {
  65578. name: string;
  65579. shader: string;
  65580. };
  65581. }
  65582. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  65583. /** @hidden */
  65584. export var volumetricLightScatteringPixelShader: {
  65585. name: string;
  65586. shader: string;
  65587. };
  65588. }
  65589. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  65590. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65591. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65592. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65593. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65594. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65595. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65596. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65597. /** @hidden */
  65598. export var volumetricLightScatteringPassVertexShader: {
  65599. name: string;
  65600. shader: string;
  65601. };
  65602. }
  65603. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  65604. /** @hidden */
  65605. export var volumetricLightScatteringPassPixelShader: {
  65606. name: string;
  65607. shader: string;
  65608. };
  65609. }
  65610. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  65611. import { Vector3 } from "babylonjs/Maths/math.vector";
  65612. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65613. import { Mesh } from "babylonjs/Meshes/mesh";
  65614. import { Camera } from "babylonjs/Cameras/camera";
  65615. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65616. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65617. import { Scene } from "babylonjs/scene";
  65618. import "babylonjs/Meshes/Builders/planeBuilder";
  65619. import "babylonjs/Shaders/depth.vertex";
  65620. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  65621. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  65622. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  65623. import { Engine } from "babylonjs/Engines/engine";
  65624. /**
  65625. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  65626. */
  65627. export class VolumetricLightScatteringPostProcess extends PostProcess {
  65628. private _volumetricLightScatteringPass;
  65629. private _volumetricLightScatteringRTT;
  65630. private _viewPort;
  65631. private _screenCoordinates;
  65632. private _cachedDefines;
  65633. /**
  65634. * If not undefined, the mesh position is computed from the attached node position
  65635. */
  65636. attachedNode: {
  65637. position: Vector3;
  65638. };
  65639. /**
  65640. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  65641. */
  65642. customMeshPosition: Vector3;
  65643. /**
  65644. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  65645. */
  65646. useCustomMeshPosition: boolean;
  65647. /**
  65648. * If the post-process should inverse the light scattering direction
  65649. */
  65650. invert: boolean;
  65651. /**
  65652. * The internal mesh used by the post-process
  65653. */
  65654. mesh: Mesh;
  65655. /**
  65656. * @hidden
  65657. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  65658. */
  65659. useDiffuseColor: boolean;
  65660. /**
  65661. * Array containing the excluded meshes not rendered in the internal pass
  65662. */
  65663. excludedMeshes: AbstractMesh[];
  65664. /**
  65665. * Controls the overall intensity of the post-process
  65666. */
  65667. exposure: number;
  65668. /**
  65669. * Dissipates each sample's contribution in range [0, 1]
  65670. */
  65671. decay: number;
  65672. /**
  65673. * Controls the overall intensity of each sample
  65674. */
  65675. weight: number;
  65676. /**
  65677. * Controls the density of each sample
  65678. */
  65679. density: number;
  65680. /**
  65681. * @constructor
  65682. * @param name The post-process name
  65683. * @param ratio The size of the post-process and/or internal pass (0.5 means that your postprocess will have a width = canvas.width 0.5 and a height = canvas.height 0.5)
  65684. * @param camera The camera that the post-process will be attached to
  65685. * @param mesh The mesh used to create the light scattering
  65686. * @param samples The post-process quality, default 100
  65687. * @param samplingModeThe post-process filtering mode
  65688. * @param engine The babylon engine
  65689. * @param reusable If the post-process is reusable
  65690. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  65691. */
  65692. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  65693. /**
  65694. * Returns the string "VolumetricLightScatteringPostProcess"
  65695. * @returns "VolumetricLightScatteringPostProcess"
  65696. */
  65697. getClassName(): string;
  65698. private _isReady;
  65699. /**
  65700. * Sets the new light position for light scattering effect
  65701. * @param position The new custom light position
  65702. */
  65703. setCustomMeshPosition(position: Vector3): void;
  65704. /**
  65705. * Returns the light position for light scattering effect
  65706. * @return Vector3 The custom light position
  65707. */
  65708. getCustomMeshPosition(): Vector3;
  65709. /**
  65710. * Disposes the internal assets and detaches the post-process from the camera
  65711. */
  65712. dispose(camera: Camera): void;
  65713. /**
  65714. * Returns the render target texture used by the post-process
  65715. * @return the render target texture used by the post-process
  65716. */
  65717. getPass(): RenderTargetTexture;
  65718. private _meshExcluded;
  65719. private _createPass;
  65720. private _updateMeshScreenCoordinates;
  65721. /**
  65722. * Creates a default mesh for the Volumeric Light Scattering post-process
  65723. * @param name The mesh name
  65724. * @param scene The scene where to create the mesh
  65725. * @return the default mesh
  65726. */
  65727. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  65728. }
  65729. }
  65730. declare module "babylonjs/PostProcesses/index" {
  65731. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  65732. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  65733. export * from "babylonjs/PostProcesses/bloomEffect";
  65734. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  65735. export * from "babylonjs/PostProcesses/blurPostProcess";
  65736. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  65737. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  65738. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  65739. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  65740. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  65741. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  65742. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  65743. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  65744. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  65745. export * from "babylonjs/PostProcesses/filterPostProcess";
  65746. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  65747. export * from "babylonjs/PostProcesses/grainPostProcess";
  65748. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  65749. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  65750. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  65751. export * from "babylonjs/PostProcesses/passPostProcess";
  65752. export * from "babylonjs/PostProcesses/postProcess";
  65753. export * from "babylonjs/PostProcesses/postProcessManager";
  65754. export * from "babylonjs/PostProcesses/refractionPostProcess";
  65755. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  65756. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  65757. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  65758. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  65759. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  65760. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  65761. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  65762. }
  65763. declare module "babylonjs/Probes/index" {
  65764. export * from "babylonjs/Probes/reflectionProbe";
  65765. }
  65766. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  65767. import { Scene } from "babylonjs/scene";
  65768. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65769. import { SmartArray } from "babylonjs/Misc/smartArray";
  65770. import { ISceneComponent } from "babylonjs/sceneComponent";
  65771. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  65772. import "babylonjs/Meshes/Builders/boxBuilder";
  65773. import "babylonjs/Shaders/color.fragment";
  65774. import "babylonjs/Shaders/color.vertex";
  65775. import { Color3 } from "babylonjs/Maths/math.color";
  65776. module "babylonjs/scene" {
  65777. interface Scene {
  65778. /** @hidden (Backing field) */
  65779. _boundingBoxRenderer: BoundingBoxRenderer;
  65780. /** @hidden (Backing field) */
  65781. _forceShowBoundingBoxes: boolean;
  65782. /**
  65783. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  65784. */
  65785. forceShowBoundingBoxes: boolean;
  65786. /**
  65787. * Gets the bounding box renderer associated with the scene
  65788. * @returns a BoundingBoxRenderer
  65789. */
  65790. getBoundingBoxRenderer(): BoundingBoxRenderer;
  65791. }
  65792. }
  65793. module "babylonjs/Meshes/abstractMesh" {
  65794. interface AbstractMesh {
  65795. /** @hidden (Backing field) */
  65796. _showBoundingBox: boolean;
  65797. /**
  65798. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  65799. */
  65800. showBoundingBox: boolean;
  65801. }
  65802. }
  65803. /**
  65804. * Component responsible of rendering the bounding box of the meshes in a scene.
  65805. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  65806. */
  65807. export class BoundingBoxRenderer implements ISceneComponent {
  65808. /**
  65809. * The component name helpfull to identify the component in the list of scene components.
  65810. */
  65811. readonly name: string;
  65812. /**
  65813. * The scene the component belongs to.
  65814. */
  65815. scene: Scene;
  65816. /**
  65817. * Color of the bounding box lines placed in front of an object
  65818. */
  65819. frontColor: Color3;
  65820. /**
  65821. * Color of the bounding box lines placed behind an object
  65822. */
  65823. backColor: Color3;
  65824. /**
  65825. * Defines if the renderer should show the back lines or not
  65826. */
  65827. showBackLines: boolean;
  65828. /**
  65829. * @hidden
  65830. */
  65831. renderList: SmartArray<BoundingBox>;
  65832. private _colorShader;
  65833. private _vertexBuffers;
  65834. private _indexBuffer;
  65835. private _fillIndexBuffer;
  65836. private _fillIndexData;
  65837. /**
  65838. * Instantiates a new bounding box renderer in a scene.
  65839. * @param scene the scene the renderer renders in
  65840. */
  65841. constructor(scene: Scene);
  65842. /**
  65843. * Registers the component in a given scene
  65844. */
  65845. register(): void;
  65846. private _evaluateSubMesh;
  65847. private _activeMesh;
  65848. private _prepareRessources;
  65849. private _createIndexBuffer;
  65850. /**
  65851. * Rebuilds the elements related to this component in case of
  65852. * context lost for instance.
  65853. */
  65854. rebuild(): void;
  65855. /**
  65856. * @hidden
  65857. */
  65858. reset(): void;
  65859. /**
  65860. * Render the bounding boxes of a specific rendering group
  65861. * @param renderingGroupId defines the rendering group to render
  65862. */
  65863. render(renderingGroupId: number): void;
  65864. /**
  65865. * In case of occlusion queries, we can render the occlusion bounding box through this method
  65866. * @param mesh Define the mesh to render the occlusion bounding box for
  65867. */
  65868. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  65869. /**
  65870. * Dispose and release the resources attached to this renderer.
  65871. */
  65872. dispose(): void;
  65873. }
  65874. }
  65875. declare module "babylonjs/Shaders/depth.fragment" {
  65876. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  65877. /** @hidden */
  65878. export var depthPixelShader: {
  65879. name: string;
  65880. shader: string;
  65881. };
  65882. }
  65883. declare module "babylonjs/Rendering/depthRenderer" {
  65884. import { Nullable } from "babylonjs/types";
  65885. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65886. import { Scene } from "babylonjs/scene";
  65887. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65888. import { Camera } from "babylonjs/Cameras/camera";
  65889. import "babylonjs/Shaders/depth.fragment";
  65890. import "babylonjs/Shaders/depth.vertex";
  65891. /**
  65892. * This represents a depth renderer in Babylon.
  65893. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  65894. */
  65895. export class DepthRenderer {
  65896. private _scene;
  65897. private _depthMap;
  65898. private _effect;
  65899. private readonly _storeNonLinearDepth;
  65900. private readonly _clearColor;
  65901. /** Get if the depth renderer is using packed depth or not */
  65902. readonly isPacked: boolean;
  65903. private _cachedDefines;
  65904. private _camera;
  65905. /**
  65906. * Specifiess that the depth renderer will only be used within
  65907. * the camera it is created for.
  65908. * This can help forcing its rendering during the camera processing.
  65909. */
  65910. useOnlyInActiveCamera: boolean;
  65911. /** @hidden */
  65912. static _SceneComponentInitialization: (scene: Scene) => void;
  65913. /**
  65914. * Instantiates a depth renderer
  65915. * @param scene The scene the renderer belongs to
  65916. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  65917. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  65918. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  65919. */
  65920. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  65921. /**
  65922. * Creates the depth rendering effect and checks if the effect is ready.
  65923. * @param subMesh The submesh to be used to render the depth map of
  65924. * @param useInstances If multiple world instances should be used
  65925. * @returns if the depth renderer is ready to render the depth map
  65926. */
  65927. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  65928. /**
  65929. * Gets the texture which the depth map will be written to.
  65930. * @returns The depth map texture
  65931. */
  65932. getDepthMap(): RenderTargetTexture;
  65933. /**
  65934. * Disposes of the depth renderer.
  65935. */
  65936. dispose(): void;
  65937. }
  65938. }
  65939. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  65940. import { Nullable } from "babylonjs/types";
  65941. import { Scene } from "babylonjs/scene";
  65942. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  65943. import { Camera } from "babylonjs/Cameras/camera";
  65944. import { ISceneComponent } from "babylonjs/sceneComponent";
  65945. module "babylonjs/scene" {
  65946. interface Scene {
  65947. /** @hidden (Backing field) */
  65948. _depthRenderer: {
  65949. [id: string]: DepthRenderer;
  65950. };
  65951. /**
  65952. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  65953. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  65954. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  65955. * @returns the created depth renderer
  65956. */
  65957. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  65958. /**
  65959. * Disables a depth renderer for a given camera
  65960. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  65961. */
  65962. disableDepthRenderer(camera?: Nullable<Camera>): void;
  65963. }
  65964. }
  65965. /**
  65966. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  65967. * in several rendering techniques.
  65968. */
  65969. export class DepthRendererSceneComponent implements ISceneComponent {
  65970. /**
  65971. * The component name helpfull to identify the component in the list of scene components.
  65972. */
  65973. readonly name: string;
  65974. /**
  65975. * The scene the component belongs to.
  65976. */
  65977. scene: Scene;
  65978. /**
  65979. * Creates a new instance of the component for the given scene
  65980. * @param scene Defines the scene to register the component in
  65981. */
  65982. constructor(scene: Scene);
  65983. /**
  65984. * Registers the component in a given scene
  65985. */
  65986. register(): void;
  65987. /**
  65988. * Rebuilds the elements related to this component in case of
  65989. * context lost for instance.
  65990. */
  65991. rebuild(): void;
  65992. /**
  65993. * Disposes the component and the associated ressources
  65994. */
  65995. dispose(): void;
  65996. private _gatherRenderTargets;
  65997. private _gatherActiveCameraRenderTargets;
  65998. }
  65999. }
  66000. declare module "babylonjs/Shaders/outline.fragment" {
  66001. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  66002. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  66003. /** @hidden */
  66004. export var outlinePixelShader: {
  66005. name: string;
  66006. shader: string;
  66007. };
  66008. }
  66009. declare module "babylonjs/Shaders/outline.vertex" {
  66010. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  66011. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  66012. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  66013. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  66014. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  66015. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  66016. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  66017. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  66018. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  66019. /** @hidden */
  66020. export var outlineVertexShader: {
  66021. name: string;
  66022. shader: string;
  66023. };
  66024. }
  66025. declare module "babylonjs/Rendering/outlineRenderer" {
  66026. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66027. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  66028. import { Scene } from "babylonjs/scene";
  66029. import { ISceneComponent } from "babylonjs/sceneComponent";
  66030. import "babylonjs/Shaders/outline.fragment";
  66031. import "babylonjs/Shaders/outline.vertex";
  66032. module "babylonjs/scene" {
  66033. interface Scene {
  66034. /** @hidden */
  66035. _outlineRenderer: OutlineRenderer;
  66036. /**
  66037. * Gets the outline renderer associated with the scene
  66038. * @returns a OutlineRenderer
  66039. */
  66040. getOutlineRenderer(): OutlineRenderer;
  66041. }
  66042. }
  66043. module "babylonjs/Meshes/abstractMesh" {
  66044. interface AbstractMesh {
  66045. /** @hidden (Backing field) */
  66046. _renderOutline: boolean;
  66047. /**
  66048. * Gets or sets a boolean indicating if the outline must be rendered as well
  66049. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  66050. */
  66051. renderOutline: boolean;
  66052. /** @hidden (Backing field) */
  66053. _renderOverlay: boolean;
  66054. /**
  66055. * Gets or sets a boolean indicating if the overlay must be rendered as well
  66056. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  66057. */
  66058. renderOverlay: boolean;
  66059. }
  66060. }
  66061. /**
  66062. * This class is responsible to draw bothe outline/overlay of meshes.
  66063. * It should not be used directly but through the available method on mesh.
  66064. */
  66065. export class OutlineRenderer implements ISceneComponent {
  66066. /**
  66067. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  66068. */
  66069. private static _StencilReference;
  66070. /**
  66071. * The name of the component. Each component must have a unique name.
  66072. */
  66073. name: string;
  66074. /**
  66075. * The scene the component belongs to.
  66076. */
  66077. scene: Scene;
  66078. /**
  66079. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  66080. */
  66081. zOffset: number;
  66082. private _engine;
  66083. private _effect;
  66084. private _cachedDefines;
  66085. private _savedDepthWrite;
  66086. /**
  66087. * Instantiates a new outline renderer. (There could be only one per scene).
  66088. * @param scene Defines the scene it belongs to
  66089. */
  66090. constructor(scene: Scene);
  66091. /**
  66092. * Register the component to one instance of a scene.
  66093. */
  66094. register(): void;
  66095. /**
  66096. * Rebuilds the elements related to this component in case of
  66097. * context lost for instance.
  66098. */
  66099. rebuild(): void;
  66100. /**
  66101. * Disposes the component and the associated ressources.
  66102. */
  66103. dispose(): void;
  66104. /**
  66105. * Renders the outline in the canvas.
  66106. * @param subMesh Defines the sumesh to render
  66107. * @param batch Defines the batch of meshes in case of instances
  66108. * @param useOverlay Defines if the rendering is for the overlay or the outline
  66109. */
  66110. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  66111. /**
  66112. * Returns whether or not the outline renderer is ready for a given submesh.
  66113. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  66114. * @param subMesh Defines the submesh to check readyness for
  66115. * @param useInstances Defines wheter wee are trying to render instances or not
  66116. * @returns true if ready otherwise false
  66117. */
  66118. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  66119. private _beforeRenderingMesh;
  66120. private _afterRenderingMesh;
  66121. }
  66122. }
  66123. declare module "babylonjs/Rendering/index" {
  66124. export * from "babylonjs/Rendering/boundingBoxRenderer";
  66125. export * from "babylonjs/Rendering/depthRenderer";
  66126. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  66127. export * from "babylonjs/Rendering/edgesRenderer";
  66128. export * from "babylonjs/Rendering/geometryBufferRenderer";
  66129. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  66130. export * from "babylonjs/Rendering/outlineRenderer";
  66131. export * from "babylonjs/Rendering/renderingGroup";
  66132. export * from "babylonjs/Rendering/renderingManager";
  66133. export * from "babylonjs/Rendering/utilityLayerRenderer";
  66134. }
  66135. declare module "babylonjs/Sprites/spritePackedManager" {
  66136. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  66137. import { Scene } from "babylonjs/scene";
  66138. /**
  66139. * Class used to manage multiple sprites of different sizes on the same spritesheet
  66140. * @see http://doc.babylonjs.com/babylon101/sprites
  66141. */
  66142. export class SpritePackedManager extends SpriteManager {
  66143. /** defines the packed manager's name */
  66144. name: string;
  66145. /**
  66146. * Creates a new sprite manager from a packed sprite sheet
  66147. * @param name defines the manager's name
  66148. * @param imgUrl defines the sprite sheet url
  66149. * @param capacity defines the maximum allowed number of sprites
  66150. * @param scene defines the hosting scene
  66151. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  66152. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  66153. * @param samplingMode defines the smapling mode to use with spritesheet
  66154. * @param fromPacked set to true; do not alter
  66155. */
  66156. constructor(
  66157. /** defines the packed manager's name */
  66158. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  66159. }
  66160. }
  66161. declare module "babylonjs/Sprites/index" {
  66162. export * from "babylonjs/Sprites/sprite";
  66163. export * from "babylonjs/Sprites/spriteManager";
  66164. export * from "babylonjs/Sprites/spritePackedManager";
  66165. export * from "babylonjs/Sprites/spriteSceneComponent";
  66166. }
  66167. declare module "babylonjs/States/index" {
  66168. export * from "babylonjs/States/alphaCullingState";
  66169. export * from "babylonjs/States/depthCullingState";
  66170. export * from "babylonjs/States/stencilState";
  66171. }
  66172. declare module "babylonjs/Misc/assetsManager" {
  66173. import { Scene } from "babylonjs/scene";
  66174. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66175. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  66176. import { Skeleton } from "babylonjs/Bones/skeleton";
  66177. import { Observable } from "babylonjs/Misc/observable";
  66178. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  66179. import { Texture } from "babylonjs/Materials/Textures/texture";
  66180. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  66181. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  66182. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  66183. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  66184. /**
  66185. * Defines the list of states available for a task inside a AssetsManager
  66186. */
  66187. export enum AssetTaskState {
  66188. /**
  66189. * Initialization
  66190. */
  66191. INIT = 0,
  66192. /**
  66193. * Running
  66194. */
  66195. RUNNING = 1,
  66196. /**
  66197. * Done
  66198. */
  66199. DONE = 2,
  66200. /**
  66201. * Error
  66202. */
  66203. ERROR = 3
  66204. }
  66205. /**
  66206. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  66207. */
  66208. export abstract class AbstractAssetTask {
  66209. /**
  66210. * Task name
  66211. */ name: string;
  66212. /**
  66213. * Callback called when the task is successful
  66214. */
  66215. onSuccess: (task: any) => void;
  66216. /**
  66217. * Callback called when the task is not successful
  66218. */
  66219. onError: (task: any, message?: string, exception?: any) => void;
  66220. /**
  66221. * Creates a new AssetsManager
  66222. * @param name defines the name of the task
  66223. */
  66224. constructor(
  66225. /**
  66226. * Task name
  66227. */ name: string);
  66228. private _isCompleted;
  66229. private _taskState;
  66230. private _errorObject;
  66231. /**
  66232. * Get if the task is completed
  66233. */
  66234. readonly isCompleted: boolean;
  66235. /**
  66236. * Gets the current state of the task
  66237. */
  66238. readonly taskState: AssetTaskState;
  66239. /**
  66240. * Gets the current error object (if task is in error)
  66241. */
  66242. readonly errorObject: {
  66243. message?: string;
  66244. exception?: any;
  66245. };
  66246. /**
  66247. * Internal only
  66248. * @hidden
  66249. */
  66250. _setErrorObject(message?: string, exception?: any): void;
  66251. /**
  66252. * Execute the current task
  66253. * @param scene defines the scene where you want your assets to be loaded
  66254. * @param onSuccess is a callback called when the task is successfully executed
  66255. * @param onError is a callback called if an error occurs
  66256. */
  66257. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66258. /**
  66259. * Execute the current task
  66260. * @param scene defines the scene where you want your assets to be loaded
  66261. * @param onSuccess is a callback called when the task is successfully executed
  66262. * @param onError is a callback called if an error occurs
  66263. */
  66264. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66265. /**
  66266. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  66267. * This can be used with failed tasks that have the reason for failure fixed.
  66268. */
  66269. reset(): void;
  66270. private onErrorCallback;
  66271. private onDoneCallback;
  66272. }
  66273. /**
  66274. * Define the interface used by progress events raised during assets loading
  66275. */
  66276. export interface IAssetsProgressEvent {
  66277. /**
  66278. * Defines the number of remaining tasks to process
  66279. */
  66280. remainingCount: number;
  66281. /**
  66282. * Defines the total number of tasks
  66283. */
  66284. totalCount: number;
  66285. /**
  66286. * Defines the task that was just processed
  66287. */
  66288. task: AbstractAssetTask;
  66289. }
  66290. /**
  66291. * Class used to share progress information about assets loading
  66292. */
  66293. export class AssetsProgressEvent implements IAssetsProgressEvent {
  66294. /**
  66295. * Defines the number of remaining tasks to process
  66296. */
  66297. remainingCount: number;
  66298. /**
  66299. * Defines the total number of tasks
  66300. */
  66301. totalCount: number;
  66302. /**
  66303. * Defines the task that was just processed
  66304. */
  66305. task: AbstractAssetTask;
  66306. /**
  66307. * Creates a AssetsProgressEvent
  66308. * @param remainingCount defines the number of remaining tasks to process
  66309. * @param totalCount defines the total number of tasks
  66310. * @param task defines the task that was just processed
  66311. */
  66312. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  66313. }
  66314. /**
  66315. * Define a task used by AssetsManager to load meshes
  66316. */
  66317. export class MeshAssetTask extends AbstractAssetTask {
  66318. /**
  66319. * Defines the name of the task
  66320. */
  66321. name: string;
  66322. /**
  66323. * Defines the list of mesh's names you want to load
  66324. */
  66325. meshesNames: any;
  66326. /**
  66327. * Defines the root url to use as a base to load your meshes and associated resources
  66328. */
  66329. rootUrl: string;
  66330. /**
  66331. * Defines the filename of the scene to load from
  66332. */
  66333. sceneFilename: string;
  66334. /**
  66335. * Gets the list of loaded meshes
  66336. */
  66337. loadedMeshes: Array<AbstractMesh>;
  66338. /**
  66339. * Gets the list of loaded particle systems
  66340. */
  66341. loadedParticleSystems: Array<IParticleSystem>;
  66342. /**
  66343. * Gets the list of loaded skeletons
  66344. */
  66345. loadedSkeletons: Array<Skeleton>;
  66346. /**
  66347. * Gets the list of loaded animation groups
  66348. */
  66349. loadedAnimationGroups: Array<AnimationGroup>;
  66350. /**
  66351. * Callback called when the task is successful
  66352. */
  66353. onSuccess: (task: MeshAssetTask) => void;
  66354. /**
  66355. * Callback called when the task is successful
  66356. */
  66357. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  66358. /**
  66359. * Creates a new MeshAssetTask
  66360. * @param name defines the name of the task
  66361. * @param meshesNames defines the list of mesh's names you want to load
  66362. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  66363. * @param sceneFilename defines the filename of the scene to load from
  66364. */
  66365. constructor(
  66366. /**
  66367. * Defines the name of the task
  66368. */
  66369. name: string,
  66370. /**
  66371. * Defines the list of mesh's names you want to load
  66372. */
  66373. meshesNames: any,
  66374. /**
  66375. * Defines the root url to use as a base to load your meshes and associated resources
  66376. */
  66377. rootUrl: string,
  66378. /**
  66379. * Defines the filename of the scene to load from
  66380. */
  66381. sceneFilename: string);
  66382. /**
  66383. * Execute the current task
  66384. * @param scene defines the scene where you want your assets to be loaded
  66385. * @param onSuccess is a callback called when the task is successfully executed
  66386. * @param onError is a callback called if an error occurs
  66387. */
  66388. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66389. }
  66390. /**
  66391. * Define a task used by AssetsManager to load text content
  66392. */
  66393. export class TextFileAssetTask extends AbstractAssetTask {
  66394. /**
  66395. * Defines the name of the task
  66396. */
  66397. name: string;
  66398. /**
  66399. * Defines the location of the file to load
  66400. */
  66401. url: string;
  66402. /**
  66403. * Gets the loaded text string
  66404. */
  66405. text: string;
  66406. /**
  66407. * Callback called when the task is successful
  66408. */
  66409. onSuccess: (task: TextFileAssetTask) => void;
  66410. /**
  66411. * Callback called when the task is successful
  66412. */
  66413. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  66414. /**
  66415. * Creates a new TextFileAssetTask object
  66416. * @param name defines the name of the task
  66417. * @param url defines the location of the file to load
  66418. */
  66419. constructor(
  66420. /**
  66421. * Defines the name of the task
  66422. */
  66423. name: string,
  66424. /**
  66425. * Defines the location of the file to load
  66426. */
  66427. url: string);
  66428. /**
  66429. * Execute the current task
  66430. * @param scene defines the scene where you want your assets to be loaded
  66431. * @param onSuccess is a callback called when the task is successfully executed
  66432. * @param onError is a callback called if an error occurs
  66433. */
  66434. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66435. }
  66436. /**
  66437. * Define a task used by AssetsManager to load binary data
  66438. */
  66439. export class BinaryFileAssetTask extends AbstractAssetTask {
  66440. /**
  66441. * Defines the name of the task
  66442. */
  66443. name: string;
  66444. /**
  66445. * Defines the location of the file to load
  66446. */
  66447. url: string;
  66448. /**
  66449. * Gets the lodaded data (as an array buffer)
  66450. */
  66451. data: ArrayBuffer;
  66452. /**
  66453. * Callback called when the task is successful
  66454. */
  66455. onSuccess: (task: BinaryFileAssetTask) => void;
  66456. /**
  66457. * Callback called when the task is successful
  66458. */
  66459. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  66460. /**
  66461. * Creates a new BinaryFileAssetTask object
  66462. * @param name defines the name of the new task
  66463. * @param url defines the location of the file to load
  66464. */
  66465. constructor(
  66466. /**
  66467. * Defines the name of the task
  66468. */
  66469. name: string,
  66470. /**
  66471. * Defines the location of the file to load
  66472. */
  66473. url: string);
  66474. /**
  66475. * Execute the current task
  66476. * @param scene defines the scene where you want your assets to be loaded
  66477. * @param onSuccess is a callback called when the task is successfully executed
  66478. * @param onError is a callback called if an error occurs
  66479. */
  66480. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66481. }
  66482. /**
  66483. * Define a task used by AssetsManager to load images
  66484. */
  66485. export class ImageAssetTask extends AbstractAssetTask {
  66486. /**
  66487. * Defines the name of the task
  66488. */
  66489. name: string;
  66490. /**
  66491. * Defines the location of the image to load
  66492. */
  66493. url: string;
  66494. /**
  66495. * Gets the loaded images
  66496. */
  66497. image: HTMLImageElement;
  66498. /**
  66499. * Callback called when the task is successful
  66500. */
  66501. onSuccess: (task: ImageAssetTask) => void;
  66502. /**
  66503. * Callback called when the task is successful
  66504. */
  66505. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  66506. /**
  66507. * Creates a new ImageAssetTask
  66508. * @param name defines the name of the task
  66509. * @param url defines the location of the image to load
  66510. */
  66511. constructor(
  66512. /**
  66513. * Defines the name of the task
  66514. */
  66515. name: string,
  66516. /**
  66517. * Defines the location of the image to load
  66518. */
  66519. url: string);
  66520. /**
  66521. * Execute the current task
  66522. * @param scene defines the scene where you want your assets to be loaded
  66523. * @param onSuccess is a callback called when the task is successfully executed
  66524. * @param onError is a callback called if an error occurs
  66525. */
  66526. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66527. }
  66528. /**
  66529. * Defines the interface used by texture loading tasks
  66530. */
  66531. export interface ITextureAssetTask<TEX extends BaseTexture> {
  66532. /**
  66533. * Gets the loaded texture
  66534. */
  66535. texture: TEX;
  66536. }
  66537. /**
  66538. * Define a task used by AssetsManager to load 2D textures
  66539. */
  66540. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  66541. /**
  66542. * Defines the name of the task
  66543. */
  66544. name: string;
  66545. /**
  66546. * Defines the location of the file to load
  66547. */
  66548. url: string;
  66549. /**
  66550. * Defines if mipmap should not be generated (default is false)
  66551. */
  66552. noMipmap?: boolean | undefined;
  66553. /**
  66554. * Defines if texture must be inverted on Y axis (default is false)
  66555. */
  66556. invertY?: boolean | undefined;
  66557. /**
  66558. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66559. */
  66560. samplingMode: number;
  66561. /**
  66562. * Gets the loaded texture
  66563. */
  66564. texture: Texture;
  66565. /**
  66566. * Callback called when the task is successful
  66567. */
  66568. onSuccess: (task: TextureAssetTask) => void;
  66569. /**
  66570. * Callback called when the task is successful
  66571. */
  66572. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  66573. /**
  66574. * Creates a new TextureAssetTask object
  66575. * @param name defines the name of the task
  66576. * @param url defines the location of the file to load
  66577. * @param noMipmap defines if mipmap should not be generated (default is false)
  66578. * @param invertY defines if texture must be inverted on Y axis (default is false)
  66579. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66580. */
  66581. constructor(
  66582. /**
  66583. * Defines the name of the task
  66584. */
  66585. name: string,
  66586. /**
  66587. * Defines the location of the file to load
  66588. */
  66589. url: string,
  66590. /**
  66591. * Defines if mipmap should not be generated (default is false)
  66592. */
  66593. noMipmap?: boolean | undefined,
  66594. /**
  66595. * Defines if texture must be inverted on Y axis (default is false)
  66596. */
  66597. invertY?: boolean | undefined,
  66598. /**
  66599. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66600. */
  66601. samplingMode?: number);
  66602. /**
  66603. * Execute the current task
  66604. * @param scene defines the scene where you want your assets to be loaded
  66605. * @param onSuccess is a callback called when the task is successfully executed
  66606. * @param onError is a callback called if an error occurs
  66607. */
  66608. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66609. }
  66610. /**
  66611. * Define a task used by AssetsManager to load cube textures
  66612. */
  66613. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  66614. /**
  66615. * Defines the name of the task
  66616. */
  66617. name: string;
  66618. /**
  66619. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66620. */
  66621. url: string;
  66622. /**
  66623. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66624. */
  66625. extensions?: string[] | undefined;
  66626. /**
  66627. * Defines if mipmaps should not be generated (default is false)
  66628. */
  66629. noMipmap?: boolean | undefined;
  66630. /**
  66631. * Defines the explicit list of files (undefined by default)
  66632. */
  66633. files?: string[] | undefined;
  66634. /**
  66635. * Gets the loaded texture
  66636. */
  66637. texture: CubeTexture;
  66638. /**
  66639. * Callback called when the task is successful
  66640. */
  66641. onSuccess: (task: CubeTextureAssetTask) => void;
  66642. /**
  66643. * Callback called when the task is successful
  66644. */
  66645. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  66646. /**
  66647. * Creates a new CubeTextureAssetTask
  66648. * @param name defines the name of the task
  66649. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66650. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66651. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66652. * @param files defines the explicit list of files (undefined by default)
  66653. */
  66654. constructor(
  66655. /**
  66656. * Defines the name of the task
  66657. */
  66658. name: string,
  66659. /**
  66660. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66661. */
  66662. url: string,
  66663. /**
  66664. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66665. */
  66666. extensions?: string[] | undefined,
  66667. /**
  66668. * Defines if mipmaps should not be generated (default is false)
  66669. */
  66670. noMipmap?: boolean | undefined,
  66671. /**
  66672. * Defines the explicit list of files (undefined by default)
  66673. */
  66674. files?: string[] | undefined);
  66675. /**
  66676. * Execute the current task
  66677. * @param scene defines the scene where you want your assets to be loaded
  66678. * @param onSuccess is a callback called when the task is successfully executed
  66679. * @param onError is a callback called if an error occurs
  66680. */
  66681. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66682. }
  66683. /**
  66684. * Define a task used by AssetsManager to load HDR cube textures
  66685. */
  66686. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  66687. /**
  66688. * Defines the name of the task
  66689. */
  66690. name: string;
  66691. /**
  66692. * Defines the location of the file to load
  66693. */
  66694. url: string;
  66695. /**
  66696. * Defines the desired size (the more it increases the longer the generation will be)
  66697. */
  66698. size: number;
  66699. /**
  66700. * Defines if mipmaps should not be generated (default is false)
  66701. */
  66702. noMipmap: boolean;
  66703. /**
  66704. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  66705. */
  66706. generateHarmonics: boolean;
  66707. /**
  66708. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  66709. */
  66710. gammaSpace: boolean;
  66711. /**
  66712. * Internal Use Only
  66713. */
  66714. reserved: boolean;
  66715. /**
  66716. * Gets the loaded texture
  66717. */
  66718. texture: HDRCubeTexture;
  66719. /**
  66720. * Callback called when the task is successful
  66721. */
  66722. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  66723. /**
  66724. * Callback called when the task is successful
  66725. */
  66726. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  66727. /**
  66728. * Creates a new HDRCubeTextureAssetTask object
  66729. * @param name defines the name of the task
  66730. * @param url defines the location of the file to load
  66731. * @param size defines the desired size (the more it increases the longer the generation will be) If the size is omitted this implies you are using a preprocessed cubemap.
  66732. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66733. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  66734. * @param gammaSpace specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  66735. * @param reserved Internal use only
  66736. */
  66737. constructor(
  66738. /**
  66739. * Defines the name of the task
  66740. */
  66741. name: string,
  66742. /**
  66743. * Defines the location of the file to load
  66744. */
  66745. url: string,
  66746. /**
  66747. * Defines the desired size (the more it increases the longer the generation will be)
  66748. */
  66749. size: number,
  66750. /**
  66751. * Defines if mipmaps should not be generated (default is false)
  66752. */
  66753. noMipmap?: boolean,
  66754. /**
  66755. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  66756. */
  66757. generateHarmonics?: boolean,
  66758. /**
  66759. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  66760. */
  66761. gammaSpace?: boolean,
  66762. /**
  66763. * Internal Use Only
  66764. */
  66765. reserved?: boolean);
  66766. /**
  66767. * Execute the current task
  66768. * @param scene defines the scene where you want your assets to be loaded
  66769. * @param onSuccess is a callback called when the task is successfully executed
  66770. * @param onError is a callback called if an error occurs
  66771. */
  66772. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66773. }
  66774. /**
  66775. * Define a task used by AssetsManager to load Equirectangular cube textures
  66776. */
  66777. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  66778. /**
  66779. * Defines the name of the task
  66780. */
  66781. name: string;
  66782. /**
  66783. * Defines the location of the file to load
  66784. */
  66785. url: string;
  66786. /**
  66787. * Defines the desired size (the more it increases the longer the generation will be)
  66788. */
  66789. size: number;
  66790. /**
  66791. * Defines if mipmaps should not be generated (default is false)
  66792. */
  66793. noMipmap: boolean;
  66794. /**
  66795. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  66796. * but the standard material would require them in Gamma space) (default is true)
  66797. */
  66798. gammaSpace: boolean;
  66799. /**
  66800. * Gets the loaded texture
  66801. */
  66802. texture: EquiRectangularCubeTexture;
  66803. /**
  66804. * Callback called when the task is successful
  66805. */
  66806. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  66807. /**
  66808. * Callback called when the task is successful
  66809. */
  66810. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  66811. /**
  66812. * Creates a new EquiRectangularCubeTextureAssetTask object
  66813. * @param name defines the name of the task
  66814. * @param url defines the location of the file to load
  66815. * @param size defines the desired size (the more it increases the longer the generation will be)
  66816. * If the size is omitted this implies you are using a preprocessed cubemap.
  66817. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66818. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  66819. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  66820. * (default is true)
  66821. */
  66822. constructor(
  66823. /**
  66824. * Defines the name of the task
  66825. */
  66826. name: string,
  66827. /**
  66828. * Defines the location of the file to load
  66829. */
  66830. url: string,
  66831. /**
  66832. * Defines the desired size (the more it increases the longer the generation will be)
  66833. */
  66834. size: number,
  66835. /**
  66836. * Defines if mipmaps should not be generated (default is false)
  66837. */
  66838. noMipmap?: boolean,
  66839. /**
  66840. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  66841. * but the standard material would require them in Gamma space) (default is true)
  66842. */
  66843. gammaSpace?: boolean);
  66844. /**
  66845. * Execute the current task
  66846. * @param scene defines the scene where you want your assets to be loaded
  66847. * @param onSuccess is a callback called when the task is successfully executed
  66848. * @param onError is a callback called if an error occurs
  66849. */
  66850. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66851. }
  66852. /**
  66853. * This class can be used to easily import assets into a scene
  66854. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  66855. */
  66856. export class AssetsManager {
  66857. private _scene;
  66858. private _isLoading;
  66859. protected _tasks: AbstractAssetTask[];
  66860. protected _waitingTasksCount: number;
  66861. protected _totalTasksCount: number;
  66862. /**
  66863. * Callback called when all tasks are processed
  66864. */
  66865. onFinish: (tasks: AbstractAssetTask[]) => void;
  66866. /**
  66867. * Callback called when a task is successful
  66868. */
  66869. onTaskSuccess: (task: AbstractAssetTask) => void;
  66870. /**
  66871. * Callback called when a task had an error
  66872. */
  66873. onTaskError: (task: AbstractAssetTask) => void;
  66874. /**
  66875. * Callback called when a task is done (whatever the result is)
  66876. */
  66877. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  66878. /**
  66879. * Observable called when all tasks are processed
  66880. */
  66881. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  66882. /**
  66883. * Observable called when a task had an error
  66884. */
  66885. onTaskErrorObservable: Observable<AbstractAssetTask>;
  66886. /**
  66887. * Observable called when all tasks were executed
  66888. */
  66889. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  66890. /**
  66891. * Observable called when a task is done (whatever the result is)
  66892. */
  66893. onProgressObservable: Observable<IAssetsProgressEvent>;
  66894. /**
  66895. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  66896. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  66897. */
  66898. useDefaultLoadingScreen: boolean;
  66899. /**
  66900. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  66901. * when all assets have been downloaded.
  66902. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  66903. */
  66904. autoHideLoadingUI: boolean;
  66905. /**
  66906. * Creates a new AssetsManager
  66907. * @param scene defines the scene to work on
  66908. */
  66909. constructor(scene: Scene);
  66910. /**
  66911. * Add a MeshAssetTask to the list of active tasks
  66912. * @param taskName defines the name of the new task
  66913. * @param meshesNames defines the name of meshes to load
  66914. * @param rootUrl defines the root url to use to locate files
  66915. * @param sceneFilename defines the filename of the scene file
  66916. * @returns a new MeshAssetTask object
  66917. */
  66918. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  66919. /**
  66920. * Add a TextFileAssetTask to the list of active tasks
  66921. * @param taskName defines the name of the new task
  66922. * @param url defines the url of the file to load
  66923. * @returns a new TextFileAssetTask object
  66924. */
  66925. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  66926. /**
  66927. * Add a BinaryFileAssetTask to the list of active tasks
  66928. * @param taskName defines the name of the new task
  66929. * @param url defines the url of the file to load
  66930. * @returns a new BinaryFileAssetTask object
  66931. */
  66932. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  66933. /**
  66934. * Add a ImageAssetTask to the list of active tasks
  66935. * @param taskName defines the name of the new task
  66936. * @param url defines the url of the file to load
  66937. * @returns a new ImageAssetTask object
  66938. */
  66939. addImageTask(taskName: string, url: string): ImageAssetTask;
  66940. /**
  66941. * Add a TextureAssetTask to the list of active tasks
  66942. * @param taskName defines the name of the new task
  66943. * @param url defines the url of the file to load
  66944. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66945. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  66946. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  66947. * @returns a new TextureAssetTask object
  66948. */
  66949. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  66950. /**
  66951. * Add a CubeTextureAssetTask to the list of active tasks
  66952. * @param taskName defines the name of the new task
  66953. * @param url defines the url of the file to load
  66954. * @param extensions defines the extension to use to load the cube map (can be null)
  66955. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66956. * @param files defines the list of files to load (can be null)
  66957. * @returns a new CubeTextureAssetTask object
  66958. */
  66959. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  66960. /**
  66961. *
  66962. * Add a HDRCubeTextureAssetTask to the list of active tasks
  66963. * @param taskName defines the name of the new task
  66964. * @param url defines the url of the file to load
  66965. * @param size defines the size you want for the cubemap (can be null)
  66966. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66967. * @param generateHarmonics defines if you want to automatically generate (true by default)
  66968. * @param gammaSpace specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  66969. * @param reserved Internal use only
  66970. * @returns a new HDRCubeTextureAssetTask object
  66971. */
  66972. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  66973. /**
  66974. *
  66975. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  66976. * @param taskName defines the name of the new task
  66977. * @param url defines the url of the file to load
  66978. * @param size defines the size you want for the cubemap (can be null)
  66979. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  66980. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  66981. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  66982. * @returns a new EquiRectangularCubeTextureAssetTask object
  66983. */
  66984. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  66985. /**
  66986. * Remove a task from the assets manager.
  66987. * @param task the task to remove
  66988. */
  66989. removeTask(task: AbstractAssetTask): void;
  66990. private _decreaseWaitingTasksCount;
  66991. private _runTask;
  66992. /**
  66993. * Reset the AssetsManager and remove all tasks
  66994. * @return the current instance of the AssetsManager
  66995. */
  66996. reset(): AssetsManager;
  66997. /**
  66998. * Start the loading process
  66999. * @return the current instance of the AssetsManager
  67000. */
  67001. load(): AssetsManager;
  67002. /**
  67003. * Start the loading process as an async operation
  67004. * @return a promise returning the list of failed tasks
  67005. */
  67006. loadAsync(): Promise<void>;
  67007. }
  67008. }
  67009. declare module "babylonjs/Misc/deferred" {
  67010. /**
  67011. * Wrapper class for promise with external resolve and reject.
  67012. */
  67013. export class Deferred<T> {
  67014. /**
  67015. * The promise associated with this deferred object.
  67016. */
  67017. readonly promise: Promise<T>;
  67018. private _resolve;
  67019. private _reject;
  67020. /**
  67021. * The resolve method of the promise associated with this deferred object.
  67022. */
  67023. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  67024. /**
  67025. * The reject method of the promise associated with this deferred object.
  67026. */
  67027. readonly reject: (reason?: any) => void;
  67028. /**
  67029. * Constructor for this deferred object.
  67030. */
  67031. constructor();
  67032. }
  67033. }
  67034. declare module "babylonjs/Misc/meshExploder" {
  67035. import { Mesh } from "babylonjs/Meshes/mesh";
  67036. /**
  67037. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  67038. */
  67039. export class MeshExploder {
  67040. private _centerMesh;
  67041. private _meshes;
  67042. private _meshesOrigins;
  67043. private _toCenterVectors;
  67044. private _scaledDirection;
  67045. private _newPosition;
  67046. private _centerPosition;
  67047. /**
  67048. * Explodes meshes from a center mesh.
  67049. * @param meshes The meshes to explode.
  67050. * @param centerMesh The mesh to be center of explosion.
  67051. */
  67052. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  67053. private _setCenterMesh;
  67054. /**
  67055. * Get class name
  67056. * @returns "MeshExploder"
  67057. */
  67058. getClassName(): string;
  67059. /**
  67060. * "Exploded meshes"
  67061. * @returns Array of meshes with the centerMesh at index 0.
  67062. */
  67063. getMeshes(): Array<Mesh>;
  67064. /**
  67065. * Explodes meshes giving a specific direction
  67066. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  67067. */
  67068. explode(direction?: number): void;
  67069. }
  67070. }
  67071. declare module "babylonjs/Misc/filesInput" {
  67072. import { Engine } from "babylonjs/Engines/engine";
  67073. import { Scene } from "babylonjs/scene";
  67074. import { SceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  67075. /**
  67076. * Class used to help managing file picking and drag'n'drop
  67077. */
  67078. export class FilesInput {
  67079. /**
  67080. * List of files ready to be loaded
  67081. */
  67082. static readonly FilesToLoad: {
  67083. [key: string]: File;
  67084. };
  67085. /**
  67086. * Callback called when a file is processed
  67087. */
  67088. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  67089. private _engine;
  67090. private _currentScene;
  67091. private _sceneLoadedCallback;
  67092. private _progressCallback;
  67093. private _additionalRenderLoopLogicCallback;
  67094. private _textureLoadingCallback;
  67095. private _startingProcessingFilesCallback;
  67096. private _onReloadCallback;
  67097. private _errorCallback;
  67098. private _elementToMonitor;
  67099. private _sceneFileToLoad;
  67100. private _filesToLoad;
  67101. /**
  67102. * Creates a new FilesInput
  67103. * @param engine defines the rendering engine
  67104. * @param scene defines the hosting scene
  67105. * @param sceneLoadedCallback callback called when scene is loaded
  67106. * @param progressCallback callback called to track progress
  67107. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  67108. * @param textureLoadingCallback callback called when a texture is loading
  67109. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  67110. * @param onReloadCallback callback called when a reload is requested
  67111. * @param errorCallback callback call if an error occurs
  67112. */
  67113. constructor(engine: Engine, scene: Scene, sceneLoadedCallback: (sceneFile: File, scene: Scene) => void, progressCallback: (progress: SceneLoaderProgressEvent) => void, additionalRenderLoopLogicCallback: () => void, textureLoadingCallback: (remaining: number) => void, startingProcessingFilesCallback: (files?: File[]) => void, onReloadCallback: (sceneFile: File) => void, errorCallback: (sceneFile: File, scene: Scene, message: string) => void);
  67114. private _dragEnterHandler;
  67115. private _dragOverHandler;
  67116. private _dropHandler;
  67117. /**
  67118. * Calls this function to listen to drag'n'drop events on a specific DOM element
  67119. * @param elementToMonitor defines the DOM element to track
  67120. */
  67121. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  67122. /**
  67123. * Release all associated resources
  67124. */
  67125. dispose(): void;
  67126. private renderFunction;
  67127. private drag;
  67128. private drop;
  67129. private _traverseFolder;
  67130. private _processFiles;
  67131. /**
  67132. * Load files from a drop event
  67133. * @param event defines the drop event to use as source
  67134. */
  67135. loadFiles(event: any): void;
  67136. private _processReload;
  67137. /**
  67138. * Reload the current scene from the loaded files
  67139. */
  67140. reload(): void;
  67141. }
  67142. }
  67143. declare module "babylonjs/Misc/HighDynamicRange/index" {
  67144. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  67145. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  67146. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  67147. }
  67148. declare module "babylonjs/Misc/sceneOptimizer" {
  67149. import { Scene, IDisposable } from "babylonjs/scene";
  67150. import { Observable } from "babylonjs/Misc/observable";
  67151. /**
  67152. * Defines the root class used to create scene optimization to use with SceneOptimizer
  67153. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67154. */
  67155. export class SceneOptimization {
  67156. /**
  67157. * Defines the priority of this optimization (0 by default which means first in the list)
  67158. */
  67159. priority: number;
  67160. /**
  67161. * Gets a string describing the action executed by the current optimization
  67162. * @returns description string
  67163. */
  67164. getDescription(): string;
  67165. /**
  67166. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67167. * @param scene defines the current scene where to apply this optimization
  67168. * @param optimizer defines the current optimizer
  67169. * @returns true if everything that can be done was applied
  67170. */
  67171. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67172. /**
  67173. * Creates the SceneOptimization object
  67174. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67175. * @param desc defines the description associated with the optimization
  67176. */
  67177. constructor(
  67178. /**
  67179. * Defines the priority of this optimization (0 by default which means first in the list)
  67180. */
  67181. priority?: number);
  67182. }
  67183. /**
  67184. * Defines an optimization used to reduce the size of render target textures
  67185. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67186. */
  67187. export class TextureOptimization extends SceneOptimization {
  67188. /**
  67189. * Defines the priority of this optimization (0 by default which means first in the list)
  67190. */
  67191. priority: number;
  67192. /**
  67193. * Defines the maximum sized allowed for textures (1024 is the default value). If a texture is bigger, it will be scaled down using a factor defined by the step parameter
  67194. */
  67195. maximumSize: number;
  67196. /**
  67197. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  67198. */
  67199. step: number;
  67200. /**
  67201. * Gets a string describing the action executed by the current optimization
  67202. * @returns description string
  67203. */
  67204. getDescription(): string;
  67205. /**
  67206. * Creates the TextureOptimization object
  67207. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67208. * @param maximumSize defines the maximum sized allowed for textures (1024 is the default value). If a texture is bigger, it will be scaled down using a factor defined by the step parameter
  67209. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  67210. */
  67211. constructor(
  67212. /**
  67213. * Defines the priority of this optimization (0 by default which means first in the list)
  67214. */
  67215. priority?: number,
  67216. /**
  67217. * Defines the maximum sized allowed for textures (1024 is the default value). If a texture is bigger, it will be scaled down using a factor defined by the step parameter
  67218. */
  67219. maximumSize?: number,
  67220. /**
  67221. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  67222. */
  67223. step?: number);
  67224. /**
  67225. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67226. * @param scene defines the current scene where to apply this optimization
  67227. * @param optimizer defines the current optimizer
  67228. * @returns true if everything that can be done was applied
  67229. */
  67230. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67231. }
  67232. /**
  67233. * Defines an optimization used to increase or decrease the rendering resolution
  67234. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67235. */
  67236. export class HardwareScalingOptimization extends SceneOptimization {
  67237. /**
  67238. * Defines the priority of this optimization (0 by default which means first in the list)
  67239. */
  67240. priority: number;
  67241. /**
  67242. * Defines the maximum scale to use (2 by default)
  67243. */
  67244. maximumScale: number;
  67245. /**
  67246. * Defines the step to use between two passes (0.5 by default)
  67247. */
  67248. step: number;
  67249. private _currentScale;
  67250. private _directionOffset;
  67251. /**
  67252. * Gets a string describing the action executed by the current optimization
  67253. * @return description string
  67254. */
  67255. getDescription(): string;
  67256. /**
  67257. * Creates the HardwareScalingOptimization object
  67258. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67259. * @param maximumScale defines the maximum scale to use (2 by default)
  67260. * @param step defines the step to use between two passes (0.5 by default)
  67261. */
  67262. constructor(
  67263. /**
  67264. * Defines the priority of this optimization (0 by default which means first in the list)
  67265. */
  67266. priority?: number,
  67267. /**
  67268. * Defines the maximum scale to use (2 by default)
  67269. */
  67270. maximumScale?: number,
  67271. /**
  67272. * Defines the step to use between two passes (0.5 by default)
  67273. */
  67274. step?: number);
  67275. /**
  67276. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67277. * @param scene defines the current scene where to apply this optimization
  67278. * @param optimizer defines the current optimizer
  67279. * @returns true if everything that can be done was applied
  67280. */
  67281. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67282. }
  67283. /**
  67284. * Defines an optimization used to remove shadows
  67285. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67286. */
  67287. export class ShadowsOptimization extends SceneOptimization {
  67288. /**
  67289. * Gets a string describing the action executed by the current optimization
  67290. * @return description string
  67291. */
  67292. getDescription(): string;
  67293. /**
  67294. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67295. * @param scene defines the current scene where to apply this optimization
  67296. * @param optimizer defines the current optimizer
  67297. * @returns true if everything that can be done was applied
  67298. */
  67299. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67300. }
  67301. /**
  67302. * Defines an optimization used to turn post-processes off
  67303. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67304. */
  67305. export class PostProcessesOptimization extends SceneOptimization {
  67306. /**
  67307. * Gets a string describing the action executed by the current optimization
  67308. * @return description string
  67309. */
  67310. getDescription(): string;
  67311. /**
  67312. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67313. * @param scene defines the current scene where to apply this optimization
  67314. * @param optimizer defines the current optimizer
  67315. * @returns true if everything that can be done was applied
  67316. */
  67317. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67318. }
  67319. /**
  67320. * Defines an optimization used to turn lens flares off
  67321. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67322. */
  67323. export class LensFlaresOptimization extends SceneOptimization {
  67324. /**
  67325. * Gets a string describing the action executed by the current optimization
  67326. * @return description string
  67327. */
  67328. getDescription(): string;
  67329. /**
  67330. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67331. * @param scene defines the current scene where to apply this optimization
  67332. * @param optimizer defines the current optimizer
  67333. * @returns true if everything that can be done was applied
  67334. */
  67335. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67336. }
  67337. /**
  67338. * Defines an optimization based on user defined callback.
  67339. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67340. */
  67341. export class CustomOptimization extends SceneOptimization {
  67342. /**
  67343. * Callback called to apply the custom optimization.
  67344. */
  67345. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  67346. /**
  67347. * Callback called to get custom description
  67348. */
  67349. onGetDescription: () => string;
  67350. /**
  67351. * Gets a string describing the action executed by the current optimization
  67352. * @returns description string
  67353. */
  67354. getDescription(): string;
  67355. /**
  67356. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67357. * @param scene defines the current scene where to apply this optimization
  67358. * @param optimizer defines the current optimizer
  67359. * @returns true if everything that can be done was applied
  67360. */
  67361. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67362. }
  67363. /**
  67364. * Defines an optimization used to turn particles off
  67365. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67366. */
  67367. export class ParticlesOptimization extends SceneOptimization {
  67368. /**
  67369. * Gets a string describing the action executed by the current optimization
  67370. * @return description string
  67371. */
  67372. getDescription(): string;
  67373. /**
  67374. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67375. * @param scene defines the current scene where to apply this optimization
  67376. * @param optimizer defines the current optimizer
  67377. * @returns true if everything that can be done was applied
  67378. */
  67379. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67380. }
  67381. /**
  67382. * Defines an optimization used to turn render targets off
  67383. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67384. */
  67385. export class RenderTargetsOptimization extends SceneOptimization {
  67386. /**
  67387. * Gets a string describing the action executed by the current optimization
  67388. * @return description string
  67389. */
  67390. getDescription(): string;
  67391. /**
  67392. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67393. * @param scene defines the current scene where to apply this optimization
  67394. * @param optimizer defines the current optimizer
  67395. * @returns true if everything that can be done was applied
  67396. */
  67397. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67398. }
  67399. /**
  67400. * Defines an optimization used to merge meshes with compatible materials
  67401. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67402. */
  67403. export class MergeMeshesOptimization extends SceneOptimization {
  67404. private static _UpdateSelectionTree;
  67405. /**
  67406. * Gets or sets a boolean which defines if optimization octree has to be updated
  67407. */
  67408. /**
  67409. * Gets or sets a boolean which defines if optimization octree has to be updated
  67410. */
  67411. static UpdateSelectionTree: boolean;
  67412. /**
  67413. * Gets a string describing the action executed by the current optimization
  67414. * @return description string
  67415. */
  67416. getDescription(): string;
  67417. private _canBeMerged;
  67418. /**
  67419. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67420. * @param scene defines the current scene where to apply this optimization
  67421. * @param optimizer defines the current optimizer
  67422. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  67423. * @returns true if everything that can be done was applied
  67424. */
  67425. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  67426. }
  67427. /**
  67428. * Defines a list of options used by SceneOptimizer
  67429. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67430. */
  67431. export class SceneOptimizerOptions {
  67432. /**
  67433. * Defines the target frame rate to reach (60 by default)
  67434. */
  67435. targetFrameRate: number;
  67436. /**
  67437. * Defines the interval between two checkes (2000ms by default)
  67438. */
  67439. trackerDuration: number;
  67440. /**
  67441. * Gets the list of optimizations to apply
  67442. */
  67443. optimizations: SceneOptimization[];
  67444. /**
  67445. * Creates a new list of options used by SceneOptimizer
  67446. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  67447. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  67448. */
  67449. constructor(
  67450. /**
  67451. * Defines the target frame rate to reach (60 by default)
  67452. */
  67453. targetFrameRate?: number,
  67454. /**
  67455. * Defines the interval between two checkes (2000ms by default)
  67456. */
  67457. trackerDuration?: number);
  67458. /**
  67459. * Add a new optimization
  67460. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  67461. * @returns the current SceneOptimizerOptions
  67462. */
  67463. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  67464. /**
  67465. * Add a new custom optimization
  67466. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  67467. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  67468. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67469. * @returns the current SceneOptimizerOptions
  67470. */
  67471. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  67472. /**
  67473. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  67474. * @param targetFrameRate defines the target frame rate (60 by default)
  67475. * @returns a SceneOptimizerOptions object
  67476. */
  67477. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67478. /**
  67479. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  67480. * @param targetFrameRate defines the target frame rate (60 by default)
  67481. * @returns a SceneOptimizerOptions object
  67482. */
  67483. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67484. /**
  67485. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  67486. * @param targetFrameRate defines the target frame rate (60 by default)
  67487. * @returns a SceneOptimizerOptions object
  67488. */
  67489. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67490. }
  67491. /**
  67492. * Class used to run optimizations in order to reach a target frame rate
  67493. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67494. */
  67495. export class SceneOptimizer implements IDisposable {
  67496. private _isRunning;
  67497. private _options;
  67498. private _scene;
  67499. private _currentPriorityLevel;
  67500. private _targetFrameRate;
  67501. private _trackerDuration;
  67502. private _currentFrameRate;
  67503. private _sceneDisposeObserver;
  67504. private _improvementMode;
  67505. /**
  67506. * Defines an observable called when the optimizer reaches the target frame rate
  67507. */
  67508. onSuccessObservable: Observable<SceneOptimizer>;
  67509. /**
  67510. * Defines an observable called when the optimizer enables an optimization
  67511. */
  67512. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  67513. /**
  67514. * Defines an observable called when the optimizer is not able to reach the target frame rate
  67515. */
  67516. onFailureObservable: Observable<SceneOptimizer>;
  67517. /**
  67518. * Gets a boolean indicating if the optimizer is in improvement mode
  67519. */
  67520. readonly isInImprovementMode: boolean;
  67521. /**
  67522. * Gets the current priority level (0 at start)
  67523. */
  67524. readonly currentPriorityLevel: number;
  67525. /**
  67526. * Gets the current frame rate checked by the SceneOptimizer
  67527. */
  67528. readonly currentFrameRate: number;
  67529. /**
  67530. * Gets or sets the current target frame rate (60 by default)
  67531. */
  67532. /**
  67533. * Gets or sets the current target frame rate (60 by default)
  67534. */
  67535. targetFrameRate: number;
  67536. /**
  67537. * Gets or sets the current interval between two checks (every 2000ms by default)
  67538. */
  67539. /**
  67540. * Gets or sets the current interval between two checks (every 2000ms by default)
  67541. */
  67542. trackerDuration: number;
  67543. /**
  67544. * Gets the list of active optimizations
  67545. */
  67546. readonly optimizations: SceneOptimization[];
  67547. /**
  67548. * Creates a new SceneOptimizer
  67549. * @param scene defines the scene to work on
  67550. * @param options defines the options to use with the SceneOptimizer
  67551. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  67552. * @param improvementMode defines if the scene optimizer must run the maximum optimization while staying over a target frame instead of trying to reach the target framerate (false by default)
  67553. */
  67554. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  67555. /**
  67556. * Stops the current optimizer
  67557. */
  67558. stop(): void;
  67559. /**
  67560. * Reset the optimizer to initial step (current priority level = 0)
  67561. */
  67562. reset(): void;
  67563. /**
  67564. * Start the optimizer. By default it will try to reach a specific framerate
  67565. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  67566. */
  67567. start(): void;
  67568. private _checkCurrentState;
  67569. /**
  67570. * Release all resources
  67571. */
  67572. dispose(): void;
  67573. /**
  67574. * Helper function to create a SceneOptimizer with one single line of code
  67575. * @param scene defines the scene to work on
  67576. * @param options defines the options to use with the SceneOptimizer
  67577. * @param onSuccess defines a callback to call on success
  67578. * @param onFailure defines a callback to call on failure
  67579. * @returns the new SceneOptimizer object
  67580. */
  67581. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  67582. }
  67583. }
  67584. declare module "babylonjs/Misc/sceneSerializer" {
  67585. import { Scene } from "babylonjs/scene";
  67586. /**
  67587. * Class used to serialize a scene into a string
  67588. */
  67589. export class SceneSerializer {
  67590. /**
  67591. * Clear cache used by a previous serialization
  67592. */
  67593. static ClearCache(): void;
  67594. /**
  67595. * Serialize a scene into a JSON compatible object
  67596. * @param scene defines the scene to serialize
  67597. * @returns a JSON compatible object
  67598. */
  67599. static Serialize(scene: Scene): any;
  67600. /**
  67601. * Serialize a mesh into a JSON compatible object
  67602. * @param toSerialize defines the mesh to serialize
  67603. * @param withParents defines if parents must be serialized as well
  67604. * @param withChildren defines if children must be serialized as well
  67605. * @returns a JSON compatible object
  67606. */
  67607. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  67608. }
  67609. }
  67610. declare module "babylonjs/Misc/textureTools" {
  67611. import { Texture } from "babylonjs/Materials/Textures/texture";
  67612. /**
  67613. * Class used to host texture specific utilities
  67614. */
  67615. export class TextureTools {
  67616. /**
  67617. * Uses the GPU to create a copy texture rescaled at a given size
  67618. * @param texture Texture to copy from
  67619. * @param width defines the desired width
  67620. * @param height defines the desired height
  67621. * @param useBilinearMode defines if bilinear mode has to be used
  67622. * @return the generated texture
  67623. */
  67624. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  67625. }
  67626. }
  67627. declare module "babylonjs/Misc/videoRecorder" {
  67628. import { Nullable } from "babylonjs/types";
  67629. import { Engine } from "babylonjs/Engines/engine";
  67630. /**
  67631. * This represents the different options available for the video capture.
  67632. */
  67633. export interface VideoRecorderOptions {
  67634. /** Defines the mime type of the video. */
  67635. mimeType: string;
  67636. /** Defines the FPS the video should be recorded at. */
  67637. fps: number;
  67638. /** Defines the chunk size for the recording data. */
  67639. recordChunckSize: number;
  67640. /** The audio tracks to attach to the recording. */
  67641. audioTracks?: MediaStreamTrack[];
  67642. }
  67643. /**
  67644. * This can help with recording videos from BabylonJS.
  67645. * This is based on the available WebRTC functionalities of the browser.
  67646. *
  67647. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  67648. */
  67649. export class VideoRecorder {
  67650. private static readonly _defaultOptions;
  67651. /**
  67652. * Returns whether or not the VideoRecorder is available in your browser.
  67653. * @param engine Defines the Babylon Engine.
  67654. * @returns true if supported otherwise false.
  67655. */
  67656. static IsSupported(engine: Engine): boolean;
  67657. private readonly _options;
  67658. private _canvas;
  67659. private _mediaRecorder;
  67660. private _recordedChunks;
  67661. private _fileName;
  67662. private _resolve;
  67663. private _reject;
  67664. /**
  67665. * True when a recording is already in progress.
  67666. */
  67667. readonly isRecording: boolean;
  67668. /**
  67669. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  67670. * @param engine Defines the BabylonJS Engine you wish to record.
  67671. * @param options Defines options that can be used to customize the capture.
  67672. */
  67673. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  67674. /**
  67675. * Stops the current recording before the default capture timeout passed in the startRecording function.
  67676. */
  67677. stopRecording(): void;
  67678. /**
  67679. * Starts recording the canvas for a max duration specified in parameters.
  67680. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  67681. * If null no automatic download will start and you can rely on the promise to get the data back.
  67682. * @param maxDuration Defines the maximum recording time in seconds.
  67683. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  67684. * @return A promise callback at the end of the recording with the video data in Blob.
  67685. */
  67686. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  67687. /**
  67688. * Releases internal resources used during the recording.
  67689. */
  67690. dispose(): void;
  67691. private _handleDataAvailable;
  67692. private _handleError;
  67693. private _handleStop;
  67694. }
  67695. }
  67696. declare module "babylonjs/Misc/screenshotTools" {
  67697. import { Camera } from "babylonjs/Cameras/camera";
  67698. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  67699. import { Engine } from "babylonjs/Engines/engine";
  67700. /**
  67701. * Class containing a set of static utilities functions for screenshots
  67702. */
  67703. export class ScreenshotTools {
  67704. /**
  67705. * Captures a screenshot of the current rendering
  67706. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67707. * @param engine defines the rendering engine
  67708. * @param camera defines the source camera
  67709. * @param size This parameter can be set to a single number or to an object with the
  67710. * following (optional) properties: precision, width, height. If a single number is passed,
  67711. * it will be used for both width and height. If an object is passed, the screenshot size
  67712. * will be derived from the parameters. The precision property is a multiplier allowing
  67713. * rendering at a higher or lower resolution
  67714. * @param successCallback defines the callback receives a single parameter which contains the
  67715. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  67716. * src parameter of an <img> to display it
  67717. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  67718. * Check your browser for supported MIME types
  67719. */
  67720. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  67721. /**
  67722. * Captures a screenshot of the current rendering
  67723. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67724. * @param engine defines the rendering engine
  67725. * @param camera defines the source camera
  67726. * @param size This parameter can be set to a single number or to an object with the
  67727. * following (optional) properties: precision, width, height. If a single number is passed,
  67728. * it will be used for both width and height. If an object is passed, the screenshot size
  67729. * will be derived from the parameters. The precision property is a multiplier allowing
  67730. * rendering at a higher or lower resolution
  67731. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  67732. * Check your browser for supported MIME types
  67733. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  67734. * to the src parameter of an <img> to display it
  67735. */
  67736. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  67737. /**
  67738. * Generates an image screenshot from the specified camera.
  67739. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67740. * @param engine The engine to use for rendering
  67741. * @param camera The camera to use for rendering
  67742. * @param size This parameter can be set to a single number or to an object with the
  67743. * following (optional) properties: precision, width, height. If a single number is passed,
  67744. * it will be used for both width and height. If an object is passed, the screenshot size
  67745. * will be derived from the parameters. The precision property is a multiplier allowing
  67746. * rendering at a higher or lower resolution
  67747. * @param successCallback The callback receives a single parameter which contains the
  67748. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  67749. * src parameter of an <img> to display it
  67750. * @param mimeType The MIME type of the screenshot image (default: image/png).
  67751. * Check your browser for supported MIME types
  67752. * @param samples Texture samples (default: 1)
  67753. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  67754. * @param fileName A name for for the downloaded file.
  67755. */
  67756. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  67757. /**
  67758. * Generates an image screenshot from the specified camera.
  67759. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67760. * @param engine The engine to use for rendering
  67761. * @param camera The camera to use for rendering
  67762. * @param size This parameter can be set to a single number or to an object with the
  67763. * following (optional) properties: precision, width, height. If a single number is passed,
  67764. * it will be used for both width and height. If an object is passed, the screenshot size
  67765. * will be derived from the parameters. The precision property is a multiplier allowing
  67766. * rendering at a higher or lower resolution
  67767. * @param mimeType The MIME type of the screenshot image (default: image/png).
  67768. * Check your browser for supported MIME types
  67769. * @param samples Texture samples (default: 1)
  67770. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  67771. * @param fileName A name for for the downloaded file.
  67772. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  67773. * to the src parameter of an <img> to display it
  67774. */
  67775. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  67776. /**
  67777. * Gets height and width for screenshot size
  67778. * @private
  67779. */
  67780. private static _getScreenshotSize;
  67781. }
  67782. }
  67783. declare module "babylonjs/Misc/dataReader" {
  67784. /**
  67785. * Interface for a data buffer
  67786. */
  67787. export interface IDataBuffer {
  67788. /**
  67789. * Reads bytes from the data buffer.
  67790. * @param byteOffset The byte offset to read
  67791. * @param byteLength The byte length to read
  67792. * @returns A promise that resolves when the bytes are read
  67793. */
  67794. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  67795. /**
  67796. * The byte length of the buffer.
  67797. */
  67798. readonly byteLength: number;
  67799. }
  67800. /**
  67801. * Utility class for reading from a data buffer
  67802. */
  67803. export class DataReader {
  67804. /**
  67805. * The data buffer associated with this data reader.
  67806. */
  67807. readonly buffer: IDataBuffer;
  67808. /**
  67809. * The current byte offset from the beginning of the data buffer.
  67810. */
  67811. byteOffset: number;
  67812. private _dataView;
  67813. private _dataByteOffset;
  67814. /**
  67815. * Constructor
  67816. * @param buffer The buffer to read
  67817. */
  67818. constructor(buffer: IDataBuffer);
  67819. /**
  67820. * Loads the given byte length.
  67821. * @param byteLength The byte length to load
  67822. * @returns A promise that resolves when the load is complete
  67823. */
  67824. loadAsync(byteLength: number): Promise<void>;
  67825. /**
  67826. * Read a unsigned 32-bit integer from the currently loaded data range.
  67827. * @returns The 32-bit integer read
  67828. */
  67829. readUint32(): number;
  67830. /**
  67831. * Read a byte array from the currently loaded data range.
  67832. * @param byteLength The byte length to read
  67833. * @returns The byte array read
  67834. */
  67835. readUint8Array(byteLength: number): Uint8Array;
  67836. /**
  67837. * Read a string from the currently loaded data range.
  67838. * @param byteLength The byte length to read
  67839. * @returns The string read
  67840. */
  67841. readString(byteLength: number): string;
  67842. /**
  67843. * Skips the given byte length the currently loaded data range.
  67844. * @param byteLength The byte length to skip
  67845. */
  67846. skipBytes(byteLength: number): void;
  67847. }
  67848. }
  67849. declare module "babylonjs/Misc/index" {
  67850. export * from "babylonjs/Misc/andOrNotEvaluator";
  67851. export * from "babylonjs/Misc/assetsManager";
  67852. export * from "babylonjs/Misc/dds";
  67853. export * from "babylonjs/Misc/decorators";
  67854. export * from "babylonjs/Misc/deferred";
  67855. export * from "babylonjs/Misc/environmentTextureTools";
  67856. export * from "babylonjs/Misc/meshExploder";
  67857. export * from "babylonjs/Misc/filesInput";
  67858. export * from "babylonjs/Misc/HighDynamicRange/index";
  67859. export * from "babylonjs/Misc/khronosTextureContainer";
  67860. export * from "babylonjs/Misc/observable";
  67861. export * from "babylonjs/Misc/performanceMonitor";
  67862. export * from "babylonjs/Misc/promise";
  67863. export * from "babylonjs/Misc/sceneOptimizer";
  67864. export * from "babylonjs/Misc/sceneSerializer";
  67865. export * from "babylonjs/Misc/smartArray";
  67866. export * from "babylonjs/Misc/stringDictionary";
  67867. export * from "babylonjs/Misc/tags";
  67868. export * from "babylonjs/Misc/textureTools";
  67869. export * from "babylonjs/Misc/tga";
  67870. export * from "babylonjs/Misc/tools";
  67871. export * from "babylonjs/Misc/videoRecorder";
  67872. export * from "babylonjs/Misc/virtualJoystick";
  67873. export * from "babylonjs/Misc/workerPool";
  67874. export * from "babylonjs/Misc/logger";
  67875. export * from "babylonjs/Misc/typeStore";
  67876. export * from "babylonjs/Misc/filesInputStore";
  67877. export * from "babylonjs/Misc/deepCopier";
  67878. export * from "babylonjs/Misc/pivotTools";
  67879. export * from "babylonjs/Misc/precisionDate";
  67880. export * from "babylonjs/Misc/screenshotTools";
  67881. export * from "babylonjs/Misc/typeStore";
  67882. export * from "babylonjs/Misc/webRequest";
  67883. export * from "babylonjs/Misc/iInspectable";
  67884. export * from "babylonjs/Misc/brdfTextureTools";
  67885. export * from "babylonjs/Misc/rgbdTextureTools";
  67886. export * from "babylonjs/Misc/gradients";
  67887. export * from "babylonjs/Misc/perfCounter";
  67888. export * from "babylonjs/Misc/fileRequest";
  67889. export * from "babylonjs/Misc/customAnimationFrameRequester";
  67890. export * from "babylonjs/Misc/retryStrategy";
  67891. export * from "babylonjs/Misc/interfaces/screenshotSize";
  67892. export * from "babylonjs/Misc/canvasGenerator";
  67893. export * from "babylonjs/Misc/fileTools";
  67894. export * from "babylonjs/Misc/stringTools";
  67895. export * from "babylonjs/Misc/dataReader";
  67896. }
  67897. declare module "babylonjs/index" {
  67898. export * from "babylonjs/abstractScene";
  67899. export * from "babylonjs/Actions/index";
  67900. export * from "babylonjs/Animations/index";
  67901. export * from "babylonjs/assetContainer";
  67902. export * from "babylonjs/Audio/index";
  67903. export * from "babylonjs/Behaviors/index";
  67904. export * from "babylonjs/Bones/index";
  67905. export * from "babylonjs/Cameras/index";
  67906. export * from "babylonjs/Collisions/index";
  67907. export * from "babylonjs/Culling/index";
  67908. export * from "babylonjs/Debug/index";
  67909. export * from "babylonjs/Engines/index";
  67910. export * from "babylonjs/Events/index";
  67911. export * from "babylonjs/Gamepads/index";
  67912. export * from "babylonjs/Gizmos/index";
  67913. export * from "babylonjs/Helpers/index";
  67914. export * from "babylonjs/Instrumentation/index";
  67915. export * from "babylonjs/Layers/index";
  67916. export * from "babylonjs/LensFlares/index";
  67917. export * from "babylonjs/Lights/index";
  67918. export * from "babylonjs/Loading/index";
  67919. export * from "babylonjs/Materials/index";
  67920. export * from "babylonjs/Maths/index";
  67921. export * from "babylonjs/Meshes/index";
  67922. export * from "babylonjs/Morph/index";
  67923. export * from "babylonjs/Navigation/index";
  67924. export * from "babylonjs/node";
  67925. export * from "babylonjs/Offline/index";
  67926. export * from "babylonjs/Particles/index";
  67927. export * from "babylonjs/Physics/index";
  67928. export * from "babylonjs/PostProcesses/index";
  67929. export * from "babylonjs/Probes/index";
  67930. export * from "babylonjs/Rendering/index";
  67931. export * from "babylonjs/scene";
  67932. export * from "babylonjs/sceneComponent";
  67933. export * from "babylonjs/Sprites/index";
  67934. export * from "babylonjs/States/index";
  67935. export * from "babylonjs/Misc/index";
  67936. export * from "babylonjs/types";
  67937. }
  67938. declare module "babylonjs/Animations/pathCursor" {
  67939. import { Vector3 } from "babylonjs/Maths/math.vector";
  67940. import { Path2 } from "babylonjs/Maths/math.path";
  67941. /**
  67942. * A cursor which tracks a point on a path
  67943. */
  67944. export class PathCursor {
  67945. private path;
  67946. /**
  67947. * Stores path cursor callbacks for when an onchange event is triggered
  67948. */
  67949. private _onchange;
  67950. /**
  67951. * The value of the path cursor
  67952. */
  67953. value: number;
  67954. /**
  67955. * The animation array of the path cursor
  67956. */
  67957. animations: Animation[];
  67958. /**
  67959. * Initializes the path cursor
  67960. * @param path The path to track
  67961. */
  67962. constructor(path: Path2);
  67963. /**
  67964. * Gets the cursor point on the path
  67965. * @returns A point on the path cursor at the cursor location
  67966. */
  67967. getPoint(): Vector3;
  67968. /**
  67969. * Moves the cursor ahead by the step amount
  67970. * @param step The amount to move the cursor forward
  67971. * @returns This path cursor
  67972. */
  67973. moveAhead(step?: number): PathCursor;
  67974. /**
  67975. * Moves the cursor behind by the step amount
  67976. * @param step The amount to move the cursor back
  67977. * @returns This path cursor
  67978. */
  67979. moveBack(step?: number): PathCursor;
  67980. /**
  67981. * Moves the cursor by the step amount
  67982. * If the step amount is greater than one, an exception is thrown
  67983. * @param step The amount to move the cursor
  67984. * @returns This path cursor
  67985. */
  67986. move(step: number): PathCursor;
  67987. /**
  67988. * Ensures that the value is limited between zero and one
  67989. * @returns This path cursor
  67990. */
  67991. private ensureLimits;
  67992. /**
  67993. * Runs onchange callbacks on change (used by the animation engine)
  67994. * @returns This path cursor
  67995. */
  67996. private raiseOnChange;
  67997. /**
  67998. * Executes a function on change
  67999. * @param f A path cursor onchange callback
  68000. * @returns This path cursor
  68001. */
  68002. onchange(f: (cursor: PathCursor) => void): PathCursor;
  68003. }
  68004. }
  68005. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  68006. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  68007. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  68008. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  68009. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  68010. }
  68011. declare module "babylonjs/Engines/Processors/Expressions/index" {
  68012. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  68013. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  68014. }
  68015. declare module "babylonjs/Engines/Processors/index" {
  68016. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  68017. export * from "babylonjs/Engines/Processors/Expressions/index";
  68018. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  68019. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  68020. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  68021. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  68022. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  68023. export * from "babylonjs/Engines/Processors/shaderProcessor";
  68024. }
  68025. declare module "babylonjs/Legacy/legacy" {
  68026. import * as Babylon from "babylonjs/index";
  68027. export * from "babylonjs/index";
  68028. }
  68029. declare module "babylonjs/Shaders/blur.fragment" {
  68030. /** @hidden */
  68031. export var blurPixelShader: {
  68032. name: string;
  68033. shader: string;
  68034. };
  68035. }
  68036. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  68037. /** @hidden */
  68038. export var pointCloudVertexDeclaration: {
  68039. name: string;
  68040. shader: string;
  68041. };
  68042. }
  68043. declare module "babylonjs" {
  68044. export * from "babylonjs/Legacy/legacy";
  68045. }
  68046. declare module BABYLON {
  68047. /** Alias type for value that can be null */
  68048. export type Nullable<T> = T | null;
  68049. /**
  68050. * Alias type for number that are floats
  68051. * @ignorenaming
  68052. */
  68053. export type float = number;
  68054. /**
  68055. * Alias type for number that are doubles.
  68056. * @ignorenaming
  68057. */
  68058. export type double = number;
  68059. /**
  68060. * Alias type for number that are integer
  68061. * @ignorenaming
  68062. */
  68063. export type int = number;
  68064. /** Alias type for number array or Float32Array */
  68065. export type FloatArray = number[] | Float32Array;
  68066. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  68067. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  68068. /**
  68069. * Alias for types that can be used by a Buffer or VertexBuffer.
  68070. */
  68071. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  68072. /**
  68073. * Alias type for primitive types
  68074. * @ignorenaming
  68075. */
  68076. type Primitive = undefined | null | boolean | string | number | Function;
  68077. /**
  68078. * Type modifier to make all the properties of an object Readonly
  68079. */
  68080. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  68081. /**
  68082. * Type modifier to make all the properties of an object Readonly recursively
  68083. */
  68084. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  68085. /**
  68086. * Type modifier to make object properties readonly.
  68087. */
  68088. export type DeepImmutableObject<T> = {
  68089. readonly [K in keyof T]: DeepImmutable<T[K]>;
  68090. };
  68091. /** @hidden */
  68092. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  68093. }
  68094. }
  68095. declare module BABYLON {
  68096. /**
  68097. * A class serves as a medium between the observable and its observers
  68098. */
  68099. export class EventState {
  68100. /**
  68101. * Create a new EventState
  68102. * @param mask defines the mask associated with this state
  68103. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68104. * @param target defines the original target of the state
  68105. * @param currentTarget defines the current target of the state
  68106. */
  68107. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  68108. /**
  68109. * Initialize the current event state
  68110. * @param mask defines the mask associated with this state
  68111. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68112. * @param target defines the original target of the state
  68113. * @param currentTarget defines the current target of the state
  68114. * @returns the current event state
  68115. */
  68116. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  68117. /**
  68118. * An Observer can set this property to true to prevent subsequent observers of being notified
  68119. */
  68120. skipNextObservers: boolean;
  68121. /**
  68122. * Get the mask value that were used to trigger the event corresponding to this EventState object
  68123. */
  68124. mask: number;
  68125. /**
  68126. * The object that originally notified the event
  68127. */
  68128. target?: any;
  68129. /**
  68130. * The current object in the bubbling phase
  68131. */
  68132. currentTarget?: any;
  68133. /**
  68134. * This will be populated with the return value of the last function that was executed.
  68135. * If it is the first function in the callback chain it will be the event data.
  68136. */
  68137. lastReturnValue?: any;
  68138. }
  68139. /**
  68140. * Represent an Observer registered to a given Observable object.
  68141. */
  68142. export class Observer<T> {
  68143. /**
  68144. * Defines the callback to call when the observer is notified
  68145. */
  68146. callback: (eventData: T, eventState: EventState) => void;
  68147. /**
  68148. * Defines the mask of the observer (used to filter notifications)
  68149. */
  68150. mask: number;
  68151. /**
  68152. * Defines the current scope used to restore the JS context
  68153. */
  68154. scope: any;
  68155. /** @hidden */
  68156. _willBeUnregistered: boolean;
  68157. /**
  68158. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  68159. */
  68160. unregisterOnNextCall: boolean;
  68161. /**
  68162. * Creates a new observer
  68163. * @param callback defines the callback to call when the observer is notified
  68164. * @param mask defines the mask of the observer (used to filter notifications)
  68165. * @param scope defines the current scope used to restore the JS context
  68166. */
  68167. constructor(
  68168. /**
  68169. * Defines the callback to call when the observer is notified
  68170. */
  68171. callback: (eventData: T, eventState: EventState) => void,
  68172. /**
  68173. * Defines the mask of the observer (used to filter notifications)
  68174. */
  68175. mask: number,
  68176. /**
  68177. * Defines the current scope used to restore the JS context
  68178. */
  68179. scope?: any);
  68180. }
  68181. /**
  68182. * Represent a list of observers registered to multiple Observables object.
  68183. */
  68184. export class MultiObserver<T> {
  68185. private _observers;
  68186. private _observables;
  68187. /**
  68188. * Release associated resources
  68189. */
  68190. dispose(): void;
  68191. /**
  68192. * Raise a callback when one of the observable will notify
  68193. * @param observables defines a list of observables to watch
  68194. * @param callback defines the callback to call on notification
  68195. * @param mask defines the mask used to filter notifications
  68196. * @param scope defines the current scope used to restore the JS context
  68197. * @returns the new MultiObserver
  68198. */
  68199. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  68200. }
  68201. /**
  68202. * The Observable class is a simple implementation of the Observable pattern.
  68203. *
  68204. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  68205. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  68206. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  68207. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  68208. */
  68209. export class Observable<T> {
  68210. private _observers;
  68211. private _eventState;
  68212. private _onObserverAdded;
  68213. /**
  68214. * Gets the list of observers
  68215. */
  68216. readonly observers: Array<Observer<T>>;
  68217. /**
  68218. * Creates a new observable
  68219. * @param onObserverAdded defines a callback to call when a new observer is added
  68220. */
  68221. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  68222. /**
  68223. * Create a new Observer with the specified callback
  68224. * @param callback the callback that will be executed for that Observer
  68225. * @param mask the mask used to filter observers
  68226. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  68227. * @param scope optional scope for the callback to be called from
  68228. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  68229. * @returns the new observer created for the callback
  68230. */
  68231. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  68232. /**
  68233. * Create a new Observer with the specified callback and unregisters after the next notification
  68234. * @param callback the callback that will be executed for that Observer
  68235. * @returns the new observer created for the callback
  68236. */
  68237. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  68238. /**
  68239. * Remove an Observer from the Observable object
  68240. * @param observer the instance of the Observer to remove
  68241. * @returns false if it doesn't belong to this Observable
  68242. */
  68243. remove(observer: Nullable<Observer<T>>): boolean;
  68244. /**
  68245. * Remove a callback from the Observable object
  68246. * @param callback the callback to remove
  68247. * @param scope optional scope. If used only the callbacks with this scope will be removed
  68248. * @returns false if it doesn't belong to this Observable
  68249. */
  68250. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  68251. private _deferUnregister;
  68252. private _remove;
  68253. /**
  68254. * Moves the observable to the top of the observer list making it get called first when notified
  68255. * @param observer the observer to move
  68256. */
  68257. makeObserverTopPriority(observer: Observer<T>): void;
  68258. /**
  68259. * Moves the observable to the bottom of the observer list making it get called last when notified
  68260. * @param observer the observer to move
  68261. */
  68262. makeObserverBottomPriority(observer: Observer<T>): void;
  68263. /**
  68264. * Notify all Observers by calling their respective callback with the given data
  68265. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  68266. * @param eventData defines the data to send to all observers
  68267. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  68268. * @param target defines the original target of the state
  68269. * @param currentTarget defines the current target of the state
  68270. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  68271. */
  68272. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  68273. /**
  68274. * Calling this will execute each callback, expecting it to be a promise or return a value.
  68275. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  68276. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  68277. * and it is crucial that all callbacks will be executed.
  68278. * The order of the callbacks is kept, callbacks are not executed parallel.
  68279. *
  68280. * @param eventData The data to be sent to each callback
  68281. * @param mask is used to filter observers defaults to -1
  68282. * @param target defines the callback target (see EventState)
  68283. * @param currentTarget defines he current object in the bubbling phase
  68284. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  68285. */
  68286. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  68287. /**
  68288. * Notify a specific observer
  68289. * @param observer defines the observer to notify
  68290. * @param eventData defines the data to be sent to each callback
  68291. * @param mask is used to filter observers defaults to -1
  68292. */
  68293. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  68294. /**
  68295. * Gets a boolean indicating if the observable has at least one observer
  68296. * @returns true is the Observable has at least one Observer registered
  68297. */
  68298. hasObservers(): boolean;
  68299. /**
  68300. * Clear the list of observers
  68301. */
  68302. clear(): void;
  68303. /**
  68304. * Clone the current observable
  68305. * @returns a new observable
  68306. */
  68307. clone(): Observable<T>;
  68308. /**
  68309. * Does this observable handles observer registered with a given mask
  68310. * @param mask defines the mask to be tested
  68311. * @return whether or not one observer registered with the given mask is handeled
  68312. **/
  68313. hasSpecificMask(mask?: number): boolean;
  68314. }
  68315. }
  68316. declare module BABYLON {
  68317. /**
  68318. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  68319. * Babylon.js
  68320. */
  68321. export class DomManagement {
  68322. /**
  68323. * Checks if the window object exists
  68324. * @returns true if the window object exists
  68325. */
  68326. static IsWindowObjectExist(): boolean;
  68327. /**
  68328. * Checks if the navigator object exists
  68329. * @returns true if the navigator object exists
  68330. */
  68331. static IsNavigatorAvailable(): boolean;
  68332. /**
  68333. * Extracts text content from a DOM element hierarchy
  68334. * @param element defines the root element
  68335. * @returns a string
  68336. */
  68337. static GetDOMTextContent(element: HTMLElement): string;
  68338. }
  68339. }
  68340. declare module BABYLON {
  68341. /**
  68342. * Logger used througouht the application to allow configuration of
  68343. * the log level required for the messages.
  68344. */
  68345. export class Logger {
  68346. /**
  68347. * No log
  68348. */
  68349. static readonly NoneLogLevel: number;
  68350. /**
  68351. * Only message logs
  68352. */
  68353. static readonly MessageLogLevel: number;
  68354. /**
  68355. * Only warning logs
  68356. */
  68357. static readonly WarningLogLevel: number;
  68358. /**
  68359. * Only error logs
  68360. */
  68361. static readonly ErrorLogLevel: number;
  68362. /**
  68363. * All logs
  68364. */
  68365. static readonly AllLogLevel: number;
  68366. private static _LogCache;
  68367. /**
  68368. * Gets a value indicating the number of loading errors
  68369. * @ignorenaming
  68370. */
  68371. static errorsCount: number;
  68372. /**
  68373. * Callback called when a new log is added
  68374. */
  68375. static OnNewCacheEntry: (entry: string) => void;
  68376. private static _AddLogEntry;
  68377. private static _FormatMessage;
  68378. private static _LogDisabled;
  68379. private static _LogEnabled;
  68380. private static _WarnDisabled;
  68381. private static _WarnEnabled;
  68382. private static _ErrorDisabled;
  68383. private static _ErrorEnabled;
  68384. /**
  68385. * Log a message to the console
  68386. */
  68387. static Log: (message: string) => void;
  68388. /**
  68389. * Write a warning message to the console
  68390. */
  68391. static Warn: (message: string) => void;
  68392. /**
  68393. * Write an error message to the console
  68394. */
  68395. static Error: (message: string) => void;
  68396. /**
  68397. * Gets current log cache (list of logs)
  68398. */
  68399. static readonly LogCache: string;
  68400. /**
  68401. * Clears the log cache
  68402. */
  68403. static ClearLogCache(): void;
  68404. /**
  68405. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  68406. */
  68407. static LogLevels: number;
  68408. }
  68409. }
  68410. declare module BABYLON {
  68411. /** @hidden */
  68412. export class _TypeStore {
  68413. /** @hidden */
  68414. static RegisteredTypes: {
  68415. [key: string]: Object;
  68416. };
  68417. /** @hidden */
  68418. static GetClass(fqdn: string): any;
  68419. }
  68420. }
  68421. declare module BABYLON {
  68422. /**
  68423. * Helper to manipulate strings
  68424. */
  68425. export class StringTools {
  68426. /**
  68427. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  68428. * @param str Source string
  68429. * @param suffix Suffix to search for in the source string
  68430. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68431. */
  68432. static EndsWith(str: string, suffix: string): boolean;
  68433. /**
  68434. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  68435. * @param str Source string
  68436. * @param suffix Suffix to search for in the source string
  68437. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68438. */
  68439. static StartsWith(str: string, suffix: string): boolean;
  68440. /**
  68441. * Decodes a buffer into a string
  68442. * @param buffer The buffer to decode
  68443. * @returns The decoded string
  68444. */
  68445. static Decode(buffer: Uint8Array | Uint16Array): string;
  68446. /**
  68447. * Encode a buffer to a base64 string
  68448. * @param buffer defines the buffer to encode
  68449. * @returns the encoded string
  68450. */
  68451. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  68452. }
  68453. }
  68454. declare module BABYLON {
  68455. /**
  68456. * Class containing a set of static utilities functions for deep copy.
  68457. */
  68458. export class DeepCopier {
  68459. /**
  68460. * Tries to copy an object by duplicating every property
  68461. * @param source defines the source object
  68462. * @param destination defines the target object
  68463. * @param doNotCopyList defines a list of properties to avoid
  68464. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  68465. */
  68466. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  68467. }
  68468. }
  68469. declare module BABYLON {
  68470. /**
  68471. * Class containing a set of static utilities functions for precision date
  68472. */
  68473. export class PrecisionDate {
  68474. /**
  68475. * Gets either window.performance.now() if supported or Date.now() else
  68476. */
  68477. static readonly Now: number;
  68478. }
  68479. }
  68480. declare module BABYLON {
  68481. /** @hidden */
  68482. export class _DevTools {
  68483. static WarnImport(name: string): string;
  68484. }
  68485. }
  68486. declare module BABYLON {
  68487. /**
  68488. * Interface used to define the mechanism to get data from the network
  68489. */
  68490. export interface IWebRequest {
  68491. /**
  68492. * Returns client's response url
  68493. */
  68494. responseURL: string;
  68495. /**
  68496. * Returns client's status
  68497. */
  68498. status: number;
  68499. /**
  68500. * Returns client's status as a text
  68501. */
  68502. statusText: string;
  68503. }
  68504. }
  68505. declare module BABYLON {
  68506. /**
  68507. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  68508. */
  68509. export class WebRequest implements IWebRequest {
  68510. private _xhr;
  68511. /**
  68512. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  68513. * i.e. when loading files, where the server/service expects an Authorization header
  68514. */
  68515. static CustomRequestHeaders: {
  68516. [key: string]: string;
  68517. };
  68518. /**
  68519. * Add callback functions in this array to update all the requests before they get sent to the network
  68520. */
  68521. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  68522. private _injectCustomRequestHeaders;
  68523. /**
  68524. * Gets or sets a function to be called when loading progress changes
  68525. */
  68526. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  68527. /**
  68528. * Returns client's state
  68529. */
  68530. readonly readyState: number;
  68531. /**
  68532. * Returns client's status
  68533. */
  68534. readonly status: number;
  68535. /**
  68536. * Returns client's status as a text
  68537. */
  68538. readonly statusText: string;
  68539. /**
  68540. * Returns client's response
  68541. */
  68542. readonly response: any;
  68543. /**
  68544. * Returns client's response url
  68545. */
  68546. readonly responseURL: string;
  68547. /**
  68548. * Returns client's response as text
  68549. */
  68550. readonly responseText: string;
  68551. /**
  68552. * Gets or sets the expected response type
  68553. */
  68554. responseType: XMLHttpRequestResponseType;
  68555. /** @hidden */
  68556. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  68557. /** @hidden */
  68558. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  68559. /**
  68560. * Cancels any network activity
  68561. */
  68562. abort(): void;
  68563. /**
  68564. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  68565. * @param body defines an optional request body
  68566. */
  68567. send(body?: Document | BodyInit | null): void;
  68568. /**
  68569. * Sets the request method, request URL
  68570. * @param method defines the method to use (GET, POST, etc..)
  68571. * @param url defines the url to connect with
  68572. */
  68573. open(method: string, url: string): void;
  68574. /**
  68575. * Sets the value of a request header.
  68576. * @param name The name of the header whose value is to be set
  68577. * @param value The value to set as the body of the header
  68578. */
  68579. setRequestHeader(name: string, value: string): void;
  68580. /**
  68581. * Get the string containing the text of a particular header's value.
  68582. * @param name The name of the header
  68583. * @returns The string containing the text of the given header name
  68584. */
  68585. getResponseHeader(name: string): Nullable<string>;
  68586. }
  68587. }
  68588. declare module BABYLON {
  68589. /**
  68590. * File request interface
  68591. */
  68592. export interface IFileRequest {
  68593. /**
  68594. * Raised when the request is complete (success or error).
  68595. */
  68596. onCompleteObservable: Observable<IFileRequest>;
  68597. /**
  68598. * Aborts the request for a file.
  68599. */
  68600. abort: () => void;
  68601. }
  68602. }
  68603. declare module BABYLON {
  68604. /**
  68605. * Define options used to create a render target texture
  68606. */
  68607. export class RenderTargetCreationOptions {
  68608. /**
  68609. * Specifies is mipmaps must be generated
  68610. */
  68611. generateMipMaps?: boolean;
  68612. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  68613. generateDepthBuffer?: boolean;
  68614. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  68615. generateStencilBuffer?: boolean;
  68616. /** Defines texture type (int by default) */
  68617. type?: number;
  68618. /** Defines sampling mode (trilinear by default) */
  68619. samplingMode?: number;
  68620. /** Defines format (RGBA by default) */
  68621. format?: number;
  68622. }
  68623. }
  68624. declare module BABYLON {
  68625. /**
  68626. * @hidden
  68627. **/
  68628. export class _TimeToken {
  68629. _startTimeQuery: Nullable<WebGLQuery>;
  68630. _endTimeQuery: Nullable<WebGLQuery>;
  68631. _timeElapsedQuery: Nullable<WebGLQuery>;
  68632. _timeElapsedQueryEnded: boolean;
  68633. }
  68634. }
  68635. declare module BABYLON {
  68636. /** Defines the cross module used constants to avoid circular dependncies */
  68637. export class Constants {
  68638. /** Defines that alpha blending is disabled */
  68639. static readonly ALPHA_DISABLE: number;
  68640. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  68641. static readonly ALPHA_ADD: number;
  68642. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  68643. static readonly ALPHA_COMBINE: number;
  68644. /** Defines that alpha blending to DEST - SRC * DEST */
  68645. static readonly ALPHA_SUBTRACT: number;
  68646. /** Defines that alpha blending to SRC * DEST */
  68647. static readonly ALPHA_MULTIPLY: number;
  68648. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  68649. static readonly ALPHA_MAXIMIZED: number;
  68650. /** Defines that alpha blending to SRC + DEST */
  68651. static readonly ALPHA_ONEONE: number;
  68652. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  68653. static readonly ALPHA_PREMULTIPLIED: number;
  68654. /**
  68655. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  68656. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  68657. */
  68658. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  68659. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  68660. static readonly ALPHA_INTERPOLATE: number;
  68661. /**
  68662. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  68663. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  68664. */
  68665. static readonly ALPHA_SCREENMODE: number;
  68666. /**
  68667. * Defines that alpha blending to SRC + DST
  68668. * Alpha will be set to SRC ALPHA + DST ALPHA
  68669. */
  68670. static readonly ALPHA_ONEONE_ONEONE: number;
  68671. /**
  68672. * Defines that alpha blending to SRC * DST ALPHA + DST
  68673. * Alpha will be set to 0
  68674. */
  68675. static readonly ALPHA_ALPHATOCOLOR: number;
  68676. /**
  68677. * Defines that alpha blending to SRC * (1 - DST) + DST * (1 - SRC)
  68678. */
  68679. static readonly ALPHA_REVERSEONEMINUS: number;
  68680. /**
  68681. * Defines that alpha blending to SRC + DST * (1 - SRC ALPHA)
  68682. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  68683. */
  68684. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  68685. /**
  68686. * Defines that alpha blending to SRC + DST
  68687. * Alpha will be set to SRC ALPHA
  68688. */
  68689. static readonly ALPHA_ONEONE_ONEZERO: number;
  68690. /** Defines that alpha blending equation a SUM */
  68691. static readonly ALPHA_EQUATION_ADD: number;
  68692. /** Defines that alpha blending equation a SUBSTRACTION */
  68693. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  68694. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  68695. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  68696. /** Defines that alpha blending equation a MAX operation */
  68697. static readonly ALPHA_EQUATION_MAX: number;
  68698. /** Defines that alpha blending equation a MIN operation */
  68699. static readonly ALPHA_EQUATION_MIN: number;
  68700. /**
  68701. * Defines that alpha blending equation a DARKEN operation:
  68702. * It takes the min of the src and sums the alpha channels.
  68703. */
  68704. static readonly ALPHA_EQUATION_DARKEN: number;
  68705. /** Defines that the ressource is not delayed*/
  68706. static readonly DELAYLOADSTATE_NONE: number;
  68707. /** Defines that the ressource was successfully delay loaded */
  68708. static readonly DELAYLOADSTATE_LOADED: number;
  68709. /** Defines that the ressource is currently delay loading */
  68710. static readonly DELAYLOADSTATE_LOADING: number;
  68711. /** Defines that the ressource is delayed and has not started loading */
  68712. static readonly DELAYLOADSTATE_NOTLOADED: number;
  68713. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  68714. static readonly NEVER: number;
  68715. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  68716. static readonly ALWAYS: number;
  68717. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  68718. static readonly LESS: number;
  68719. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  68720. static readonly EQUAL: number;
  68721. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  68722. static readonly LEQUAL: number;
  68723. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  68724. static readonly GREATER: number;
  68725. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  68726. static readonly GEQUAL: number;
  68727. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  68728. static readonly NOTEQUAL: number;
  68729. /** Passed to stencilOperation to specify that stencil value must be kept */
  68730. static readonly KEEP: number;
  68731. /** Passed to stencilOperation to specify that stencil value must be replaced */
  68732. static readonly REPLACE: number;
  68733. /** Passed to stencilOperation to specify that stencil value must be incremented */
  68734. static readonly INCR: number;
  68735. /** Passed to stencilOperation to specify that stencil value must be decremented */
  68736. static readonly DECR: number;
  68737. /** Passed to stencilOperation to specify that stencil value must be inverted */
  68738. static readonly INVERT: number;
  68739. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  68740. static readonly INCR_WRAP: number;
  68741. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  68742. static readonly DECR_WRAP: number;
  68743. /** Texture is not repeating outside of 0..1 UVs */
  68744. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  68745. /** Texture is repeating outside of 0..1 UVs */
  68746. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  68747. /** Texture is repeating and mirrored */
  68748. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  68749. /** ALPHA */
  68750. static readonly TEXTUREFORMAT_ALPHA: number;
  68751. /** LUMINANCE */
  68752. static readonly TEXTUREFORMAT_LUMINANCE: number;
  68753. /** LUMINANCE_ALPHA */
  68754. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  68755. /** RGB */
  68756. static readonly TEXTUREFORMAT_RGB: number;
  68757. /** RGBA */
  68758. static readonly TEXTUREFORMAT_RGBA: number;
  68759. /** RED */
  68760. static readonly TEXTUREFORMAT_RED: number;
  68761. /** RED (2nd reference) */
  68762. static readonly TEXTUREFORMAT_R: number;
  68763. /** RG */
  68764. static readonly TEXTUREFORMAT_RG: number;
  68765. /** RED_INTEGER */
  68766. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  68767. /** RED_INTEGER (2nd reference) */
  68768. static readonly TEXTUREFORMAT_R_INTEGER: number;
  68769. /** RG_INTEGER */
  68770. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  68771. /** RGB_INTEGER */
  68772. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  68773. /** RGBA_INTEGER */
  68774. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  68775. /** UNSIGNED_BYTE */
  68776. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  68777. /** UNSIGNED_BYTE (2nd reference) */
  68778. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  68779. /** FLOAT */
  68780. static readonly TEXTURETYPE_FLOAT: number;
  68781. /** HALF_FLOAT */
  68782. static readonly TEXTURETYPE_HALF_FLOAT: number;
  68783. /** BYTE */
  68784. static readonly TEXTURETYPE_BYTE: number;
  68785. /** SHORT */
  68786. static readonly TEXTURETYPE_SHORT: number;
  68787. /** UNSIGNED_SHORT */
  68788. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  68789. /** INT */
  68790. static readonly TEXTURETYPE_INT: number;
  68791. /** UNSIGNED_INT */
  68792. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  68793. /** UNSIGNED_SHORT_4_4_4_4 */
  68794. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  68795. /** UNSIGNED_SHORT_5_5_5_1 */
  68796. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  68797. /** UNSIGNED_SHORT_5_6_5 */
  68798. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  68799. /** UNSIGNED_INT_2_10_10_10_REV */
  68800. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  68801. /** UNSIGNED_INT_24_8 */
  68802. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  68803. /** UNSIGNED_INT_10F_11F_11F_REV */
  68804. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  68805. /** UNSIGNED_INT_5_9_9_9_REV */
  68806. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  68807. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  68808. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  68809. /** nearest is mag = nearest and min = nearest and mip = linear */
  68810. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  68811. /** Bilinear is mag = linear and min = linear and mip = nearest */
  68812. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  68813. /** Trilinear is mag = linear and min = linear and mip = linear */
  68814. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  68815. /** nearest is mag = nearest and min = nearest and mip = linear */
  68816. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  68817. /** Bilinear is mag = linear and min = linear and mip = nearest */
  68818. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  68819. /** Trilinear is mag = linear and min = linear and mip = linear */
  68820. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  68821. /** mag = nearest and min = nearest and mip = nearest */
  68822. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  68823. /** mag = nearest and min = linear and mip = nearest */
  68824. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  68825. /** mag = nearest and min = linear and mip = linear */
  68826. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  68827. /** mag = nearest and min = linear and mip = none */
  68828. static readonly TEXTURE_NEAREST_LINEAR: number;
  68829. /** mag = nearest and min = nearest and mip = none */
  68830. static readonly TEXTURE_NEAREST_NEAREST: number;
  68831. /** mag = linear and min = nearest and mip = nearest */
  68832. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  68833. /** mag = linear and min = nearest and mip = linear */
  68834. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  68835. /** mag = linear and min = linear and mip = none */
  68836. static readonly TEXTURE_LINEAR_LINEAR: number;
  68837. /** mag = linear and min = nearest and mip = none */
  68838. static readonly TEXTURE_LINEAR_NEAREST: number;
  68839. /** Explicit coordinates mode */
  68840. static readonly TEXTURE_EXPLICIT_MODE: number;
  68841. /** Spherical coordinates mode */
  68842. static readonly TEXTURE_SPHERICAL_MODE: number;
  68843. /** Planar coordinates mode */
  68844. static readonly TEXTURE_PLANAR_MODE: number;
  68845. /** Cubic coordinates mode */
  68846. static readonly TEXTURE_CUBIC_MODE: number;
  68847. /** Projection coordinates mode */
  68848. static readonly TEXTURE_PROJECTION_MODE: number;
  68849. /** Skybox coordinates mode */
  68850. static readonly TEXTURE_SKYBOX_MODE: number;
  68851. /** Inverse Cubic coordinates mode */
  68852. static readonly TEXTURE_INVCUBIC_MODE: number;
  68853. /** Equirectangular coordinates mode */
  68854. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  68855. /** Equirectangular Fixed coordinates mode */
  68856. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  68857. /** Equirectangular Fixed Mirrored coordinates mode */
  68858. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  68859. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  68860. static readonly SCALEMODE_FLOOR: number;
  68861. /** Defines that texture rescaling will look for the nearest power of 2 size */
  68862. static readonly SCALEMODE_NEAREST: number;
  68863. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  68864. static readonly SCALEMODE_CEILING: number;
  68865. /**
  68866. * The dirty texture flag value
  68867. */
  68868. static readonly MATERIAL_TextureDirtyFlag: number;
  68869. /**
  68870. * The dirty light flag value
  68871. */
  68872. static readonly MATERIAL_LightDirtyFlag: number;
  68873. /**
  68874. * The dirty fresnel flag value
  68875. */
  68876. static readonly MATERIAL_FresnelDirtyFlag: number;
  68877. /**
  68878. * The dirty attribute flag value
  68879. */
  68880. static readonly MATERIAL_AttributesDirtyFlag: number;
  68881. /**
  68882. * The dirty misc flag value
  68883. */
  68884. static readonly MATERIAL_MiscDirtyFlag: number;
  68885. /**
  68886. * The all dirty flag value
  68887. */
  68888. static readonly MATERIAL_AllDirtyFlag: number;
  68889. /**
  68890. * Returns the triangle fill mode
  68891. */
  68892. static readonly MATERIAL_TriangleFillMode: number;
  68893. /**
  68894. * Returns the wireframe mode
  68895. */
  68896. static readonly MATERIAL_WireFrameFillMode: number;
  68897. /**
  68898. * Returns the point fill mode
  68899. */
  68900. static readonly MATERIAL_PointFillMode: number;
  68901. /**
  68902. * Returns the point list draw mode
  68903. */
  68904. static readonly MATERIAL_PointListDrawMode: number;
  68905. /**
  68906. * Returns the line list draw mode
  68907. */
  68908. static readonly MATERIAL_LineListDrawMode: number;
  68909. /**
  68910. * Returns the line loop draw mode
  68911. */
  68912. static readonly MATERIAL_LineLoopDrawMode: number;
  68913. /**
  68914. * Returns the line strip draw mode
  68915. */
  68916. static readonly MATERIAL_LineStripDrawMode: number;
  68917. /**
  68918. * Returns the triangle strip draw mode
  68919. */
  68920. static readonly MATERIAL_TriangleStripDrawMode: number;
  68921. /**
  68922. * Returns the triangle fan draw mode
  68923. */
  68924. static readonly MATERIAL_TriangleFanDrawMode: number;
  68925. /**
  68926. * Stores the clock-wise side orientation
  68927. */
  68928. static readonly MATERIAL_ClockWiseSideOrientation: number;
  68929. /**
  68930. * Stores the counter clock-wise side orientation
  68931. */
  68932. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  68933. /**
  68934. * Nothing
  68935. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68936. */
  68937. static readonly ACTION_NothingTrigger: number;
  68938. /**
  68939. * On pick
  68940. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68941. */
  68942. static readonly ACTION_OnPickTrigger: number;
  68943. /**
  68944. * On left pick
  68945. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68946. */
  68947. static readonly ACTION_OnLeftPickTrigger: number;
  68948. /**
  68949. * On right pick
  68950. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68951. */
  68952. static readonly ACTION_OnRightPickTrigger: number;
  68953. /**
  68954. * On center pick
  68955. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68956. */
  68957. static readonly ACTION_OnCenterPickTrigger: number;
  68958. /**
  68959. * On pick down
  68960. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68961. */
  68962. static readonly ACTION_OnPickDownTrigger: number;
  68963. /**
  68964. * On double pick
  68965. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68966. */
  68967. static readonly ACTION_OnDoublePickTrigger: number;
  68968. /**
  68969. * On pick up
  68970. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68971. */
  68972. static readonly ACTION_OnPickUpTrigger: number;
  68973. /**
  68974. * On pick out.
  68975. * This trigger will only be raised if you also declared a OnPickDown
  68976. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68977. */
  68978. static readonly ACTION_OnPickOutTrigger: number;
  68979. /**
  68980. * On long press
  68981. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68982. */
  68983. static readonly ACTION_OnLongPressTrigger: number;
  68984. /**
  68985. * On pointer over
  68986. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68987. */
  68988. static readonly ACTION_OnPointerOverTrigger: number;
  68989. /**
  68990. * On pointer out
  68991. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68992. */
  68993. static readonly ACTION_OnPointerOutTrigger: number;
  68994. /**
  68995. * On every frame
  68996. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  68997. */
  68998. static readonly ACTION_OnEveryFrameTrigger: number;
  68999. /**
  69000. * On intersection enter
  69001. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69002. */
  69003. static readonly ACTION_OnIntersectionEnterTrigger: number;
  69004. /**
  69005. * On intersection exit
  69006. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69007. */
  69008. static readonly ACTION_OnIntersectionExitTrigger: number;
  69009. /**
  69010. * On key down
  69011. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69012. */
  69013. static readonly ACTION_OnKeyDownTrigger: number;
  69014. /**
  69015. * On key up
  69016. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69017. */
  69018. static readonly ACTION_OnKeyUpTrigger: number;
  69019. /**
  69020. * Billboard mode will only apply to Y axis
  69021. */
  69022. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  69023. /**
  69024. * Billboard mode will apply to all axes
  69025. */
  69026. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  69027. /**
  69028. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  69029. */
  69030. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  69031. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  69032. * Test order :
  69033. * Is the bounding sphere outside the frustum ?
  69034. * If not, are the bounding box vertices outside the frustum ?
  69035. * It not, then the cullable object is in the frustum.
  69036. */
  69037. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  69038. /** Culling strategy : Bounding Sphere Only.
  69039. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  69040. * It's also less accurate than the standard because some not visible objects can still be selected.
  69041. * Test : is the bounding sphere outside the frustum ?
  69042. * If not, then the cullable object is in the frustum.
  69043. */
  69044. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  69045. /** Culling strategy : Optimistic Inclusion.
  69046. * This in an inclusion test first, then the standard exclusion test.
  69047. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  69048. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  69049. * Anyway, it's as accurate as the standard strategy.
  69050. * Test :
  69051. * Is the cullable object bounding sphere center in the frustum ?
  69052. * If not, apply the default culling strategy.
  69053. */
  69054. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  69055. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  69056. * This in an inclusion test first, then the bounding sphere only exclusion test.
  69057. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  69058. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  69059. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  69060. * Test :
  69061. * Is the cullable object bounding sphere center in the frustum ?
  69062. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  69063. */
  69064. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  69065. /**
  69066. * No logging while loading
  69067. */
  69068. static readonly SCENELOADER_NO_LOGGING: number;
  69069. /**
  69070. * Minimal logging while loading
  69071. */
  69072. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  69073. /**
  69074. * Summary logging while loading
  69075. */
  69076. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  69077. /**
  69078. * Detailled logging while loading
  69079. */
  69080. static readonly SCENELOADER_DETAILED_LOGGING: number;
  69081. }
  69082. }
  69083. declare module BABYLON {
  69084. /**
  69085. * This represents the required contract to create a new type of texture loader.
  69086. */
  69087. export interface IInternalTextureLoader {
  69088. /**
  69089. * Defines wether the loader supports cascade loading the different faces.
  69090. */
  69091. supportCascades: boolean;
  69092. /**
  69093. * This returns if the loader support the current file information.
  69094. * @param extension defines the file extension of the file being loaded
  69095. * @param textureFormatInUse defines the current compressed format in use iun the engine
  69096. * @param fallback defines the fallback internal texture if any
  69097. * @param isBase64 defines whether the texture is encoded as a base64
  69098. * @param isBuffer defines whether the texture data are stored as a buffer
  69099. * @returns true if the loader can load the specified file
  69100. */
  69101. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  69102. /**
  69103. * Transform the url before loading if required.
  69104. * @param rootUrl the url of the texture
  69105. * @param textureFormatInUse defines the current compressed format in use iun the engine
  69106. * @returns the transformed texture
  69107. */
  69108. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  69109. /**
  69110. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  69111. * @param rootUrl the url of the texture
  69112. * @param textureFormatInUse defines the current compressed format in use iun the engine
  69113. * @returns the fallback texture
  69114. */
  69115. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  69116. /**
  69117. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  69118. * @param data contains the texture data
  69119. * @param texture defines the BabylonJS internal texture
  69120. * @param createPolynomials will be true if polynomials have been requested
  69121. * @param onLoad defines the callback to trigger once the texture is ready
  69122. * @param onError defines the callback to trigger in case of error
  69123. */
  69124. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  69125. /**
  69126. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  69127. * @param data contains the texture data
  69128. * @param texture defines the BabylonJS internal texture
  69129. * @param callback defines the method to call once ready to upload
  69130. */
  69131. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  69132. }
  69133. }
  69134. declare module BABYLON {
  69135. /**
  69136. * Class used to store and describe the pipeline context associated with an effect
  69137. */
  69138. export interface IPipelineContext {
  69139. /**
  69140. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  69141. */
  69142. isAsync: boolean;
  69143. /**
  69144. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  69145. */
  69146. isReady: boolean;
  69147. /** @hidden */
  69148. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  69149. }
  69150. }
  69151. declare module BABYLON {
  69152. /**
  69153. * Class used to store gfx data (like WebGLBuffer)
  69154. */
  69155. export class DataBuffer {
  69156. /**
  69157. * Gets or sets the number of objects referencing this buffer
  69158. */
  69159. references: number;
  69160. /** Gets or sets the size of the underlying buffer */
  69161. capacity: number;
  69162. /**
  69163. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  69164. */
  69165. is32Bits: boolean;
  69166. /**
  69167. * Gets the underlying buffer
  69168. */
  69169. readonly underlyingResource: any;
  69170. }
  69171. }
  69172. declare module BABYLON {
  69173. /** @hidden */
  69174. export interface IShaderProcessor {
  69175. attributeProcessor?: (attribute: string) => string;
  69176. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  69177. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  69178. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  69179. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  69180. lineProcessor?: (line: string, isFragment: boolean) => string;
  69181. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  69182. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  69183. }
  69184. }
  69185. declare module BABYLON {
  69186. /** @hidden */
  69187. export interface ProcessingOptions {
  69188. defines: string[];
  69189. indexParameters: any;
  69190. isFragment: boolean;
  69191. shouldUseHighPrecisionShader: boolean;
  69192. supportsUniformBuffers: boolean;
  69193. shadersRepository: string;
  69194. includesShadersStore: {
  69195. [key: string]: string;
  69196. };
  69197. processor?: IShaderProcessor;
  69198. version: string;
  69199. platformName: string;
  69200. lookForClosingBracketForUniformBuffer?: boolean;
  69201. }
  69202. }
  69203. declare module BABYLON {
  69204. /** @hidden */
  69205. export class ShaderCodeNode {
  69206. line: string;
  69207. children: ShaderCodeNode[];
  69208. additionalDefineKey?: string;
  69209. additionalDefineValue?: string;
  69210. isValid(preprocessors: {
  69211. [key: string]: string;
  69212. }): boolean;
  69213. process(preprocessors: {
  69214. [key: string]: string;
  69215. }, options: ProcessingOptions): string;
  69216. }
  69217. }
  69218. declare module BABYLON {
  69219. /** @hidden */
  69220. export class ShaderCodeCursor {
  69221. private _lines;
  69222. lineIndex: number;
  69223. readonly currentLine: string;
  69224. readonly canRead: boolean;
  69225. lines: string[];
  69226. }
  69227. }
  69228. declare module BABYLON {
  69229. /** @hidden */
  69230. export class ShaderCodeConditionNode extends ShaderCodeNode {
  69231. process(preprocessors: {
  69232. [key: string]: string;
  69233. }, options: ProcessingOptions): string;
  69234. }
  69235. }
  69236. declare module BABYLON {
  69237. /** @hidden */
  69238. export class ShaderDefineExpression {
  69239. isTrue(preprocessors: {
  69240. [key: string]: string;
  69241. }): boolean;
  69242. }
  69243. }
  69244. declare module BABYLON {
  69245. /** @hidden */
  69246. export class ShaderCodeTestNode extends ShaderCodeNode {
  69247. testExpression: ShaderDefineExpression;
  69248. isValid(preprocessors: {
  69249. [key: string]: string;
  69250. }): boolean;
  69251. }
  69252. }
  69253. declare module BABYLON {
  69254. /** @hidden */
  69255. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  69256. define: string;
  69257. not: boolean;
  69258. constructor(define: string, not?: boolean);
  69259. isTrue(preprocessors: {
  69260. [key: string]: string;
  69261. }): boolean;
  69262. }
  69263. }
  69264. declare module BABYLON {
  69265. /** @hidden */
  69266. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  69267. leftOperand: ShaderDefineExpression;
  69268. rightOperand: ShaderDefineExpression;
  69269. isTrue(preprocessors: {
  69270. [key: string]: string;
  69271. }): boolean;
  69272. }
  69273. }
  69274. declare module BABYLON {
  69275. /** @hidden */
  69276. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  69277. leftOperand: ShaderDefineExpression;
  69278. rightOperand: ShaderDefineExpression;
  69279. isTrue(preprocessors: {
  69280. [key: string]: string;
  69281. }): boolean;
  69282. }
  69283. }
  69284. declare module BABYLON {
  69285. /** @hidden */
  69286. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  69287. define: string;
  69288. operand: string;
  69289. testValue: string;
  69290. constructor(define: string, operand: string, testValue: string);
  69291. isTrue(preprocessors: {
  69292. [key: string]: string;
  69293. }): boolean;
  69294. }
  69295. }
  69296. declare module BABYLON {
  69297. /**
  69298. * Class used to enable access to offline support
  69299. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  69300. */
  69301. export interface IOfflineProvider {
  69302. /**
  69303. * Gets a boolean indicating if scene must be saved in the database
  69304. */
  69305. enableSceneOffline: boolean;
  69306. /**
  69307. * Gets a boolean indicating if textures must be saved in the database
  69308. */
  69309. enableTexturesOffline: boolean;
  69310. /**
  69311. * Open the offline support and make it available
  69312. * @param successCallback defines the callback to call on success
  69313. * @param errorCallback defines the callback to call on error
  69314. */
  69315. open(successCallback: () => void, errorCallback: () => void): void;
  69316. /**
  69317. * Loads an image from the offline support
  69318. * @param url defines the url to load from
  69319. * @param image defines the target DOM image
  69320. */
  69321. loadImage(url: string, image: HTMLImageElement): void;
  69322. /**
  69323. * Loads a file from offline support
  69324. * @param url defines the URL to load from
  69325. * @param sceneLoaded defines a callback to call on success
  69326. * @param progressCallBack defines a callback to call when progress changed
  69327. * @param errorCallback defines a callback to call on error
  69328. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  69329. */
  69330. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  69331. }
  69332. }
  69333. declare module BABYLON {
  69334. /**
  69335. * Class used to help managing file picking and drag'n'drop
  69336. * File Storage
  69337. */
  69338. export class FilesInputStore {
  69339. /**
  69340. * List of files ready to be loaded
  69341. */
  69342. static FilesToLoad: {
  69343. [key: string]: File;
  69344. };
  69345. }
  69346. }
  69347. declare module BABYLON {
  69348. /**
  69349. * Class used to define a retry strategy when error happens while loading assets
  69350. */
  69351. export class RetryStrategy {
  69352. /**
  69353. * Function used to defines an exponential back off strategy
  69354. * @param maxRetries defines the maximum number of retries (3 by default)
  69355. * @param baseInterval defines the interval between retries
  69356. * @returns the strategy function to use
  69357. */
  69358. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  69359. }
  69360. }
  69361. declare module BABYLON {
  69362. /**
  69363. * @ignore
  69364. * Application error to support additional information when loading a file
  69365. */
  69366. export abstract class BaseError extends Error {
  69367. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  69368. }
  69369. }
  69370. declare module BABYLON {
  69371. /** @ignore */
  69372. export class LoadFileError extends BaseError {
  69373. request?: WebRequest;
  69374. file?: File;
  69375. /**
  69376. * Creates a new LoadFileError
  69377. * @param message defines the message of the error
  69378. * @param request defines the optional web request
  69379. * @param file defines the optional file
  69380. */
  69381. constructor(message: string, object?: WebRequest | File);
  69382. }
  69383. /** @ignore */
  69384. export class RequestFileError extends BaseError {
  69385. request: WebRequest;
  69386. /**
  69387. * Creates a new LoadFileError
  69388. * @param message defines the message of the error
  69389. * @param request defines the optional web request
  69390. */
  69391. constructor(message: string, request: WebRequest);
  69392. }
  69393. /** @ignore */
  69394. export class ReadFileError extends BaseError {
  69395. file: File;
  69396. /**
  69397. * Creates a new ReadFileError
  69398. * @param message defines the message of the error
  69399. * @param file defines the optional file
  69400. */
  69401. constructor(message: string, file: File);
  69402. }
  69403. /**
  69404. * @hidden
  69405. */
  69406. export class FileTools {
  69407. /**
  69408. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  69409. */
  69410. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  69411. /**
  69412. * Gets or sets the base URL to use to load assets
  69413. */
  69414. static BaseUrl: string;
  69415. /**
  69416. * Default behaviour for cors in the application.
  69417. * It can be a string if the expected behavior is identical in the entire app.
  69418. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  69419. */
  69420. static CorsBehavior: string | ((url: string | string[]) => string);
  69421. /**
  69422. * Gets or sets a function used to pre-process url before using them to load assets
  69423. */
  69424. static PreprocessUrl: (url: string) => string;
  69425. /**
  69426. * Removes unwanted characters from an url
  69427. * @param url defines the url to clean
  69428. * @returns the cleaned url
  69429. */
  69430. private static _CleanUrl;
  69431. /**
  69432. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  69433. * @param url define the url we are trying
  69434. * @param element define the dom element where to configure the cors policy
  69435. */
  69436. static SetCorsBehavior(url: string | string[], element: {
  69437. crossOrigin: string | null;
  69438. }): void;
  69439. /**
  69440. * Loads an image as an HTMLImageElement.
  69441. * @param input url string, ArrayBuffer, or Blob to load
  69442. * @param onLoad callback called when the image successfully loads
  69443. * @param onError callback called when the image fails to load
  69444. * @param offlineProvider offline provider for caching
  69445. * @param mimeType optional mime type
  69446. * @returns the HTMLImageElement of the loaded image
  69447. */
  69448. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  69449. /**
  69450. * Reads a file from a File object
  69451. * @param file defines the file to load
  69452. * @param onSuccess defines the callback to call when data is loaded
  69453. * @param onProgress defines the callback to call during loading process
  69454. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  69455. * @param onError defines the callback to call when an error occurs
  69456. * @returns a file request object
  69457. */
  69458. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  69459. /**
  69460. * Loads a file from a url
  69461. * @param url url to load
  69462. * @param onSuccess callback called when the file successfully loads
  69463. * @param onProgress callback called while file is loading (if the server supports this mode)
  69464. * @param offlineProvider defines the offline provider for caching
  69465. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  69466. * @param onError callback called when the file fails to load
  69467. * @returns a file request object
  69468. */
  69469. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  69470. /**
  69471. * Loads a file
  69472. * @param url url to load
  69473. * @param onSuccess callback called when the file successfully loads
  69474. * @param onProgress callback called while file is loading (if the server supports this mode)
  69475. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  69476. * @param onError callback called when the file fails to load
  69477. * @param onOpened callback called when the web request is opened
  69478. * @returns a file request object
  69479. */
  69480. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  69481. /**
  69482. * Checks if the loaded document was accessed via `file:`-Protocol.
  69483. * @returns boolean
  69484. */
  69485. static IsFileURL(): boolean;
  69486. }
  69487. }
  69488. declare module BABYLON {
  69489. /** @hidden */
  69490. export class ShaderProcessor {
  69491. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  69492. private static _ProcessPrecision;
  69493. private static _ExtractOperation;
  69494. private static _BuildSubExpression;
  69495. private static _BuildExpression;
  69496. private static _MoveCursorWithinIf;
  69497. private static _MoveCursor;
  69498. private static _EvaluatePreProcessors;
  69499. private static _PreparePreProcessors;
  69500. private static _ProcessShaderConversion;
  69501. private static _ProcessIncludes;
  69502. }
  69503. }
  69504. declare module BABYLON {
  69505. /**
  69506. * @hidden
  69507. */
  69508. export interface IColor4Like {
  69509. r: float;
  69510. g: float;
  69511. b: float;
  69512. a: float;
  69513. }
  69514. /**
  69515. * @hidden
  69516. */
  69517. export interface IColor3Like {
  69518. r: float;
  69519. g: float;
  69520. b: float;
  69521. }
  69522. /**
  69523. * @hidden
  69524. */
  69525. export interface IVector4Like {
  69526. x: float;
  69527. y: float;
  69528. z: float;
  69529. w: float;
  69530. }
  69531. /**
  69532. * @hidden
  69533. */
  69534. export interface IVector3Like {
  69535. x: float;
  69536. y: float;
  69537. z: float;
  69538. }
  69539. /**
  69540. * @hidden
  69541. */
  69542. export interface IVector2Like {
  69543. x: float;
  69544. y: float;
  69545. }
  69546. /**
  69547. * @hidden
  69548. */
  69549. export interface IMatrixLike {
  69550. toArray(): DeepImmutable<Float32Array>;
  69551. updateFlag: int;
  69552. }
  69553. /**
  69554. * @hidden
  69555. */
  69556. export interface IViewportLike {
  69557. x: float;
  69558. y: float;
  69559. width: float;
  69560. height: float;
  69561. }
  69562. /**
  69563. * @hidden
  69564. */
  69565. export interface IPlaneLike {
  69566. normal: IVector3Like;
  69567. d: float;
  69568. normalize(): void;
  69569. }
  69570. }
  69571. declare module BABYLON {
  69572. /**
  69573. * Interface used to define common properties for effect fallbacks
  69574. */
  69575. export interface IEffectFallbacks {
  69576. /**
  69577. * Removes the defines that should be removed when falling back.
  69578. * @param currentDefines defines the current define statements for the shader.
  69579. * @param effect defines the current effect we try to compile
  69580. * @returns The resulting defines with defines of the current rank removed.
  69581. */
  69582. reduce(currentDefines: string, effect: Effect): string;
  69583. /**
  69584. * Removes the fallback from the bound mesh.
  69585. */
  69586. unBindMesh(): void;
  69587. /**
  69588. * Checks to see if more fallbacks are still availible.
  69589. */
  69590. hasMoreFallbacks: boolean;
  69591. }
  69592. }
  69593. declare module BABYLON {
  69594. /**
  69595. * Class used to evalaute queries containing `and` and `or` operators
  69596. */
  69597. export class AndOrNotEvaluator {
  69598. /**
  69599. * Evaluate a query
  69600. * @param query defines the query to evaluate
  69601. * @param evaluateCallback defines the callback used to filter result
  69602. * @returns true if the query matches
  69603. */
  69604. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  69605. private static _HandleParenthesisContent;
  69606. private static _SimplifyNegation;
  69607. }
  69608. }
  69609. declare module BABYLON {
  69610. /**
  69611. * Class used to store custom tags
  69612. */
  69613. export class Tags {
  69614. /**
  69615. * Adds support for tags on the given object
  69616. * @param obj defines the object to use
  69617. */
  69618. static EnableFor(obj: any): void;
  69619. /**
  69620. * Removes tags support
  69621. * @param obj defines the object to use
  69622. */
  69623. static DisableFor(obj: any): void;
  69624. /**
  69625. * Gets a boolean indicating if the given object has tags
  69626. * @param obj defines the object to use
  69627. * @returns a boolean
  69628. */
  69629. static HasTags(obj: any): boolean;
  69630. /**
  69631. * Gets the tags available on a given object
  69632. * @param obj defines the object to use
  69633. * @param asString defines if the tags must be returned as a string instead of an array of strings
  69634. * @returns the tags
  69635. */
  69636. static GetTags(obj: any, asString?: boolean): any;
  69637. /**
  69638. * Adds tags to an object
  69639. * @param obj defines the object to use
  69640. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  69641. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  69642. */
  69643. static AddTagsTo(obj: any, tagsString: string): void;
  69644. /**
  69645. * @hidden
  69646. */
  69647. static _AddTagTo(obj: any, tag: string): void;
  69648. /**
  69649. * Removes specific tags from a specific object
  69650. * @param obj defines the object to use
  69651. * @param tagsString defines the tags to remove
  69652. */
  69653. static RemoveTagsFrom(obj: any, tagsString: string): void;
  69654. /**
  69655. * @hidden
  69656. */
  69657. static _RemoveTagFrom(obj: any, tag: string): void;
  69658. /**
  69659. * Defines if tags hosted on an object match a given query
  69660. * @param obj defines the object to use
  69661. * @param tagsQuery defines the tag query
  69662. * @returns a boolean
  69663. */
  69664. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  69665. }
  69666. }
  69667. declare module BABYLON {
  69668. /**
  69669. * Scalar computation library
  69670. */
  69671. export class Scalar {
  69672. /**
  69673. * Two pi constants convenient for computation.
  69674. */
  69675. static TwoPi: number;
  69676. /**
  69677. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  69678. * @param a number
  69679. * @param b number
  69680. * @param epsilon (default = 1.401298E-45)
  69681. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  69682. */
  69683. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  69684. /**
  69685. * Returns a string : the upper case translation of the number i to hexadecimal.
  69686. * @param i number
  69687. * @returns the upper case translation of the number i to hexadecimal.
  69688. */
  69689. static ToHex(i: number): string;
  69690. /**
  69691. * Returns -1 if value is negative and +1 is value is positive.
  69692. * @param value the value
  69693. * @returns the value itself if it's equal to zero.
  69694. */
  69695. static Sign(value: number): number;
  69696. /**
  69697. * Returns the value itself if it's between min and max.
  69698. * Returns min if the value is lower than min.
  69699. * Returns max if the value is greater than max.
  69700. * @param value the value to clmap
  69701. * @param min the min value to clamp to (default: 0)
  69702. * @param max the max value to clamp to (default: 1)
  69703. * @returns the clamped value
  69704. */
  69705. static Clamp(value: number, min?: number, max?: number): number;
  69706. /**
  69707. * the log2 of value.
  69708. * @param value the value to compute log2 of
  69709. * @returns the log2 of value.
  69710. */
  69711. static Log2(value: number): number;
  69712. /**
  69713. * Loops the value, so that it is never larger than length and never smaller than 0.
  69714. *
  69715. * This is similar to the modulo operator but it works with floating point numbers.
  69716. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  69717. * With t = 5 and length = 2.5, the result would be 0.0.
  69718. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  69719. * @param value the value
  69720. * @param length the length
  69721. * @returns the looped value
  69722. */
  69723. static Repeat(value: number, length: number): number;
  69724. /**
  69725. * Normalize the value between 0.0 and 1.0 using min and max values
  69726. * @param value value to normalize
  69727. * @param min max to normalize between
  69728. * @param max min to normalize between
  69729. * @returns the normalized value
  69730. */
  69731. static Normalize(value: number, min: number, max: number): number;
  69732. /**
  69733. * Denormalize the value from 0.0 and 1.0 using min and max values
  69734. * @param normalized value to denormalize
  69735. * @param min max to denormalize between
  69736. * @param max min to denormalize between
  69737. * @returns the denormalized value
  69738. */
  69739. static Denormalize(normalized: number, min: number, max: number): number;
  69740. /**
  69741. * Calculates the shortest difference between two given angles given in degrees.
  69742. * @param current current angle in degrees
  69743. * @param target target angle in degrees
  69744. * @returns the delta
  69745. */
  69746. static DeltaAngle(current: number, target: number): number;
  69747. /**
  69748. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  69749. * @param tx value
  69750. * @param length length
  69751. * @returns The returned value will move back and forth between 0 and length
  69752. */
  69753. static PingPong(tx: number, length: number): number;
  69754. /**
  69755. * Interpolates between min and max with smoothing at the limits.
  69756. *
  69757. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  69758. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  69759. * @param from from
  69760. * @param to to
  69761. * @param tx value
  69762. * @returns the smooth stepped value
  69763. */
  69764. static SmoothStep(from: number, to: number, tx: number): number;
  69765. /**
  69766. * Moves a value current towards target.
  69767. *
  69768. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  69769. * Negative values of maxDelta pushes the value away from target.
  69770. * @param current current value
  69771. * @param target target value
  69772. * @param maxDelta max distance to move
  69773. * @returns resulting value
  69774. */
  69775. static MoveTowards(current: number, target: number, maxDelta: number): number;
  69776. /**
  69777. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  69778. *
  69779. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  69780. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  69781. * @param current current value
  69782. * @param target target value
  69783. * @param maxDelta max distance to move
  69784. * @returns resulting angle
  69785. */
  69786. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  69787. /**
  69788. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  69789. * @param start start value
  69790. * @param end target value
  69791. * @param amount amount to lerp between
  69792. * @returns the lerped value
  69793. */
  69794. static Lerp(start: number, end: number, amount: number): number;
  69795. /**
  69796. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  69797. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  69798. * @param start start value
  69799. * @param end target value
  69800. * @param amount amount to lerp between
  69801. * @returns the lerped value
  69802. */
  69803. static LerpAngle(start: number, end: number, amount: number): number;
  69804. /**
  69805. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  69806. * @param a start value
  69807. * @param b target value
  69808. * @param value value between a and b
  69809. * @returns the inverseLerp value
  69810. */
  69811. static InverseLerp(a: number, b: number, value: number): number;
  69812. /**
  69813. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  69814. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  69815. * @param value1 spline value
  69816. * @param tangent1 spline value
  69817. * @param value2 spline value
  69818. * @param tangent2 spline value
  69819. * @param amount input value
  69820. * @returns hermite result
  69821. */
  69822. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  69823. /**
  69824. * Returns a random float number between and min and max values
  69825. * @param min min value of random
  69826. * @param max max value of random
  69827. * @returns random value
  69828. */
  69829. static RandomRange(min: number, max: number): number;
  69830. /**
  69831. * This function returns percentage of a number in a given range.
  69832. *
  69833. * RangeToPercent(40,20,60) will return 0.5 (50%)
  69834. * RangeToPercent(34,0,100) will return 0.34 (34%)
  69835. * @param number to convert to percentage
  69836. * @param min min range
  69837. * @param max max range
  69838. * @returns the percentage
  69839. */
  69840. static RangeToPercent(number: number, min: number, max: number): number;
  69841. /**
  69842. * This function returns number that corresponds to the percentage in a given range.
  69843. *
  69844. * PercentToRange(0.34,0,100) will return 34.
  69845. * @param percent to convert to number
  69846. * @param min min range
  69847. * @param max max range
  69848. * @returns the number
  69849. */
  69850. static PercentToRange(percent: number, min: number, max: number): number;
  69851. /**
  69852. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  69853. * @param angle The angle to normalize in radian.
  69854. * @return The converted angle.
  69855. */
  69856. static NormalizeRadians(angle: number): number;
  69857. }
  69858. }
  69859. declare module BABYLON {
  69860. /**
  69861. * Constant used to convert a value to gamma space
  69862. * @ignorenaming
  69863. */
  69864. export const ToGammaSpace: number;
  69865. /**
  69866. * Constant used to convert a value to linear space
  69867. * @ignorenaming
  69868. */
  69869. export const ToLinearSpace = 2.2;
  69870. /**
  69871. * Constant used to define the minimal number value in Babylon.js
  69872. * @ignorenaming
  69873. */
  69874. let Epsilon: number;
  69875. }
  69876. declare module BABYLON {
  69877. /**
  69878. * Class used to represent a viewport on screen
  69879. */
  69880. export class Viewport {
  69881. /** viewport left coordinate */
  69882. x: number;
  69883. /** viewport top coordinate */
  69884. y: number;
  69885. /**viewport width */
  69886. width: number;
  69887. /** viewport height */
  69888. height: number;
  69889. /**
  69890. * Creates a Viewport object located at (x, y) and sized (width, height)
  69891. * @param x defines viewport left coordinate
  69892. * @param y defines viewport top coordinate
  69893. * @param width defines the viewport width
  69894. * @param height defines the viewport height
  69895. */
  69896. constructor(
  69897. /** viewport left coordinate */
  69898. x: number,
  69899. /** viewport top coordinate */
  69900. y: number,
  69901. /**viewport width */
  69902. width: number,
  69903. /** viewport height */
  69904. height: number);
  69905. /**
  69906. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  69907. * @param renderWidth defines the rendering width
  69908. * @param renderHeight defines the rendering height
  69909. * @returns a new Viewport
  69910. */
  69911. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  69912. /**
  69913. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  69914. * @param renderWidth defines the rendering width
  69915. * @param renderHeight defines the rendering height
  69916. * @param ref defines the target viewport
  69917. * @returns the current viewport
  69918. */
  69919. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  69920. /**
  69921. * Returns a new Viewport copied from the current one
  69922. * @returns a new Viewport
  69923. */
  69924. clone(): Viewport;
  69925. }
  69926. }
  69927. declare module BABYLON {
  69928. /**
  69929. * Class containing a set of static utilities functions for arrays.
  69930. */
  69931. export class ArrayTools {
  69932. /**
  69933. * Returns an array of the given size filled with element built from the given constructor and the paramters
  69934. * @param size the number of element to construct and put in the array
  69935. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  69936. * @returns a new array filled with new objects
  69937. */
  69938. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  69939. }
  69940. }
  69941. declare module BABYLON {
  69942. /**
  69943. * Class representing a vector containing 2 coordinates
  69944. */
  69945. export class Vector2 {
  69946. /** defines the first coordinate */
  69947. x: number;
  69948. /** defines the second coordinate */
  69949. y: number;
  69950. /**
  69951. * Creates a new Vector2 from the given x and y coordinates
  69952. * @param x defines the first coordinate
  69953. * @param y defines the second coordinate
  69954. */
  69955. constructor(
  69956. /** defines the first coordinate */
  69957. x?: number,
  69958. /** defines the second coordinate */
  69959. y?: number);
  69960. /**
  69961. * Gets a string with the Vector2 coordinates
  69962. * @returns a string with the Vector2 coordinates
  69963. */
  69964. toString(): string;
  69965. /**
  69966. * Gets class name
  69967. * @returns the string "Vector2"
  69968. */
  69969. getClassName(): string;
  69970. /**
  69971. * Gets current vector hash code
  69972. * @returns the Vector2 hash code as a number
  69973. */
  69974. getHashCode(): number;
  69975. /**
  69976. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  69977. * @param array defines the source array
  69978. * @param index defines the offset in source array
  69979. * @returns the current Vector2
  69980. */
  69981. toArray(array: FloatArray, index?: number): Vector2;
  69982. /**
  69983. * Copy the current vector to an array
  69984. * @returns a new array with 2 elements: the Vector2 coordinates.
  69985. */
  69986. asArray(): number[];
  69987. /**
  69988. * Sets the Vector2 coordinates with the given Vector2 coordinates
  69989. * @param source defines the source Vector2
  69990. * @returns the current updated Vector2
  69991. */
  69992. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  69993. /**
  69994. * Sets the Vector2 coordinates with the given floats
  69995. * @param x defines the first coordinate
  69996. * @param y defines the second coordinate
  69997. * @returns the current updated Vector2
  69998. */
  69999. copyFromFloats(x: number, y: number): Vector2;
  70000. /**
  70001. * Sets the Vector2 coordinates with the given floats
  70002. * @param x defines the first coordinate
  70003. * @param y defines the second coordinate
  70004. * @returns the current updated Vector2
  70005. */
  70006. set(x: number, y: number): Vector2;
  70007. /**
  70008. * Add another vector with the current one
  70009. * @param otherVector defines the other vector
  70010. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  70011. */
  70012. add(otherVector: DeepImmutable<Vector2>): Vector2;
  70013. /**
  70014. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  70015. * @param otherVector defines the other vector
  70016. * @param result defines the target vector
  70017. * @returns the unmodified current Vector2
  70018. */
  70019. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70020. /**
  70021. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  70022. * @param otherVector defines the other vector
  70023. * @returns the current updated Vector2
  70024. */
  70025. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70026. /**
  70027. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  70028. * @param otherVector defines the other vector
  70029. * @returns a new Vector2
  70030. */
  70031. addVector3(otherVector: Vector3): Vector2;
  70032. /**
  70033. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  70034. * @param otherVector defines the other vector
  70035. * @returns a new Vector2
  70036. */
  70037. subtract(otherVector: Vector2): Vector2;
  70038. /**
  70039. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  70040. * @param otherVector defines the other vector
  70041. * @param result defines the target vector
  70042. * @returns the unmodified current Vector2
  70043. */
  70044. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70045. /**
  70046. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  70047. * @param otherVector defines the other vector
  70048. * @returns the current updated Vector2
  70049. */
  70050. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70051. /**
  70052. * Multiplies in place the current Vector2 coordinates by the given ones
  70053. * @param otherVector defines the other vector
  70054. * @returns the current updated Vector2
  70055. */
  70056. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70057. /**
  70058. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  70059. * @param otherVector defines the other vector
  70060. * @returns a new Vector2
  70061. */
  70062. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  70063. /**
  70064. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  70065. * @param otherVector defines the other vector
  70066. * @param result defines the target vector
  70067. * @returns the unmodified current Vector2
  70068. */
  70069. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70070. /**
  70071. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  70072. * @param x defines the first coordinate
  70073. * @param y defines the second coordinate
  70074. * @returns a new Vector2
  70075. */
  70076. multiplyByFloats(x: number, y: number): Vector2;
  70077. /**
  70078. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  70079. * @param otherVector defines the other vector
  70080. * @returns a new Vector2
  70081. */
  70082. divide(otherVector: Vector2): Vector2;
  70083. /**
  70084. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  70085. * @param otherVector defines the other vector
  70086. * @param result defines the target vector
  70087. * @returns the unmodified current Vector2
  70088. */
  70089. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70090. /**
  70091. * Divides the current Vector2 coordinates by the given ones
  70092. * @param otherVector defines the other vector
  70093. * @returns the current updated Vector2
  70094. */
  70095. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70096. /**
  70097. * Gets a new Vector2 with current Vector2 negated coordinates
  70098. * @returns a new Vector2
  70099. */
  70100. negate(): Vector2;
  70101. /**
  70102. * Multiply the Vector2 coordinates by scale
  70103. * @param scale defines the scaling factor
  70104. * @returns the current updated Vector2
  70105. */
  70106. scaleInPlace(scale: number): Vector2;
  70107. /**
  70108. * Returns a new Vector2 scaled by "scale" from the current Vector2
  70109. * @param scale defines the scaling factor
  70110. * @returns a new Vector2
  70111. */
  70112. scale(scale: number): Vector2;
  70113. /**
  70114. * Scale the current Vector2 values by a factor to a given Vector2
  70115. * @param scale defines the scale factor
  70116. * @param result defines the Vector2 object where to store the result
  70117. * @returns the unmodified current Vector2
  70118. */
  70119. scaleToRef(scale: number, result: Vector2): Vector2;
  70120. /**
  70121. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  70122. * @param scale defines the scale factor
  70123. * @param result defines the Vector2 object where to store the result
  70124. * @returns the unmodified current Vector2
  70125. */
  70126. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  70127. /**
  70128. * Gets a boolean if two vectors are equals
  70129. * @param otherVector defines the other vector
  70130. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  70131. */
  70132. equals(otherVector: DeepImmutable<Vector2>): boolean;
  70133. /**
  70134. * Gets a boolean if two vectors are equals (using an epsilon value)
  70135. * @param otherVector defines the other vector
  70136. * @param epsilon defines the minimal distance to consider equality
  70137. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  70138. */
  70139. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  70140. /**
  70141. * Gets a new Vector2 from current Vector2 floored values
  70142. * @returns a new Vector2
  70143. */
  70144. floor(): Vector2;
  70145. /**
  70146. * Gets a new Vector2 from current Vector2 floored values
  70147. * @returns a new Vector2
  70148. */
  70149. fract(): Vector2;
  70150. /**
  70151. * Gets the length of the vector
  70152. * @returns the vector length (float)
  70153. */
  70154. length(): number;
  70155. /**
  70156. * Gets the vector squared length
  70157. * @returns the vector squared length (float)
  70158. */
  70159. lengthSquared(): number;
  70160. /**
  70161. * Normalize the vector
  70162. * @returns the current updated Vector2
  70163. */
  70164. normalize(): Vector2;
  70165. /**
  70166. * Gets a new Vector2 copied from the Vector2
  70167. * @returns a new Vector2
  70168. */
  70169. clone(): Vector2;
  70170. /**
  70171. * Gets a new Vector2(0, 0)
  70172. * @returns a new Vector2
  70173. */
  70174. static Zero(): Vector2;
  70175. /**
  70176. * Gets a new Vector2(1, 1)
  70177. * @returns a new Vector2
  70178. */
  70179. static One(): Vector2;
  70180. /**
  70181. * Gets a new Vector2 set from the given index element of the given array
  70182. * @param array defines the data source
  70183. * @param offset defines the offset in the data source
  70184. * @returns a new Vector2
  70185. */
  70186. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  70187. /**
  70188. * Sets "result" from the given index element of the given array
  70189. * @param array defines the data source
  70190. * @param offset defines the offset in the data source
  70191. * @param result defines the target vector
  70192. */
  70193. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  70194. /**
  70195. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  70196. * @param value1 defines 1st point of control
  70197. * @param value2 defines 2nd point of control
  70198. * @param value3 defines 3rd point of control
  70199. * @param value4 defines 4th point of control
  70200. * @param amount defines the interpolation factor
  70201. * @returns a new Vector2
  70202. */
  70203. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  70204. /**
  70205. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  70206. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  70207. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  70208. * @param value defines the value to clamp
  70209. * @param min defines the lower limit
  70210. * @param max defines the upper limit
  70211. * @returns a new Vector2
  70212. */
  70213. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  70214. /**
  70215. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  70216. * @param value1 defines the 1st control point
  70217. * @param tangent1 defines the outgoing tangent
  70218. * @param value2 defines the 2nd control point
  70219. * @param tangent2 defines the incoming tangent
  70220. * @param amount defines the interpolation factor
  70221. * @returns a new Vector2
  70222. */
  70223. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  70224. /**
  70225. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  70226. * @param start defines the start vector
  70227. * @param end defines the end vector
  70228. * @param amount defines the interpolation factor
  70229. * @returns a new Vector2
  70230. */
  70231. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  70232. /**
  70233. * Gets the dot product of the vector "left" and the vector "right"
  70234. * @param left defines first vector
  70235. * @param right defines second vector
  70236. * @returns the dot product (float)
  70237. */
  70238. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  70239. /**
  70240. * Returns a new Vector2 equal to the normalized given vector
  70241. * @param vector defines the vector to normalize
  70242. * @returns a new Vector2
  70243. */
  70244. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  70245. /**
  70246. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  70247. * @param left defines 1st vector
  70248. * @param right defines 2nd vector
  70249. * @returns a new Vector2
  70250. */
  70251. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  70252. /**
  70253. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  70254. * @param left defines 1st vector
  70255. * @param right defines 2nd vector
  70256. * @returns a new Vector2
  70257. */
  70258. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  70259. /**
  70260. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  70261. * @param vector defines the vector to transform
  70262. * @param transformation defines the matrix to apply
  70263. * @returns a new Vector2
  70264. */
  70265. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  70266. /**
  70267. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  70268. * @param vector defines the vector to transform
  70269. * @param transformation defines the matrix to apply
  70270. * @param result defines the target vector
  70271. */
  70272. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  70273. /**
  70274. * Determines if a given vector is included in a triangle
  70275. * @param p defines the vector to test
  70276. * @param p0 defines 1st triangle point
  70277. * @param p1 defines 2nd triangle point
  70278. * @param p2 defines 3rd triangle point
  70279. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  70280. */
  70281. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  70282. /**
  70283. * Gets the distance between the vectors "value1" and "value2"
  70284. * @param value1 defines first vector
  70285. * @param value2 defines second vector
  70286. * @returns the distance between vectors
  70287. */
  70288. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  70289. /**
  70290. * Returns the squared distance between the vectors "value1" and "value2"
  70291. * @param value1 defines first vector
  70292. * @param value2 defines second vector
  70293. * @returns the squared distance between vectors
  70294. */
  70295. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  70296. /**
  70297. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  70298. * @param value1 defines first vector
  70299. * @param value2 defines second vector
  70300. * @returns a new Vector2
  70301. */
  70302. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  70303. /**
  70304. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  70305. * @param p defines the middle point
  70306. * @param segA defines one point of the segment
  70307. * @param segB defines the other point of the segment
  70308. * @returns the shortest distance
  70309. */
  70310. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  70311. }
  70312. /**
  70313. * Classed used to store (x,y,z) vector representation
  70314. * A Vector3 is the main object used in 3D geometry
  70315. * It can represent etiher the coordinates of a point the space, either a direction
  70316. * Reminder: js uses a left handed forward facing system
  70317. */
  70318. export class Vector3 {
  70319. /**
  70320. * Defines the first coordinates (on X axis)
  70321. */
  70322. x: number;
  70323. /**
  70324. * Defines the second coordinates (on Y axis)
  70325. */
  70326. y: number;
  70327. /**
  70328. * Defines the third coordinates (on Z axis)
  70329. */
  70330. z: number;
  70331. private static _UpReadOnly;
  70332. private static _ZeroReadOnly;
  70333. /**
  70334. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  70335. * @param x defines the first coordinates (on X axis)
  70336. * @param y defines the second coordinates (on Y axis)
  70337. * @param z defines the third coordinates (on Z axis)
  70338. */
  70339. constructor(
  70340. /**
  70341. * Defines the first coordinates (on X axis)
  70342. */
  70343. x?: number,
  70344. /**
  70345. * Defines the second coordinates (on Y axis)
  70346. */
  70347. y?: number,
  70348. /**
  70349. * Defines the third coordinates (on Z axis)
  70350. */
  70351. z?: number);
  70352. /**
  70353. * Creates a string representation of the Vector3
  70354. * @returns a string with the Vector3 coordinates.
  70355. */
  70356. toString(): string;
  70357. /**
  70358. * Gets the class name
  70359. * @returns the string "Vector3"
  70360. */
  70361. getClassName(): string;
  70362. /**
  70363. * Creates the Vector3 hash code
  70364. * @returns a number which tends to be unique between Vector3 instances
  70365. */
  70366. getHashCode(): number;
  70367. /**
  70368. * Creates an array containing three elements : the coordinates of the Vector3
  70369. * @returns a new array of numbers
  70370. */
  70371. asArray(): number[];
  70372. /**
  70373. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  70374. * @param array defines the destination array
  70375. * @param index defines the offset in the destination array
  70376. * @returns the current Vector3
  70377. */
  70378. toArray(array: FloatArray, index?: number): Vector3;
  70379. /**
  70380. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  70381. * @returns a new Quaternion object, computed from the Vector3 coordinates
  70382. */
  70383. toQuaternion(): Quaternion;
  70384. /**
  70385. * Adds the given vector to the current Vector3
  70386. * @param otherVector defines the second operand
  70387. * @returns the current updated Vector3
  70388. */
  70389. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70390. /**
  70391. * Adds the given coordinates to the current Vector3
  70392. * @param x defines the x coordinate of the operand
  70393. * @param y defines the y coordinate of the operand
  70394. * @param z defines the z coordinate of the operand
  70395. * @returns the current updated Vector3
  70396. */
  70397. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70398. /**
  70399. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  70400. * @param otherVector defines the second operand
  70401. * @returns the resulting Vector3
  70402. */
  70403. add(otherVector: DeepImmutable<Vector3>): Vector3;
  70404. /**
  70405. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  70406. * @param otherVector defines the second operand
  70407. * @param result defines the Vector3 object where to store the result
  70408. * @returns the current Vector3
  70409. */
  70410. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70411. /**
  70412. * Subtract the given vector from the current Vector3
  70413. * @param otherVector defines the second operand
  70414. * @returns the current updated Vector3
  70415. */
  70416. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70417. /**
  70418. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  70419. * @param otherVector defines the second operand
  70420. * @returns the resulting Vector3
  70421. */
  70422. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  70423. /**
  70424. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  70425. * @param otherVector defines the second operand
  70426. * @param result defines the Vector3 object where to store the result
  70427. * @returns the current Vector3
  70428. */
  70429. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70430. /**
  70431. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  70432. * @param x defines the x coordinate of the operand
  70433. * @param y defines the y coordinate of the operand
  70434. * @param z defines the z coordinate of the operand
  70435. * @returns the resulting Vector3
  70436. */
  70437. subtractFromFloats(x: number, y: number, z: number): Vector3;
  70438. /**
  70439. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  70440. * @param x defines the x coordinate of the operand
  70441. * @param y defines the y coordinate of the operand
  70442. * @param z defines the z coordinate of the operand
  70443. * @param result defines the Vector3 object where to store the result
  70444. * @returns the current Vector3
  70445. */
  70446. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  70447. /**
  70448. * Gets a new Vector3 set with the current Vector3 negated coordinates
  70449. * @returns a new Vector3
  70450. */
  70451. negate(): Vector3;
  70452. /**
  70453. * Multiplies the Vector3 coordinates by the float "scale"
  70454. * @param scale defines the multiplier factor
  70455. * @returns the current updated Vector3
  70456. */
  70457. scaleInPlace(scale: number): Vector3;
  70458. /**
  70459. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  70460. * @param scale defines the multiplier factor
  70461. * @returns a new Vector3
  70462. */
  70463. scale(scale: number): Vector3;
  70464. /**
  70465. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  70466. * @param scale defines the multiplier factor
  70467. * @param result defines the Vector3 object where to store the result
  70468. * @returns the current Vector3
  70469. */
  70470. scaleToRef(scale: number, result: Vector3): Vector3;
  70471. /**
  70472. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  70473. * @param scale defines the scale factor
  70474. * @param result defines the Vector3 object where to store the result
  70475. * @returns the unmodified current Vector3
  70476. */
  70477. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  70478. /**
  70479. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  70480. * @param otherVector defines the second operand
  70481. * @returns true if both vectors are equals
  70482. */
  70483. equals(otherVector: DeepImmutable<Vector3>): boolean;
  70484. /**
  70485. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  70486. * @param otherVector defines the second operand
  70487. * @param epsilon defines the minimal distance to define values as equals
  70488. * @returns true if both vectors are distant less than epsilon
  70489. */
  70490. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  70491. /**
  70492. * Returns true if the current Vector3 coordinates equals the given floats
  70493. * @param x defines the x coordinate of the operand
  70494. * @param y defines the y coordinate of the operand
  70495. * @param z defines the z coordinate of the operand
  70496. * @returns true if both vectors are equals
  70497. */
  70498. equalsToFloats(x: number, y: number, z: number): boolean;
  70499. /**
  70500. * Multiplies the current Vector3 coordinates by the given ones
  70501. * @param otherVector defines the second operand
  70502. * @returns the current updated Vector3
  70503. */
  70504. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70505. /**
  70506. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  70507. * @param otherVector defines the second operand
  70508. * @returns the new Vector3
  70509. */
  70510. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  70511. /**
  70512. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  70513. * @param otherVector defines the second operand
  70514. * @param result defines the Vector3 object where to store the result
  70515. * @returns the current Vector3
  70516. */
  70517. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70518. /**
  70519. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  70520. * @param x defines the x coordinate of the operand
  70521. * @param y defines the y coordinate of the operand
  70522. * @param z defines the z coordinate of the operand
  70523. * @returns the new Vector3
  70524. */
  70525. multiplyByFloats(x: number, y: number, z: number): Vector3;
  70526. /**
  70527. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  70528. * @param otherVector defines the second operand
  70529. * @returns the new Vector3
  70530. */
  70531. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  70532. /**
  70533. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  70534. * @param otherVector defines the second operand
  70535. * @param result defines the Vector3 object where to store the result
  70536. * @returns the current Vector3
  70537. */
  70538. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70539. /**
  70540. * Divides the current Vector3 coordinates by the given ones.
  70541. * @param otherVector defines the second operand
  70542. * @returns the current updated Vector3
  70543. */
  70544. divideInPlace(otherVector: Vector3): Vector3;
  70545. /**
  70546. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  70547. * @param other defines the second operand
  70548. * @returns the current updated Vector3
  70549. */
  70550. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  70551. /**
  70552. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  70553. * @param other defines the second operand
  70554. * @returns the current updated Vector3
  70555. */
  70556. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  70557. /**
  70558. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  70559. * @param x defines the x coordinate of the operand
  70560. * @param y defines the y coordinate of the operand
  70561. * @param z defines the z coordinate of the operand
  70562. * @returns the current updated Vector3
  70563. */
  70564. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70565. /**
  70566. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  70567. * @param x defines the x coordinate of the operand
  70568. * @param y defines the y coordinate of the operand
  70569. * @param z defines the z coordinate of the operand
  70570. * @returns the current updated Vector3
  70571. */
  70572. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70573. /**
  70574. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  70575. * Check if is non uniform within a certain amount of decimal places to account for this
  70576. * @param epsilon the amount the values can differ
  70577. * @returns if the the vector is non uniform to a certain number of decimal places
  70578. */
  70579. isNonUniformWithinEpsilon(epsilon: number): boolean;
  70580. /**
  70581. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  70582. */
  70583. readonly isNonUniform: boolean;
  70584. /**
  70585. * Gets a new Vector3 from current Vector3 floored values
  70586. * @returns a new Vector3
  70587. */
  70588. floor(): Vector3;
  70589. /**
  70590. * Gets a new Vector3 from current Vector3 floored values
  70591. * @returns a new Vector3
  70592. */
  70593. fract(): Vector3;
  70594. /**
  70595. * Gets the length of the Vector3
  70596. * @returns the length of the Vector3
  70597. */
  70598. length(): number;
  70599. /**
  70600. * Gets the squared length of the Vector3
  70601. * @returns squared length of the Vector3
  70602. */
  70603. lengthSquared(): number;
  70604. /**
  70605. * Normalize the current Vector3.
  70606. * Please note that this is an in place operation.
  70607. * @returns the current updated Vector3
  70608. */
  70609. normalize(): Vector3;
  70610. /**
  70611. * Reorders the x y z properties of the vector in place
  70612. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  70613. * @returns the current updated vector
  70614. */
  70615. reorderInPlace(order: string): this;
  70616. /**
  70617. * Rotates the vector around 0,0,0 by a quaternion
  70618. * @param quaternion the rotation quaternion
  70619. * @param result vector to store the result
  70620. * @returns the resulting vector
  70621. */
  70622. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  70623. /**
  70624. * Rotates a vector around a given point
  70625. * @param quaternion the rotation quaternion
  70626. * @param point the point to rotate around
  70627. * @param result vector to store the result
  70628. * @returns the resulting vector
  70629. */
  70630. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  70631. /**
  70632. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  70633. * The cross product is then orthogonal to both current and "other"
  70634. * @param other defines the right operand
  70635. * @returns the cross product
  70636. */
  70637. cross(other: Vector3): Vector3;
  70638. /**
  70639. * Normalize the current Vector3 with the given input length.
  70640. * Please note that this is an in place operation.
  70641. * @param len the length of the vector
  70642. * @returns the current updated Vector3
  70643. */
  70644. normalizeFromLength(len: number): Vector3;
  70645. /**
  70646. * Normalize the current Vector3 to a new vector
  70647. * @returns the new Vector3
  70648. */
  70649. normalizeToNew(): Vector3;
  70650. /**
  70651. * Normalize the current Vector3 to the reference
  70652. * @param reference define the Vector3 to update
  70653. * @returns the updated Vector3
  70654. */
  70655. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  70656. /**
  70657. * Creates a new Vector3 copied from the current Vector3
  70658. * @returns the new Vector3
  70659. */
  70660. clone(): Vector3;
  70661. /**
  70662. * Copies the given vector coordinates to the current Vector3 ones
  70663. * @param source defines the source Vector3
  70664. * @returns the current updated Vector3
  70665. */
  70666. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  70667. /**
  70668. * Copies the given floats to the current Vector3 coordinates
  70669. * @param x defines the x coordinate of the operand
  70670. * @param y defines the y coordinate of the operand
  70671. * @param z defines the z coordinate of the operand
  70672. * @returns the current updated Vector3
  70673. */
  70674. copyFromFloats(x: number, y: number, z: number): Vector3;
  70675. /**
  70676. * Copies the given floats to the current Vector3 coordinates
  70677. * @param x defines the x coordinate of the operand
  70678. * @param y defines the y coordinate of the operand
  70679. * @param z defines the z coordinate of the operand
  70680. * @returns the current updated Vector3
  70681. */
  70682. set(x: number, y: number, z: number): Vector3;
  70683. /**
  70684. * Copies the given float to the current Vector3 coordinates
  70685. * @param v defines the x, y and z coordinates of the operand
  70686. * @returns the current updated Vector3
  70687. */
  70688. setAll(v: number): Vector3;
  70689. /**
  70690. * Get the clip factor between two vectors
  70691. * @param vector0 defines the first operand
  70692. * @param vector1 defines the second operand
  70693. * @param axis defines the axis to use
  70694. * @param size defines the size along the axis
  70695. * @returns the clip factor
  70696. */
  70697. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  70698. /**
  70699. * Get angle between two vectors
  70700. * @param vector0 angle between vector0 and vector1
  70701. * @param vector1 angle between vector0 and vector1
  70702. * @param normal direction of the normal
  70703. * @return the angle between vector0 and vector1
  70704. */
  70705. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  70706. /**
  70707. * Returns a new Vector3 set from the index "offset" of the given array
  70708. * @param array defines the source array
  70709. * @param offset defines the offset in the source array
  70710. * @returns the new Vector3
  70711. */
  70712. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  70713. /**
  70714. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  70715. * This function is deprecated. Use FromArray instead
  70716. * @param array defines the source array
  70717. * @param offset defines the offset in the source array
  70718. * @returns the new Vector3
  70719. */
  70720. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  70721. /**
  70722. * Sets the given vector "result" with the element values from the index "offset" of the given array
  70723. * @param array defines the source array
  70724. * @param offset defines the offset in the source array
  70725. * @param result defines the Vector3 where to store the result
  70726. */
  70727. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  70728. /**
  70729. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  70730. * This function is deprecated. Use FromArrayToRef instead.
  70731. * @param array defines the source array
  70732. * @param offset defines the offset in the source array
  70733. * @param result defines the Vector3 where to store the result
  70734. */
  70735. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  70736. /**
  70737. * Sets the given vector "result" with the given floats.
  70738. * @param x defines the x coordinate of the source
  70739. * @param y defines the y coordinate of the source
  70740. * @param z defines the z coordinate of the source
  70741. * @param result defines the Vector3 where to store the result
  70742. */
  70743. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  70744. /**
  70745. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  70746. * @returns a new empty Vector3
  70747. */
  70748. static Zero(): Vector3;
  70749. /**
  70750. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  70751. * @returns a new unit Vector3
  70752. */
  70753. static One(): Vector3;
  70754. /**
  70755. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  70756. * @returns a new up Vector3
  70757. */
  70758. static Up(): Vector3;
  70759. /**
  70760. * Gets a up Vector3 that must not be updated
  70761. */
  70762. static readonly UpReadOnly: DeepImmutable<Vector3>;
  70763. /**
  70764. * Gets a zero Vector3 that must not be updated
  70765. */
  70766. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  70767. /**
  70768. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  70769. * @returns a new down Vector3
  70770. */
  70771. static Down(): Vector3;
  70772. /**
  70773. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  70774. * @returns a new forward Vector3
  70775. */
  70776. static Forward(): Vector3;
  70777. /**
  70778. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  70779. * @returns a new forward Vector3
  70780. */
  70781. static Backward(): Vector3;
  70782. /**
  70783. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  70784. * @returns a new right Vector3
  70785. */
  70786. static Right(): Vector3;
  70787. /**
  70788. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  70789. * @returns a new left Vector3
  70790. */
  70791. static Left(): Vector3;
  70792. /**
  70793. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  70794. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  70795. * @param vector defines the Vector3 to transform
  70796. * @param transformation defines the transformation matrix
  70797. * @returns the transformed Vector3
  70798. */
  70799. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  70800. /**
  70801. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  70802. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  70803. * @param vector defines the Vector3 to transform
  70804. * @param transformation defines the transformation matrix
  70805. * @param result defines the Vector3 where to store the result
  70806. */
  70807. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70808. /**
  70809. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  70810. * This method computes tranformed coordinates only, not transformed direction vectors
  70811. * @param x define the x coordinate of the source vector
  70812. * @param y define the y coordinate of the source vector
  70813. * @param z define the z coordinate of the source vector
  70814. * @param transformation defines the transformation matrix
  70815. * @param result defines the Vector3 where to store the result
  70816. */
  70817. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70818. /**
  70819. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  70820. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  70821. * @param vector defines the Vector3 to transform
  70822. * @param transformation defines the transformation matrix
  70823. * @returns the new Vector3
  70824. */
  70825. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  70826. /**
  70827. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  70828. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  70829. * @param vector defines the Vector3 to transform
  70830. * @param transformation defines the transformation matrix
  70831. * @param result defines the Vector3 where to store the result
  70832. */
  70833. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70834. /**
  70835. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  70836. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  70837. * @param x define the x coordinate of the source vector
  70838. * @param y define the y coordinate of the source vector
  70839. * @param z define the z coordinate of the source vector
  70840. * @param transformation defines the transformation matrix
  70841. * @param result defines the Vector3 where to store the result
  70842. */
  70843. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  70844. /**
  70845. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  70846. * @param value1 defines the first control point
  70847. * @param value2 defines the second control point
  70848. * @param value3 defines the third control point
  70849. * @param value4 defines the fourth control point
  70850. * @param amount defines the amount on the spline to use
  70851. * @returns the new Vector3
  70852. */
  70853. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  70854. /**
  70855. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  70856. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  70857. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  70858. * @param value defines the current value
  70859. * @param min defines the lower range value
  70860. * @param max defines the upper range value
  70861. * @returns the new Vector3
  70862. */
  70863. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  70864. /**
  70865. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  70866. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  70867. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  70868. * @param value defines the current value
  70869. * @param min defines the lower range value
  70870. * @param max defines the upper range value
  70871. * @param result defines the Vector3 where to store the result
  70872. */
  70873. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  70874. /**
  70875. * Checks if a given vector is inside a specific range
  70876. * @param v defines the vector to test
  70877. * @param min defines the minimum range
  70878. * @param max defines the maximum range
  70879. */
  70880. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  70881. /**
  70882. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  70883. * @param value1 defines the first control point
  70884. * @param tangent1 defines the first tangent vector
  70885. * @param value2 defines the second control point
  70886. * @param tangent2 defines the second tangent vector
  70887. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  70888. * @returns the new Vector3
  70889. */
  70890. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  70891. /**
  70892. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  70893. * @param start defines the start value
  70894. * @param end defines the end value
  70895. * @param amount max defines amount between both (between 0 and 1)
  70896. * @returns the new Vector3
  70897. */
  70898. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  70899. /**
  70900. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  70901. * @param start defines the start value
  70902. * @param end defines the end value
  70903. * @param amount max defines amount between both (between 0 and 1)
  70904. * @param result defines the Vector3 where to store the result
  70905. */
  70906. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  70907. /**
  70908. * Returns the dot product (float) between the vectors "left" and "right"
  70909. * @param left defines the left operand
  70910. * @param right defines the right operand
  70911. * @returns the dot product
  70912. */
  70913. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  70914. /**
  70915. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  70916. * The cross product is then orthogonal to both "left" and "right"
  70917. * @param left defines the left operand
  70918. * @param right defines the right operand
  70919. * @returns the cross product
  70920. */
  70921. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  70922. /**
  70923. * Sets the given vector "result" with the cross product of "left" and "right"
  70924. * The cross product is then orthogonal to both "left" and "right"
  70925. * @param left defines the left operand
  70926. * @param right defines the right operand
  70927. * @param result defines the Vector3 where to store the result
  70928. */
  70929. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  70930. /**
  70931. * Returns a new Vector3 as the normalization of the given vector
  70932. * @param vector defines the Vector3 to normalize
  70933. * @returns the new Vector3
  70934. */
  70935. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  70936. /**
  70937. * Sets the given vector "result" with the normalization of the given first vector
  70938. * @param vector defines the Vector3 to normalize
  70939. * @param result defines the Vector3 where to store the result
  70940. */
  70941. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  70942. /**
  70943. * Project a Vector3 onto screen space
  70944. * @param vector defines the Vector3 to project
  70945. * @param world defines the world matrix to use
  70946. * @param transform defines the transform (view x projection) matrix to use
  70947. * @param viewport defines the screen viewport to use
  70948. * @returns the new Vector3
  70949. */
  70950. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  70951. /** @hidden */
  70952. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  70953. /**
  70954. * Unproject from screen space to object space
  70955. * @param source defines the screen space Vector3 to use
  70956. * @param viewportWidth defines the current width of the viewport
  70957. * @param viewportHeight defines the current height of the viewport
  70958. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70959. * @param transform defines the transform (view x projection) matrix to use
  70960. * @returns the new Vector3
  70961. */
  70962. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  70963. /**
  70964. * Unproject from screen space to object space
  70965. * @param source defines the screen space Vector3 to use
  70966. * @param viewportWidth defines the current width of the viewport
  70967. * @param viewportHeight defines the current height of the viewport
  70968. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70969. * @param view defines the view matrix to use
  70970. * @param projection defines the projection matrix to use
  70971. * @returns the new Vector3
  70972. */
  70973. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  70974. /**
  70975. * Unproject from screen space to object space
  70976. * @param source defines the screen space Vector3 to use
  70977. * @param viewportWidth defines the current width of the viewport
  70978. * @param viewportHeight defines the current height of the viewport
  70979. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70980. * @param view defines the view matrix to use
  70981. * @param projection defines the projection matrix to use
  70982. * @param result defines the Vector3 where to store the result
  70983. */
  70984. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  70985. /**
  70986. * Unproject from screen space to object space
  70987. * @param sourceX defines the screen space x coordinate to use
  70988. * @param sourceY defines the screen space y coordinate to use
  70989. * @param sourceZ defines the screen space z coordinate to use
  70990. * @param viewportWidth defines the current width of the viewport
  70991. * @param viewportHeight defines the current height of the viewport
  70992. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  70993. * @param view defines the view matrix to use
  70994. * @param projection defines the projection matrix to use
  70995. * @param result defines the Vector3 where to store the result
  70996. */
  70997. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  70998. /**
  70999. * Gets the minimal coordinate values between two Vector3
  71000. * @param left defines the first operand
  71001. * @param right defines the second operand
  71002. * @returns the new Vector3
  71003. */
  71004. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  71005. /**
  71006. * Gets the maximal coordinate values between two Vector3
  71007. * @param left defines the first operand
  71008. * @param right defines the second operand
  71009. * @returns the new Vector3
  71010. */
  71011. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  71012. /**
  71013. * Returns the distance between the vectors "value1" and "value2"
  71014. * @param value1 defines the first operand
  71015. * @param value2 defines the second operand
  71016. * @returns the distance
  71017. */
  71018. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  71019. /**
  71020. * Returns the squared distance between the vectors "value1" and "value2"
  71021. * @param value1 defines the first operand
  71022. * @param value2 defines the second operand
  71023. * @returns the squared distance
  71024. */
  71025. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  71026. /**
  71027. * Returns a new Vector3 located at the center between "value1" and "value2"
  71028. * @param value1 defines the first operand
  71029. * @param value2 defines the second operand
  71030. * @returns the new Vector3
  71031. */
  71032. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  71033. /**
  71034. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  71035. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  71036. * to something in order to rotate it from its local system to the given target system
  71037. * Note: axis1, axis2 and axis3 are normalized during this operation
  71038. * @param axis1 defines the first axis
  71039. * @param axis2 defines the second axis
  71040. * @param axis3 defines the third axis
  71041. * @returns a new Vector3
  71042. */
  71043. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  71044. /**
  71045. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  71046. * @param axis1 defines the first axis
  71047. * @param axis2 defines the second axis
  71048. * @param axis3 defines the third axis
  71049. * @param ref defines the Vector3 where to store the result
  71050. */
  71051. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  71052. }
  71053. /**
  71054. * Vector4 class created for EulerAngle class conversion to Quaternion
  71055. */
  71056. export class Vector4 {
  71057. /** x value of the vector */
  71058. x: number;
  71059. /** y value of the vector */
  71060. y: number;
  71061. /** z value of the vector */
  71062. z: number;
  71063. /** w value of the vector */
  71064. w: number;
  71065. /**
  71066. * Creates a Vector4 object from the given floats.
  71067. * @param x x value of the vector
  71068. * @param y y value of the vector
  71069. * @param z z value of the vector
  71070. * @param w w value of the vector
  71071. */
  71072. constructor(
  71073. /** x value of the vector */
  71074. x: number,
  71075. /** y value of the vector */
  71076. y: number,
  71077. /** z value of the vector */
  71078. z: number,
  71079. /** w value of the vector */
  71080. w: number);
  71081. /**
  71082. * Returns the string with the Vector4 coordinates.
  71083. * @returns a string containing all the vector values
  71084. */
  71085. toString(): string;
  71086. /**
  71087. * Returns the string "Vector4".
  71088. * @returns "Vector4"
  71089. */
  71090. getClassName(): string;
  71091. /**
  71092. * Returns the Vector4 hash code.
  71093. * @returns a unique hash code
  71094. */
  71095. getHashCode(): number;
  71096. /**
  71097. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  71098. * @returns the resulting array
  71099. */
  71100. asArray(): number[];
  71101. /**
  71102. * Populates the given array from the given index with the Vector4 coordinates.
  71103. * @param array array to populate
  71104. * @param index index of the array to start at (default: 0)
  71105. * @returns the Vector4.
  71106. */
  71107. toArray(array: FloatArray, index?: number): Vector4;
  71108. /**
  71109. * Adds the given vector to the current Vector4.
  71110. * @param otherVector the vector to add
  71111. * @returns the updated Vector4.
  71112. */
  71113. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  71114. /**
  71115. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  71116. * @param otherVector the vector to add
  71117. * @returns the resulting vector
  71118. */
  71119. add(otherVector: DeepImmutable<Vector4>): Vector4;
  71120. /**
  71121. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  71122. * @param otherVector the vector to add
  71123. * @param result the vector to store the result
  71124. * @returns the current Vector4.
  71125. */
  71126. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71127. /**
  71128. * Subtract in place the given vector from the current Vector4.
  71129. * @param otherVector the vector to subtract
  71130. * @returns the updated Vector4.
  71131. */
  71132. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  71133. /**
  71134. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  71135. * @param otherVector the vector to add
  71136. * @returns the new vector with the result
  71137. */
  71138. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  71139. /**
  71140. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  71141. * @param otherVector the vector to subtract
  71142. * @param result the vector to store the result
  71143. * @returns the current Vector4.
  71144. */
  71145. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71146. /**
  71147. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  71148. */
  71149. /**
  71150. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  71151. * @param x value to subtract
  71152. * @param y value to subtract
  71153. * @param z value to subtract
  71154. * @param w value to subtract
  71155. * @returns new vector containing the result
  71156. */
  71157. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  71158. /**
  71159. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  71160. * @param x value to subtract
  71161. * @param y value to subtract
  71162. * @param z value to subtract
  71163. * @param w value to subtract
  71164. * @param result the vector to store the result in
  71165. * @returns the current Vector4.
  71166. */
  71167. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  71168. /**
  71169. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  71170. * @returns a new vector with the negated values
  71171. */
  71172. negate(): Vector4;
  71173. /**
  71174. * Multiplies the current Vector4 coordinates by scale (float).
  71175. * @param scale the number to scale with
  71176. * @returns the updated Vector4.
  71177. */
  71178. scaleInPlace(scale: number): Vector4;
  71179. /**
  71180. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  71181. * @param scale the number to scale with
  71182. * @returns a new vector with the result
  71183. */
  71184. scale(scale: number): Vector4;
  71185. /**
  71186. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  71187. * @param scale the number to scale with
  71188. * @param result a vector to store the result in
  71189. * @returns the current Vector4.
  71190. */
  71191. scaleToRef(scale: number, result: Vector4): Vector4;
  71192. /**
  71193. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  71194. * @param scale defines the scale factor
  71195. * @param result defines the Vector4 object where to store the result
  71196. * @returns the unmodified current Vector4
  71197. */
  71198. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  71199. /**
  71200. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  71201. * @param otherVector the vector to compare against
  71202. * @returns true if they are equal
  71203. */
  71204. equals(otherVector: DeepImmutable<Vector4>): boolean;
  71205. /**
  71206. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  71207. * @param otherVector vector to compare against
  71208. * @param epsilon (Default: very small number)
  71209. * @returns true if they are equal
  71210. */
  71211. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  71212. /**
  71213. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  71214. * @param x x value to compare against
  71215. * @param y y value to compare against
  71216. * @param z z value to compare against
  71217. * @param w w value to compare against
  71218. * @returns true if equal
  71219. */
  71220. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  71221. /**
  71222. * Multiplies in place the current Vector4 by the given one.
  71223. * @param otherVector vector to multiple with
  71224. * @returns the updated Vector4.
  71225. */
  71226. multiplyInPlace(otherVector: Vector4): Vector4;
  71227. /**
  71228. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  71229. * @param otherVector vector to multiple with
  71230. * @returns resulting new vector
  71231. */
  71232. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  71233. /**
  71234. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  71235. * @param otherVector vector to multiple with
  71236. * @param result vector to store the result
  71237. * @returns the current Vector4.
  71238. */
  71239. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71240. /**
  71241. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  71242. * @param x x value multiply with
  71243. * @param y y value multiply with
  71244. * @param z z value multiply with
  71245. * @param w w value multiply with
  71246. * @returns resulting new vector
  71247. */
  71248. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  71249. /**
  71250. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  71251. * @param otherVector vector to devide with
  71252. * @returns resulting new vector
  71253. */
  71254. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  71255. /**
  71256. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  71257. * @param otherVector vector to devide with
  71258. * @param result vector to store the result
  71259. * @returns the current Vector4.
  71260. */
  71261. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71262. /**
  71263. * Divides the current Vector3 coordinates by the given ones.
  71264. * @param otherVector vector to devide with
  71265. * @returns the updated Vector3.
  71266. */
  71267. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  71268. /**
  71269. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  71270. * @param other defines the second operand
  71271. * @returns the current updated Vector4
  71272. */
  71273. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  71274. /**
  71275. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  71276. * @param other defines the second operand
  71277. * @returns the current updated Vector4
  71278. */
  71279. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  71280. /**
  71281. * Gets a new Vector4 from current Vector4 floored values
  71282. * @returns a new Vector4
  71283. */
  71284. floor(): Vector4;
  71285. /**
  71286. * Gets a new Vector4 from current Vector3 floored values
  71287. * @returns a new Vector4
  71288. */
  71289. fract(): Vector4;
  71290. /**
  71291. * Returns the Vector4 length (float).
  71292. * @returns the length
  71293. */
  71294. length(): number;
  71295. /**
  71296. * Returns the Vector4 squared length (float).
  71297. * @returns the length squared
  71298. */
  71299. lengthSquared(): number;
  71300. /**
  71301. * Normalizes in place the Vector4.
  71302. * @returns the updated Vector4.
  71303. */
  71304. normalize(): Vector4;
  71305. /**
  71306. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  71307. * @returns this converted to a new vector3
  71308. */
  71309. toVector3(): Vector3;
  71310. /**
  71311. * Returns a new Vector4 copied from the current one.
  71312. * @returns the new cloned vector
  71313. */
  71314. clone(): Vector4;
  71315. /**
  71316. * Updates the current Vector4 with the given one coordinates.
  71317. * @param source the source vector to copy from
  71318. * @returns the updated Vector4.
  71319. */
  71320. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  71321. /**
  71322. * Updates the current Vector4 coordinates with the given floats.
  71323. * @param x float to copy from
  71324. * @param y float to copy from
  71325. * @param z float to copy from
  71326. * @param w float to copy from
  71327. * @returns the updated Vector4.
  71328. */
  71329. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  71330. /**
  71331. * Updates the current Vector4 coordinates with the given floats.
  71332. * @param x float to set from
  71333. * @param y float to set from
  71334. * @param z float to set from
  71335. * @param w float to set from
  71336. * @returns the updated Vector4.
  71337. */
  71338. set(x: number, y: number, z: number, w: number): Vector4;
  71339. /**
  71340. * Copies the given float to the current Vector3 coordinates
  71341. * @param v defines the x, y, z and w coordinates of the operand
  71342. * @returns the current updated Vector3
  71343. */
  71344. setAll(v: number): Vector4;
  71345. /**
  71346. * Returns a new Vector4 set from the starting index of the given array.
  71347. * @param array the array to pull values from
  71348. * @param offset the offset into the array to start at
  71349. * @returns the new vector
  71350. */
  71351. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  71352. /**
  71353. * Updates the given vector "result" from the starting index of the given array.
  71354. * @param array the array to pull values from
  71355. * @param offset the offset into the array to start at
  71356. * @param result the vector to store the result in
  71357. */
  71358. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  71359. /**
  71360. * Updates the given vector "result" from the starting index of the given Float32Array.
  71361. * @param array the array to pull values from
  71362. * @param offset the offset into the array to start at
  71363. * @param result the vector to store the result in
  71364. */
  71365. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  71366. /**
  71367. * Updates the given vector "result" coordinates from the given floats.
  71368. * @param x float to set from
  71369. * @param y float to set from
  71370. * @param z float to set from
  71371. * @param w float to set from
  71372. * @param result the vector to the floats in
  71373. */
  71374. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  71375. /**
  71376. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  71377. * @returns the new vector
  71378. */
  71379. static Zero(): Vector4;
  71380. /**
  71381. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  71382. * @returns the new vector
  71383. */
  71384. static One(): Vector4;
  71385. /**
  71386. * Returns a new normalized Vector4 from the given one.
  71387. * @param vector the vector to normalize
  71388. * @returns the vector
  71389. */
  71390. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  71391. /**
  71392. * Updates the given vector "result" from the normalization of the given one.
  71393. * @param vector the vector to normalize
  71394. * @param result the vector to store the result in
  71395. */
  71396. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  71397. /**
  71398. * Returns a vector with the minimum values from the left and right vectors
  71399. * @param left left vector to minimize
  71400. * @param right right vector to minimize
  71401. * @returns a new vector with the minimum of the left and right vector values
  71402. */
  71403. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  71404. /**
  71405. * Returns a vector with the maximum values from the left and right vectors
  71406. * @param left left vector to maximize
  71407. * @param right right vector to maximize
  71408. * @returns a new vector with the maximum of the left and right vector values
  71409. */
  71410. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  71411. /**
  71412. * Returns the distance (float) between the vectors "value1" and "value2".
  71413. * @param value1 value to calulate the distance between
  71414. * @param value2 value to calulate the distance between
  71415. * @return the distance between the two vectors
  71416. */
  71417. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  71418. /**
  71419. * Returns the squared distance (float) between the vectors "value1" and "value2".
  71420. * @param value1 value to calulate the distance between
  71421. * @param value2 value to calulate the distance between
  71422. * @return the distance between the two vectors squared
  71423. */
  71424. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  71425. /**
  71426. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  71427. * @param value1 value to calulate the center between
  71428. * @param value2 value to calulate the center between
  71429. * @return the center between the two vectors
  71430. */
  71431. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  71432. /**
  71433. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  71434. * This methods computes transformed normalized direction vectors only.
  71435. * @param vector the vector to transform
  71436. * @param transformation the transformation matrix to apply
  71437. * @returns the new vector
  71438. */
  71439. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  71440. /**
  71441. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  71442. * This methods computes transformed normalized direction vectors only.
  71443. * @param vector the vector to transform
  71444. * @param transformation the transformation matrix to apply
  71445. * @param result the vector to store the result in
  71446. */
  71447. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  71448. /**
  71449. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  71450. * This methods computes transformed normalized direction vectors only.
  71451. * @param x value to transform
  71452. * @param y value to transform
  71453. * @param z value to transform
  71454. * @param w value to transform
  71455. * @param transformation the transformation matrix to apply
  71456. * @param result the vector to store the results in
  71457. */
  71458. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  71459. /**
  71460. * Creates a new Vector4 from a Vector3
  71461. * @param source defines the source data
  71462. * @param w defines the 4th component (default is 0)
  71463. * @returns a new Vector4
  71464. */
  71465. static FromVector3(source: Vector3, w?: number): Vector4;
  71466. }
  71467. /**
  71468. * Class used to store quaternion data
  71469. * @see https://en.wikipedia.org/wiki/Quaternion
  71470. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  71471. */
  71472. export class Quaternion {
  71473. /** defines the first component (0 by default) */
  71474. x: number;
  71475. /** defines the second component (0 by default) */
  71476. y: number;
  71477. /** defines the third component (0 by default) */
  71478. z: number;
  71479. /** defines the fourth component (1.0 by default) */
  71480. w: number;
  71481. /**
  71482. * Creates a new Quaternion from the given floats
  71483. * @param x defines the first component (0 by default)
  71484. * @param y defines the second component (0 by default)
  71485. * @param z defines the third component (0 by default)
  71486. * @param w defines the fourth component (1.0 by default)
  71487. */
  71488. constructor(
  71489. /** defines the first component (0 by default) */
  71490. x?: number,
  71491. /** defines the second component (0 by default) */
  71492. y?: number,
  71493. /** defines the third component (0 by default) */
  71494. z?: number,
  71495. /** defines the fourth component (1.0 by default) */
  71496. w?: number);
  71497. /**
  71498. * Gets a string representation for the current quaternion
  71499. * @returns a string with the Quaternion coordinates
  71500. */
  71501. toString(): string;
  71502. /**
  71503. * Gets the class name of the quaternion
  71504. * @returns the string "Quaternion"
  71505. */
  71506. getClassName(): string;
  71507. /**
  71508. * Gets a hash code for this quaternion
  71509. * @returns the quaternion hash code
  71510. */
  71511. getHashCode(): number;
  71512. /**
  71513. * Copy the quaternion to an array
  71514. * @returns a new array populated with 4 elements from the quaternion coordinates
  71515. */
  71516. asArray(): number[];
  71517. /**
  71518. * Check if two quaternions are equals
  71519. * @param otherQuaternion defines the second operand
  71520. * @return true if the current quaternion and the given one coordinates are strictly equals
  71521. */
  71522. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  71523. /**
  71524. * Clone the current quaternion
  71525. * @returns a new quaternion copied from the current one
  71526. */
  71527. clone(): Quaternion;
  71528. /**
  71529. * Copy a quaternion to the current one
  71530. * @param other defines the other quaternion
  71531. * @returns the updated current quaternion
  71532. */
  71533. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  71534. /**
  71535. * Updates the current quaternion with the given float coordinates
  71536. * @param x defines the x coordinate
  71537. * @param y defines the y coordinate
  71538. * @param z defines the z coordinate
  71539. * @param w defines the w coordinate
  71540. * @returns the updated current quaternion
  71541. */
  71542. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  71543. /**
  71544. * Updates the current quaternion from the given float coordinates
  71545. * @param x defines the x coordinate
  71546. * @param y defines the y coordinate
  71547. * @param z defines the z coordinate
  71548. * @param w defines the w coordinate
  71549. * @returns the updated current quaternion
  71550. */
  71551. set(x: number, y: number, z: number, w: number): Quaternion;
  71552. /**
  71553. * Adds two quaternions
  71554. * @param other defines the second operand
  71555. * @returns a new quaternion as the addition result of the given one and the current quaternion
  71556. */
  71557. add(other: DeepImmutable<Quaternion>): Quaternion;
  71558. /**
  71559. * Add a quaternion to the current one
  71560. * @param other defines the quaternion to add
  71561. * @returns the current quaternion
  71562. */
  71563. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  71564. /**
  71565. * Subtract two quaternions
  71566. * @param other defines the second operand
  71567. * @returns a new quaternion as the subtraction result of the given one from the current one
  71568. */
  71569. subtract(other: Quaternion): Quaternion;
  71570. /**
  71571. * Multiplies the current quaternion by a scale factor
  71572. * @param value defines the scale factor
  71573. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  71574. */
  71575. scale(value: number): Quaternion;
  71576. /**
  71577. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  71578. * @param scale defines the scale factor
  71579. * @param result defines the Quaternion object where to store the result
  71580. * @returns the unmodified current quaternion
  71581. */
  71582. scaleToRef(scale: number, result: Quaternion): Quaternion;
  71583. /**
  71584. * Multiplies in place the current quaternion by a scale factor
  71585. * @param value defines the scale factor
  71586. * @returns the current modified quaternion
  71587. */
  71588. scaleInPlace(value: number): Quaternion;
  71589. /**
  71590. * Scale the current quaternion values by a factor and add the result to a given quaternion
  71591. * @param scale defines the scale factor
  71592. * @param result defines the Quaternion object where to store the result
  71593. * @returns the unmodified current quaternion
  71594. */
  71595. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  71596. /**
  71597. * Multiplies two quaternions
  71598. * @param q1 defines the second operand
  71599. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  71600. */
  71601. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  71602. /**
  71603. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  71604. * @param q1 defines the second operand
  71605. * @param result defines the target quaternion
  71606. * @returns the current quaternion
  71607. */
  71608. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  71609. /**
  71610. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  71611. * @param q1 defines the second operand
  71612. * @returns the currentupdated quaternion
  71613. */
  71614. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  71615. /**
  71616. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  71617. * @param ref defines the target quaternion
  71618. * @returns the current quaternion
  71619. */
  71620. conjugateToRef(ref: Quaternion): Quaternion;
  71621. /**
  71622. * Conjugates in place (1-q) the current quaternion
  71623. * @returns the current updated quaternion
  71624. */
  71625. conjugateInPlace(): Quaternion;
  71626. /**
  71627. * Conjugates in place (1-q) the current quaternion
  71628. * @returns a new quaternion
  71629. */
  71630. conjugate(): Quaternion;
  71631. /**
  71632. * Gets length of current quaternion
  71633. * @returns the quaternion length (float)
  71634. */
  71635. length(): number;
  71636. /**
  71637. * Normalize in place the current quaternion
  71638. * @returns the current updated quaternion
  71639. */
  71640. normalize(): Quaternion;
  71641. /**
  71642. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  71643. * @param order is a reserved parameter and is ignore for now
  71644. * @returns a new Vector3 containing the Euler angles
  71645. */
  71646. toEulerAngles(order?: string): Vector3;
  71647. /**
  71648. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  71649. * @param result defines the vector which will be filled with the Euler angles
  71650. * @param order is a reserved parameter and is ignore for now
  71651. * @returns the current unchanged quaternion
  71652. */
  71653. toEulerAnglesToRef(result: Vector3): Quaternion;
  71654. /**
  71655. * Updates the given rotation matrix with the current quaternion values
  71656. * @param result defines the target matrix
  71657. * @returns the current unchanged quaternion
  71658. */
  71659. toRotationMatrix(result: Matrix): Quaternion;
  71660. /**
  71661. * Updates the current quaternion from the given rotation matrix values
  71662. * @param matrix defines the source matrix
  71663. * @returns the current updated quaternion
  71664. */
  71665. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  71666. /**
  71667. * Creates a new quaternion from a rotation matrix
  71668. * @param matrix defines the source matrix
  71669. * @returns a new quaternion created from the given rotation matrix values
  71670. */
  71671. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  71672. /**
  71673. * Updates the given quaternion with the given rotation matrix values
  71674. * @param matrix defines the source matrix
  71675. * @param result defines the target quaternion
  71676. */
  71677. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  71678. /**
  71679. * Returns the dot product (float) between the quaternions "left" and "right"
  71680. * @param left defines the left operand
  71681. * @param right defines the right operand
  71682. * @returns the dot product
  71683. */
  71684. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  71685. /**
  71686. * Checks if the two quaternions are close to each other
  71687. * @param quat0 defines the first quaternion to check
  71688. * @param quat1 defines the second quaternion to check
  71689. * @returns true if the two quaternions are close to each other
  71690. */
  71691. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  71692. /**
  71693. * Creates an empty quaternion
  71694. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  71695. */
  71696. static Zero(): Quaternion;
  71697. /**
  71698. * Inverse a given quaternion
  71699. * @param q defines the source quaternion
  71700. * @returns a new quaternion as the inverted current quaternion
  71701. */
  71702. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  71703. /**
  71704. * Inverse a given quaternion
  71705. * @param q defines the source quaternion
  71706. * @param result the quaternion the result will be stored in
  71707. * @returns the result quaternion
  71708. */
  71709. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  71710. /**
  71711. * Creates an identity quaternion
  71712. * @returns the identity quaternion
  71713. */
  71714. static Identity(): Quaternion;
  71715. /**
  71716. * Gets a boolean indicating if the given quaternion is identity
  71717. * @param quaternion defines the quaternion to check
  71718. * @returns true if the quaternion is identity
  71719. */
  71720. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  71721. /**
  71722. * Creates a quaternion from a rotation around an axis
  71723. * @param axis defines the axis to use
  71724. * @param angle defines the angle to use
  71725. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  71726. */
  71727. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  71728. /**
  71729. * Creates a rotation around an axis and stores it into the given quaternion
  71730. * @param axis defines the axis to use
  71731. * @param angle defines the angle to use
  71732. * @param result defines the target quaternion
  71733. * @returns the target quaternion
  71734. */
  71735. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  71736. /**
  71737. * Creates a new quaternion from data stored into an array
  71738. * @param array defines the data source
  71739. * @param offset defines the offset in the source array where the data starts
  71740. * @returns a new quaternion
  71741. */
  71742. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  71743. /**
  71744. * Create a quaternion from Euler rotation angles
  71745. * @param x Pitch
  71746. * @param y Yaw
  71747. * @param z Roll
  71748. * @returns the new Quaternion
  71749. */
  71750. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  71751. /**
  71752. * Updates a quaternion from Euler rotation angles
  71753. * @param x Pitch
  71754. * @param y Yaw
  71755. * @param z Roll
  71756. * @param result the quaternion to store the result
  71757. * @returns the updated quaternion
  71758. */
  71759. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  71760. /**
  71761. * Create a quaternion from Euler rotation vector
  71762. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  71763. * @returns the new Quaternion
  71764. */
  71765. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  71766. /**
  71767. * Updates a quaternion from Euler rotation vector
  71768. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  71769. * @param result the quaternion to store the result
  71770. * @returns the updated quaternion
  71771. */
  71772. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  71773. /**
  71774. * Creates a new quaternion from the given Euler float angles (y, x, z)
  71775. * @param yaw defines the rotation around Y axis
  71776. * @param pitch defines the rotation around X axis
  71777. * @param roll defines the rotation around Z axis
  71778. * @returns the new quaternion
  71779. */
  71780. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  71781. /**
  71782. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  71783. * @param yaw defines the rotation around Y axis
  71784. * @param pitch defines the rotation around X axis
  71785. * @param roll defines the rotation around Z axis
  71786. * @param result defines the target quaternion
  71787. */
  71788. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  71789. /**
  71790. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  71791. * @param alpha defines the rotation around first axis
  71792. * @param beta defines the rotation around second axis
  71793. * @param gamma defines the rotation around third axis
  71794. * @returns the new quaternion
  71795. */
  71796. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  71797. /**
  71798. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  71799. * @param alpha defines the rotation around first axis
  71800. * @param beta defines the rotation around second axis
  71801. * @param gamma defines the rotation around third axis
  71802. * @param result defines the target quaternion
  71803. */
  71804. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  71805. /**
  71806. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  71807. * @param axis1 defines the first axis
  71808. * @param axis2 defines the second axis
  71809. * @param axis3 defines the third axis
  71810. * @returns the new quaternion
  71811. */
  71812. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  71813. /**
  71814. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  71815. * @param axis1 defines the first axis
  71816. * @param axis2 defines the second axis
  71817. * @param axis3 defines the third axis
  71818. * @param ref defines the target quaternion
  71819. */
  71820. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  71821. /**
  71822. * Interpolates between two quaternions
  71823. * @param left defines first quaternion
  71824. * @param right defines second quaternion
  71825. * @param amount defines the gradient to use
  71826. * @returns the new interpolated quaternion
  71827. */
  71828. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  71829. /**
  71830. * Interpolates between two quaternions and stores it into a target quaternion
  71831. * @param left defines first quaternion
  71832. * @param right defines second quaternion
  71833. * @param amount defines the gradient to use
  71834. * @param result defines the target quaternion
  71835. */
  71836. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  71837. /**
  71838. * Interpolate between two quaternions using Hermite interpolation
  71839. * @param value1 defines first quaternion
  71840. * @param tangent1 defines the incoming tangent
  71841. * @param value2 defines second quaternion
  71842. * @param tangent2 defines the outgoing tangent
  71843. * @param amount defines the target quaternion
  71844. * @returns the new interpolated quaternion
  71845. */
  71846. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  71847. }
  71848. /**
  71849. * Class used to store matrix data (4x4)
  71850. */
  71851. export class Matrix {
  71852. private static _updateFlagSeed;
  71853. private static _identityReadOnly;
  71854. private _isIdentity;
  71855. private _isIdentityDirty;
  71856. private _isIdentity3x2;
  71857. private _isIdentity3x2Dirty;
  71858. /**
  71859. * Gets the update flag of the matrix which is an unique number for the matrix.
  71860. * It will be incremented every time the matrix data change.
  71861. * You can use it to speed the comparison between two versions of the same matrix.
  71862. */
  71863. updateFlag: number;
  71864. private readonly _m;
  71865. /**
  71866. * Gets the internal data of the matrix
  71867. */
  71868. readonly m: DeepImmutable<Float32Array>;
  71869. /** @hidden */
  71870. _markAsUpdated(): void;
  71871. /** @hidden */
  71872. private _updateIdentityStatus;
  71873. /**
  71874. * Creates an empty matrix (filled with zeros)
  71875. */
  71876. constructor();
  71877. /**
  71878. * Check if the current matrix is identity
  71879. * @returns true is the matrix is the identity matrix
  71880. */
  71881. isIdentity(): boolean;
  71882. /**
  71883. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  71884. * @returns true is the matrix is the identity matrix
  71885. */
  71886. isIdentityAs3x2(): boolean;
  71887. /**
  71888. * Gets the determinant of the matrix
  71889. * @returns the matrix determinant
  71890. */
  71891. determinant(): number;
  71892. /**
  71893. * Returns the matrix as a Float32Array
  71894. * @returns the matrix underlying array
  71895. */
  71896. toArray(): DeepImmutable<Float32Array>;
  71897. /**
  71898. * Returns the matrix as a Float32Array
  71899. * @returns the matrix underlying array.
  71900. */
  71901. asArray(): DeepImmutable<Float32Array>;
  71902. /**
  71903. * Inverts the current matrix in place
  71904. * @returns the current inverted matrix
  71905. */
  71906. invert(): Matrix;
  71907. /**
  71908. * Sets all the matrix elements to zero
  71909. * @returns the current matrix
  71910. */
  71911. reset(): Matrix;
  71912. /**
  71913. * Adds the current matrix with a second one
  71914. * @param other defines the matrix to add
  71915. * @returns a new matrix as the addition of the current matrix and the given one
  71916. */
  71917. add(other: DeepImmutable<Matrix>): Matrix;
  71918. /**
  71919. * Sets the given matrix "result" to the addition of the current matrix and the given one
  71920. * @param other defines the matrix to add
  71921. * @param result defines the target matrix
  71922. * @returns the current matrix
  71923. */
  71924. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  71925. /**
  71926. * Adds in place the given matrix to the current matrix
  71927. * @param other defines the second operand
  71928. * @returns the current updated matrix
  71929. */
  71930. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  71931. /**
  71932. * Sets the given matrix to the current inverted Matrix
  71933. * @param other defines the target matrix
  71934. * @returns the unmodified current matrix
  71935. */
  71936. invertToRef(other: Matrix): Matrix;
  71937. /**
  71938. * add a value at the specified position in the current Matrix
  71939. * @param index the index of the value within the matrix. between 0 and 15.
  71940. * @param value the value to be added
  71941. * @returns the current updated matrix
  71942. */
  71943. addAtIndex(index: number, value: number): Matrix;
  71944. /**
  71945. * mutiply the specified position in the current Matrix by a value
  71946. * @param index the index of the value within the matrix. between 0 and 15.
  71947. * @param value the value to be added
  71948. * @returns the current updated matrix
  71949. */
  71950. multiplyAtIndex(index: number, value: number): Matrix;
  71951. /**
  71952. * Inserts the translation vector (using 3 floats) in the current matrix
  71953. * @param x defines the 1st component of the translation
  71954. * @param y defines the 2nd component of the translation
  71955. * @param z defines the 3rd component of the translation
  71956. * @returns the current updated matrix
  71957. */
  71958. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  71959. /**
  71960. * Adds the translation vector (using 3 floats) in the current matrix
  71961. * @param x defines the 1st component of the translation
  71962. * @param y defines the 2nd component of the translation
  71963. * @param z defines the 3rd component of the translation
  71964. * @returns the current updated matrix
  71965. */
  71966. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  71967. /**
  71968. * Inserts the translation vector in the current matrix
  71969. * @param vector3 defines the translation to insert
  71970. * @returns the current updated matrix
  71971. */
  71972. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  71973. /**
  71974. * Gets the translation value of the current matrix
  71975. * @returns a new Vector3 as the extracted translation from the matrix
  71976. */
  71977. getTranslation(): Vector3;
  71978. /**
  71979. * Fill a Vector3 with the extracted translation from the matrix
  71980. * @param result defines the Vector3 where to store the translation
  71981. * @returns the current matrix
  71982. */
  71983. getTranslationToRef(result: Vector3): Matrix;
  71984. /**
  71985. * Remove rotation and scaling part from the matrix
  71986. * @returns the updated matrix
  71987. */
  71988. removeRotationAndScaling(): Matrix;
  71989. /**
  71990. * Multiply two matrices
  71991. * @param other defines the second operand
  71992. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  71993. */
  71994. multiply(other: DeepImmutable<Matrix>): Matrix;
  71995. /**
  71996. * Copy the current matrix from the given one
  71997. * @param other defines the source matrix
  71998. * @returns the current updated matrix
  71999. */
  72000. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  72001. /**
  72002. * Populates the given array from the starting index with the current matrix values
  72003. * @param array defines the target array
  72004. * @param offset defines the offset in the target array where to start storing values
  72005. * @returns the current matrix
  72006. */
  72007. copyToArray(array: Float32Array, offset?: number): Matrix;
  72008. /**
  72009. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  72010. * @param other defines the second operand
  72011. * @param result defines the matrix where to store the multiplication
  72012. * @returns the current matrix
  72013. */
  72014. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  72015. /**
  72016. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  72017. * @param other defines the second operand
  72018. * @param result defines the array where to store the multiplication
  72019. * @param offset defines the offset in the target array where to start storing values
  72020. * @returns the current matrix
  72021. */
  72022. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  72023. /**
  72024. * Check equality between this matrix and a second one
  72025. * @param value defines the second matrix to compare
  72026. * @returns true is the current matrix and the given one values are strictly equal
  72027. */
  72028. equals(value: DeepImmutable<Matrix>): boolean;
  72029. /**
  72030. * Clone the current matrix
  72031. * @returns a new matrix from the current matrix
  72032. */
  72033. clone(): Matrix;
  72034. /**
  72035. * Returns the name of the current matrix class
  72036. * @returns the string "Matrix"
  72037. */
  72038. getClassName(): string;
  72039. /**
  72040. * Gets the hash code of the current matrix
  72041. * @returns the hash code
  72042. */
  72043. getHashCode(): number;
  72044. /**
  72045. * Decomposes the current Matrix into a translation, rotation and scaling components
  72046. * @param scale defines the scale vector3 given as a reference to update
  72047. * @param rotation defines the rotation quaternion given as a reference to update
  72048. * @param translation defines the translation vector3 given as a reference to update
  72049. * @returns true if operation was successful
  72050. */
  72051. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  72052. /**
  72053. * Gets specific row of the matrix
  72054. * @param index defines the number of the row to get
  72055. * @returns the index-th row of the current matrix as a new Vector4
  72056. */
  72057. getRow(index: number): Nullable<Vector4>;
  72058. /**
  72059. * Sets the index-th row of the current matrix to the vector4 values
  72060. * @param index defines the number of the row to set
  72061. * @param row defines the target vector4
  72062. * @returns the updated current matrix
  72063. */
  72064. setRow(index: number, row: Vector4): Matrix;
  72065. /**
  72066. * Compute the transpose of the matrix
  72067. * @returns the new transposed matrix
  72068. */
  72069. transpose(): Matrix;
  72070. /**
  72071. * Compute the transpose of the matrix and store it in a given matrix
  72072. * @param result defines the target matrix
  72073. * @returns the current matrix
  72074. */
  72075. transposeToRef(result: Matrix): Matrix;
  72076. /**
  72077. * Sets the index-th row of the current matrix with the given 4 x float values
  72078. * @param index defines the row index
  72079. * @param x defines the x component to set
  72080. * @param y defines the y component to set
  72081. * @param z defines the z component to set
  72082. * @param w defines the w component to set
  72083. * @returns the updated current matrix
  72084. */
  72085. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  72086. /**
  72087. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  72088. * @param scale defines the scale factor
  72089. * @returns a new matrix
  72090. */
  72091. scale(scale: number): Matrix;
  72092. /**
  72093. * Scale the current matrix values by a factor to a given result matrix
  72094. * @param scale defines the scale factor
  72095. * @param result defines the matrix to store the result
  72096. * @returns the current matrix
  72097. */
  72098. scaleToRef(scale: number, result: Matrix): Matrix;
  72099. /**
  72100. * Scale the current matrix values by a factor and add the result to a given matrix
  72101. * @param scale defines the scale factor
  72102. * @param result defines the Matrix to store the result
  72103. * @returns the current matrix
  72104. */
  72105. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  72106. /**
  72107. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  72108. * @param ref matrix to store the result
  72109. */
  72110. toNormalMatrix(ref: Matrix): void;
  72111. /**
  72112. * Gets only rotation part of the current matrix
  72113. * @returns a new matrix sets to the extracted rotation matrix from the current one
  72114. */
  72115. getRotationMatrix(): Matrix;
  72116. /**
  72117. * Extracts the rotation matrix from the current one and sets it as the given "result"
  72118. * @param result defines the target matrix to store data to
  72119. * @returns the current matrix
  72120. */
  72121. getRotationMatrixToRef(result: Matrix): Matrix;
  72122. /**
  72123. * Toggles model matrix from being right handed to left handed in place and vice versa
  72124. */
  72125. toggleModelMatrixHandInPlace(): void;
  72126. /**
  72127. * Toggles projection matrix from being right handed to left handed in place and vice versa
  72128. */
  72129. toggleProjectionMatrixHandInPlace(): void;
  72130. /**
  72131. * Creates a matrix from an array
  72132. * @param array defines the source array
  72133. * @param offset defines an offset in the source array
  72134. * @returns a new Matrix set from the starting index of the given array
  72135. */
  72136. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  72137. /**
  72138. * Copy the content of an array into a given matrix
  72139. * @param array defines the source array
  72140. * @param offset defines an offset in the source array
  72141. * @param result defines the target matrix
  72142. */
  72143. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  72144. /**
  72145. * Stores an array into a matrix after having multiplied each component by a given factor
  72146. * @param array defines the source array
  72147. * @param offset defines the offset in the source array
  72148. * @param scale defines the scaling factor
  72149. * @param result defines the target matrix
  72150. */
  72151. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  72152. /**
  72153. * Gets an identity matrix that must not be updated
  72154. */
  72155. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  72156. /**
  72157. * Stores a list of values (16) inside a given matrix
  72158. * @param initialM11 defines 1st value of 1st row
  72159. * @param initialM12 defines 2nd value of 1st row
  72160. * @param initialM13 defines 3rd value of 1st row
  72161. * @param initialM14 defines 4th value of 1st row
  72162. * @param initialM21 defines 1st value of 2nd row
  72163. * @param initialM22 defines 2nd value of 2nd row
  72164. * @param initialM23 defines 3rd value of 2nd row
  72165. * @param initialM24 defines 4th value of 2nd row
  72166. * @param initialM31 defines 1st value of 3rd row
  72167. * @param initialM32 defines 2nd value of 3rd row
  72168. * @param initialM33 defines 3rd value of 3rd row
  72169. * @param initialM34 defines 4th value of 3rd row
  72170. * @param initialM41 defines 1st value of 4th row
  72171. * @param initialM42 defines 2nd value of 4th row
  72172. * @param initialM43 defines 3rd value of 4th row
  72173. * @param initialM44 defines 4th value of 4th row
  72174. * @param result defines the target matrix
  72175. */
  72176. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  72177. /**
  72178. * Creates new matrix from a list of values (16)
  72179. * @param initialM11 defines 1st value of 1st row
  72180. * @param initialM12 defines 2nd value of 1st row
  72181. * @param initialM13 defines 3rd value of 1st row
  72182. * @param initialM14 defines 4th value of 1st row
  72183. * @param initialM21 defines 1st value of 2nd row
  72184. * @param initialM22 defines 2nd value of 2nd row
  72185. * @param initialM23 defines 3rd value of 2nd row
  72186. * @param initialM24 defines 4th value of 2nd row
  72187. * @param initialM31 defines 1st value of 3rd row
  72188. * @param initialM32 defines 2nd value of 3rd row
  72189. * @param initialM33 defines 3rd value of 3rd row
  72190. * @param initialM34 defines 4th value of 3rd row
  72191. * @param initialM41 defines 1st value of 4th row
  72192. * @param initialM42 defines 2nd value of 4th row
  72193. * @param initialM43 defines 3rd value of 4th row
  72194. * @param initialM44 defines 4th value of 4th row
  72195. * @returns the new matrix
  72196. */
  72197. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  72198. /**
  72199. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  72200. * @param scale defines the scale vector3
  72201. * @param rotation defines the rotation quaternion
  72202. * @param translation defines the translation vector3
  72203. * @returns a new matrix
  72204. */
  72205. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  72206. /**
  72207. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  72208. * @param scale defines the scale vector3
  72209. * @param rotation defines the rotation quaternion
  72210. * @param translation defines the translation vector3
  72211. * @param result defines the target matrix
  72212. */
  72213. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  72214. /**
  72215. * Creates a new identity matrix
  72216. * @returns a new identity matrix
  72217. */
  72218. static Identity(): Matrix;
  72219. /**
  72220. * Creates a new identity matrix and stores the result in a given matrix
  72221. * @param result defines the target matrix
  72222. */
  72223. static IdentityToRef(result: Matrix): void;
  72224. /**
  72225. * Creates a new zero matrix
  72226. * @returns a new zero matrix
  72227. */
  72228. static Zero(): Matrix;
  72229. /**
  72230. * Creates a new rotation matrix for "angle" radians around the X axis
  72231. * @param angle defines the angle (in radians) to use
  72232. * @return the new matrix
  72233. */
  72234. static RotationX(angle: number): Matrix;
  72235. /**
  72236. * Creates a new matrix as the invert of a given matrix
  72237. * @param source defines the source matrix
  72238. * @returns the new matrix
  72239. */
  72240. static Invert(source: DeepImmutable<Matrix>): Matrix;
  72241. /**
  72242. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  72243. * @param angle defines the angle (in radians) to use
  72244. * @param result defines the target matrix
  72245. */
  72246. static RotationXToRef(angle: number, result: Matrix): void;
  72247. /**
  72248. * Creates a new rotation matrix for "angle" radians around the Y axis
  72249. * @param angle defines the angle (in radians) to use
  72250. * @return the new matrix
  72251. */
  72252. static RotationY(angle: number): Matrix;
  72253. /**
  72254. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  72255. * @param angle defines the angle (in radians) to use
  72256. * @param result defines the target matrix
  72257. */
  72258. static RotationYToRef(angle: number, result: Matrix): void;
  72259. /**
  72260. * Creates a new rotation matrix for "angle" radians around the Z axis
  72261. * @param angle defines the angle (in radians) to use
  72262. * @return the new matrix
  72263. */
  72264. static RotationZ(angle: number): Matrix;
  72265. /**
  72266. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  72267. * @param angle defines the angle (in radians) to use
  72268. * @param result defines the target matrix
  72269. */
  72270. static RotationZToRef(angle: number, result: Matrix): void;
  72271. /**
  72272. * Creates a new rotation matrix for "angle" radians around the given axis
  72273. * @param axis defines the axis to use
  72274. * @param angle defines the angle (in radians) to use
  72275. * @return the new matrix
  72276. */
  72277. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  72278. /**
  72279. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  72280. * @param axis defines the axis to use
  72281. * @param angle defines the angle (in radians) to use
  72282. * @param result defines the target matrix
  72283. */
  72284. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  72285. /**
  72286. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  72287. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  72288. * @param from defines the vector to align
  72289. * @param to defines the vector to align to
  72290. * @param result defines the target matrix
  72291. */
  72292. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  72293. /**
  72294. * Creates a rotation matrix
  72295. * @param yaw defines the yaw angle in radians (Y axis)
  72296. * @param pitch defines the pitch angle in radians (X axis)
  72297. * @param roll defines the roll angle in radians (X axis)
  72298. * @returns the new rotation matrix
  72299. */
  72300. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  72301. /**
  72302. * Creates a rotation matrix and stores it in a given matrix
  72303. * @param yaw defines the yaw angle in radians (Y axis)
  72304. * @param pitch defines the pitch angle in radians (X axis)
  72305. * @param roll defines the roll angle in radians (X axis)
  72306. * @param result defines the target matrix
  72307. */
  72308. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  72309. /**
  72310. * Creates a scaling matrix
  72311. * @param x defines the scale factor on X axis
  72312. * @param y defines the scale factor on Y axis
  72313. * @param z defines the scale factor on Z axis
  72314. * @returns the new matrix
  72315. */
  72316. static Scaling(x: number, y: number, z: number): Matrix;
  72317. /**
  72318. * Creates a scaling matrix and stores it in a given matrix
  72319. * @param x defines the scale factor on X axis
  72320. * @param y defines the scale factor on Y axis
  72321. * @param z defines the scale factor on Z axis
  72322. * @param result defines the target matrix
  72323. */
  72324. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  72325. /**
  72326. * Creates a translation matrix
  72327. * @param x defines the translation on X axis
  72328. * @param y defines the translation on Y axis
  72329. * @param z defines the translationon Z axis
  72330. * @returns the new matrix
  72331. */
  72332. static Translation(x: number, y: number, z: number): Matrix;
  72333. /**
  72334. * Creates a translation matrix and stores it in a given matrix
  72335. * @param x defines the translation on X axis
  72336. * @param y defines the translation on Y axis
  72337. * @param z defines the translationon Z axis
  72338. * @param result defines the target matrix
  72339. */
  72340. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  72341. /**
  72342. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  72343. * @param startValue defines the start value
  72344. * @param endValue defines the end value
  72345. * @param gradient defines the gradient factor
  72346. * @returns the new matrix
  72347. */
  72348. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  72349. /**
  72350. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  72351. * @param startValue defines the start value
  72352. * @param endValue defines the end value
  72353. * @param gradient defines the gradient factor
  72354. * @param result defines the Matrix object where to store data
  72355. */
  72356. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  72357. /**
  72358. * Builds a new matrix whose values are computed by:
  72359. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  72360. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  72361. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  72362. * @param startValue defines the first matrix
  72363. * @param endValue defines the second matrix
  72364. * @param gradient defines the gradient between the two matrices
  72365. * @returns the new matrix
  72366. */
  72367. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  72368. /**
  72369. * Update a matrix to values which are computed by:
  72370. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  72371. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  72372. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  72373. * @param startValue defines the first matrix
  72374. * @param endValue defines the second matrix
  72375. * @param gradient defines the gradient between the two matrices
  72376. * @param result defines the target matrix
  72377. */
  72378. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  72379. /**
  72380. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  72381. * This function works in left handed mode
  72382. * @param eye defines the final position of the entity
  72383. * @param target defines where the entity should look at
  72384. * @param up defines the up vector for the entity
  72385. * @returns the new matrix
  72386. */
  72387. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  72388. /**
  72389. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  72390. * This function works in left handed mode
  72391. * @param eye defines the final position of the entity
  72392. * @param target defines where the entity should look at
  72393. * @param up defines the up vector for the entity
  72394. * @param result defines the target matrix
  72395. */
  72396. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  72397. /**
  72398. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  72399. * This function works in right handed mode
  72400. * @param eye defines the final position of the entity
  72401. * @param target defines where the entity should look at
  72402. * @param up defines the up vector for the entity
  72403. * @returns the new matrix
  72404. */
  72405. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  72406. /**
  72407. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  72408. * This function works in right handed mode
  72409. * @param eye defines the final position of the entity
  72410. * @param target defines where the entity should look at
  72411. * @param up defines the up vector for the entity
  72412. * @param result defines the target matrix
  72413. */
  72414. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  72415. /**
  72416. * Create a left-handed orthographic projection matrix
  72417. * @param width defines the viewport width
  72418. * @param height defines the viewport height
  72419. * @param znear defines the near clip plane
  72420. * @param zfar defines the far clip plane
  72421. * @returns a new matrix as a left-handed orthographic projection matrix
  72422. */
  72423. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  72424. /**
  72425. * Store a left-handed orthographic projection to a given matrix
  72426. * @param width defines the viewport width
  72427. * @param height defines the viewport height
  72428. * @param znear defines the near clip plane
  72429. * @param zfar defines the far clip plane
  72430. * @param result defines the target matrix
  72431. */
  72432. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  72433. /**
  72434. * Create a left-handed orthographic projection matrix
  72435. * @param left defines the viewport left coordinate
  72436. * @param right defines the viewport right coordinate
  72437. * @param bottom defines the viewport bottom coordinate
  72438. * @param top defines the viewport top coordinate
  72439. * @param znear defines the near clip plane
  72440. * @param zfar defines the far clip plane
  72441. * @returns a new matrix as a left-handed orthographic projection matrix
  72442. */
  72443. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  72444. /**
  72445. * Stores a left-handed orthographic projection into a given matrix
  72446. * @param left defines the viewport left coordinate
  72447. * @param right defines the viewport right coordinate
  72448. * @param bottom defines the viewport bottom coordinate
  72449. * @param top defines the viewport top coordinate
  72450. * @param znear defines the near clip plane
  72451. * @param zfar defines the far clip plane
  72452. * @param result defines the target matrix
  72453. */
  72454. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  72455. /**
  72456. * Creates a right-handed orthographic projection matrix
  72457. * @param left defines the viewport left coordinate
  72458. * @param right defines the viewport right coordinate
  72459. * @param bottom defines the viewport bottom coordinate
  72460. * @param top defines the viewport top coordinate
  72461. * @param znear defines the near clip plane
  72462. * @param zfar defines the far clip plane
  72463. * @returns a new matrix as a right-handed orthographic projection matrix
  72464. */
  72465. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  72466. /**
  72467. * Stores a right-handed orthographic projection into a given matrix
  72468. * @param left defines the viewport left coordinate
  72469. * @param right defines the viewport right coordinate
  72470. * @param bottom defines the viewport bottom coordinate
  72471. * @param top defines the viewport top coordinate
  72472. * @param znear defines the near clip plane
  72473. * @param zfar defines the far clip plane
  72474. * @param result defines the target matrix
  72475. */
  72476. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  72477. /**
  72478. * Creates a left-handed perspective projection matrix
  72479. * @param width defines the viewport width
  72480. * @param height defines the viewport height
  72481. * @param znear defines the near clip plane
  72482. * @param zfar defines the far clip plane
  72483. * @returns a new matrix as a left-handed perspective projection matrix
  72484. */
  72485. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  72486. /**
  72487. * Creates a left-handed perspective projection matrix
  72488. * @param fov defines the horizontal field of view
  72489. * @param aspect defines the aspect ratio
  72490. * @param znear defines the near clip plane
  72491. * @param zfar defines the far clip plane
  72492. * @returns a new matrix as a left-handed perspective projection matrix
  72493. */
  72494. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  72495. /**
  72496. * Stores a left-handed perspective projection into a given matrix
  72497. * @param fov defines the horizontal field of view
  72498. * @param aspect defines the aspect ratio
  72499. * @param znear defines the near clip plane
  72500. * @param zfar defines the far clip plane
  72501. * @param result defines the target matrix
  72502. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72503. */
  72504. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72505. /**
  72506. * Creates a right-handed perspective projection matrix
  72507. * @param fov defines the horizontal field of view
  72508. * @param aspect defines the aspect ratio
  72509. * @param znear defines the near clip plane
  72510. * @param zfar defines the far clip plane
  72511. * @returns a new matrix as a right-handed perspective projection matrix
  72512. */
  72513. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  72514. /**
  72515. * Stores a right-handed perspective projection into a given matrix
  72516. * @param fov defines the horizontal field of view
  72517. * @param aspect defines the aspect ratio
  72518. * @param znear defines the near clip plane
  72519. * @param zfar defines the far clip plane
  72520. * @param result defines the target matrix
  72521. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72522. */
  72523. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72524. /**
  72525. * Stores a perspective projection for WebVR info a given matrix
  72526. * @param fov defines the field of view
  72527. * @param znear defines the near clip plane
  72528. * @param zfar defines the far clip plane
  72529. * @param result defines the target matrix
  72530. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  72531. */
  72532. static PerspectiveFovWebVRToRef(fov: {
  72533. upDegrees: number;
  72534. downDegrees: number;
  72535. leftDegrees: number;
  72536. rightDegrees: number;
  72537. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  72538. /**
  72539. * Computes a complete transformation matrix
  72540. * @param viewport defines the viewport to use
  72541. * @param world defines the world matrix
  72542. * @param view defines the view matrix
  72543. * @param projection defines the projection matrix
  72544. * @param zmin defines the near clip plane
  72545. * @param zmax defines the far clip plane
  72546. * @returns the transformation matrix
  72547. */
  72548. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  72549. /**
  72550. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  72551. * @param matrix defines the matrix to use
  72552. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  72553. */
  72554. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  72555. /**
  72556. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  72557. * @param matrix defines the matrix to use
  72558. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  72559. */
  72560. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  72561. /**
  72562. * Compute the transpose of a given matrix
  72563. * @param matrix defines the matrix to transpose
  72564. * @returns the new matrix
  72565. */
  72566. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  72567. /**
  72568. * Compute the transpose of a matrix and store it in a target matrix
  72569. * @param matrix defines the matrix to transpose
  72570. * @param result defines the target matrix
  72571. */
  72572. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  72573. /**
  72574. * Computes a reflection matrix from a plane
  72575. * @param plane defines the reflection plane
  72576. * @returns a new matrix
  72577. */
  72578. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  72579. /**
  72580. * Computes a reflection matrix from a plane
  72581. * @param plane defines the reflection plane
  72582. * @param result defines the target matrix
  72583. */
  72584. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  72585. /**
  72586. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  72587. * @param xaxis defines the value of the 1st axis
  72588. * @param yaxis defines the value of the 2nd axis
  72589. * @param zaxis defines the value of the 3rd axis
  72590. * @param result defines the target matrix
  72591. */
  72592. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  72593. /**
  72594. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  72595. * @param quat defines the quaternion to use
  72596. * @param result defines the target matrix
  72597. */
  72598. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  72599. }
  72600. /**
  72601. * @hidden
  72602. */
  72603. export class TmpVectors {
  72604. static Vector2: Vector2[];
  72605. static Vector3: Vector3[];
  72606. static Vector4: Vector4[];
  72607. static Quaternion: Quaternion[];
  72608. static Matrix: Matrix[];
  72609. }
  72610. }
  72611. declare module BABYLON {
  72612. /**
  72613. * Defines potential orientation for back face culling
  72614. */
  72615. export enum Orientation {
  72616. /**
  72617. * Clockwise
  72618. */
  72619. CW = 0,
  72620. /** Counter clockwise */
  72621. CCW = 1
  72622. }
  72623. /** Class used to represent a Bezier curve */
  72624. export class BezierCurve {
  72625. /**
  72626. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  72627. * @param t defines the time
  72628. * @param x1 defines the left coordinate on X axis
  72629. * @param y1 defines the left coordinate on Y axis
  72630. * @param x2 defines the right coordinate on X axis
  72631. * @param y2 defines the right coordinate on Y axis
  72632. * @returns the interpolated value
  72633. */
  72634. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  72635. }
  72636. /**
  72637. * Defines angle representation
  72638. */
  72639. export class Angle {
  72640. private _radians;
  72641. /**
  72642. * Creates an Angle object of "radians" radians (float).
  72643. * @param radians the angle in radians
  72644. */
  72645. constructor(radians: number);
  72646. /**
  72647. * Get value in degrees
  72648. * @returns the Angle value in degrees (float)
  72649. */
  72650. degrees(): number;
  72651. /**
  72652. * Get value in radians
  72653. * @returns the Angle value in radians (float)
  72654. */
  72655. radians(): number;
  72656. /**
  72657. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  72658. * @param a defines first vector
  72659. * @param b defines second vector
  72660. * @returns a new Angle
  72661. */
  72662. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  72663. /**
  72664. * Gets a new Angle object from the given float in radians
  72665. * @param radians defines the angle value in radians
  72666. * @returns a new Angle
  72667. */
  72668. static FromRadians(radians: number): Angle;
  72669. /**
  72670. * Gets a new Angle object from the given float in degrees
  72671. * @param degrees defines the angle value in degrees
  72672. * @returns a new Angle
  72673. */
  72674. static FromDegrees(degrees: number): Angle;
  72675. }
  72676. /**
  72677. * This represents an arc in a 2d space.
  72678. */
  72679. export class Arc2 {
  72680. /** Defines the start point of the arc */
  72681. startPoint: Vector2;
  72682. /** Defines the mid point of the arc */
  72683. midPoint: Vector2;
  72684. /** Defines the end point of the arc */
  72685. endPoint: Vector2;
  72686. /**
  72687. * Defines the center point of the arc.
  72688. */
  72689. centerPoint: Vector2;
  72690. /**
  72691. * Defines the radius of the arc.
  72692. */
  72693. radius: number;
  72694. /**
  72695. * Defines the angle of the arc (from mid point to end point).
  72696. */
  72697. angle: Angle;
  72698. /**
  72699. * Defines the start angle of the arc (from start point to middle point).
  72700. */
  72701. startAngle: Angle;
  72702. /**
  72703. * Defines the orientation of the arc (clock wise/counter clock wise).
  72704. */
  72705. orientation: Orientation;
  72706. /**
  72707. * Creates an Arc object from the three given points : start, middle and end.
  72708. * @param startPoint Defines the start point of the arc
  72709. * @param midPoint Defines the midlle point of the arc
  72710. * @param endPoint Defines the end point of the arc
  72711. */
  72712. constructor(
  72713. /** Defines the start point of the arc */
  72714. startPoint: Vector2,
  72715. /** Defines the mid point of the arc */
  72716. midPoint: Vector2,
  72717. /** Defines the end point of the arc */
  72718. endPoint: Vector2);
  72719. }
  72720. /**
  72721. * Represents a 2D path made up of multiple 2D points
  72722. */
  72723. export class Path2 {
  72724. private _points;
  72725. private _length;
  72726. /**
  72727. * If the path start and end point are the same
  72728. */
  72729. closed: boolean;
  72730. /**
  72731. * Creates a Path2 object from the starting 2D coordinates x and y.
  72732. * @param x the starting points x value
  72733. * @param y the starting points y value
  72734. */
  72735. constructor(x: number, y: number);
  72736. /**
  72737. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  72738. * @param x the added points x value
  72739. * @param y the added points y value
  72740. * @returns the updated Path2.
  72741. */
  72742. addLineTo(x: number, y: number): Path2;
  72743. /**
  72744. * Adds _numberOfSegments_ segments according to the arc definition (middle point coordinates, end point coordinates, the arc start point being the current Path2 last point) to the current Path2.
  72745. * @param midX middle point x value
  72746. * @param midY middle point y value
  72747. * @param endX end point x value
  72748. * @param endY end point y value
  72749. * @param numberOfSegments (default: 36)
  72750. * @returns the updated Path2.
  72751. */
  72752. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  72753. /**
  72754. * Closes the Path2.
  72755. * @returns the Path2.
  72756. */
  72757. close(): Path2;
  72758. /**
  72759. * Gets the sum of the distance between each sequential point in the path
  72760. * @returns the Path2 total length (float).
  72761. */
  72762. length(): number;
  72763. /**
  72764. * Gets the points which construct the path
  72765. * @returns the Path2 internal array of points.
  72766. */
  72767. getPoints(): Vector2[];
  72768. /**
  72769. * Retreives the point at the distance aways from the starting point
  72770. * @param normalizedLengthPosition the length along the path to retreive the point from
  72771. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  72772. */
  72773. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  72774. /**
  72775. * Creates a new path starting from an x and y position
  72776. * @param x starting x value
  72777. * @param y starting y value
  72778. * @returns a new Path2 starting at the coordinates (x, y).
  72779. */
  72780. static StartingAt(x: number, y: number): Path2;
  72781. }
  72782. /**
  72783. * Represents a 3D path made up of multiple 3D points
  72784. */
  72785. export class Path3D {
  72786. /**
  72787. * an array of Vector3, the curve axis of the Path3D
  72788. */
  72789. path: Vector3[];
  72790. private _curve;
  72791. private _distances;
  72792. private _tangents;
  72793. private _normals;
  72794. private _binormals;
  72795. private _raw;
  72796. /**
  72797. * new Path3D(path, normal, raw)
  72798. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  72799. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  72800. * @param path an array of Vector3, the curve axis of the Path3D
  72801. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  72802. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  72803. */
  72804. constructor(
  72805. /**
  72806. * an array of Vector3, the curve axis of the Path3D
  72807. */
  72808. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean);
  72809. /**
  72810. * Returns the Path3D array of successive Vector3 designing its curve.
  72811. * @returns the Path3D array of successive Vector3 designing its curve.
  72812. */
  72813. getCurve(): Vector3[];
  72814. /**
  72815. * Returns an array populated with tangent vectors on each Path3D curve point.
  72816. * @returns an array populated with tangent vectors on each Path3D curve point.
  72817. */
  72818. getTangents(): Vector3[];
  72819. /**
  72820. * Returns an array populated with normal vectors on each Path3D curve point.
  72821. * @returns an array populated with normal vectors on each Path3D curve point.
  72822. */
  72823. getNormals(): Vector3[];
  72824. /**
  72825. * Returns an array populated with binormal vectors on each Path3D curve point.
  72826. * @returns an array populated with binormal vectors on each Path3D curve point.
  72827. */
  72828. getBinormals(): Vector3[];
  72829. /**
  72830. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  72831. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  72832. */
  72833. getDistances(): number[];
  72834. /**
  72835. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  72836. * @param path path which all values are copied into the curves points
  72837. * @param firstNormal which should be projected onto the curve
  72838. * @returns the same object updated.
  72839. */
  72840. update(path: Vector3[], firstNormal?: Nullable<Vector3>): Path3D;
  72841. private _compute;
  72842. private _getFirstNonNullVector;
  72843. private _getLastNonNullVector;
  72844. private _normalVector;
  72845. }
  72846. /**
  72847. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  72848. * A Curve3 is designed from a series of successive Vector3.
  72849. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  72850. */
  72851. export class Curve3 {
  72852. private _points;
  72853. private _length;
  72854. /**
  72855. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  72856. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  72857. * @param v1 (Vector3) the control point
  72858. * @param v2 (Vector3) the end point of the Quadratic Bezier
  72859. * @param nbPoints (integer) the wanted number of points in the curve
  72860. * @returns the created Curve3
  72861. */
  72862. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  72863. /**
  72864. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  72865. * @param v0 (Vector3) the origin point of the Cubic Bezier
  72866. * @param v1 (Vector3) the first control point
  72867. * @param v2 (Vector3) the second control point
  72868. * @param v3 (Vector3) the end point of the Cubic Bezier
  72869. * @param nbPoints (integer) the wanted number of points in the curve
  72870. * @returns the created Curve3
  72871. */
  72872. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  72873. /**
  72874. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  72875. * @param p1 (Vector3) the origin point of the Hermite Spline
  72876. * @param t1 (Vector3) the tangent vector at the origin point
  72877. * @param p2 (Vector3) the end point of the Hermite Spline
  72878. * @param t2 (Vector3) the tangent vector at the end point
  72879. * @param nbPoints (integer) the wanted number of points in the curve
  72880. * @returns the created Curve3
  72881. */
  72882. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  72883. /**
  72884. * Returns a Curve3 object along a CatmullRom Spline curve :
  72885. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  72886. * @param nbPoints (integer) the wanted number of points between each curve control points
  72887. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  72888. * @returns the created Curve3
  72889. */
  72890. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  72891. /**
  72892. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  72893. * A Curve3 is designed from a series of successive Vector3.
  72894. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  72895. * @param points points which make up the curve
  72896. */
  72897. constructor(points: Vector3[]);
  72898. /**
  72899. * @returns the Curve3 stored array of successive Vector3
  72900. */
  72901. getPoints(): Vector3[];
  72902. /**
  72903. * @returns the computed length (float) of the curve.
  72904. */
  72905. length(): number;
  72906. /**
  72907. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  72908. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  72909. * curveA and curveB keep unchanged.
  72910. * @param curve the curve to continue from this curve
  72911. * @returns the newly constructed curve
  72912. */
  72913. continue(curve: DeepImmutable<Curve3>): Curve3;
  72914. private _computeLength;
  72915. }
  72916. }
  72917. declare module BABYLON {
  72918. /**
  72919. * This represents the main contract an easing function should follow.
  72920. * Easing functions are used throughout the animation system.
  72921. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72922. */
  72923. export interface IEasingFunction {
  72924. /**
  72925. * Given an input gradient between 0 and 1, this returns the corrseponding value
  72926. * of the easing function.
  72927. * The link below provides some of the most common examples of easing functions.
  72928. * @see https://easings.net/
  72929. * @param gradient Defines the value between 0 and 1 we want the easing value for
  72930. * @returns the corresponding value on the curve defined by the easing function
  72931. */
  72932. ease(gradient: number): number;
  72933. }
  72934. /**
  72935. * Base class used for every default easing function.
  72936. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72937. */
  72938. export class EasingFunction implements IEasingFunction {
  72939. /**
  72940. * Interpolation follows the mathematical formula associated with the easing function.
  72941. */
  72942. static readonly EASINGMODE_EASEIN: number;
  72943. /**
  72944. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  72945. */
  72946. static readonly EASINGMODE_EASEOUT: number;
  72947. /**
  72948. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  72949. */
  72950. static readonly EASINGMODE_EASEINOUT: number;
  72951. private _easingMode;
  72952. /**
  72953. * Sets the easing mode of the current function.
  72954. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  72955. */
  72956. setEasingMode(easingMode: number): void;
  72957. /**
  72958. * Gets the current easing mode.
  72959. * @returns the easing mode
  72960. */
  72961. getEasingMode(): number;
  72962. /**
  72963. * @hidden
  72964. */
  72965. easeInCore(gradient: number): number;
  72966. /**
  72967. * Given an input gradient between 0 and 1, this returns the corresponding value
  72968. * of the easing function.
  72969. * @param gradient Defines the value between 0 and 1 we want the easing value for
  72970. * @returns the corresponding value on the curve defined by the easing function
  72971. */
  72972. ease(gradient: number): number;
  72973. }
  72974. /**
  72975. * Easing function with a circle shape (see link below).
  72976. * @see https://easings.net/#easeInCirc
  72977. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72978. */
  72979. export class CircleEase extends EasingFunction implements IEasingFunction {
  72980. /** @hidden */
  72981. easeInCore(gradient: number): number;
  72982. }
  72983. /**
  72984. * Easing function with a ease back shape (see link below).
  72985. * @see https://easings.net/#easeInBack
  72986. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  72987. */
  72988. export class BackEase extends EasingFunction implements IEasingFunction {
  72989. /** Defines the amplitude of the function */
  72990. amplitude: number;
  72991. /**
  72992. * Instantiates a back ease easing
  72993. * @see https://easings.net/#easeInBack
  72994. * @param amplitude Defines the amplitude of the function
  72995. */
  72996. constructor(
  72997. /** Defines the amplitude of the function */
  72998. amplitude?: number);
  72999. /** @hidden */
  73000. easeInCore(gradient: number): number;
  73001. }
  73002. /**
  73003. * Easing function with a bouncing shape (see link below).
  73004. * @see https://easings.net/#easeInBounce
  73005. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73006. */
  73007. export class BounceEase extends EasingFunction implements IEasingFunction {
  73008. /** Defines the number of bounces */
  73009. bounces: number;
  73010. /** Defines the amplitude of the bounce */
  73011. bounciness: number;
  73012. /**
  73013. * Instantiates a bounce easing
  73014. * @see https://easings.net/#easeInBounce
  73015. * @param bounces Defines the number of bounces
  73016. * @param bounciness Defines the amplitude of the bounce
  73017. */
  73018. constructor(
  73019. /** Defines the number of bounces */
  73020. bounces?: number,
  73021. /** Defines the amplitude of the bounce */
  73022. bounciness?: number);
  73023. /** @hidden */
  73024. easeInCore(gradient: number): number;
  73025. }
  73026. /**
  73027. * Easing function with a power of 3 shape (see link below).
  73028. * @see https://easings.net/#easeInCubic
  73029. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73030. */
  73031. export class CubicEase extends EasingFunction implements IEasingFunction {
  73032. /** @hidden */
  73033. easeInCore(gradient: number): number;
  73034. }
  73035. /**
  73036. * Easing function with an elastic shape (see link below).
  73037. * @see https://easings.net/#easeInElastic
  73038. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73039. */
  73040. export class ElasticEase extends EasingFunction implements IEasingFunction {
  73041. /** Defines the number of oscillations*/
  73042. oscillations: number;
  73043. /** Defines the amplitude of the oscillations*/
  73044. springiness: number;
  73045. /**
  73046. * Instantiates an elastic easing function
  73047. * @see https://easings.net/#easeInElastic
  73048. * @param oscillations Defines the number of oscillations
  73049. * @param springiness Defines the amplitude of the oscillations
  73050. */
  73051. constructor(
  73052. /** Defines the number of oscillations*/
  73053. oscillations?: number,
  73054. /** Defines the amplitude of the oscillations*/
  73055. springiness?: number);
  73056. /** @hidden */
  73057. easeInCore(gradient: number): number;
  73058. }
  73059. /**
  73060. * Easing function with an exponential shape (see link below).
  73061. * @see https://easings.net/#easeInExpo
  73062. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73063. */
  73064. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  73065. /** Defines the exponent of the function */
  73066. exponent: number;
  73067. /**
  73068. * Instantiates an exponential easing function
  73069. * @see https://easings.net/#easeInExpo
  73070. * @param exponent Defines the exponent of the function
  73071. */
  73072. constructor(
  73073. /** Defines the exponent of the function */
  73074. exponent?: number);
  73075. /** @hidden */
  73076. easeInCore(gradient: number): number;
  73077. }
  73078. /**
  73079. * Easing function with a power shape (see link below).
  73080. * @see https://easings.net/#easeInQuad
  73081. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73082. */
  73083. export class PowerEase extends EasingFunction implements IEasingFunction {
  73084. /** Defines the power of the function */
  73085. power: number;
  73086. /**
  73087. * Instantiates an power base easing function
  73088. * @see https://easings.net/#easeInQuad
  73089. * @param power Defines the power of the function
  73090. */
  73091. constructor(
  73092. /** Defines the power of the function */
  73093. power?: number);
  73094. /** @hidden */
  73095. easeInCore(gradient: number): number;
  73096. }
  73097. /**
  73098. * Easing function with a power of 2 shape (see link below).
  73099. * @see https://easings.net/#easeInQuad
  73100. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73101. */
  73102. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  73103. /** @hidden */
  73104. easeInCore(gradient: number): number;
  73105. }
  73106. /**
  73107. * Easing function with a power of 4 shape (see link below).
  73108. * @see https://easings.net/#easeInQuart
  73109. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73110. */
  73111. export class QuarticEase extends EasingFunction implements IEasingFunction {
  73112. /** @hidden */
  73113. easeInCore(gradient: number): number;
  73114. }
  73115. /**
  73116. * Easing function with a power of 5 shape (see link below).
  73117. * @see https://easings.net/#easeInQuint
  73118. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73119. */
  73120. export class QuinticEase extends EasingFunction implements IEasingFunction {
  73121. /** @hidden */
  73122. easeInCore(gradient: number): number;
  73123. }
  73124. /**
  73125. * Easing function with a sin shape (see link below).
  73126. * @see https://easings.net/#easeInSine
  73127. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73128. */
  73129. export class SineEase extends EasingFunction implements IEasingFunction {
  73130. /** @hidden */
  73131. easeInCore(gradient: number): number;
  73132. }
  73133. /**
  73134. * Easing function with a bezier shape (see link below).
  73135. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  73136. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73137. */
  73138. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  73139. /** Defines the x component of the start tangent in the bezier curve */
  73140. x1: number;
  73141. /** Defines the y component of the start tangent in the bezier curve */
  73142. y1: number;
  73143. /** Defines the x component of the end tangent in the bezier curve */
  73144. x2: number;
  73145. /** Defines the y component of the end tangent in the bezier curve */
  73146. y2: number;
  73147. /**
  73148. * Instantiates a bezier function
  73149. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  73150. * @param x1 Defines the x component of the start tangent in the bezier curve
  73151. * @param y1 Defines the y component of the start tangent in the bezier curve
  73152. * @param x2 Defines the x component of the end tangent in the bezier curve
  73153. * @param y2 Defines the y component of the end tangent in the bezier curve
  73154. */
  73155. constructor(
  73156. /** Defines the x component of the start tangent in the bezier curve */
  73157. x1?: number,
  73158. /** Defines the y component of the start tangent in the bezier curve */
  73159. y1?: number,
  73160. /** Defines the x component of the end tangent in the bezier curve */
  73161. x2?: number,
  73162. /** Defines the y component of the end tangent in the bezier curve */
  73163. y2?: number);
  73164. /** @hidden */
  73165. easeInCore(gradient: number): number;
  73166. }
  73167. }
  73168. declare module BABYLON {
  73169. /**
  73170. * Class used to hold a RBG color
  73171. */
  73172. export class Color3 {
  73173. /**
  73174. * Defines the red component (between 0 and 1, default is 0)
  73175. */
  73176. r: number;
  73177. /**
  73178. * Defines the green component (between 0 and 1, default is 0)
  73179. */
  73180. g: number;
  73181. /**
  73182. * Defines the blue component (between 0 and 1, default is 0)
  73183. */
  73184. b: number;
  73185. /**
  73186. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  73187. * @param r defines the red component (between 0 and 1, default is 0)
  73188. * @param g defines the green component (between 0 and 1, default is 0)
  73189. * @param b defines the blue component (between 0 and 1, default is 0)
  73190. */
  73191. constructor(
  73192. /**
  73193. * Defines the red component (between 0 and 1, default is 0)
  73194. */
  73195. r?: number,
  73196. /**
  73197. * Defines the green component (between 0 and 1, default is 0)
  73198. */
  73199. g?: number,
  73200. /**
  73201. * Defines the blue component (between 0 and 1, default is 0)
  73202. */
  73203. b?: number);
  73204. /**
  73205. * Creates a string with the Color3 current values
  73206. * @returns the string representation of the Color3 object
  73207. */
  73208. toString(): string;
  73209. /**
  73210. * Returns the string "Color3"
  73211. * @returns "Color3"
  73212. */
  73213. getClassName(): string;
  73214. /**
  73215. * Compute the Color3 hash code
  73216. * @returns an unique number that can be used to hash Color3 objects
  73217. */
  73218. getHashCode(): number;
  73219. /**
  73220. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  73221. * @param array defines the array where to store the r,g,b components
  73222. * @param index defines an optional index in the target array to define where to start storing values
  73223. * @returns the current Color3 object
  73224. */
  73225. toArray(array: FloatArray, index?: number): Color3;
  73226. /**
  73227. * Returns a new Color4 object from the current Color3 and the given alpha
  73228. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  73229. * @returns a new Color4 object
  73230. */
  73231. toColor4(alpha?: number): Color4;
  73232. /**
  73233. * Returns a new array populated with 3 numeric elements : red, green and blue values
  73234. * @returns the new array
  73235. */
  73236. asArray(): number[];
  73237. /**
  73238. * Returns the luminance value
  73239. * @returns a float value
  73240. */
  73241. toLuminance(): number;
  73242. /**
  73243. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  73244. * @param otherColor defines the second operand
  73245. * @returns the new Color3 object
  73246. */
  73247. multiply(otherColor: DeepImmutable<Color3>): Color3;
  73248. /**
  73249. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  73250. * @param otherColor defines the second operand
  73251. * @param result defines the Color3 object where to store the result
  73252. * @returns the current Color3
  73253. */
  73254. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73255. /**
  73256. * Determines equality between Color3 objects
  73257. * @param otherColor defines the second operand
  73258. * @returns true if the rgb values are equal to the given ones
  73259. */
  73260. equals(otherColor: DeepImmutable<Color3>): boolean;
  73261. /**
  73262. * Determines equality between the current Color3 object and a set of r,b,g values
  73263. * @param r defines the red component to check
  73264. * @param g defines the green component to check
  73265. * @param b defines the blue component to check
  73266. * @returns true if the rgb values are equal to the given ones
  73267. */
  73268. equalsFloats(r: number, g: number, b: number): boolean;
  73269. /**
  73270. * Multiplies in place each rgb value by scale
  73271. * @param scale defines the scaling factor
  73272. * @returns the updated Color3
  73273. */
  73274. scale(scale: number): Color3;
  73275. /**
  73276. * Multiplies the rgb values by scale and stores the result into "result"
  73277. * @param scale defines the scaling factor
  73278. * @param result defines the Color3 object where to store the result
  73279. * @returns the unmodified current Color3
  73280. */
  73281. scaleToRef(scale: number, result: Color3): Color3;
  73282. /**
  73283. * Scale the current Color3 values by a factor and add the result to a given Color3
  73284. * @param scale defines the scale factor
  73285. * @param result defines color to store the result into
  73286. * @returns the unmodified current Color3
  73287. */
  73288. scaleAndAddToRef(scale: number, result: Color3): Color3;
  73289. /**
  73290. * Clamps the rgb values by the min and max values and stores the result into "result"
  73291. * @param min defines minimum clamping value (default is 0)
  73292. * @param max defines maximum clamping value (default is 1)
  73293. * @param result defines color to store the result into
  73294. * @returns the original Color3
  73295. */
  73296. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  73297. /**
  73298. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  73299. * @param otherColor defines the second operand
  73300. * @returns the new Color3
  73301. */
  73302. add(otherColor: DeepImmutable<Color3>): Color3;
  73303. /**
  73304. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  73305. * @param otherColor defines the second operand
  73306. * @param result defines Color3 object to store the result into
  73307. * @returns the unmodified current Color3
  73308. */
  73309. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73310. /**
  73311. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  73312. * @param otherColor defines the second operand
  73313. * @returns the new Color3
  73314. */
  73315. subtract(otherColor: DeepImmutable<Color3>): Color3;
  73316. /**
  73317. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  73318. * @param otherColor defines the second operand
  73319. * @param result defines Color3 object to store the result into
  73320. * @returns the unmodified current Color3
  73321. */
  73322. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73323. /**
  73324. * Copy the current object
  73325. * @returns a new Color3 copied the current one
  73326. */
  73327. clone(): Color3;
  73328. /**
  73329. * Copies the rgb values from the source in the current Color3
  73330. * @param source defines the source Color3 object
  73331. * @returns the updated Color3 object
  73332. */
  73333. copyFrom(source: DeepImmutable<Color3>): Color3;
  73334. /**
  73335. * Updates the Color3 rgb values from the given floats
  73336. * @param r defines the red component to read from
  73337. * @param g defines the green component to read from
  73338. * @param b defines the blue component to read from
  73339. * @returns the current Color3 object
  73340. */
  73341. copyFromFloats(r: number, g: number, b: number): Color3;
  73342. /**
  73343. * Updates the Color3 rgb values from the given floats
  73344. * @param r defines the red component to read from
  73345. * @param g defines the green component to read from
  73346. * @param b defines the blue component to read from
  73347. * @returns the current Color3 object
  73348. */
  73349. set(r: number, g: number, b: number): Color3;
  73350. /**
  73351. * Compute the Color3 hexadecimal code as a string
  73352. * @returns a string containing the hexadecimal representation of the Color3 object
  73353. */
  73354. toHexString(): string;
  73355. /**
  73356. * Computes a new Color3 converted from the current one to linear space
  73357. * @returns a new Color3 object
  73358. */
  73359. toLinearSpace(): Color3;
  73360. /**
  73361. * Converts current color in rgb space to HSV values
  73362. * @returns a new color3 representing the HSV values
  73363. */
  73364. toHSV(): Color3;
  73365. /**
  73366. * Converts current color in rgb space to HSV values
  73367. * @param result defines the Color3 where to store the HSV values
  73368. */
  73369. toHSVToRef(result: Color3): void;
  73370. /**
  73371. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  73372. * @param convertedColor defines the Color3 object where to store the linear space version
  73373. * @returns the unmodified Color3
  73374. */
  73375. toLinearSpaceToRef(convertedColor: Color3): Color3;
  73376. /**
  73377. * Computes a new Color3 converted from the current one to gamma space
  73378. * @returns a new Color3 object
  73379. */
  73380. toGammaSpace(): Color3;
  73381. /**
  73382. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  73383. * @param convertedColor defines the Color3 object where to store the gamma space version
  73384. * @returns the unmodified Color3
  73385. */
  73386. toGammaSpaceToRef(convertedColor: Color3): Color3;
  73387. private static _BlackReadOnly;
  73388. /**
  73389. * Convert Hue, saturation and value to a Color3 (RGB)
  73390. * @param hue defines the hue
  73391. * @param saturation defines the saturation
  73392. * @param value defines the value
  73393. * @param result defines the Color3 where to store the RGB values
  73394. */
  73395. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  73396. /**
  73397. * Creates a new Color3 from the string containing valid hexadecimal values
  73398. * @param hex defines a string containing valid hexadecimal values
  73399. * @returns a new Color3 object
  73400. */
  73401. static FromHexString(hex: string): Color3;
  73402. /**
  73403. * Creates a new Color3 from the starting index of the given array
  73404. * @param array defines the source array
  73405. * @param offset defines an offset in the source array
  73406. * @returns a new Color3 object
  73407. */
  73408. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  73409. /**
  73410. * Creates a new Color3 from integer values (< 256)
  73411. * @param r defines the red component to read from (value between 0 and 255)
  73412. * @param g defines the green component to read from (value between 0 and 255)
  73413. * @param b defines the blue component to read from (value between 0 and 255)
  73414. * @returns a new Color3 object
  73415. */
  73416. static FromInts(r: number, g: number, b: number): Color3;
  73417. /**
  73418. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  73419. * @param start defines the start Color3 value
  73420. * @param end defines the end Color3 value
  73421. * @param amount defines the gradient value between start and end
  73422. * @returns a new Color3 object
  73423. */
  73424. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  73425. /**
  73426. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  73427. * @param left defines the start value
  73428. * @param right defines the end value
  73429. * @param amount defines the gradient factor
  73430. * @param result defines the Color3 object where to store the result
  73431. */
  73432. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  73433. /**
  73434. * Returns a Color3 value containing a red color
  73435. * @returns a new Color3 object
  73436. */
  73437. static Red(): Color3;
  73438. /**
  73439. * Returns a Color3 value containing a green color
  73440. * @returns a new Color3 object
  73441. */
  73442. static Green(): Color3;
  73443. /**
  73444. * Returns a Color3 value containing a blue color
  73445. * @returns a new Color3 object
  73446. */
  73447. static Blue(): Color3;
  73448. /**
  73449. * Returns a Color3 value containing a black color
  73450. * @returns a new Color3 object
  73451. */
  73452. static Black(): Color3;
  73453. /**
  73454. * Gets a Color3 value containing a black color that must not be updated
  73455. */
  73456. static readonly BlackReadOnly: DeepImmutable<Color3>;
  73457. /**
  73458. * Returns a Color3 value containing a white color
  73459. * @returns a new Color3 object
  73460. */
  73461. static White(): Color3;
  73462. /**
  73463. * Returns a Color3 value containing a purple color
  73464. * @returns a new Color3 object
  73465. */
  73466. static Purple(): Color3;
  73467. /**
  73468. * Returns a Color3 value containing a magenta color
  73469. * @returns a new Color3 object
  73470. */
  73471. static Magenta(): Color3;
  73472. /**
  73473. * Returns a Color3 value containing a yellow color
  73474. * @returns a new Color3 object
  73475. */
  73476. static Yellow(): Color3;
  73477. /**
  73478. * Returns a Color3 value containing a gray color
  73479. * @returns a new Color3 object
  73480. */
  73481. static Gray(): Color3;
  73482. /**
  73483. * Returns a Color3 value containing a teal color
  73484. * @returns a new Color3 object
  73485. */
  73486. static Teal(): Color3;
  73487. /**
  73488. * Returns a Color3 value containing a random color
  73489. * @returns a new Color3 object
  73490. */
  73491. static Random(): Color3;
  73492. }
  73493. /**
  73494. * Class used to hold a RBGA color
  73495. */
  73496. export class Color4 {
  73497. /**
  73498. * Defines the red component (between 0 and 1, default is 0)
  73499. */
  73500. r: number;
  73501. /**
  73502. * Defines the green component (between 0 and 1, default is 0)
  73503. */
  73504. g: number;
  73505. /**
  73506. * Defines the blue component (between 0 and 1, default is 0)
  73507. */
  73508. b: number;
  73509. /**
  73510. * Defines the alpha component (between 0 and 1, default is 1)
  73511. */
  73512. a: number;
  73513. /**
  73514. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  73515. * @param r defines the red component (between 0 and 1, default is 0)
  73516. * @param g defines the green component (between 0 and 1, default is 0)
  73517. * @param b defines the blue component (between 0 and 1, default is 0)
  73518. * @param a defines the alpha component (between 0 and 1, default is 1)
  73519. */
  73520. constructor(
  73521. /**
  73522. * Defines the red component (between 0 and 1, default is 0)
  73523. */
  73524. r?: number,
  73525. /**
  73526. * Defines the green component (between 0 and 1, default is 0)
  73527. */
  73528. g?: number,
  73529. /**
  73530. * Defines the blue component (between 0 and 1, default is 0)
  73531. */
  73532. b?: number,
  73533. /**
  73534. * Defines the alpha component (between 0 and 1, default is 1)
  73535. */
  73536. a?: number);
  73537. /**
  73538. * Adds in place the given Color4 values to the current Color4 object
  73539. * @param right defines the second operand
  73540. * @returns the current updated Color4 object
  73541. */
  73542. addInPlace(right: DeepImmutable<Color4>): Color4;
  73543. /**
  73544. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  73545. * @returns the new array
  73546. */
  73547. asArray(): number[];
  73548. /**
  73549. * Stores from the starting index in the given array the Color4 successive values
  73550. * @param array defines the array where to store the r,g,b components
  73551. * @param index defines an optional index in the target array to define where to start storing values
  73552. * @returns the current Color4 object
  73553. */
  73554. toArray(array: number[], index?: number): Color4;
  73555. /**
  73556. * Determines equality between Color4 objects
  73557. * @param otherColor defines the second operand
  73558. * @returns true if the rgba values are equal to the given ones
  73559. */
  73560. equals(otherColor: DeepImmutable<Color4>): boolean;
  73561. /**
  73562. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  73563. * @param right defines the second operand
  73564. * @returns a new Color4 object
  73565. */
  73566. add(right: DeepImmutable<Color4>): Color4;
  73567. /**
  73568. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  73569. * @param right defines the second operand
  73570. * @returns a new Color4 object
  73571. */
  73572. subtract(right: DeepImmutable<Color4>): Color4;
  73573. /**
  73574. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  73575. * @param right defines the second operand
  73576. * @param result defines the Color4 object where to store the result
  73577. * @returns the current Color4 object
  73578. */
  73579. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  73580. /**
  73581. * Creates a new Color4 with the current Color4 values multiplied by scale
  73582. * @param scale defines the scaling factor to apply
  73583. * @returns a new Color4 object
  73584. */
  73585. scale(scale: number): Color4;
  73586. /**
  73587. * Multiplies the current Color4 values by scale and stores the result in "result"
  73588. * @param scale defines the scaling factor to apply
  73589. * @param result defines the Color4 object where to store the result
  73590. * @returns the current unmodified Color4
  73591. */
  73592. scaleToRef(scale: number, result: Color4): Color4;
  73593. /**
  73594. * Scale the current Color4 values by a factor and add the result to a given Color4
  73595. * @param scale defines the scale factor
  73596. * @param result defines the Color4 object where to store the result
  73597. * @returns the unmodified current Color4
  73598. */
  73599. scaleAndAddToRef(scale: number, result: Color4): Color4;
  73600. /**
  73601. * Clamps the rgb values by the min and max values and stores the result into "result"
  73602. * @param min defines minimum clamping value (default is 0)
  73603. * @param max defines maximum clamping value (default is 1)
  73604. * @param result defines color to store the result into.
  73605. * @returns the cuurent Color4
  73606. */
  73607. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  73608. /**
  73609. * Multipy an Color4 value by another and return a new Color4 object
  73610. * @param color defines the Color4 value to multiply by
  73611. * @returns a new Color4 object
  73612. */
  73613. multiply(color: Color4): Color4;
  73614. /**
  73615. * Multipy a Color4 value by another and push the result in a reference value
  73616. * @param color defines the Color4 value to multiply by
  73617. * @param result defines the Color4 to fill the result in
  73618. * @returns the result Color4
  73619. */
  73620. multiplyToRef(color: Color4, result: Color4): Color4;
  73621. /**
  73622. * Creates a string with the Color4 current values
  73623. * @returns the string representation of the Color4 object
  73624. */
  73625. toString(): string;
  73626. /**
  73627. * Returns the string "Color4"
  73628. * @returns "Color4"
  73629. */
  73630. getClassName(): string;
  73631. /**
  73632. * Compute the Color4 hash code
  73633. * @returns an unique number that can be used to hash Color4 objects
  73634. */
  73635. getHashCode(): number;
  73636. /**
  73637. * Creates a new Color4 copied from the current one
  73638. * @returns a new Color4 object
  73639. */
  73640. clone(): Color4;
  73641. /**
  73642. * Copies the given Color4 values into the current one
  73643. * @param source defines the source Color4 object
  73644. * @returns the current updated Color4 object
  73645. */
  73646. copyFrom(source: Color4): Color4;
  73647. /**
  73648. * Copies the given float values into the current one
  73649. * @param r defines the red component to read from
  73650. * @param g defines the green component to read from
  73651. * @param b defines the blue component to read from
  73652. * @param a defines the alpha component to read from
  73653. * @returns the current updated Color4 object
  73654. */
  73655. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  73656. /**
  73657. * Copies the given float values into the current one
  73658. * @param r defines the red component to read from
  73659. * @param g defines the green component to read from
  73660. * @param b defines the blue component to read from
  73661. * @param a defines the alpha component to read from
  73662. * @returns the current updated Color4 object
  73663. */
  73664. set(r: number, g: number, b: number, a: number): Color4;
  73665. /**
  73666. * Compute the Color4 hexadecimal code as a string
  73667. * @returns a string containing the hexadecimal representation of the Color4 object
  73668. */
  73669. toHexString(): string;
  73670. /**
  73671. * Computes a new Color4 converted from the current one to linear space
  73672. * @returns a new Color4 object
  73673. */
  73674. toLinearSpace(): Color4;
  73675. /**
  73676. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  73677. * @param convertedColor defines the Color4 object where to store the linear space version
  73678. * @returns the unmodified Color4
  73679. */
  73680. toLinearSpaceToRef(convertedColor: Color4): Color4;
  73681. /**
  73682. * Computes a new Color4 converted from the current one to gamma space
  73683. * @returns a new Color4 object
  73684. */
  73685. toGammaSpace(): Color4;
  73686. /**
  73687. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  73688. * @param convertedColor defines the Color4 object where to store the gamma space version
  73689. * @returns the unmodified Color4
  73690. */
  73691. toGammaSpaceToRef(convertedColor: Color4): Color4;
  73692. /**
  73693. * Creates a new Color4 from the string containing valid hexadecimal values
  73694. * @param hex defines a string containing valid hexadecimal values
  73695. * @returns a new Color4 object
  73696. */
  73697. static FromHexString(hex: string): Color4;
  73698. /**
  73699. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  73700. * @param left defines the start value
  73701. * @param right defines the end value
  73702. * @param amount defines the gradient factor
  73703. * @returns a new Color4 object
  73704. */
  73705. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  73706. /**
  73707. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  73708. * @param left defines the start value
  73709. * @param right defines the end value
  73710. * @param amount defines the gradient factor
  73711. * @param result defines the Color4 object where to store data
  73712. */
  73713. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  73714. /**
  73715. * Creates a new Color4 from a Color3 and an alpha value
  73716. * @param color3 defines the source Color3 to read from
  73717. * @param alpha defines the alpha component (1.0 by default)
  73718. * @returns a new Color4 object
  73719. */
  73720. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  73721. /**
  73722. * Creates a new Color4 from the starting index element of the given array
  73723. * @param array defines the source array to read from
  73724. * @param offset defines the offset in the source array
  73725. * @returns a new Color4 object
  73726. */
  73727. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  73728. /**
  73729. * Creates a new Color3 from integer values (< 256)
  73730. * @param r defines the red component to read from (value between 0 and 255)
  73731. * @param g defines the green component to read from (value between 0 and 255)
  73732. * @param b defines the blue component to read from (value between 0 and 255)
  73733. * @param a defines the alpha component to read from (value between 0 and 255)
  73734. * @returns a new Color3 object
  73735. */
  73736. static FromInts(r: number, g: number, b: number, a: number): Color4;
  73737. /**
  73738. * Check the content of a given array and convert it to an array containing RGBA data
  73739. * If the original array was already containing count * 4 values then it is returned directly
  73740. * @param colors defines the array to check
  73741. * @param count defines the number of RGBA data to expect
  73742. * @returns an array containing count * 4 values (RGBA)
  73743. */
  73744. static CheckColors4(colors: number[], count: number): number[];
  73745. }
  73746. /**
  73747. * @hidden
  73748. */
  73749. export class TmpColors {
  73750. static Color3: Color3[];
  73751. static Color4: Color4[];
  73752. }
  73753. }
  73754. declare module BABYLON {
  73755. /**
  73756. * Defines an interface which represents an animation key frame
  73757. */
  73758. export interface IAnimationKey {
  73759. /**
  73760. * Frame of the key frame
  73761. */
  73762. frame: number;
  73763. /**
  73764. * Value at the specifies key frame
  73765. */
  73766. value: any;
  73767. /**
  73768. * The input tangent for the cubic hermite spline
  73769. */
  73770. inTangent?: any;
  73771. /**
  73772. * The output tangent for the cubic hermite spline
  73773. */
  73774. outTangent?: any;
  73775. /**
  73776. * The animation interpolation type
  73777. */
  73778. interpolation?: AnimationKeyInterpolation;
  73779. }
  73780. /**
  73781. * Enum for the animation key frame interpolation type
  73782. */
  73783. export enum AnimationKeyInterpolation {
  73784. /**
  73785. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  73786. */
  73787. STEP = 1
  73788. }
  73789. }
  73790. declare module BABYLON {
  73791. /**
  73792. * Represents the range of an animation
  73793. */
  73794. export class AnimationRange {
  73795. /**The name of the animation range**/
  73796. name: string;
  73797. /**The starting frame of the animation */
  73798. from: number;
  73799. /**The ending frame of the animation*/
  73800. to: number;
  73801. /**
  73802. * Initializes the range of an animation
  73803. * @param name The name of the animation range
  73804. * @param from The starting frame of the animation
  73805. * @param to The ending frame of the animation
  73806. */
  73807. constructor(
  73808. /**The name of the animation range**/
  73809. name: string,
  73810. /**The starting frame of the animation */
  73811. from: number,
  73812. /**The ending frame of the animation*/
  73813. to: number);
  73814. /**
  73815. * Makes a copy of the animation range
  73816. * @returns A copy of the animation range
  73817. */
  73818. clone(): AnimationRange;
  73819. }
  73820. }
  73821. declare module BABYLON {
  73822. /**
  73823. * Composed of a frame, and an action function
  73824. */
  73825. export class AnimationEvent {
  73826. /** The frame for which the event is triggered **/
  73827. frame: number;
  73828. /** The event to perform when triggered **/
  73829. action: (currentFrame: number) => void;
  73830. /** Specifies if the event should be triggered only once**/
  73831. onlyOnce?: boolean | undefined;
  73832. /**
  73833. * Specifies if the animation event is done
  73834. */
  73835. isDone: boolean;
  73836. /**
  73837. * Initializes the animation event
  73838. * @param frame The frame for which the event is triggered
  73839. * @param action The event to perform when triggered
  73840. * @param onlyOnce Specifies if the event should be triggered only once
  73841. */
  73842. constructor(
  73843. /** The frame for which the event is triggered **/
  73844. frame: number,
  73845. /** The event to perform when triggered **/
  73846. action: (currentFrame: number) => void,
  73847. /** Specifies if the event should be triggered only once**/
  73848. onlyOnce?: boolean | undefined);
  73849. /** @hidden */
  73850. _clone(): AnimationEvent;
  73851. }
  73852. }
  73853. declare module BABYLON {
  73854. /**
  73855. * Interface used to define a behavior
  73856. */
  73857. export interface Behavior<T> {
  73858. /** gets or sets behavior's name */
  73859. name: string;
  73860. /**
  73861. * Function called when the behavior needs to be initialized (after attaching it to a target)
  73862. */
  73863. init(): void;
  73864. /**
  73865. * Called when the behavior is attached to a target
  73866. * @param target defines the target where the behavior is attached to
  73867. */
  73868. attach(target: T): void;
  73869. /**
  73870. * Called when the behavior is detached from its target
  73871. */
  73872. detach(): void;
  73873. }
  73874. /**
  73875. * Interface implemented by classes supporting behaviors
  73876. */
  73877. export interface IBehaviorAware<T> {
  73878. /**
  73879. * Attach a behavior
  73880. * @param behavior defines the behavior to attach
  73881. * @returns the current host
  73882. */
  73883. addBehavior(behavior: Behavior<T>): T;
  73884. /**
  73885. * Remove a behavior from the current object
  73886. * @param behavior defines the behavior to detach
  73887. * @returns the current host
  73888. */
  73889. removeBehavior(behavior: Behavior<T>): T;
  73890. /**
  73891. * Gets a behavior using its name to search
  73892. * @param name defines the name to search
  73893. * @returns the behavior or null if not found
  73894. */
  73895. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  73896. }
  73897. }
  73898. declare module BABYLON {
  73899. /**
  73900. * Defines an array and its length.
  73901. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  73902. */
  73903. export interface ISmartArrayLike<T> {
  73904. /**
  73905. * The data of the array.
  73906. */
  73907. data: Array<T>;
  73908. /**
  73909. * The active length of the array.
  73910. */
  73911. length: number;
  73912. }
  73913. /**
  73914. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  73915. */
  73916. export class SmartArray<T> implements ISmartArrayLike<T> {
  73917. /**
  73918. * The full set of data from the array.
  73919. */
  73920. data: Array<T>;
  73921. /**
  73922. * The active length of the array.
  73923. */
  73924. length: number;
  73925. protected _id: number;
  73926. /**
  73927. * Instantiates a Smart Array.
  73928. * @param capacity defines the default capacity of the array.
  73929. */
  73930. constructor(capacity: number);
  73931. /**
  73932. * Pushes a value at the end of the active data.
  73933. * @param value defines the object to push in the array.
  73934. */
  73935. push(value: T): void;
  73936. /**
  73937. * Iterates over the active data and apply the lambda to them.
  73938. * @param func defines the action to apply on each value.
  73939. */
  73940. forEach(func: (content: T) => void): void;
  73941. /**
  73942. * Sorts the full sets of data.
  73943. * @param compareFn defines the comparison function to apply.
  73944. */
  73945. sort(compareFn: (a: T, b: T) => number): void;
  73946. /**
  73947. * Resets the active data to an empty array.
  73948. */
  73949. reset(): void;
  73950. /**
  73951. * Releases all the data from the array as well as the array.
  73952. */
  73953. dispose(): void;
  73954. /**
  73955. * Concats the active data with a given array.
  73956. * @param array defines the data to concatenate with.
  73957. */
  73958. concat(array: any): void;
  73959. /**
  73960. * Returns the position of a value in the active data.
  73961. * @param value defines the value to find the index for
  73962. * @returns the index if found in the active data otherwise -1
  73963. */
  73964. indexOf(value: T): number;
  73965. /**
  73966. * Returns whether an element is part of the active data.
  73967. * @param value defines the value to look for
  73968. * @returns true if found in the active data otherwise false
  73969. */
  73970. contains(value: T): boolean;
  73971. private static _GlobalId;
  73972. }
  73973. /**
  73974. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  73975. * The data in this array can only be present once
  73976. */
  73977. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  73978. private _duplicateId;
  73979. /**
  73980. * Pushes a value at the end of the active data.
  73981. * THIS DOES NOT PREVENT DUPPLICATE DATA
  73982. * @param value defines the object to push in the array.
  73983. */
  73984. push(value: T): void;
  73985. /**
  73986. * Pushes a value at the end of the active data.
  73987. * If the data is already present, it won t be added again
  73988. * @param value defines the object to push in the array.
  73989. * @returns true if added false if it was already present
  73990. */
  73991. pushNoDuplicate(value: T): boolean;
  73992. /**
  73993. * Resets the active data to an empty array.
  73994. */
  73995. reset(): void;
  73996. /**
  73997. * Concats the active data with a given array.
  73998. * This ensures no dupplicate will be present in the result.
  73999. * @param array defines the data to concatenate with.
  74000. */
  74001. concatWithNoDuplicate(array: any): void;
  74002. }
  74003. }
  74004. declare module BABYLON {
  74005. /**
  74006. * @ignore
  74007. * This is a list of all the different input types that are available in the application.
  74008. * Fo instance: ArcRotateCameraGamepadInput...
  74009. */
  74010. export var CameraInputTypes: {};
  74011. /**
  74012. * This is the contract to implement in order to create a new input class.
  74013. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  74014. */
  74015. export interface ICameraInput<TCamera extends Camera> {
  74016. /**
  74017. * Defines the camera the input is attached to.
  74018. */
  74019. camera: Nullable<TCamera>;
  74020. /**
  74021. * Gets the class name of the current intput.
  74022. * @returns the class name
  74023. */
  74024. getClassName(): string;
  74025. /**
  74026. * Get the friendly name associated with the input class.
  74027. * @returns the input friendly name
  74028. */
  74029. getSimpleName(): string;
  74030. /**
  74031. * Attach the input controls to a specific dom element to get the input from.
  74032. * @param element Defines the element the controls should be listened from
  74033. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  74034. */
  74035. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  74036. /**
  74037. * Detach the current controls from the specified dom element.
  74038. * @param element Defines the element to stop listening the inputs from
  74039. */
  74040. detachControl(element: Nullable<HTMLElement>): void;
  74041. /**
  74042. * Update the current camera state depending on the inputs that have been used this frame.
  74043. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  74044. */
  74045. checkInputs?: () => void;
  74046. }
  74047. /**
  74048. * Represents a map of input types to input instance or input index to input instance.
  74049. */
  74050. export interface CameraInputsMap<TCamera extends Camera> {
  74051. /**
  74052. * Accessor to the input by input type.
  74053. */
  74054. [name: string]: ICameraInput<TCamera>;
  74055. /**
  74056. * Accessor to the input by input index.
  74057. */
  74058. [idx: number]: ICameraInput<TCamera>;
  74059. }
  74060. /**
  74061. * This represents the input manager used within a camera.
  74062. * It helps dealing with all the different kind of input attached to a camera.
  74063. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  74064. */
  74065. export class CameraInputsManager<TCamera extends Camera> {
  74066. /**
  74067. * Defines the list of inputs attahed to the camera.
  74068. */
  74069. attached: CameraInputsMap<TCamera>;
  74070. /**
  74071. * Defines the dom element the camera is collecting inputs from.
  74072. * This is null if the controls have not been attached.
  74073. */
  74074. attachedElement: Nullable<HTMLElement>;
  74075. /**
  74076. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  74077. */
  74078. noPreventDefault: boolean;
  74079. /**
  74080. * Defined the camera the input manager belongs to.
  74081. */
  74082. camera: TCamera;
  74083. /**
  74084. * Update the current camera state depending on the inputs that have been used this frame.
  74085. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  74086. */
  74087. checkInputs: () => void;
  74088. /**
  74089. * Instantiate a new Camera Input Manager.
  74090. * @param camera Defines the camera the input manager blongs to
  74091. */
  74092. constructor(camera: TCamera);
  74093. /**
  74094. * Add an input method to a camera
  74095. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  74096. * @param input camera input method
  74097. */
  74098. add(input: ICameraInput<TCamera>): void;
  74099. /**
  74100. * Remove a specific input method from a camera
  74101. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  74102. * @param inputToRemove camera input method
  74103. */
  74104. remove(inputToRemove: ICameraInput<TCamera>): void;
  74105. /**
  74106. * Remove a specific input type from a camera
  74107. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  74108. * @param inputType the type of the input to remove
  74109. */
  74110. removeByType(inputType: string): void;
  74111. private _addCheckInputs;
  74112. /**
  74113. * Attach the input controls to the currently attached dom element to listen the events from.
  74114. * @param input Defines the input to attach
  74115. */
  74116. attachInput(input: ICameraInput<TCamera>): void;
  74117. /**
  74118. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  74119. * @param element Defines the dom element to collect the events from
  74120. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  74121. */
  74122. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  74123. /**
  74124. * Detach the current manager inputs controls from a specific dom element.
  74125. * @param element Defines the dom element to collect the events from
  74126. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  74127. */
  74128. detachElement(element: HTMLElement, disconnect?: boolean): void;
  74129. /**
  74130. * Rebuild the dynamic inputCheck function from the current list of
  74131. * defined inputs in the manager.
  74132. */
  74133. rebuildInputCheck(): void;
  74134. /**
  74135. * Remove all attached input methods from a camera
  74136. */
  74137. clear(): void;
  74138. /**
  74139. * Serialize the current input manager attached to a camera.
  74140. * This ensures than once parsed,
  74141. * the input associated to the camera will be identical to the current ones
  74142. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  74143. */
  74144. serialize(serializedCamera: any): void;
  74145. /**
  74146. * Parses an input manager serialized JSON to restore the previous list of inputs
  74147. * and states associated to a camera.
  74148. * @param parsedCamera Defines the JSON to parse
  74149. */
  74150. parse(parsedCamera: any): void;
  74151. }
  74152. }
  74153. declare module BABYLON {
  74154. /**
  74155. * Class used to store data that will be store in GPU memory
  74156. */
  74157. export class Buffer {
  74158. private _engine;
  74159. private _buffer;
  74160. /** @hidden */
  74161. _data: Nullable<DataArray>;
  74162. private _updatable;
  74163. private _instanced;
  74164. private _divisor;
  74165. /**
  74166. * Gets the byte stride.
  74167. */
  74168. readonly byteStride: number;
  74169. /**
  74170. * Constructor
  74171. * @param engine the engine
  74172. * @param data the data to use for this buffer
  74173. * @param updatable whether the data is updatable
  74174. * @param stride the stride (optional)
  74175. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  74176. * @param instanced whether the buffer is instanced (optional)
  74177. * @param useBytes set to true if the stride in in bytes (optional)
  74178. * @param divisor sets an optional divisor for instances (1 by default)
  74179. */
  74180. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  74181. /**
  74182. * Create a new VertexBuffer based on the current buffer
  74183. * @param kind defines the vertex buffer kind (position, normal, etc.)
  74184. * @param offset defines offset in the buffer (0 by default)
  74185. * @param size defines the size in floats of attributes (position is 3 for instance)
  74186. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  74187. * @param instanced defines if the vertex buffer contains indexed data
  74188. * @param useBytes defines if the offset and stride are in bytes *
  74189. * @param divisor sets an optional divisor for instances (1 by default)
  74190. * @returns the new vertex buffer
  74191. */
  74192. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  74193. /**
  74194. * Gets a boolean indicating if the Buffer is updatable?
  74195. * @returns true if the buffer is updatable
  74196. */
  74197. isUpdatable(): boolean;
  74198. /**
  74199. * Gets current buffer's data
  74200. * @returns a DataArray or null
  74201. */
  74202. getData(): Nullable<DataArray>;
  74203. /**
  74204. * Gets underlying native buffer
  74205. * @returns underlying native buffer
  74206. */
  74207. getBuffer(): Nullable<DataBuffer>;
  74208. /**
  74209. * Gets the stride in float32 units (i.e. byte stride / 4).
  74210. * May not be an integer if the byte stride is not divisible by 4.
  74211. * DEPRECATED. Use byteStride instead.
  74212. * @returns the stride in float32 units
  74213. */
  74214. getStrideSize(): number;
  74215. /**
  74216. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  74217. * @param data defines the data to store
  74218. */
  74219. create(data?: Nullable<DataArray>): void;
  74220. /** @hidden */
  74221. _rebuild(): void;
  74222. /**
  74223. * Update current buffer data
  74224. * @param data defines the data to store
  74225. */
  74226. update(data: DataArray): void;
  74227. /**
  74228. * Updates the data directly.
  74229. * @param data the new data
  74230. * @param offset the new offset
  74231. * @param vertexCount the vertex count (optional)
  74232. * @param useBytes set to true if the offset is in bytes
  74233. */
  74234. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  74235. /**
  74236. * Release all resources
  74237. */
  74238. dispose(): void;
  74239. }
  74240. /**
  74241. * Specialized buffer used to store vertex data
  74242. */
  74243. export class VertexBuffer {
  74244. /** @hidden */
  74245. _buffer: Buffer;
  74246. private _kind;
  74247. private _size;
  74248. private _ownsBuffer;
  74249. private _instanced;
  74250. private _instanceDivisor;
  74251. /**
  74252. * The byte type.
  74253. */
  74254. static readonly BYTE: number;
  74255. /**
  74256. * The unsigned byte type.
  74257. */
  74258. static readonly UNSIGNED_BYTE: number;
  74259. /**
  74260. * The short type.
  74261. */
  74262. static readonly SHORT: number;
  74263. /**
  74264. * The unsigned short type.
  74265. */
  74266. static readonly UNSIGNED_SHORT: number;
  74267. /**
  74268. * The integer type.
  74269. */
  74270. static readonly INT: number;
  74271. /**
  74272. * The unsigned integer type.
  74273. */
  74274. static readonly UNSIGNED_INT: number;
  74275. /**
  74276. * The float type.
  74277. */
  74278. static readonly FLOAT: number;
  74279. /**
  74280. * Gets or sets the instance divisor when in instanced mode
  74281. */
  74282. instanceDivisor: number;
  74283. /**
  74284. * Gets the byte stride.
  74285. */
  74286. readonly byteStride: number;
  74287. /**
  74288. * Gets the byte offset.
  74289. */
  74290. readonly byteOffset: number;
  74291. /**
  74292. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  74293. */
  74294. readonly normalized: boolean;
  74295. /**
  74296. * Gets the data type of each component in the array.
  74297. */
  74298. readonly type: number;
  74299. /**
  74300. * Constructor
  74301. * @param engine the engine
  74302. * @param data the data to use for this vertex buffer
  74303. * @param kind the vertex buffer kind
  74304. * @param updatable whether the data is updatable
  74305. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  74306. * @param stride the stride (optional)
  74307. * @param instanced whether the buffer is instanced (optional)
  74308. * @param offset the offset of the data (optional)
  74309. * @param size the number of components (optional)
  74310. * @param type the type of the component (optional)
  74311. * @param normalized whether the data contains normalized data (optional)
  74312. * @param useBytes set to true if stride and offset are in bytes (optional)
  74313. * @param divisor defines the instance divisor to use (1 by default)
  74314. */
  74315. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  74316. /** @hidden */
  74317. _rebuild(): void;
  74318. /**
  74319. * Returns the kind of the VertexBuffer (string)
  74320. * @returns a string
  74321. */
  74322. getKind(): string;
  74323. /**
  74324. * Gets a boolean indicating if the VertexBuffer is updatable?
  74325. * @returns true if the buffer is updatable
  74326. */
  74327. isUpdatable(): boolean;
  74328. /**
  74329. * Gets current buffer's data
  74330. * @returns a DataArray or null
  74331. */
  74332. getData(): Nullable<DataArray>;
  74333. /**
  74334. * Gets underlying native buffer
  74335. * @returns underlying native buffer
  74336. */
  74337. getBuffer(): Nullable<DataBuffer>;
  74338. /**
  74339. * Gets the stride in float32 units (i.e. byte stride / 4).
  74340. * May not be an integer if the byte stride is not divisible by 4.
  74341. * DEPRECATED. Use byteStride instead.
  74342. * @returns the stride in float32 units
  74343. */
  74344. getStrideSize(): number;
  74345. /**
  74346. * Returns the offset as a multiple of the type byte length.
  74347. * DEPRECATED. Use byteOffset instead.
  74348. * @returns the offset in bytes
  74349. */
  74350. getOffset(): number;
  74351. /**
  74352. * Returns the number of components per vertex attribute (integer)
  74353. * @returns the size in float
  74354. */
  74355. getSize(): number;
  74356. /**
  74357. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  74358. * @returns true if this buffer is instanced
  74359. */
  74360. getIsInstanced(): boolean;
  74361. /**
  74362. * Returns the instancing divisor, zero for non-instanced (integer).
  74363. * @returns a number
  74364. */
  74365. getInstanceDivisor(): number;
  74366. /**
  74367. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  74368. * @param data defines the data to store
  74369. */
  74370. create(data?: DataArray): void;
  74371. /**
  74372. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  74373. * This function will create a new buffer if the current one is not updatable
  74374. * @param data defines the data to store
  74375. */
  74376. update(data: DataArray): void;
  74377. /**
  74378. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  74379. * Returns the directly updated WebGLBuffer.
  74380. * @param data the new data
  74381. * @param offset the new offset
  74382. * @param useBytes set to true if the offset is in bytes
  74383. */
  74384. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  74385. /**
  74386. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  74387. */
  74388. dispose(): void;
  74389. /**
  74390. * Enumerates each value of this vertex buffer as numbers.
  74391. * @param count the number of values to enumerate
  74392. * @param callback the callback function called for each value
  74393. */
  74394. forEach(count: number, callback: (value: number, index: number) => void): void;
  74395. /**
  74396. * Positions
  74397. */
  74398. static readonly PositionKind: string;
  74399. /**
  74400. * Normals
  74401. */
  74402. static readonly NormalKind: string;
  74403. /**
  74404. * Tangents
  74405. */
  74406. static readonly TangentKind: string;
  74407. /**
  74408. * Texture coordinates
  74409. */
  74410. static readonly UVKind: string;
  74411. /**
  74412. * Texture coordinates 2
  74413. */
  74414. static readonly UV2Kind: string;
  74415. /**
  74416. * Texture coordinates 3
  74417. */
  74418. static readonly UV3Kind: string;
  74419. /**
  74420. * Texture coordinates 4
  74421. */
  74422. static readonly UV4Kind: string;
  74423. /**
  74424. * Texture coordinates 5
  74425. */
  74426. static readonly UV5Kind: string;
  74427. /**
  74428. * Texture coordinates 6
  74429. */
  74430. static readonly UV6Kind: string;
  74431. /**
  74432. * Colors
  74433. */
  74434. static readonly ColorKind: string;
  74435. /**
  74436. * Matrix indices (for bones)
  74437. */
  74438. static readonly MatricesIndicesKind: string;
  74439. /**
  74440. * Matrix weights (for bones)
  74441. */
  74442. static readonly MatricesWeightsKind: string;
  74443. /**
  74444. * Additional matrix indices (for bones)
  74445. */
  74446. static readonly MatricesIndicesExtraKind: string;
  74447. /**
  74448. * Additional matrix weights (for bones)
  74449. */
  74450. static readonly MatricesWeightsExtraKind: string;
  74451. /**
  74452. * Deduces the stride given a kind.
  74453. * @param kind The kind string to deduce
  74454. * @returns The deduced stride
  74455. */
  74456. static DeduceStride(kind: string): number;
  74457. /**
  74458. * Gets the byte length of the given type.
  74459. * @param type the type
  74460. * @returns the number of bytes
  74461. */
  74462. static GetTypeByteLength(type: number): number;
  74463. /**
  74464. * Enumerates each value of the given parameters as numbers.
  74465. * @param data the data to enumerate
  74466. * @param byteOffset the byte offset of the data
  74467. * @param byteStride the byte stride of the data
  74468. * @param componentCount the number of components per element
  74469. * @param componentType the type of the component
  74470. * @param count the number of values to enumerate
  74471. * @param normalized whether the data is normalized
  74472. * @param callback the callback function called for each value
  74473. */
  74474. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  74475. private static _GetFloatValue;
  74476. }
  74477. }
  74478. declare module BABYLON {
  74479. /**
  74480. * @hidden
  74481. */
  74482. export class IntersectionInfo {
  74483. bu: Nullable<number>;
  74484. bv: Nullable<number>;
  74485. distance: number;
  74486. faceId: number;
  74487. subMeshId: number;
  74488. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  74489. }
  74490. }
  74491. declare module BABYLON {
  74492. /**
  74493. * Represens a plane by the equation ax + by + cz + d = 0
  74494. */
  74495. export class Plane {
  74496. private static _TmpMatrix;
  74497. /**
  74498. * Normal of the plane (a,b,c)
  74499. */
  74500. normal: Vector3;
  74501. /**
  74502. * d component of the plane
  74503. */
  74504. d: number;
  74505. /**
  74506. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  74507. * @param a a component of the plane
  74508. * @param b b component of the plane
  74509. * @param c c component of the plane
  74510. * @param d d component of the plane
  74511. */
  74512. constructor(a: number, b: number, c: number, d: number);
  74513. /**
  74514. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  74515. */
  74516. asArray(): number[];
  74517. /**
  74518. * @returns a new plane copied from the current Plane.
  74519. */
  74520. clone(): Plane;
  74521. /**
  74522. * @returns the string "Plane".
  74523. */
  74524. getClassName(): string;
  74525. /**
  74526. * @returns the Plane hash code.
  74527. */
  74528. getHashCode(): number;
  74529. /**
  74530. * Normalize the current Plane in place.
  74531. * @returns the updated Plane.
  74532. */
  74533. normalize(): Plane;
  74534. /**
  74535. * Applies a transformation the plane and returns the result
  74536. * @param transformation the transformation matrix to be applied to the plane
  74537. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  74538. */
  74539. transform(transformation: DeepImmutable<Matrix>): Plane;
  74540. /**
  74541. * Calcualtte the dot product between the point and the plane normal
  74542. * @param point point to calculate the dot product with
  74543. * @returns the dot product (float) of the point coordinates and the plane normal.
  74544. */
  74545. dotCoordinate(point: DeepImmutable<Vector3>): number;
  74546. /**
  74547. * Updates the current Plane from the plane defined by the three given points.
  74548. * @param point1 one of the points used to contruct the plane
  74549. * @param point2 one of the points used to contruct the plane
  74550. * @param point3 one of the points used to contruct the plane
  74551. * @returns the updated Plane.
  74552. */
  74553. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  74554. /**
  74555. * Checks if the plane is facing a given direction
  74556. * @param direction the direction to check if the plane is facing
  74557. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  74558. * @returns True is the vector "direction" is the same side than the plane normal.
  74559. */
  74560. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  74561. /**
  74562. * Calculates the distance to a point
  74563. * @param point point to calculate distance to
  74564. * @returns the signed distance (float) from the given point to the Plane.
  74565. */
  74566. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  74567. /**
  74568. * Creates a plane from an array
  74569. * @param array the array to create a plane from
  74570. * @returns a new Plane from the given array.
  74571. */
  74572. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  74573. /**
  74574. * Creates a plane from three points
  74575. * @param point1 point used to create the plane
  74576. * @param point2 point used to create the plane
  74577. * @param point3 point used to create the plane
  74578. * @returns a new Plane defined by the three given points.
  74579. */
  74580. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  74581. /**
  74582. * Creates a plane from an origin point and a normal
  74583. * @param origin origin of the plane to be constructed
  74584. * @param normal normal of the plane to be constructed
  74585. * @returns a new Plane the normal vector to this plane at the given origin point.
  74586. * Note : the vector "normal" is updated because normalized.
  74587. */
  74588. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  74589. /**
  74590. * Calculates the distance from a plane and a point
  74591. * @param origin origin of the plane to be constructed
  74592. * @param normal normal of the plane to be constructed
  74593. * @param point point to calculate distance to
  74594. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  74595. */
  74596. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  74597. }
  74598. }
  74599. declare module BABYLON {
  74600. /**
  74601. * Class used to store bounding sphere information
  74602. */
  74603. export class BoundingSphere {
  74604. /**
  74605. * Gets the center of the bounding sphere in local space
  74606. */
  74607. readonly center: Vector3;
  74608. /**
  74609. * Radius of the bounding sphere in local space
  74610. */
  74611. radius: number;
  74612. /**
  74613. * Gets the center of the bounding sphere in world space
  74614. */
  74615. readonly centerWorld: Vector3;
  74616. /**
  74617. * Radius of the bounding sphere in world space
  74618. */
  74619. radiusWorld: number;
  74620. /**
  74621. * Gets the minimum vector in local space
  74622. */
  74623. readonly minimum: Vector3;
  74624. /**
  74625. * Gets the maximum vector in local space
  74626. */
  74627. readonly maximum: Vector3;
  74628. private _worldMatrix;
  74629. private static readonly TmpVector3;
  74630. /**
  74631. * Creates a new bounding sphere
  74632. * @param min defines the minimum vector (in local space)
  74633. * @param max defines the maximum vector (in local space)
  74634. * @param worldMatrix defines the new world matrix
  74635. */
  74636. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  74637. /**
  74638. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  74639. * @param min defines the new minimum vector (in local space)
  74640. * @param max defines the new maximum vector (in local space)
  74641. * @param worldMatrix defines the new world matrix
  74642. */
  74643. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  74644. /**
  74645. * Scale the current bounding sphere by applying a scale factor
  74646. * @param factor defines the scale factor to apply
  74647. * @returns the current bounding box
  74648. */
  74649. scale(factor: number): BoundingSphere;
  74650. /**
  74651. * Gets the world matrix of the bounding box
  74652. * @returns a matrix
  74653. */
  74654. getWorldMatrix(): DeepImmutable<Matrix>;
  74655. /** @hidden */
  74656. _update(worldMatrix: DeepImmutable<Matrix>): void;
  74657. /**
  74658. * Tests if the bounding sphere is intersecting the frustum planes
  74659. * @param frustumPlanes defines the frustum planes to test
  74660. * @returns true if there is an intersection
  74661. */
  74662. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74663. /**
  74664. * Tests if the bounding sphere center is in between the frustum planes.
  74665. * Used for optimistic fast inclusion.
  74666. * @param frustumPlanes defines the frustum planes to test
  74667. * @returns true if the sphere center is in between the frustum planes
  74668. */
  74669. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74670. /**
  74671. * Tests if a point is inside the bounding sphere
  74672. * @param point defines the point to test
  74673. * @returns true if the point is inside the bounding sphere
  74674. */
  74675. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  74676. /**
  74677. * Checks if two sphere intersct
  74678. * @param sphere0 sphere 0
  74679. * @param sphere1 sphere 1
  74680. * @returns true if the speres intersect
  74681. */
  74682. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  74683. }
  74684. }
  74685. declare module BABYLON {
  74686. /**
  74687. * Class used to store bounding box information
  74688. */
  74689. export class BoundingBox implements ICullable {
  74690. /**
  74691. * Gets the 8 vectors representing the bounding box in local space
  74692. */
  74693. readonly vectors: Vector3[];
  74694. /**
  74695. * Gets the center of the bounding box in local space
  74696. */
  74697. readonly center: Vector3;
  74698. /**
  74699. * Gets the center of the bounding box in world space
  74700. */
  74701. readonly centerWorld: Vector3;
  74702. /**
  74703. * Gets the extend size in local space
  74704. */
  74705. readonly extendSize: Vector3;
  74706. /**
  74707. * Gets the extend size in world space
  74708. */
  74709. readonly extendSizeWorld: Vector3;
  74710. /**
  74711. * Gets the OBB (object bounding box) directions
  74712. */
  74713. readonly directions: Vector3[];
  74714. /**
  74715. * Gets the 8 vectors representing the bounding box in world space
  74716. */
  74717. readonly vectorsWorld: Vector3[];
  74718. /**
  74719. * Gets the minimum vector in world space
  74720. */
  74721. readonly minimumWorld: Vector3;
  74722. /**
  74723. * Gets the maximum vector in world space
  74724. */
  74725. readonly maximumWorld: Vector3;
  74726. /**
  74727. * Gets the minimum vector in local space
  74728. */
  74729. readonly minimum: Vector3;
  74730. /**
  74731. * Gets the maximum vector in local space
  74732. */
  74733. readonly maximum: Vector3;
  74734. private _worldMatrix;
  74735. private static readonly TmpVector3;
  74736. /**
  74737. * @hidden
  74738. */
  74739. _tag: number;
  74740. /**
  74741. * Creates a new bounding box
  74742. * @param min defines the minimum vector (in local space)
  74743. * @param max defines the maximum vector (in local space)
  74744. * @param worldMatrix defines the new world matrix
  74745. */
  74746. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  74747. /**
  74748. * Recreates the entire bounding box from scratch as if we call the constructor in place
  74749. * @param min defines the new minimum vector (in local space)
  74750. * @param max defines the new maximum vector (in local space)
  74751. * @param worldMatrix defines the new world matrix
  74752. */
  74753. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  74754. /**
  74755. * Scale the current bounding box by applying a scale factor
  74756. * @param factor defines the scale factor to apply
  74757. * @returns the current bounding box
  74758. */
  74759. scale(factor: number): BoundingBox;
  74760. /**
  74761. * Gets the world matrix of the bounding box
  74762. * @returns a matrix
  74763. */
  74764. getWorldMatrix(): DeepImmutable<Matrix>;
  74765. /** @hidden */
  74766. _update(world: DeepImmutable<Matrix>): void;
  74767. /**
  74768. * Tests if the bounding box is intersecting the frustum planes
  74769. * @param frustumPlanes defines the frustum planes to test
  74770. * @returns true if there is an intersection
  74771. */
  74772. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74773. /**
  74774. * Tests if the bounding box is entirely inside the frustum planes
  74775. * @param frustumPlanes defines the frustum planes to test
  74776. * @returns true if there is an inclusion
  74777. */
  74778. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74779. /**
  74780. * Tests if a point is inside the bounding box
  74781. * @param point defines the point to test
  74782. * @returns true if the point is inside the bounding box
  74783. */
  74784. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  74785. /**
  74786. * Tests if the bounding box intersects with a bounding sphere
  74787. * @param sphere defines the sphere to test
  74788. * @returns true if there is an intersection
  74789. */
  74790. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  74791. /**
  74792. * Tests if the bounding box intersects with a box defined by a min and max vectors
  74793. * @param min defines the min vector to use
  74794. * @param max defines the max vector to use
  74795. * @returns true if there is an intersection
  74796. */
  74797. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  74798. /**
  74799. * Tests if two bounding boxes are intersections
  74800. * @param box0 defines the first box to test
  74801. * @param box1 defines the second box to test
  74802. * @returns true if there is an intersection
  74803. */
  74804. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  74805. /**
  74806. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  74807. * @param minPoint defines the minimum vector of the bounding box
  74808. * @param maxPoint defines the maximum vector of the bounding box
  74809. * @param sphereCenter defines the sphere center
  74810. * @param sphereRadius defines the sphere radius
  74811. * @returns true if there is an intersection
  74812. */
  74813. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  74814. /**
  74815. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  74816. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  74817. * @param frustumPlanes defines the frustum planes to test
  74818. * @return true if there is an inclusion
  74819. */
  74820. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74821. /**
  74822. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  74823. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  74824. * @param frustumPlanes defines the frustum planes to test
  74825. * @return true if there is an intersection
  74826. */
  74827. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74828. }
  74829. }
  74830. declare module BABYLON {
  74831. /** @hidden */
  74832. export class Collider {
  74833. /** Define if a collision was found */
  74834. collisionFound: boolean;
  74835. /**
  74836. * Define last intersection point in local space
  74837. */
  74838. intersectionPoint: Vector3;
  74839. /**
  74840. * Define last collided mesh
  74841. */
  74842. collidedMesh: Nullable<AbstractMesh>;
  74843. private _collisionPoint;
  74844. private _planeIntersectionPoint;
  74845. private _tempVector;
  74846. private _tempVector2;
  74847. private _tempVector3;
  74848. private _tempVector4;
  74849. private _edge;
  74850. private _baseToVertex;
  74851. private _destinationPoint;
  74852. private _slidePlaneNormal;
  74853. private _displacementVector;
  74854. /** @hidden */
  74855. _radius: Vector3;
  74856. /** @hidden */
  74857. _retry: number;
  74858. private _velocity;
  74859. private _basePoint;
  74860. private _epsilon;
  74861. /** @hidden */
  74862. _velocityWorldLength: number;
  74863. /** @hidden */
  74864. _basePointWorld: Vector3;
  74865. private _velocityWorld;
  74866. private _normalizedVelocity;
  74867. /** @hidden */
  74868. _initialVelocity: Vector3;
  74869. /** @hidden */
  74870. _initialPosition: Vector3;
  74871. private _nearestDistance;
  74872. private _collisionMask;
  74873. collisionMask: number;
  74874. /**
  74875. * Gets the plane normal used to compute the sliding response (in local space)
  74876. */
  74877. readonly slidePlaneNormal: Vector3;
  74878. /** @hidden */
  74879. _initialize(source: Vector3, dir: Vector3, e: number): void;
  74880. /** @hidden */
  74881. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  74882. /** @hidden */
  74883. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  74884. /** @hidden */
  74885. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  74886. /** @hidden */
  74887. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  74888. /** @hidden */
  74889. _getResponse(pos: Vector3, vel: Vector3): void;
  74890. }
  74891. }
  74892. declare module BABYLON {
  74893. /**
  74894. * Interface for cullable objects
  74895. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  74896. */
  74897. export interface ICullable {
  74898. /**
  74899. * Checks if the object or part of the object is in the frustum
  74900. * @param frustumPlanes Camera near/planes
  74901. * @returns true if the object is in frustum otherwise false
  74902. */
  74903. isInFrustum(frustumPlanes: Plane[]): boolean;
  74904. /**
  74905. * Checks if a cullable object (mesh...) is in the camera frustum
  74906. * Unlike isInFrustum this cheks the full bounding box
  74907. * @param frustumPlanes Camera near/planes
  74908. * @returns true if the object is in frustum otherwise false
  74909. */
  74910. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  74911. }
  74912. /**
  74913. * Info for a bounding data of a mesh
  74914. */
  74915. export class BoundingInfo implements ICullable {
  74916. /**
  74917. * Bounding box for the mesh
  74918. */
  74919. readonly boundingBox: BoundingBox;
  74920. /**
  74921. * Bounding sphere for the mesh
  74922. */
  74923. readonly boundingSphere: BoundingSphere;
  74924. private _isLocked;
  74925. private static readonly TmpVector3;
  74926. /**
  74927. * Constructs bounding info
  74928. * @param minimum min vector of the bounding box/sphere
  74929. * @param maximum max vector of the bounding box/sphere
  74930. * @param worldMatrix defines the new world matrix
  74931. */
  74932. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  74933. /**
  74934. * Recreates the entire bounding info from scratch as if we call the constructor in place
  74935. * @param min defines the new minimum vector (in local space)
  74936. * @param max defines the new maximum vector (in local space)
  74937. * @param worldMatrix defines the new world matrix
  74938. */
  74939. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  74940. /**
  74941. * min vector of the bounding box/sphere
  74942. */
  74943. readonly minimum: Vector3;
  74944. /**
  74945. * max vector of the bounding box/sphere
  74946. */
  74947. readonly maximum: Vector3;
  74948. /**
  74949. * If the info is locked and won't be updated to avoid perf overhead
  74950. */
  74951. isLocked: boolean;
  74952. /**
  74953. * Updates the bounding sphere and box
  74954. * @param world world matrix to be used to update
  74955. */
  74956. update(world: DeepImmutable<Matrix>): void;
  74957. /**
  74958. * Recreate the bounding info to be centered around a specific point given a specific extend.
  74959. * @param center New center of the bounding info
  74960. * @param extend New extend of the bounding info
  74961. * @returns the current bounding info
  74962. */
  74963. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  74964. /**
  74965. * Scale the current bounding info by applying a scale factor
  74966. * @param factor defines the scale factor to apply
  74967. * @returns the current bounding info
  74968. */
  74969. scale(factor: number): BoundingInfo;
  74970. /**
  74971. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  74972. * @param frustumPlanes defines the frustum to test
  74973. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  74974. * @returns true if the bounding info is in the frustum planes
  74975. */
  74976. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  74977. /**
  74978. * Gets the world distance between the min and max points of the bounding box
  74979. */
  74980. readonly diagonalLength: number;
  74981. /**
  74982. * Checks if a cullable object (mesh...) is in the camera frustum
  74983. * Unlike isInFrustum this cheks the full bounding box
  74984. * @param frustumPlanes Camera near/planes
  74985. * @returns true if the object is in frustum otherwise false
  74986. */
  74987. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  74988. /** @hidden */
  74989. _checkCollision(collider: Collider): boolean;
  74990. /**
  74991. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  74992. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  74993. * @param point the point to check intersection with
  74994. * @returns if the point intersects
  74995. */
  74996. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  74997. /**
  74998. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  74999. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  75000. * @param boundingInfo the bounding info to check intersection with
  75001. * @param precise if the intersection should be done using OBB
  75002. * @returns if the bounding info intersects
  75003. */
  75004. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  75005. }
  75006. }
  75007. declare module BABYLON {
  75008. /**
  75009. * Extracts minimum and maximum values from a list of indexed positions
  75010. * @param positions defines the positions to use
  75011. * @param indices defines the indices to the positions
  75012. * @param indexStart defines the start index
  75013. * @param indexCount defines the end index
  75014. * @param bias defines bias value to add to the result
  75015. * @return minimum and maximum values
  75016. */
  75017. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  75018. minimum: Vector3;
  75019. maximum: Vector3;
  75020. };
  75021. /**
  75022. * Extracts minimum and maximum values from a list of positions
  75023. * @param positions defines the positions to use
  75024. * @param start defines the start index in the positions array
  75025. * @param count defines the number of positions to handle
  75026. * @param bias defines bias value to add to the result
  75027. * @param stride defines the stride size to use (distance between two positions in the positions array)
  75028. * @return minimum and maximum values
  75029. */
  75030. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  75031. minimum: Vector3;
  75032. maximum: Vector3;
  75033. };
  75034. }
  75035. declare module BABYLON {
  75036. /** @hidden */
  75037. export class WebGLDataBuffer extends DataBuffer {
  75038. private _buffer;
  75039. constructor(resource: WebGLBuffer);
  75040. readonly underlyingResource: any;
  75041. }
  75042. }
  75043. declare module BABYLON {
  75044. /** @hidden */
  75045. export class WebGLPipelineContext implements IPipelineContext {
  75046. engine: ThinEngine;
  75047. program: Nullable<WebGLProgram>;
  75048. context?: WebGLRenderingContext;
  75049. vertexShader?: WebGLShader;
  75050. fragmentShader?: WebGLShader;
  75051. isParallelCompiled: boolean;
  75052. onCompiled?: () => void;
  75053. transformFeedback?: WebGLTransformFeedback | null;
  75054. readonly isAsync: boolean;
  75055. readonly isReady: boolean;
  75056. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  75057. }
  75058. }
  75059. declare module BABYLON {
  75060. interface ThinEngine {
  75061. /**
  75062. * Create an uniform buffer
  75063. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  75064. * @param elements defines the content of the uniform buffer
  75065. * @returns the webGL uniform buffer
  75066. */
  75067. createUniformBuffer(elements: FloatArray): DataBuffer;
  75068. /**
  75069. * Create a dynamic uniform buffer
  75070. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  75071. * @param elements defines the content of the uniform buffer
  75072. * @returns the webGL uniform buffer
  75073. */
  75074. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  75075. /**
  75076. * Update an existing uniform buffer
  75077. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  75078. * @param uniformBuffer defines the target uniform buffer
  75079. * @param elements defines the content to update
  75080. * @param offset defines the offset in the uniform buffer where update should start
  75081. * @param count defines the size of the data to update
  75082. */
  75083. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  75084. /**
  75085. * Bind an uniform buffer to the current webGL context
  75086. * @param buffer defines the buffer to bind
  75087. */
  75088. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  75089. /**
  75090. * Bind a buffer to the current webGL context at a given location
  75091. * @param buffer defines the buffer to bind
  75092. * @param location defines the index where to bind the buffer
  75093. */
  75094. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  75095. /**
  75096. * Bind a specific block at a given index in a specific shader program
  75097. * @param pipelineContext defines the pipeline context to use
  75098. * @param blockName defines the block name
  75099. * @param index defines the index where to bind the block
  75100. */
  75101. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  75102. }
  75103. }
  75104. declare module BABYLON {
  75105. /**
  75106. * Uniform buffer objects.
  75107. *
  75108. * Handles blocks of uniform on the GPU.
  75109. *
  75110. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  75111. *
  75112. * For more information, please refer to :
  75113. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  75114. */
  75115. export class UniformBuffer {
  75116. private _engine;
  75117. private _buffer;
  75118. private _data;
  75119. private _bufferData;
  75120. private _dynamic?;
  75121. private _uniformLocations;
  75122. private _uniformSizes;
  75123. private _uniformLocationPointer;
  75124. private _needSync;
  75125. private _noUBO;
  75126. private _currentEffect;
  75127. /** @hidden */
  75128. _alreadyBound: boolean;
  75129. private static _MAX_UNIFORM_SIZE;
  75130. private static _tempBuffer;
  75131. /**
  75132. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  75133. * This is dynamic to allow compat with webgl 1 and 2.
  75134. * You will need to pass the name of the uniform as well as the value.
  75135. */
  75136. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  75137. /**
  75138. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  75139. * This is dynamic to allow compat with webgl 1 and 2.
  75140. * You will need to pass the name of the uniform as well as the value.
  75141. */
  75142. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  75143. /**
  75144. * Lambda to Update a single float in a uniform buffer.
  75145. * This is dynamic to allow compat with webgl 1 and 2.
  75146. * You will need to pass the name of the uniform as well as the value.
  75147. */
  75148. updateFloat: (name: string, x: number) => void;
  75149. /**
  75150. * Lambda to Update a vec2 of float in a uniform buffer.
  75151. * This is dynamic to allow compat with webgl 1 and 2.
  75152. * You will need to pass the name of the uniform as well as the value.
  75153. */
  75154. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  75155. /**
  75156. * Lambda to Update a vec3 of float in a uniform buffer.
  75157. * This is dynamic to allow compat with webgl 1 and 2.
  75158. * You will need to pass the name of the uniform as well as the value.
  75159. */
  75160. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  75161. /**
  75162. * Lambda to Update a vec4 of float in a uniform buffer.
  75163. * This is dynamic to allow compat with webgl 1 and 2.
  75164. * You will need to pass the name of the uniform as well as the value.
  75165. */
  75166. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  75167. /**
  75168. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  75169. * This is dynamic to allow compat with webgl 1 and 2.
  75170. * You will need to pass the name of the uniform as well as the value.
  75171. */
  75172. updateMatrix: (name: string, mat: Matrix) => void;
  75173. /**
  75174. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  75175. * This is dynamic to allow compat with webgl 1 and 2.
  75176. * You will need to pass the name of the uniform as well as the value.
  75177. */
  75178. updateVector3: (name: string, vector: Vector3) => void;
  75179. /**
  75180. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  75181. * This is dynamic to allow compat with webgl 1 and 2.
  75182. * You will need to pass the name of the uniform as well as the value.
  75183. */
  75184. updateVector4: (name: string, vector: Vector4) => void;
  75185. /**
  75186. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  75187. * This is dynamic to allow compat with webgl 1 and 2.
  75188. * You will need to pass the name of the uniform as well as the value.
  75189. */
  75190. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  75191. /**
  75192. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  75193. * This is dynamic to allow compat with webgl 1 and 2.
  75194. * You will need to pass the name of the uniform as well as the value.
  75195. */
  75196. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  75197. /**
  75198. * Instantiates a new Uniform buffer objects.
  75199. *
  75200. * Handles blocks of uniform on the GPU.
  75201. *
  75202. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  75203. *
  75204. * For more information, please refer to :
  75205. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  75206. * @param engine Define the engine the buffer is associated with
  75207. * @param data Define the data contained in the buffer
  75208. * @param dynamic Define if the buffer is updatable
  75209. */
  75210. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  75211. /**
  75212. * Indicates if the buffer is using the WebGL2 UBO implementation,
  75213. * or just falling back on setUniformXXX calls.
  75214. */
  75215. readonly useUbo: boolean;
  75216. /**
  75217. * Indicates if the WebGL underlying uniform buffer is in sync
  75218. * with the javascript cache data.
  75219. */
  75220. readonly isSync: boolean;
  75221. /**
  75222. * Indicates if the WebGL underlying uniform buffer is dynamic.
  75223. * Also, a dynamic UniformBuffer will disable cache verification and always
  75224. * update the underlying WebGL uniform buffer to the GPU.
  75225. * @returns if Dynamic, otherwise false
  75226. */
  75227. isDynamic(): boolean;
  75228. /**
  75229. * The data cache on JS side.
  75230. * @returns the underlying data as a float array
  75231. */
  75232. getData(): Float32Array;
  75233. /**
  75234. * The underlying WebGL Uniform buffer.
  75235. * @returns the webgl buffer
  75236. */
  75237. getBuffer(): Nullable<DataBuffer>;
  75238. /**
  75239. * std140 layout specifies how to align data within an UBO structure.
  75240. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  75241. * for specs.
  75242. */
  75243. private _fillAlignment;
  75244. /**
  75245. * Adds an uniform in the buffer.
  75246. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  75247. * for the layout to be correct !
  75248. * @param name Name of the uniform, as used in the uniform block in the shader.
  75249. * @param size Data size, or data directly.
  75250. */
  75251. addUniform(name: string, size: number | number[]): void;
  75252. /**
  75253. * Adds a Matrix 4x4 to the uniform buffer.
  75254. * @param name Name of the uniform, as used in the uniform block in the shader.
  75255. * @param mat A 4x4 matrix.
  75256. */
  75257. addMatrix(name: string, mat: Matrix): void;
  75258. /**
  75259. * Adds a vec2 to the uniform buffer.
  75260. * @param name Name of the uniform, as used in the uniform block in the shader.
  75261. * @param x Define the x component value of the vec2
  75262. * @param y Define the y component value of the vec2
  75263. */
  75264. addFloat2(name: string, x: number, y: number): void;
  75265. /**
  75266. * Adds a vec3 to the uniform buffer.
  75267. * @param name Name of the uniform, as used in the uniform block in the shader.
  75268. * @param x Define the x component value of the vec3
  75269. * @param y Define the y component value of the vec3
  75270. * @param z Define the z component value of the vec3
  75271. */
  75272. addFloat3(name: string, x: number, y: number, z: number): void;
  75273. /**
  75274. * Adds a vec3 to the uniform buffer.
  75275. * @param name Name of the uniform, as used in the uniform block in the shader.
  75276. * @param color Define the vec3 from a Color
  75277. */
  75278. addColor3(name: string, color: Color3): void;
  75279. /**
  75280. * Adds a vec4 to the uniform buffer.
  75281. * @param name Name of the uniform, as used in the uniform block in the shader.
  75282. * @param color Define the rgb components from a Color
  75283. * @param alpha Define the a component of the vec4
  75284. */
  75285. addColor4(name: string, color: Color3, alpha: number): void;
  75286. /**
  75287. * Adds a vec3 to the uniform buffer.
  75288. * @param name Name of the uniform, as used in the uniform block in the shader.
  75289. * @param vector Define the vec3 components from a Vector
  75290. */
  75291. addVector3(name: string, vector: Vector3): void;
  75292. /**
  75293. * Adds a Matrix 3x3 to the uniform buffer.
  75294. * @param name Name of the uniform, as used in the uniform block in the shader.
  75295. */
  75296. addMatrix3x3(name: string): void;
  75297. /**
  75298. * Adds a Matrix 2x2 to the uniform buffer.
  75299. * @param name Name of the uniform, as used in the uniform block in the shader.
  75300. */
  75301. addMatrix2x2(name: string): void;
  75302. /**
  75303. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  75304. */
  75305. create(): void;
  75306. /** @hidden */
  75307. _rebuild(): void;
  75308. /**
  75309. * Updates the WebGL Uniform Buffer on the GPU.
  75310. * If the `dynamic` flag is set to true, no cache comparison is done.
  75311. * Otherwise, the buffer will be updated only if the cache differs.
  75312. */
  75313. update(): void;
  75314. /**
  75315. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  75316. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  75317. * @param data Define the flattened data
  75318. * @param size Define the size of the data.
  75319. */
  75320. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  75321. private _valueCache;
  75322. private _cacheMatrix;
  75323. private _updateMatrix3x3ForUniform;
  75324. private _updateMatrix3x3ForEffect;
  75325. private _updateMatrix2x2ForEffect;
  75326. private _updateMatrix2x2ForUniform;
  75327. private _updateFloatForEffect;
  75328. private _updateFloatForUniform;
  75329. private _updateFloat2ForEffect;
  75330. private _updateFloat2ForUniform;
  75331. private _updateFloat3ForEffect;
  75332. private _updateFloat3ForUniform;
  75333. private _updateFloat4ForEffect;
  75334. private _updateFloat4ForUniform;
  75335. private _updateMatrixForEffect;
  75336. private _updateMatrixForUniform;
  75337. private _updateVector3ForEffect;
  75338. private _updateVector3ForUniform;
  75339. private _updateVector4ForEffect;
  75340. private _updateVector4ForUniform;
  75341. private _updateColor3ForEffect;
  75342. private _updateColor3ForUniform;
  75343. private _updateColor4ForEffect;
  75344. private _updateColor4ForUniform;
  75345. /**
  75346. * Sets a sampler uniform on the effect.
  75347. * @param name Define the name of the sampler.
  75348. * @param texture Define the texture to set in the sampler
  75349. */
  75350. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  75351. /**
  75352. * Directly updates the value of the uniform in the cache AND on the GPU.
  75353. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  75354. * @param data Define the flattened data
  75355. */
  75356. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  75357. /**
  75358. * Binds this uniform buffer to an effect.
  75359. * @param effect Define the effect to bind the buffer to
  75360. * @param name Name of the uniform block in the shader.
  75361. */
  75362. bindToEffect(effect: Effect, name: string): void;
  75363. /**
  75364. * Disposes the uniform buffer.
  75365. */
  75366. dispose(): void;
  75367. }
  75368. }
  75369. declare module BABYLON {
  75370. /**
  75371. * Enum that determines the text-wrapping mode to use.
  75372. */
  75373. export enum InspectableType {
  75374. /**
  75375. * Checkbox for booleans
  75376. */
  75377. Checkbox = 0,
  75378. /**
  75379. * Sliders for numbers
  75380. */
  75381. Slider = 1,
  75382. /**
  75383. * Vector3
  75384. */
  75385. Vector3 = 2,
  75386. /**
  75387. * Quaternions
  75388. */
  75389. Quaternion = 3,
  75390. /**
  75391. * Color3
  75392. */
  75393. Color3 = 4,
  75394. /**
  75395. * String
  75396. */
  75397. String = 5
  75398. }
  75399. /**
  75400. * Interface used to define custom inspectable properties.
  75401. * This interface is used by the inspector to display custom property grids
  75402. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  75403. */
  75404. export interface IInspectable {
  75405. /**
  75406. * Gets the label to display
  75407. */
  75408. label: string;
  75409. /**
  75410. * Gets the name of the property to edit
  75411. */
  75412. propertyName: string;
  75413. /**
  75414. * Gets the type of the editor to use
  75415. */
  75416. type: InspectableType;
  75417. /**
  75418. * Gets the minimum value of the property when using in "slider" mode
  75419. */
  75420. min?: number;
  75421. /**
  75422. * Gets the maximum value of the property when using in "slider" mode
  75423. */
  75424. max?: number;
  75425. /**
  75426. * Gets the setp to use when using in "slider" mode
  75427. */
  75428. step?: number;
  75429. }
  75430. }
  75431. declare module BABYLON {
  75432. /**
  75433. * Class used to provide helper for timing
  75434. */
  75435. export class TimingTools {
  75436. /**
  75437. * Polyfill for setImmediate
  75438. * @param action defines the action to execute after the current execution block
  75439. */
  75440. static SetImmediate(action: () => void): void;
  75441. }
  75442. }
  75443. declare module BABYLON {
  75444. /**
  75445. * Class used to enable instatition of objects by class name
  75446. */
  75447. export class InstantiationTools {
  75448. /**
  75449. * Use this object to register external classes like custom textures or material
  75450. * to allow the laoders to instantiate them
  75451. */
  75452. static RegisteredExternalClasses: {
  75453. [key: string]: Object;
  75454. };
  75455. /**
  75456. * Tries to instantiate a new object from a given class name
  75457. * @param className defines the class name to instantiate
  75458. * @returns the new object or null if the system was not able to do the instantiation
  75459. */
  75460. static Instantiate(className: string): any;
  75461. }
  75462. }
  75463. declare module BABYLON {
  75464. /**
  75465. * Define options used to create a depth texture
  75466. */
  75467. export class DepthTextureCreationOptions {
  75468. /** Specifies whether or not a stencil should be allocated in the texture */
  75469. generateStencil?: boolean;
  75470. /** Specifies whether or not bilinear filtering is enable on the texture */
  75471. bilinearFiltering?: boolean;
  75472. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  75473. comparisonFunction?: number;
  75474. /** Specifies if the created texture is a cube texture */
  75475. isCube?: boolean;
  75476. }
  75477. }
  75478. declare module BABYLON {
  75479. interface ThinEngine {
  75480. /**
  75481. * Creates a depth stencil cube texture.
  75482. * This is only available in WebGL 2.
  75483. * @param size The size of face edge in the cube texture.
  75484. * @param options The options defining the cube texture.
  75485. * @returns The cube texture
  75486. */
  75487. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  75488. /**
  75489. * Creates a cube texture
  75490. * @param rootUrl defines the url where the files to load is located
  75491. * @param scene defines the current scene
  75492. * @param files defines the list of files to load (1 per face)
  75493. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75494. * @param onLoad defines an optional callback raised when the texture is loaded
  75495. * @param onError defines an optional callback raised if there is an issue to load the texture
  75496. * @param format defines the format of the data
  75497. * @param forcedExtension defines the extension to use to pick the right loader
  75498. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  75499. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75500. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75501. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  75502. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  75503. * @returns the cube texture as an InternalTexture
  75504. */
  75505. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>, excludeLoaders: Array<IInternalTextureLoader>): InternalTexture;
  75506. /**
  75507. * Creates a cube texture
  75508. * @param rootUrl defines the url where the files to load is located
  75509. * @param scene defines the current scene
  75510. * @param files defines the list of files to load (1 per face)
  75511. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75512. * @param onLoad defines an optional callback raised when the texture is loaded
  75513. * @param onError defines an optional callback raised if there is an issue to load the texture
  75514. * @param format defines the format of the data
  75515. * @param forcedExtension defines the extension to use to pick the right loader
  75516. * @returns the cube texture as an InternalTexture
  75517. */
  75518. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any): InternalTexture;
  75519. /**
  75520. * Creates a cube texture
  75521. * @param rootUrl defines the url where the files to load is located
  75522. * @param scene defines the current scene
  75523. * @param files defines the list of files to load (1 per face)
  75524. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75525. * @param onLoad defines an optional callback raised when the texture is loaded
  75526. * @param onError defines an optional callback raised if there is an issue to load the texture
  75527. * @param format defines the format of the data
  75528. * @param forcedExtension defines the extension to use to pick the right loader
  75529. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  75530. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75531. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75532. * @returns the cube texture as an InternalTexture
  75533. */
  75534. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number): InternalTexture;
  75535. /** @hidden */
  75536. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  75537. /** @hidden */
  75538. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  75539. /** @hidden */
  75540. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  75541. /** @hidden */
  75542. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  75543. /**
  75544. * @hidden
  75545. */
  75546. _setCubeMapTextureParams(loadMipmap: boolean): void;
  75547. }
  75548. }
  75549. declare module BABYLON {
  75550. /**
  75551. * Class for creating a cube texture
  75552. */
  75553. export class CubeTexture extends BaseTexture {
  75554. private _delayedOnLoad;
  75555. /**
  75556. * The url of the texture
  75557. */
  75558. url: string;
  75559. /**
  75560. * Gets or sets the center of the bounding box associated with the cube texture.
  75561. * It must define where the camera used to render the texture was set
  75562. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  75563. */
  75564. boundingBoxPosition: Vector3;
  75565. private _boundingBoxSize;
  75566. /**
  75567. * Gets or sets the size of the bounding box associated with the cube texture
  75568. * When defined, the cubemap will switch to local mode
  75569. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  75570. * @example https://www.babylonjs-playground.com/#RNASML
  75571. */
  75572. /**
  75573. * Returns the bounding box size
  75574. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  75575. */
  75576. boundingBoxSize: Vector3;
  75577. protected _rotationY: number;
  75578. /**
  75579. * Sets texture matrix rotation angle around Y axis in radians.
  75580. */
  75581. /**
  75582. * Gets texture matrix rotation angle around Y axis radians.
  75583. */
  75584. rotationY: number;
  75585. /**
  75586. * Are mip maps generated for this texture or not.
  75587. */
  75588. readonly noMipmap: boolean;
  75589. private _noMipmap;
  75590. private _files;
  75591. protected _forcedExtension: Nullable<string>;
  75592. private _extensions;
  75593. private _textureMatrix;
  75594. private _format;
  75595. private _createPolynomials;
  75596. /** @hidden */
  75597. _prefiltered: boolean;
  75598. /**
  75599. * Creates a cube texture from an array of image urls
  75600. * @param files defines an array of image urls
  75601. * @param scene defines the hosting scene
  75602. * @param noMipmap specifies if mip maps are not used
  75603. * @returns a cube texture
  75604. */
  75605. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  75606. /**
  75607. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  75608. * @param url defines the url of the prefiltered texture
  75609. * @param scene defines the scene the texture is attached to
  75610. * @param forcedExtension defines the extension of the file if different from the url
  75611. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  75612. * @return the prefiltered texture
  75613. */
  75614. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  75615. /**
  75616. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  75617. * as prefiltered data.
  75618. * @param rootUrl defines the url of the texture or the root name of the six images
  75619. * @param scene defines the scene the texture is attached to
  75620. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  75621. * @param noMipmap defines if mipmaps should be created or not
  75622. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  75623. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  75624. * @param onError defines a callback triggered in case of error during load
  75625. * @param format defines the internal format to use for the texture once loaded
  75626. * @param prefiltered defines whether or not the texture is created from prefiltered data
  75627. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  75628. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  75629. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75630. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75631. * @return the cube texture
  75632. */
  75633. constructor(rootUrl: string, scene: Scene, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  75634. /**
  75635. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  75636. */
  75637. readonly isPrefiltered: boolean;
  75638. /**
  75639. * Get the current class name of the texture useful for serialization or dynamic coding.
  75640. * @returns "CubeTexture"
  75641. */
  75642. getClassName(): string;
  75643. /**
  75644. * Update the url (and optional buffer) of this texture if url was null during construction.
  75645. * @param url the url of the texture
  75646. * @param forcedExtension defines the extension to use
  75647. * @param onLoad callback called when the texture is loaded (defaults to null)
  75648. */
  75649. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  75650. /**
  75651. * Delays loading of the cube texture
  75652. * @param forcedExtension defines the extension to use
  75653. */
  75654. delayLoad(forcedExtension?: string): void;
  75655. /**
  75656. * Returns the reflection texture matrix
  75657. * @returns the reflection texture matrix
  75658. */
  75659. getReflectionTextureMatrix(): Matrix;
  75660. /**
  75661. * Sets the reflection texture matrix
  75662. * @param value Reflection texture matrix
  75663. */
  75664. setReflectionTextureMatrix(value: Matrix): void;
  75665. /**
  75666. * Parses text to create a cube texture
  75667. * @param parsedTexture define the serialized text to read from
  75668. * @param scene defines the hosting scene
  75669. * @param rootUrl defines the root url of the cube texture
  75670. * @returns a cube texture
  75671. */
  75672. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  75673. /**
  75674. * Makes a clone, or deep copy, of the cube texture
  75675. * @returns a new cube texture
  75676. */
  75677. clone(): CubeTexture;
  75678. }
  75679. }
  75680. declare module BABYLON {
  75681. /**
  75682. * Manages the defines for the Material
  75683. */
  75684. export class MaterialDefines {
  75685. /** @hidden */
  75686. protected _keys: string[];
  75687. private _isDirty;
  75688. /** @hidden */
  75689. _renderId: number;
  75690. /** @hidden */
  75691. _areLightsDirty: boolean;
  75692. /** @hidden */
  75693. _areLightsDisposed: boolean;
  75694. /** @hidden */
  75695. _areAttributesDirty: boolean;
  75696. /** @hidden */
  75697. _areTexturesDirty: boolean;
  75698. /** @hidden */
  75699. _areFresnelDirty: boolean;
  75700. /** @hidden */
  75701. _areMiscDirty: boolean;
  75702. /** @hidden */
  75703. _areImageProcessingDirty: boolean;
  75704. /** @hidden */
  75705. _normals: boolean;
  75706. /** @hidden */
  75707. _uvs: boolean;
  75708. /** @hidden */
  75709. _needNormals: boolean;
  75710. /** @hidden */
  75711. _needUVs: boolean;
  75712. [id: string]: any;
  75713. /**
  75714. * Specifies if the material needs to be re-calculated
  75715. */
  75716. readonly isDirty: boolean;
  75717. /**
  75718. * Marks the material to indicate that it has been re-calculated
  75719. */
  75720. markAsProcessed(): void;
  75721. /**
  75722. * Marks the material to indicate that it needs to be re-calculated
  75723. */
  75724. markAsUnprocessed(): void;
  75725. /**
  75726. * Marks the material to indicate all of its defines need to be re-calculated
  75727. */
  75728. markAllAsDirty(): void;
  75729. /**
  75730. * Marks the material to indicate that image processing needs to be re-calculated
  75731. */
  75732. markAsImageProcessingDirty(): void;
  75733. /**
  75734. * Marks the material to indicate the lights need to be re-calculated
  75735. * @param disposed Defines whether the light is dirty due to dispose or not
  75736. */
  75737. markAsLightDirty(disposed?: boolean): void;
  75738. /**
  75739. * Marks the attribute state as changed
  75740. */
  75741. markAsAttributesDirty(): void;
  75742. /**
  75743. * Marks the texture state as changed
  75744. */
  75745. markAsTexturesDirty(): void;
  75746. /**
  75747. * Marks the fresnel state as changed
  75748. */
  75749. markAsFresnelDirty(): void;
  75750. /**
  75751. * Marks the misc state as changed
  75752. */
  75753. markAsMiscDirty(): void;
  75754. /**
  75755. * Rebuilds the material defines
  75756. */
  75757. rebuild(): void;
  75758. /**
  75759. * Specifies if two material defines are equal
  75760. * @param other - A material define instance to compare to
  75761. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  75762. */
  75763. isEqual(other: MaterialDefines): boolean;
  75764. /**
  75765. * Clones this instance's defines to another instance
  75766. * @param other - material defines to clone values to
  75767. */
  75768. cloneTo(other: MaterialDefines): void;
  75769. /**
  75770. * Resets the material define values
  75771. */
  75772. reset(): void;
  75773. /**
  75774. * Converts the material define values to a string
  75775. * @returns - String of material define information
  75776. */
  75777. toString(): string;
  75778. }
  75779. }
  75780. declare module BABYLON {
  75781. /**
  75782. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  75783. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  75784. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  75785. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  75786. */
  75787. export class ColorCurves {
  75788. private _dirty;
  75789. private _tempColor;
  75790. private _globalCurve;
  75791. private _highlightsCurve;
  75792. private _midtonesCurve;
  75793. private _shadowsCurve;
  75794. private _positiveCurve;
  75795. private _negativeCurve;
  75796. private _globalHue;
  75797. private _globalDensity;
  75798. private _globalSaturation;
  75799. private _globalExposure;
  75800. /**
  75801. * Gets the global Hue value.
  75802. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  75803. */
  75804. /**
  75805. * Sets the global Hue value.
  75806. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  75807. */
  75808. globalHue: number;
  75809. /**
  75810. * Gets the global Density value.
  75811. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  75812. * Values less than zero provide a filter of opposite hue.
  75813. */
  75814. /**
  75815. * Sets the global Density value.
  75816. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  75817. * Values less than zero provide a filter of opposite hue.
  75818. */
  75819. globalDensity: number;
  75820. /**
  75821. * Gets the global Saturation value.
  75822. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  75823. */
  75824. /**
  75825. * Sets the global Saturation value.
  75826. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  75827. */
  75828. globalSaturation: number;
  75829. /**
  75830. * Gets the global Exposure value.
  75831. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  75832. */
  75833. /**
  75834. * Sets the global Exposure value.
  75835. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  75836. */
  75837. globalExposure: number;
  75838. private _highlightsHue;
  75839. private _highlightsDensity;
  75840. private _highlightsSaturation;
  75841. private _highlightsExposure;
  75842. /**
  75843. * Gets the highlights Hue value.
  75844. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  75845. */
  75846. /**
  75847. * Sets the highlights Hue value.
  75848. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  75849. */
  75850. highlightsHue: number;
  75851. /**
  75852. * Gets the highlights Density value.
  75853. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  75854. * Values less than zero provide a filter of opposite hue.
  75855. */
  75856. /**
  75857. * Sets the highlights Density value.
  75858. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  75859. * Values less than zero provide a filter of opposite hue.
  75860. */
  75861. highlightsDensity: number;
  75862. /**
  75863. * Gets the highlights Saturation value.
  75864. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  75865. */
  75866. /**
  75867. * Sets the highlights Saturation value.
  75868. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  75869. */
  75870. highlightsSaturation: number;
  75871. /**
  75872. * Gets the highlights Exposure value.
  75873. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  75874. */
  75875. /**
  75876. * Sets the highlights Exposure value.
  75877. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  75878. */
  75879. highlightsExposure: number;
  75880. private _midtonesHue;
  75881. private _midtonesDensity;
  75882. private _midtonesSaturation;
  75883. private _midtonesExposure;
  75884. /**
  75885. * Gets the midtones Hue value.
  75886. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  75887. */
  75888. /**
  75889. * Sets the midtones Hue value.
  75890. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  75891. */
  75892. midtonesHue: number;
  75893. /**
  75894. * Gets the midtones Density value.
  75895. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  75896. * Values less than zero provide a filter of opposite hue.
  75897. */
  75898. /**
  75899. * Sets the midtones Density value.
  75900. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  75901. * Values less than zero provide a filter of opposite hue.
  75902. */
  75903. midtonesDensity: number;
  75904. /**
  75905. * Gets the midtones Saturation value.
  75906. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  75907. */
  75908. /**
  75909. * Sets the midtones Saturation value.
  75910. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  75911. */
  75912. midtonesSaturation: number;
  75913. /**
  75914. * Gets the midtones Exposure value.
  75915. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  75916. */
  75917. /**
  75918. * Sets the midtones Exposure value.
  75919. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  75920. */
  75921. midtonesExposure: number;
  75922. private _shadowsHue;
  75923. private _shadowsDensity;
  75924. private _shadowsSaturation;
  75925. private _shadowsExposure;
  75926. /**
  75927. * Gets the shadows Hue value.
  75928. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  75929. */
  75930. /**
  75931. * Sets the shadows Hue value.
  75932. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  75933. */
  75934. shadowsHue: number;
  75935. /**
  75936. * Gets the shadows Density value.
  75937. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  75938. * Values less than zero provide a filter of opposite hue.
  75939. */
  75940. /**
  75941. * Sets the shadows Density value.
  75942. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  75943. * Values less than zero provide a filter of opposite hue.
  75944. */
  75945. shadowsDensity: number;
  75946. /**
  75947. * Gets the shadows Saturation value.
  75948. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  75949. */
  75950. /**
  75951. * Sets the shadows Saturation value.
  75952. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  75953. */
  75954. shadowsSaturation: number;
  75955. /**
  75956. * Gets the shadows Exposure value.
  75957. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  75958. */
  75959. /**
  75960. * Sets the shadows Exposure value.
  75961. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  75962. */
  75963. shadowsExposure: number;
  75964. /**
  75965. * Returns the class name
  75966. * @returns The class name
  75967. */
  75968. getClassName(): string;
  75969. /**
  75970. * Binds the color curves to the shader.
  75971. * @param colorCurves The color curve to bind
  75972. * @param effect The effect to bind to
  75973. * @param positiveUniform The positive uniform shader parameter
  75974. * @param neutralUniform The neutral uniform shader parameter
  75975. * @param negativeUniform The negative uniform shader parameter
  75976. */
  75977. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  75978. /**
  75979. * Prepare the list of uniforms associated with the ColorCurves effects.
  75980. * @param uniformsList The list of uniforms used in the effect
  75981. */
  75982. static PrepareUniforms(uniformsList: string[]): void;
  75983. /**
  75984. * Returns color grading data based on a hue, density, saturation and exposure value.
  75985. * @param filterHue The hue of the color filter.
  75986. * @param filterDensity The density of the color filter.
  75987. * @param saturation The saturation.
  75988. * @param exposure The exposure.
  75989. * @param result The result data container.
  75990. */
  75991. private getColorGradingDataToRef;
  75992. /**
  75993. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  75994. * @param value The input slider value in range [-100,100].
  75995. * @returns Adjusted value.
  75996. */
  75997. private static applyColorGradingSliderNonlinear;
  75998. /**
  75999. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  76000. * @param hue The hue (H) input.
  76001. * @param saturation The saturation (S) input.
  76002. * @param brightness The brightness (B) input.
  76003. * @result An RGBA color represented as Vector4.
  76004. */
  76005. private static fromHSBToRef;
  76006. /**
  76007. * Returns a value clamped between min and max
  76008. * @param value The value to clamp
  76009. * @param min The minimum of value
  76010. * @param max The maximum of value
  76011. * @returns The clamped value.
  76012. */
  76013. private static clamp;
  76014. /**
  76015. * Clones the current color curve instance.
  76016. * @return The cloned curves
  76017. */
  76018. clone(): ColorCurves;
  76019. /**
  76020. * Serializes the current color curve instance to a json representation.
  76021. * @return a JSON representation
  76022. */
  76023. serialize(): any;
  76024. /**
  76025. * Parses the color curve from a json representation.
  76026. * @param source the JSON source to parse
  76027. * @return The parsed curves
  76028. */
  76029. static Parse(source: any): ColorCurves;
  76030. }
  76031. }
  76032. declare module BABYLON {
  76033. /**
  76034. * Interface to follow in your material defines to integrate easily the
  76035. * Image proccessing functions.
  76036. * @hidden
  76037. */
  76038. export interface IImageProcessingConfigurationDefines {
  76039. IMAGEPROCESSING: boolean;
  76040. VIGNETTE: boolean;
  76041. VIGNETTEBLENDMODEMULTIPLY: boolean;
  76042. VIGNETTEBLENDMODEOPAQUE: boolean;
  76043. TONEMAPPING: boolean;
  76044. TONEMAPPING_ACES: boolean;
  76045. CONTRAST: boolean;
  76046. EXPOSURE: boolean;
  76047. COLORCURVES: boolean;
  76048. COLORGRADING: boolean;
  76049. COLORGRADING3D: boolean;
  76050. SAMPLER3DGREENDEPTH: boolean;
  76051. SAMPLER3DBGRMAP: boolean;
  76052. IMAGEPROCESSINGPOSTPROCESS: boolean;
  76053. }
  76054. /**
  76055. * @hidden
  76056. */
  76057. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  76058. IMAGEPROCESSING: boolean;
  76059. VIGNETTE: boolean;
  76060. VIGNETTEBLENDMODEMULTIPLY: boolean;
  76061. VIGNETTEBLENDMODEOPAQUE: boolean;
  76062. TONEMAPPING: boolean;
  76063. TONEMAPPING_ACES: boolean;
  76064. CONTRAST: boolean;
  76065. COLORCURVES: boolean;
  76066. COLORGRADING: boolean;
  76067. COLORGRADING3D: boolean;
  76068. SAMPLER3DGREENDEPTH: boolean;
  76069. SAMPLER3DBGRMAP: boolean;
  76070. IMAGEPROCESSINGPOSTPROCESS: boolean;
  76071. EXPOSURE: boolean;
  76072. constructor();
  76073. }
  76074. /**
  76075. * This groups together the common properties used for image processing either in direct forward pass
  76076. * or through post processing effect depending on the use of the image processing pipeline in your scene
  76077. * or not.
  76078. */
  76079. export class ImageProcessingConfiguration {
  76080. /**
  76081. * Default tone mapping applied in BabylonJS.
  76082. */
  76083. static readonly TONEMAPPING_STANDARD: number;
  76084. /**
  76085. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  76086. * to other engines rendering to increase portability.
  76087. */
  76088. static readonly TONEMAPPING_ACES: number;
  76089. /**
  76090. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  76091. */
  76092. colorCurves: Nullable<ColorCurves>;
  76093. private _colorCurvesEnabled;
  76094. /**
  76095. * Gets wether the color curves effect is enabled.
  76096. */
  76097. /**
  76098. * Sets wether the color curves effect is enabled.
  76099. */
  76100. colorCurvesEnabled: boolean;
  76101. private _colorGradingTexture;
  76102. /**
  76103. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  76104. */
  76105. /**
  76106. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  76107. */
  76108. colorGradingTexture: Nullable<BaseTexture>;
  76109. private _colorGradingEnabled;
  76110. /**
  76111. * Gets wether the color grading effect is enabled.
  76112. */
  76113. /**
  76114. * Sets wether the color grading effect is enabled.
  76115. */
  76116. colorGradingEnabled: boolean;
  76117. private _colorGradingWithGreenDepth;
  76118. /**
  76119. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  76120. */
  76121. /**
  76122. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  76123. */
  76124. colorGradingWithGreenDepth: boolean;
  76125. private _colorGradingBGR;
  76126. /**
  76127. * Gets wether the color grading texture contains BGR values.
  76128. */
  76129. /**
  76130. * Sets wether the color grading texture contains BGR values.
  76131. */
  76132. colorGradingBGR: boolean;
  76133. /** @hidden */
  76134. _exposure: number;
  76135. /**
  76136. * Gets the Exposure used in the effect.
  76137. */
  76138. /**
  76139. * Sets the Exposure used in the effect.
  76140. */
  76141. exposure: number;
  76142. private _toneMappingEnabled;
  76143. /**
  76144. * Gets wether the tone mapping effect is enabled.
  76145. */
  76146. /**
  76147. * Sets wether the tone mapping effect is enabled.
  76148. */
  76149. toneMappingEnabled: boolean;
  76150. private _toneMappingType;
  76151. /**
  76152. * Gets the type of tone mapping effect.
  76153. */
  76154. /**
  76155. * Sets the type of tone mapping effect used in BabylonJS.
  76156. */
  76157. toneMappingType: number;
  76158. protected _contrast: number;
  76159. /**
  76160. * Gets the contrast used in the effect.
  76161. */
  76162. /**
  76163. * Sets the contrast used in the effect.
  76164. */
  76165. contrast: number;
  76166. /**
  76167. * Vignette stretch size.
  76168. */
  76169. vignetteStretch: number;
  76170. /**
  76171. * Vignette centre X Offset.
  76172. */
  76173. vignetteCentreX: number;
  76174. /**
  76175. * Vignette centre Y Offset.
  76176. */
  76177. vignetteCentreY: number;
  76178. /**
  76179. * Vignette weight or intensity of the vignette effect.
  76180. */
  76181. vignetteWeight: number;
  76182. /**
  76183. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  76184. * if vignetteEnabled is set to true.
  76185. */
  76186. vignetteColor: Color4;
  76187. /**
  76188. * Camera field of view used by the Vignette effect.
  76189. */
  76190. vignetteCameraFov: number;
  76191. private _vignetteBlendMode;
  76192. /**
  76193. * Gets the vignette blend mode allowing different kind of effect.
  76194. */
  76195. /**
  76196. * Sets the vignette blend mode allowing different kind of effect.
  76197. */
  76198. vignetteBlendMode: number;
  76199. private _vignetteEnabled;
  76200. /**
  76201. * Gets wether the vignette effect is enabled.
  76202. */
  76203. /**
  76204. * Sets wether the vignette effect is enabled.
  76205. */
  76206. vignetteEnabled: boolean;
  76207. private _applyByPostProcess;
  76208. /**
  76209. * Gets wether the image processing is applied through a post process or not.
  76210. */
  76211. /**
  76212. * Sets wether the image processing is applied through a post process or not.
  76213. */
  76214. applyByPostProcess: boolean;
  76215. private _isEnabled;
  76216. /**
  76217. * Gets wether the image processing is enabled or not.
  76218. */
  76219. /**
  76220. * Sets wether the image processing is enabled or not.
  76221. */
  76222. isEnabled: boolean;
  76223. /**
  76224. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  76225. */
  76226. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  76227. /**
  76228. * Method called each time the image processing information changes requires to recompile the effect.
  76229. */
  76230. protected _updateParameters(): void;
  76231. /**
  76232. * Gets the current class name.
  76233. * @return "ImageProcessingConfiguration"
  76234. */
  76235. getClassName(): string;
  76236. /**
  76237. * Prepare the list of uniforms associated with the Image Processing effects.
  76238. * @param uniforms The list of uniforms used in the effect
  76239. * @param defines the list of defines currently in use
  76240. */
  76241. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  76242. /**
  76243. * Prepare the list of samplers associated with the Image Processing effects.
  76244. * @param samplersList The list of uniforms used in the effect
  76245. * @param defines the list of defines currently in use
  76246. */
  76247. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  76248. /**
  76249. * Prepare the list of defines associated to the shader.
  76250. * @param defines the list of defines to complete
  76251. * @param forPostProcess Define if we are currently in post process mode or not
  76252. */
  76253. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  76254. /**
  76255. * Returns true if all the image processing information are ready.
  76256. * @returns True if ready, otherwise, false
  76257. */
  76258. isReady(): boolean;
  76259. /**
  76260. * Binds the image processing to the shader.
  76261. * @param effect The effect to bind to
  76262. * @param overrideAspectRatio Override the aspect ratio of the effect
  76263. */
  76264. bind(effect: Effect, overrideAspectRatio?: number): void;
  76265. /**
  76266. * Clones the current image processing instance.
  76267. * @return The cloned image processing
  76268. */
  76269. clone(): ImageProcessingConfiguration;
  76270. /**
  76271. * Serializes the current image processing instance to a json representation.
  76272. * @return a JSON representation
  76273. */
  76274. serialize(): any;
  76275. /**
  76276. * Parses the image processing from a json representation.
  76277. * @param source the JSON source to parse
  76278. * @return The parsed image processing
  76279. */
  76280. static Parse(source: any): ImageProcessingConfiguration;
  76281. private static _VIGNETTEMODE_MULTIPLY;
  76282. private static _VIGNETTEMODE_OPAQUE;
  76283. /**
  76284. * Used to apply the vignette as a mix with the pixel color.
  76285. */
  76286. static readonly VIGNETTEMODE_MULTIPLY: number;
  76287. /**
  76288. * Used to apply the vignette as a replacement of the pixel color.
  76289. */
  76290. static readonly VIGNETTEMODE_OPAQUE: number;
  76291. }
  76292. }
  76293. declare module BABYLON {
  76294. /** @hidden */
  76295. export var postprocessVertexShader: {
  76296. name: string;
  76297. shader: string;
  76298. };
  76299. }
  76300. declare module BABYLON {
  76301. interface ThinEngine {
  76302. /**
  76303. * Creates a new render target texture
  76304. * @param size defines the size of the texture
  76305. * @param options defines the options used to create the texture
  76306. * @returns a new render target texture stored in an InternalTexture
  76307. */
  76308. createRenderTargetTexture(size: number | {
  76309. width: number;
  76310. height: number;
  76311. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  76312. /**
  76313. * Creates a depth stencil texture.
  76314. * This is only available in WebGL 2 or with the depth texture extension available.
  76315. * @param size The size of face edge in the texture.
  76316. * @param options The options defining the texture.
  76317. * @returns The texture
  76318. */
  76319. createDepthStencilTexture(size: number | {
  76320. width: number;
  76321. height: number;
  76322. }, options: DepthTextureCreationOptions): InternalTexture;
  76323. /** @hidden */
  76324. _createDepthStencilTexture(size: number | {
  76325. width: number;
  76326. height: number;
  76327. }, options: DepthTextureCreationOptions): InternalTexture;
  76328. }
  76329. }
  76330. declare module BABYLON {
  76331. /** Defines supported spaces */
  76332. export enum Space {
  76333. /** Local (object) space */
  76334. LOCAL = 0,
  76335. /** World space */
  76336. WORLD = 1,
  76337. /** Bone space */
  76338. BONE = 2
  76339. }
  76340. /** Defines the 3 main axes */
  76341. export class Axis {
  76342. /** X axis */
  76343. static X: Vector3;
  76344. /** Y axis */
  76345. static Y: Vector3;
  76346. /** Z axis */
  76347. static Z: Vector3;
  76348. }
  76349. }
  76350. declare module BABYLON {
  76351. /**
  76352. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  76353. * This is the base of the follow, arc rotate cameras and Free camera
  76354. * @see http://doc.babylonjs.com/features/cameras
  76355. */
  76356. export class TargetCamera extends Camera {
  76357. private static _RigCamTransformMatrix;
  76358. private static _TargetTransformMatrix;
  76359. private static _TargetFocalPoint;
  76360. /**
  76361. * Define the current direction the camera is moving to
  76362. */
  76363. cameraDirection: Vector3;
  76364. /**
  76365. * Define the current rotation the camera is rotating to
  76366. */
  76367. cameraRotation: Vector2;
  76368. /**
  76369. * When set, the up vector of the camera will be updated by the rotation of the camera
  76370. */
  76371. updateUpVectorFromRotation: boolean;
  76372. private _tmpQuaternion;
  76373. /**
  76374. * Define the current rotation of the camera
  76375. */
  76376. rotation: Vector3;
  76377. /**
  76378. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  76379. */
  76380. rotationQuaternion: Quaternion;
  76381. /**
  76382. * Define the current speed of the camera
  76383. */
  76384. speed: number;
  76385. /**
  76386. * Add cconstraint to the camera to prevent it to move freely in all directions and
  76387. * around all axis.
  76388. */
  76389. noRotationConstraint: boolean;
  76390. /**
  76391. * Define the current target of the camera as an object or a position.
  76392. */
  76393. lockedTarget: any;
  76394. /** @hidden */
  76395. _currentTarget: Vector3;
  76396. /** @hidden */
  76397. _initialFocalDistance: number;
  76398. /** @hidden */
  76399. _viewMatrix: Matrix;
  76400. /** @hidden */
  76401. _camMatrix: Matrix;
  76402. /** @hidden */
  76403. _cameraTransformMatrix: Matrix;
  76404. /** @hidden */
  76405. _cameraRotationMatrix: Matrix;
  76406. /** @hidden */
  76407. _referencePoint: Vector3;
  76408. /** @hidden */
  76409. _transformedReferencePoint: Vector3;
  76410. protected _globalCurrentTarget: Vector3;
  76411. protected _globalCurrentUpVector: Vector3;
  76412. /** @hidden */
  76413. _reset: () => void;
  76414. private _defaultUp;
  76415. /**
  76416. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  76417. * This is the base of the follow, arc rotate cameras and Free camera
  76418. * @see http://doc.babylonjs.com/features/cameras
  76419. * @param name Defines the name of the camera in the scene
  76420. * @param position Defines the start position of the camera in the scene
  76421. * @param scene Defines the scene the camera belongs to
  76422. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  76423. */
  76424. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  76425. /**
  76426. * Gets the position in front of the camera at a given distance.
  76427. * @param distance The distance from the camera we want the position to be
  76428. * @returns the position
  76429. */
  76430. getFrontPosition(distance: number): Vector3;
  76431. /** @hidden */
  76432. _getLockedTargetPosition(): Nullable<Vector3>;
  76433. private _storedPosition;
  76434. private _storedRotation;
  76435. private _storedRotationQuaternion;
  76436. /**
  76437. * Store current camera state of the camera (fov, position, rotation, etc..)
  76438. * @returns the camera
  76439. */
  76440. storeState(): Camera;
  76441. /**
  76442. * Restored camera state. You must call storeState() first
  76443. * @returns whether it was successful or not
  76444. * @hidden
  76445. */
  76446. _restoreStateValues(): boolean;
  76447. /** @hidden */
  76448. _initCache(): void;
  76449. /** @hidden */
  76450. _updateCache(ignoreParentClass?: boolean): void;
  76451. /** @hidden */
  76452. _isSynchronizedViewMatrix(): boolean;
  76453. /** @hidden */
  76454. _computeLocalCameraSpeed(): number;
  76455. /**
  76456. * Defines the target the camera should look at.
  76457. * @param target Defines the new target as a Vector or a mesh
  76458. */
  76459. setTarget(target: Vector3): void;
  76460. /**
  76461. * Return the current target position of the camera. This value is expressed in local space.
  76462. * @returns the target position
  76463. */
  76464. getTarget(): Vector3;
  76465. /** @hidden */
  76466. _decideIfNeedsToMove(): boolean;
  76467. /** @hidden */
  76468. _updatePosition(): void;
  76469. /** @hidden */
  76470. _checkInputs(): void;
  76471. protected _updateCameraRotationMatrix(): void;
  76472. /**
  76473. * Update the up vector to apply the rotation of the camera (So if you changed the camera rotation.z this will let you update the up vector as well)
  76474. * @returns the current camera
  76475. */
  76476. private _rotateUpVectorWithCameraRotationMatrix;
  76477. private _cachedRotationZ;
  76478. private _cachedQuaternionRotationZ;
  76479. /** @hidden */
  76480. _getViewMatrix(): Matrix;
  76481. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  76482. /**
  76483. * @hidden
  76484. */
  76485. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  76486. /**
  76487. * @hidden
  76488. */
  76489. _updateRigCameras(): void;
  76490. private _getRigCamPositionAndTarget;
  76491. /**
  76492. * Gets the current object class name.
  76493. * @return the class name
  76494. */
  76495. getClassName(): string;
  76496. }
  76497. }
  76498. declare module BABYLON {
  76499. /**
  76500. * Gather the list of keyboard event types as constants.
  76501. */
  76502. export class KeyboardEventTypes {
  76503. /**
  76504. * The keydown event is fired when a key becomes active (pressed).
  76505. */
  76506. static readonly KEYDOWN: number;
  76507. /**
  76508. * The keyup event is fired when a key has been released.
  76509. */
  76510. static readonly KEYUP: number;
  76511. }
  76512. /**
  76513. * This class is used to store keyboard related info for the onKeyboardObservable event.
  76514. */
  76515. export class KeyboardInfo {
  76516. /**
  76517. * Defines the type of event (KeyboardEventTypes)
  76518. */
  76519. type: number;
  76520. /**
  76521. * Defines the related dom event
  76522. */
  76523. event: KeyboardEvent;
  76524. /**
  76525. * Instantiates a new keyboard info.
  76526. * This class is used to store keyboard related info for the onKeyboardObservable event.
  76527. * @param type Defines the type of event (KeyboardEventTypes)
  76528. * @param event Defines the related dom event
  76529. */
  76530. constructor(
  76531. /**
  76532. * Defines the type of event (KeyboardEventTypes)
  76533. */
  76534. type: number,
  76535. /**
  76536. * Defines the related dom event
  76537. */
  76538. event: KeyboardEvent);
  76539. }
  76540. /**
  76541. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  76542. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  76543. */
  76544. export class KeyboardInfoPre extends KeyboardInfo {
  76545. /**
  76546. * Defines the type of event (KeyboardEventTypes)
  76547. */
  76548. type: number;
  76549. /**
  76550. * Defines the related dom event
  76551. */
  76552. event: KeyboardEvent;
  76553. /**
  76554. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  76555. */
  76556. skipOnPointerObservable: boolean;
  76557. /**
  76558. * Instantiates a new keyboard pre info.
  76559. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  76560. * @param type Defines the type of event (KeyboardEventTypes)
  76561. * @param event Defines the related dom event
  76562. */
  76563. constructor(
  76564. /**
  76565. * Defines the type of event (KeyboardEventTypes)
  76566. */
  76567. type: number,
  76568. /**
  76569. * Defines the related dom event
  76570. */
  76571. event: KeyboardEvent);
  76572. }
  76573. }
  76574. declare module BABYLON {
  76575. /**
  76576. * Manage the keyboard inputs to control the movement of a free camera.
  76577. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  76578. */
  76579. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  76580. /**
  76581. * Defines the camera the input is attached to.
  76582. */
  76583. camera: FreeCamera;
  76584. /**
  76585. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  76586. */
  76587. keysUp: number[];
  76588. /**
  76589. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  76590. */
  76591. keysDown: number[];
  76592. /**
  76593. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  76594. */
  76595. keysLeft: number[];
  76596. /**
  76597. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  76598. */
  76599. keysRight: number[];
  76600. private _keys;
  76601. private _onCanvasBlurObserver;
  76602. private _onKeyboardObserver;
  76603. private _engine;
  76604. private _scene;
  76605. /**
  76606. * Attach the input controls to a specific dom element to get the input from.
  76607. * @param element Defines the element the controls should be listened from
  76608. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  76609. */
  76610. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  76611. /**
  76612. * Detach the current controls from the specified dom element.
  76613. * @param element Defines the element to stop listening the inputs from
  76614. */
  76615. detachControl(element: Nullable<HTMLElement>): void;
  76616. /**
  76617. * Update the current camera state depending on the inputs that have been used this frame.
  76618. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  76619. */
  76620. checkInputs(): void;
  76621. /**
  76622. * Gets the class name of the current intput.
  76623. * @returns the class name
  76624. */
  76625. getClassName(): string;
  76626. /** @hidden */
  76627. _onLostFocus(): void;
  76628. /**
  76629. * Get the friendly name associated with the input class.
  76630. * @returns the input friendly name
  76631. */
  76632. getSimpleName(): string;
  76633. }
  76634. }
  76635. declare module BABYLON {
  76636. /**
  76637. * Interface describing all the common properties and methods a shadow light needs to implement.
  76638. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  76639. * as well as binding the different shadow properties to the effects.
  76640. */
  76641. export interface IShadowLight extends Light {
  76642. /**
  76643. * The light id in the scene (used in scene.findLighById for instance)
  76644. */
  76645. id: string;
  76646. /**
  76647. * The position the shdow will be casted from.
  76648. */
  76649. position: Vector3;
  76650. /**
  76651. * In 2d mode (needCube being false), the direction used to cast the shadow.
  76652. */
  76653. direction: Vector3;
  76654. /**
  76655. * The transformed position. Position of the light in world space taking parenting in account.
  76656. */
  76657. transformedPosition: Vector3;
  76658. /**
  76659. * The transformed direction. Direction of the light in world space taking parenting in account.
  76660. */
  76661. transformedDirection: Vector3;
  76662. /**
  76663. * The friendly name of the light in the scene.
  76664. */
  76665. name: string;
  76666. /**
  76667. * Defines the shadow projection clipping minimum z value.
  76668. */
  76669. shadowMinZ: number;
  76670. /**
  76671. * Defines the shadow projection clipping maximum z value.
  76672. */
  76673. shadowMaxZ: number;
  76674. /**
  76675. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  76676. * @returns true if the information has been computed, false if it does not need to (no parenting)
  76677. */
  76678. computeTransformedInformation(): boolean;
  76679. /**
  76680. * Gets the scene the light belongs to.
  76681. * @returns The scene
  76682. */
  76683. getScene(): Scene;
  76684. /**
  76685. * Callback defining a custom Projection Matrix Builder.
  76686. * This can be used to override the default projection matrix computation.
  76687. */
  76688. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  76689. /**
  76690. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  76691. * @param matrix The materix to updated with the projection information
  76692. * @param viewMatrix The transform matrix of the light
  76693. * @param renderList The list of mesh to render in the map
  76694. * @returns The current light
  76695. */
  76696. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  76697. /**
  76698. * Gets the current depth scale used in ESM.
  76699. * @returns The scale
  76700. */
  76701. getDepthScale(): number;
  76702. /**
  76703. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  76704. * @returns true if a cube texture needs to be use
  76705. */
  76706. needCube(): boolean;
  76707. /**
  76708. * Detects if the projection matrix requires to be recomputed this frame.
  76709. * @returns true if it requires to be recomputed otherwise, false.
  76710. */
  76711. needProjectionMatrixCompute(): boolean;
  76712. /**
  76713. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  76714. */
  76715. forceProjectionMatrixCompute(): void;
  76716. /**
  76717. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  76718. * @param faceIndex The index of the face we are computed the direction to generate shadow
  76719. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  76720. */
  76721. getShadowDirection(faceIndex?: number): Vector3;
  76722. /**
  76723. * Gets the minZ used for shadow according to both the scene and the light.
  76724. * @param activeCamera The camera we are returning the min for
  76725. * @returns the depth min z
  76726. */
  76727. getDepthMinZ(activeCamera: Camera): number;
  76728. /**
  76729. * Gets the maxZ used for shadow according to both the scene and the light.
  76730. * @param activeCamera The camera we are returning the max for
  76731. * @returns the depth max z
  76732. */
  76733. getDepthMaxZ(activeCamera: Camera): number;
  76734. }
  76735. /**
  76736. * Base implementation IShadowLight
  76737. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  76738. */
  76739. export abstract class ShadowLight extends Light implements IShadowLight {
  76740. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  76741. protected _position: Vector3;
  76742. protected _setPosition(value: Vector3): void;
  76743. /**
  76744. * Sets the position the shadow will be casted from. Also use as the light position for both
  76745. * point and spot lights.
  76746. */
  76747. /**
  76748. * Sets the position the shadow will be casted from. Also use as the light position for both
  76749. * point and spot lights.
  76750. */
  76751. position: Vector3;
  76752. protected _direction: Vector3;
  76753. protected _setDirection(value: Vector3): void;
  76754. /**
  76755. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  76756. * Also use as the light direction on spot and directional lights.
  76757. */
  76758. /**
  76759. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  76760. * Also use as the light direction on spot and directional lights.
  76761. */
  76762. direction: Vector3;
  76763. private _shadowMinZ;
  76764. /**
  76765. * Gets the shadow projection clipping minimum z value.
  76766. */
  76767. /**
  76768. * Sets the shadow projection clipping minimum z value.
  76769. */
  76770. shadowMinZ: number;
  76771. private _shadowMaxZ;
  76772. /**
  76773. * Sets the shadow projection clipping maximum z value.
  76774. */
  76775. /**
  76776. * Gets the shadow projection clipping maximum z value.
  76777. */
  76778. shadowMaxZ: number;
  76779. /**
  76780. * Callback defining a custom Projection Matrix Builder.
  76781. * This can be used to override the default projection matrix computation.
  76782. */
  76783. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  76784. /**
  76785. * The transformed position. Position of the light in world space taking parenting in account.
  76786. */
  76787. transformedPosition: Vector3;
  76788. /**
  76789. * The transformed direction. Direction of the light in world space taking parenting in account.
  76790. */
  76791. transformedDirection: Vector3;
  76792. private _needProjectionMatrixCompute;
  76793. /**
  76794. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  76795. * @returns true if the information has been computed, false if it does not need to (no parenting)
  76796. */
  76797. computeTransformedInformation(): boolean;
  76798. /**
  76799. * Return the depth scale used for the shadow map.
  76800. * @returns the depth scale.
  76801. */
  76802. getDepthScale(): number;
  76803. /**
  76804. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  76805. * @param faceIndex The index of the face we are computed the direction to generate shadow
  76806. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  76807. */
  76808. getShadowDirection(faceIndex?: number): Vector3;
  76809. /**
  76810. * Returns the ShadowLight absolute position in the World.
  76811. * @returns the position vector in world space
  76812. */
  76813. getAbsolutePosition(): Vector3;
  76814. /**
  76815. * Sets the ShadowLight direction toward the passed target.
  76816. * @param target The point to target in local space
  76817. * @returns the updated ShadowLight direction
  76818. */
  76819. setDirectionToTarget(target: Vector3): Vector3;
  76820. /**
  76821. * Returns the light rotation in euler definition.
  76822. * @returns the x y z rotation in local space.
  76823. */
  76824. getRotation(): Vector3;
  76825. /**
  76826. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  76827. * @returns true if a cube texture needs to be use
  76828. */
  76829. needCube(): boolean;
  76830. /**
  76831. * Detects if the projection matrix requires to be recomputed this frame.
  76832. * @returns true if it requires to be recomputed otherwise, false.
  76833. */
  76834. needProjectionMatrixCompute(): boolean;
  76835. /**
  76836. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  76837. */
  76838. forceProjectionMatrixCompute(): void;
  76839. /** @hidden */
  76840. _initCache(): void;
  76841. /** @hidden */
  76842. _isSynchronized(): boolean;
  76843. /**
  76844. * Computes the world matrix of the node
  76845. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  76846. * @returns the world matrix
  76847. */
  76848. computeWorldMatrix(force?: boolean): Matrix;
  76849. /**
  76850. * Gets the minZ used for shadow according to both the scene and the light.
  76851. * @param activeCamera The camera we are returning the min for
  76852. * @returns the depth min z
  76853. */
  76854. getDepthMinZ(activeCamera: Camera): number;
  76855. /**
  76856. * Gets the maxZ used for shadow according to both the scene and the light.
  76857. * @param activeCamera The camera we are returning the max for
  76858. * @returns the depth max z
  76859. */
  76860. getDepthMaxZ(activeCamera: Camera): number;
  76861. /**
  76862. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  76863. * @param matrix The materix to updated with the projection information
  76864. * @param viewMatrix The transform matrix of the light
  76865. * @param renderList The list of mesh to render in the map
  76866. * @returns The current light
  76867. */
  76868. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  76869. }
  76870. }
  76871. declare module BABYLON {
  76872. /**
  76873. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  76874. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  76875. */
  76876. export class EffectFallbacks implements IEffectFallbacks {
  76877. private _defines;
  76878. private _currentRank;
  76879. private _maxRank;
  76880. private _mesh;
  76881. /**
  76882. * Removes the fallback from the bound mesh.
  76883. */
  76884. unBindMesh(): void;
  76885. /**
  76886. * Adds a fallback on the specified property.
  76887. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  76888. * @param define The name of the define in the shader
  76889. */
  76890. addFallback(rank: number, define: string): void;
  76891. /**
  76892. * Sets the mesh to use CPU skinning when needing to fallback.
  76893. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  76894. * @param mesh The mesh to use the fallbacks.
  76895. */
  76896. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  76897. /**
  76898. * Checks to see if more fallbacks are still availible.
  76899. */
  76900. readonly hasMoreFallbacks: boolean;
  76901. /**
  76902. * Removes the defines that should be removed when falling back.
  76903. * @param currentDefines defines the current define statements for the shader.
  76904. * @param effect defines the current effect we try to compile
  76905. * @returns The resulting defines with defines of the current rank removed.
  76906. */
  76907. reduce(currentDefines: string, effect: Effect): string;
  76908. }
  76909. }
  76910. declare module BABYLON {
  76911. /**
  76912. * "Static Class" containing the most commonly used helper while dealing with material for
  76913. * rendering purpose.
  76914. *
  76915. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  76916. *
  76917. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  76918. */
  76919. export class MaterialHelper {
  76920. /**
  76921. * Bind the current view position to an effect.
  76922. * @param effect The effect to be bound
  76923. * @param scene The scene the eyes position is used from
  76924. */
  76925. static BindEyePosition(effect: Effect, scene: Scene): void;
  76926. /**
  76927. * Helps preparing the defines values about the UVs in used in the effect.
  76928. * UVs are shared as much as we can accross channels in the shaders.
  76929. * @param texture The texture we are preparing the UVs for
  76930. * @param defines The defines to update
  76931. * @param key The channel key "diffuse", "specular"... used in the shader
  76932. */
  76933. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  76934. /**
  76935. * Binds a texture matrix value to its corrsponding uniform
  76936. * @param texture The texture to bind the matrix for
  76937. * @param uniformBuffer The uniform buffer receivin the data
  76938. * @param key The channel key "diffuse", "specular"... used in the shader
  76939. */
  76940. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  76941. /**
  76942. * Gets the current status of the fog (should it be enabled?)
  76943. * @param mesh defines the mesh to evaluate for fog support
  76944. * @param scene defines the hosting scene
  76945. * @returns true if fog must be enabled
  76946. */
  76947. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  76948. /**
  76949. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  76950. * @param mesh defines the current mesh
  76951. * @param scene defines the current scene
  76952. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  76953. * @param pointsCloud defines if point cloud rendering has to be turned on
  76954. * @param fogEnabled defines if fog has to be turned on
  76955. * @param alphaTest defines if alpha testing has to be turned on
  76956. * @param defines defines the current list of defines
  76957. */
  76958. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  76959. /**
  76960. * Helper used to prepare the list of defines associated with frame values for shader compilation
  76961. * @param scene defines the current scene
  76962. * @param engine defines the current engine
  76963. * @param defines specifies the list of active defines
  76964. * @param useInstances defines if instances have to be turned on
  76965. * @param useClipPlane defines if clip plane have to be turned on
  76966. */
  76967. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  76968. /**
  76969. * Prepares the defines for bones
  76970. * @param mesh The mesh containing the geometry data we will draw
  76971. * @param defines The defines to update
  76972. */
  76973. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  76974. /**
  76975. * Prepares the defines for morph targets
  76976. * @param mesh The mesh containing the geometry data we will draw
  76977. * @param defines The defines to update
  76978. */
  76979. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  76980. /**
  76981. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  76982. * @param mesh The mesh containing the geometry data we will draw
  76983. * @param defines The defines to update
  76984. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  76985. * @param useBones Precise whether bones should be used or not (override mesh info)
  76986. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  76987. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  76988. * @returns false if defines are considered not dirty and have not been checked
  76989. */
  76990. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  76991. /**
  76992. * Prepares the defines related to multiview
  76993. * @param scene The scene we are intending to draw
  76994. * @param defines The defines to update
  76995. */
  76996. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  76997. /**
  76998. * Prepares the defines related to the light information passed in parameter
  76999. * @param scene The scene we are intending to draw
  77000. * @param mesh The mesh the effect is compiling for
  77001. * @param light The light the effect is compiling for
  77002. * @param lightIndex The index of the light
  77003. * @param defines The defines to update
  77004. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  77005. * @param state Defines the current state regarding what is needed (normals, etc...)
  77006. */
  77007. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  77008. needNormals: boolean;
  77009. needRebuild: boolean;
  77010. shadowEnabled: boolean;
  77011. specularEnabled: boolean;
  77012. lightmapMode: boolean;
  77013. }): void;
  77014. /**
  77015. * Prepares the defines related to the light information passed in parameter
  77016. * @param scene The scene we are intending to draw
  77017. * @param mesh The mesh the effect is compiling for
  77018. * @param defines The defines to update
  77019. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  77020. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  77021. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  77022. * @returns true if normals will be required for the rest of the effect
  77023. */
  77024. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  77025. /**
  77026. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  77027. * @param lightIndex defines the light index
  77028. * @param uniformsList The uniform list
  77029. * @param samplersList The sampler list
  77030. * @param projectedLightTexture defines if projected texture must be used
  77031. * @param uniformBuffersList defines an optional list of uniform buffers
  77032. */
  77033. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  77034. /**
  77035. * Prepares the uniforms and samplers list to be used in the effect
  77036. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  77037. * @param samplersList The sampler list
  77038. * @param defines The defines helping in the list generation
  77039. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  77040. */
  77041. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  77042. /**
  77043. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  77044. * @param defines The defines to update while falling back
  77045. * @param fallbacks The authorized effect fallbacks
  77046. * @param maxSimultaneousLights The maximum number of lights allowed
  77047. * @param rank the current rank of the Effect
  77048. * @returns The newly affected rank
  77049. */
  77050. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  77051. private static _TmpMorphInfluencers;
  77052. /**
  77053. * Prepares the list of attributes required for morph targets according to the effect defines.
  77054. * @param attribs The current list of supported attribs
  77055. * @param mesh The mesh to prepare the morph targets attributes for
  77056. * @param influencers The number of influencers
  77057. */
  77058. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  77059. /**
  77060. * Prepares the list of attributes required for morph targets according to the effect defines.
  77061. * @param attribs The current list of supported attribs
  77062. * @param mesh The mesh to prepare the morph targets attributes for
  77063. * @param defines The current Defines of the effect
  77064. */
  77065. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  77066. /**
  77067. * Prepares the list of attributes required for bones according to the effect defines.
  77068. * @param attribs The current list of supported attribs
  77069. * @param mesh The mesh to prepare the bones attributes for
  77070. * @param defines The current Defines of the effect
  77071. * @param fallbacks The current efffect fallback strategy
  77072. */
  77073. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  77074. /**
  77075. * Check and prepare the list of attributes required for instances according to the effect defines.
  77076. * @param attribs The current list of supported attribs
  77077. * @param defines The current MaterialDefines of the effect
  77078. */
  77079. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  77080. /**
  77081. * Add the list of attributes required for instances to the attribs array.
  77082. * @param attribs The current list of supported attribs
  77083. */
  77084. static PushAttributesForInstances(attribs: string[]): void;
  77085. /**
  77086. * Binds the light information to the effect.
  77087. * @param light The light containing the generator
  77088. * @param effect The effect we are binding the data to
  77089. * @param lightIndex The light index in the effect used to render
  77090. */
  77091. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  77092. /**
  77093. * Binds the lights information from the scene to the effect for the given mesh.
  77094. * @param light Light to bind
  77095. * @param lightIndex Light index
  77096. * @param scene The scene where the light belongs to
  77097. * @param effect The effect we are binding the data to
  77098. * @param useSpecular Defines if specular is supported
  77099. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  77100. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  77101. */
  77102. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  77103. /**
  77104. * Binds the lights information from the scene to the effect for the given mesh.
  77105. * @param scene The scene the lights belongs to
  77106. * @param mesh The mesh we are binding the information to render
  77107. * @param effect The effect we are binding the data to
  77108. * @param defines The generated defines for the effect
  77109. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  77110. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  77111. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  77112. */
  77113. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  77114. private static _tempFogColor;
  77115. /**
  77116. * Binds the fog information from the scene to the effect for the given mesh.
  77117. * @param scene The scene the lights belongs to
  77118. * @param mesh The mesh we are binding the information to render
  77119. * @param effect The effect we are binding the data to
  77120. * @param linearSpace Defines if the fog effect is applied in linear space
  77121. */
  77122. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  77123. /**
  77124. * Binds the bones information from the mesh to the effect.
  77125. * @param mesh The mesh we are binding the information to render
  77126. * @param effect The effect we are binding the data to
  77127. */
  77128. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  77129. /**
  77130. * Binds the morph targets information from the mesh to the effect.
  77131. * @param abstractMesh The mesh we are binding the information to render
  77132. * @param effect The effect we are binding the data to
  77133. */
  77134. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  77135. /**
  77136. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  77137. * @param defines The generated defines used in the effect
  77138. * @param effect The effect we are binding the data to
  77139. * @param scene The scene we are willing to render with logarithmic scale for
  77140. */
  77141. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  77142. /**
  77143. * Binds the clip plane information from the scene to the effect.
  77144. * @param scene The scene the clip plane information are extracted from
  77145. * @param effect The effect we are binding the data to
  77146. */
  77147. static BindClipPlane(effect: Effect, scene: Scene): void;
  77148. }
  77149. }
  77150. declare module BABYLON {
  77151. /** @hidden */
  77152. export var packingFunctions: {
  77153. name: string;
  77154. shader: string;
  77155. };
  77156. }
  77157. declare module BABYLON {
  77158. /** @hidden */
  77159. export var shadowMapPixelShader: {
  77160. name: string;
  77161. shader: string;
  77162. };
  77163. }
  77164. declare module BABYLON {
  77165. /** @hidden */
  77166. export var bonesDeclaration: {
  77167. name: string;
  77168. shader: string;
  77169. };
  77170. }
  77171. declare module BABYLON {
  77172. /** @hidden */
  77173. export var morphTargetsVertexGlobalDeclaration: {
  77174. name: string;
  77175. shader: string;
  77176. };
  77177. }
  77178. declare module BABYLON {
  77179. /** @hidden */
  77180. export var morphTargetsVertexDeclaration: {
  77181. name: string;
  77182. shader: string;
  77183. };
  77184. }
  77185. declare module BABYLON {
  77186. /** @hidden */
  77187. export var instancesDeclaration: {
  77188. name: string;
  77189. shader: string;
  77190. };
  77191. }
  77192. declare module BABYLON {
  77193. /** @hidden */
  77194. export var helperFunctions: {
  77195. name: string;
  77196. shader: string;
  77197. };
  77198. }
  77199. declare module BABYLON {
  77200. /** @hidden */
  77201. export var morphTargetsVertex: {
  77202. name: string;
  77203. shader: string;
  77204. };
  77205. }
  77206. declare module BABYLON {
  77207. /** @hidden */
  77208. export var instancesVertex: {
  77209. name: string;
  77210. shader: string;
  77211. };
  77212. }
  77213. declare module BABYLON {
  77214. /** @hidden */
  77215. export var bonesVertex: {
  77216. name: string;
  77217. shader: string;
  77218. };
  77219. }
  77220. declare module BABYLON {
  77221. /** @hidden */
  77222. export var shadowMapVertexShader: {
  77223. name: string;
  77224. shader: string;
  77225. };
  77226. }
  77227. declare module BABYLON {
  77228. /** @hidden */
  77229. export var depthBoxBlurPixelShader: {
  77230. name: string;
  77231. shader: string;
  77232. };
  77233. }
  77234. declare module BABYLON {
  77235. /**
  77236. * Defines the options associated with the creation of a custom shader for a shadow generator.
  77237. */
  77238. export interface ICustomShaderOptions {
  77239. /**
  77240. * Gets or sets the custom shader name to use
  77241. */
  77242. shaderName: string;
  77243. /**
  77244. * The list of attribute names used in the shader
  77245. */
  77246. attributes?: string[];
  77247. /**
  77248. * The list of unifrom names used in the shader
  77249. */
  77250. uniforms?: string[];
  77251. /**
  77252. * The list of sampler names used in the shader
  77253. */
  77254. samplers?: string[];
  77255. /**
  77256. * The list of defines used in the shader
  77257. */
  77258. defines?: string[];
  77259. }
  77260. /**
  77261. * Interface to implement to create a shadow generator compatible with BJS.
  77262. */
  77263. export interface IShadowGenerator {
  77264. /**
  77265. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  77266. * @returns The render target texture if present otherwise, null
  77267. */
  77268. getShadowMap(): Nullable<RenderTargetTexture>;
  77269. /**
  77270. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  77271. * @returns The render target texture if the shadow map is present otherwise, null
  77272. */
  77273. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  77274. /**
  77275. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  77276. * @param subMesh The submesh we want to render in the shadow map
  77277. * @param useInstances Defines wether will draw in the map using instances
  77278. * @returns true if ready otherwise, false
  77279. */
  77280. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  77281. /**
  77282. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  77283. * @param defines Defines of the material we want to update
  77284. * @param lightIndex Index of the light in the enabled light list of the material
  77285. */
  77286. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  77287. /**
  77288. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  77289. * defined in the generator but impacting the effect).
  77290. * It implies the unifroms available on the materials are the standard BJS ones.
  77291. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  77292. * @param effect The effect we are binfing the information for
  77293. */
  77294. bindShadowLight(lightIndex: string, effect: Effect): void;
  77295. /**
  77296. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  77297. * (eq to shadow prjection matrix * light transform matrix)
  77298. * @returns The transform matrix used to create the shadow map
  77299. */
  77300. getTransformMatrix(): Matrix;
  77301. /**
  77302. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  77303. * Cube and 2D textures for instance.
  77304. */
  77305. recreateShadowMap(): void;
  77306. /**
  77307. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77308. * @param onCompiled Callback triggered at the and of the effects compilation
  77309. * @param options Sets of optional options forcing the compilation with different modes
  77310. */
  77311. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  77312. useInstances: boolean;
  77313. }>): void;
  77314. /**
  77315. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77316. * @param options Sets of optional options forcing the compilation with different modes
  77317. * @returns A promise that resolves when the compilation completes
  77318. */
  77319. forceCompilationAsync(options?: Partial<{
  77320. useInstances: boolean;
  77321. }>): Promise<void>;
  77322. /**
  77323. * Serializes the shadow generator setup to a json object.
  77324. * @returns The serialized JSON object
  77325. */
  77326. serialize(): any;
  77327. /**
  77328. * Disposes the Shadow map and related Textures and effects.
  77329. */
  77330. dispose(): void;
  77331. }
  77332. /**
  77333. * Default implementation IShadowGenerator.
  77334. * This is the main object responsible of generating shadows in the framework.
  77335. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  77336. */
  77337. export class ShadowGenerator implements IShadowGenerator {
  77338. /**
  77339. * Shadow generator mode None: no filtering applied.
  77340. */
  77341. static readonly FILTER_NONE: number;
  77342. /**
  77343. * Shadow generator mode ESM: Exponential Shadow Mapping.
  77344. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77345. */
  77346. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  77347. /**
  77348. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  77349. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  77350. */
  77351. static readonly FILTER_POISSONSAMPLING: number;
  77352. /**
  77353. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  77354. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77355. */
  77356. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  77357. /**
  77358. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  77359. * edge artifacts on steep falloff.
  77360. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77361. */
  77362. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  77363. /**
  77364. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  77365. * edge artifacts on steep falloff.
  77366. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77367. */
  77368. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  77369. /**
  77370. * Shadow generator mode PCF: Percentage Closer Filtering
  77371. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  77372. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  77373. */
  77374. static readonly FILTER_PCF: number;
  77375. /**
  77376. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  77377. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  77378. * Contact Hardening
  77379. */
  77380. static readonly FILTER_PCSS: number;
  77381. /**
  77382. * Reserved for PCF and PCSS
  77383. * Highest Quality.
  77384. *
  77385. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  77386. *
  77387. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  77388. */
  77389. static readonly QUALITY_HIGH: number;
  77390. /**
  77391. * Reserved for PCF and PCSS
  77392. * Good tradeoff for quality/perf cross devices
  77393. *
  77394. * Execute PCF on a 3*3 kernel.
  77395. *
  77396. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  77397. */
  77398. static readonly QUALITY_MEDIUM: number;
  77399. /**
  77400. * Reserved for PCF and PCSS
  77401. * The lowest quality but the fastest.
  77402. *
  77403. * Execute PCF on a 1*1 kernel.
  77404. *
  77405. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  77406. */
  77407. static readonly QUALITY_LOW: number;
  77408. /** Gets or sets the custom shader name to use */
  77409. customShaderOptions: ICustomShaderOptions;
  77410. /**
  77411. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  77412. */
  77413. onBeforeShadowMapRenderObservable: Observable<Effect>;
  77414. /**
  77415. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  77416. */
  77417. onAfterShadowMapRenderObservable: Observable<Effect>;
  77418. /**
  77419. * Observable triggered before a mesh is rendered in the shadow map.
  77420. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  77421. */
  77422. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  77423. /**
  77424. * Observable triggered after a mesh is rendered in the shadow map.
  77425. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  77426. */
  77427. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  77428. private _bias;
  77429. /**
  77430. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  77431. */
  77432. /**
  77433. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  77434. */
  77435. bias: number;
  77436. private _normalBias;
  77437. /**
  77438. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  77439. */
  77440. /**
  77441. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  77442. */
  77443. normalBias: number;
  77444. private _blurBoxOffset;
  77445. /**
  77446. * Gets the blur box offset: offset applied during the blur pass.
  77447. * Only useful if useKernelBlur = false
  77448. */
  77449. /**
  77450. * Sets the blur box offset: offset applied during the blur pass.
  77451. * Only useful if useKernelBlur = false
  77452. */
  77453. blurBoxOffset: number;
  77454. private _blurScale;
  77455. /**
  77456. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  77457. * 2 means half of the size.
  77458. */
  77459. /**
  77460. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  77461. * 2 means half of the size.
  77462. */
  77463. blurScale: number;
  77464. private _blurKernel;
  77465. /**
  77466. * Gets the blur kernel: kernel size of the blur pass.
  77467. * Only useful if useKernelBlur = true
  77468. */
  77469. /**
  77470. * Sets the blur kernel: kernel size of the blur pass.
  77471. * Only useful if useKernelBlur = true
  77472. */
  77473. blurKernel: number;
  77474. private _useKernelBlur;
  77475. /**
  77476. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  77477. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  77478. */
  77479. /**
  77480. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  77481. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  77482. */
  77483. useKernelBlur: boolean;
  77484. private _depthScale;
  77485. /**
  77486. * Gets the depth scale used in ESM mode.
  77487. */
  77488. /**
  77489. * Sets the depth scale used in ESM mode.
  77490. * This can override the scale stored on the light.
  77491. */
  77492. depthScale: number;
  77493. private _filter;
  77494. /**
  77495. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  77496. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  77497. */
  77498. /**
  77499. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  77500. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  77501. */
  77502. filter: number;
  77503. /**
  77504. * Gets if the current filter is set to Poisson Sampling.
  77505. */
  77506. /**
  77507. * Sets the current filter to Poisson Sampling.
  77508. */
  77509. usePoissonSampling: boolean;
  77510. /**
  77511. * Gets if the current filter is set to ESM.
  77512. */
  77513. /**
  77514. * Sets the current filter is to ESM.
  77515. */
  77516. useExponentialShadowMap: boolean;
  77517. /**
  77518. * Gets if the current filter is set to filtered ESM.
  77519. */
  77520. /**
  77521. * Gets if the current filter is set to filtered ESM.
  77522. */
  77523. useBlurExponentialShadowMap: boolean;
  77524. /**
  77525. * Gets if the current filter is set to "close ESM" (using the inverse of the
  77526. * exponential to prevent steep falloff artifacts).
  77527. */
  77528. /**
  77529. * Sets the current filter to "close ESM" (using the inverse of the
  77530. * exponential to prevent steep falloff artifacts).
  77531. */
  77532. useCloseExponentialShadowMap: boolean;
  77533. /**
  77534. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  77535. * exponential to prevent steep falloff artifacts).
  77536. */
  77537. /**
  77538. * Sets the current filter to filtered "close ESM" (using the inverse of the
  77539. * exponential to prevent steep falloff artifacts).
  77540. */
  77541. useBlurCloseExponentialShadowMap: boolean;
  77542. /**
  77543. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  77544. */
  77545. /**
  77546. * Sets the current filter to "PCF" (percentage closer filtering).
  77547. */
  77548. usePercentageCloserFiltering: boolean;
  77549. private _filteringQuality;
  77550. /**
  77551. * Gets the PCF or PCSS Quality.
  77552. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  77553. */
  77554. /**
  77555. * Sets the PCF or PCSS Quality.
  77556. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  77557. */
  77558. filteringQuality: number;
  77559. /**
  77560. * Gets if the current filter is set to "PCSS" (contact hardening).
  77561. */
  77562. /**
  77563. * Sets the current filter to "PCSS" (contact hardening).
  77564. */
  77565. useContactHardeningShadow: boolean;
  77566. private _contactHardeningLightSizeUVRatio;
  77567. /**
  77568. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  77569. * Using a ratio helps keeping shape stability independently of the map size.
  77570. *
  77571. * It does not account for the light projection as it was having too much
  77572. * instability during the light setup or during light position changes.
  77573. *
  77574. * Only valid if useContactHardeningShadow is true.
  77575. */
  77576. /**
  77577. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  77578. * Using a ratio helps keeping shape stability independently of the map size.
  77579. *
  77580. * It does not account for the light projection as it was having too much
  77581. * instability during the light setup or during light position changes.
  77582. *
  77583. * Only valid if useContactHardeningShadow is true.
  77584. */
  77585. contactHardeningLightSizeUVRatio: number;
  77586. private _darkness;
  77587. /** Gets or sets the actual darkness of a shadow */
  77588. darkness: number;
  77589. /**
  77590. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  77591. * 0 means strongest and 1 would means no shadow.
  77592. * @returns the darkness.
  77593. */
  77594. getDarkness(): number;
  77595. /**
  77596. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  77597. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  77598. * @returns the shadow generator allowing fluent coding.
  77599. */
  77600. setDarkness(darkness: number): ShadowGenerator;
  77601. private _transparencyShadow;
  77602. /** Gets or sets the ability to have transparent shadow */
  77603. transparencyShadow: boolean;
  77604. /**
  77605. * Sets the ability to have transparent shadow (boolean).
  77606. * @param transparent True if transparent else False
  77607. * @returns the shadow generator allowing fluent coding
  77608. */
  77609. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  77610. private _shadowMap;
  77611. private _shadowMap2;
  77612. /**
  77613. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  77614. * @returns The render target texture if present otherwise, null
  77615. */
  77616. getShadowMap(): Nullable<RenderTargetTexture>;
  77617. /**
  77618. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  77619. * @returns The render target texture if the shadow map is present otherwise, null
  77620. */
  77621. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  77622. /**
  77623. * Gets the class name of that object
  77624. * @returns "ShadowGenerator"
  77625. */
  77626. getClassName(): string;
  77627. /**
  77628. * Helper function to add a mesh and its descendants to the list of shadow casters.
  77629. * @param mesh Mesh to add
  77630. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  77631. * @returns the Shadow Generator itself
  77632. */
  77633. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  77634. /**
  77635. * Helper function to remove a mesh and its descendants from the list of shadow casters
  77636. * @param mesh Mesh to remove
  77637. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  77638. * @returns the Shadow Generator itself
  77639. */
  77640. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  77641. /**
  77642. * Controls the extent to which the shadows fade out at the edge of the frustum
  77643. * Used only by directionals and spots
  77644. */
  77645. frustumEdgeFalloff: number;
  77646. private _light;
  77647. /**
  77648. * Returns the associated light object.
  77649. * @returns the light generating the shadow
  77650. */
  77651. getLight(): IShadowLight;
  77652. /**
  77653. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  77654. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  77655. * It might on the other hand introduce peter panning.
  77656. */
  77657. forceBackFacesOnly: boolean;
  77658. private _scene;
  77659. private _lightDirection;
  77660. private _effect;
  77661. private _viewMatrix;
  77662. private _projectionMatrix;
  77663. private _transformMatrix;
  77664. private _cachedPosition;
  77665. private _cachedDirection;
  77666. private _cachedDefines;
  77667. private _currentRenderID;
  77668. private _boxBlurPostprocess;
  77669. private _kernelBlurXPostprocess;
  77670. private _kernelBlurYPostprocess;
  77671. private _blurPostProcesses;
  77672. private _mapSize;
  77673. private _currentFaceIndex;
  77674. private _currentFaceIndexCache;
  77675. private _textureType;
  77676. private _defaultTextureMatrix;
  77677. private _storedUniqueId;
  77678. /** @hidden */
  77679. static _SceneComponentInitialization: (scene: Scene) => void;
  77680. /**
  77681. * Creates a ShadowGenerator object.
  77682. * A ShadowGenerator is the required tool to use the shadows.
  77683. * Each light casting shadows needs to use its own ShadowGenerator.
  77684. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  77685. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  77686. * @param light The light object generating the shadows.
  77687. * @param usefulFloatFirst By default the generator will try to use half float textures but if you need precision (for self shadowing for instance), you can use this option to enforce full float texture.
  77688. */
  77689. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  77690. private _initializeGenerator;
  77691. private _initializeShadowMap;
  77692. private _initializeBlurRTTAndPostProcesses;
  77693. private _renderForShadowMap;
  77694. private _renderSubMeshForShadowMap;
  77695. private _applyFilterValues;
  77696. /**
  77697. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77698. * @param onCompiled Callback triggered at the and of the effects compilation
  77699. * @param options Sets of optional options forcing the compilation with different modes
  77700. */
  77701. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  77702. useInstances: boolean;
  77703. }>): void;
  77704. /**
  77705. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77706. * @param options Sets of optional options forcing the compilation with different modes
  77707. * @returns A promise that resolves when the compilation completes
  77708. */
  77709. forceCompilationAsync(options?: Partial<{
  77710. useInstances: boolean;
  77711. }>): Promise<void>;
  77712. /**
  77713. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  77714. * @param subMesh The submesh we want to render in the shadow map
  77715. * @param useInstances Defines wether will draw in the map using instances
  77716. * @returns true if ready otherwise, false
  77717. */
  77718. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  77719. /**
  77720. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  77721. * @param defines Defines of the material we want to update
  77722. * @param lightIndex Index of the light in the enabled light list of the material
  77723. */
  77724. prepareDefines(defines: any, lightIndex: number): void;
  77725. /**
  77726. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  77727. * defined in the generator but impacting the effect).
  77728. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  77729. * @param effect The effect we are binfing the information for
  77730. */
  77731. bindShadowLight(lightIndex: string, effect: Effect): void;
  77732. /**
  77733. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  77734. * (eq to shadow prjection matrix * light transform matrix)
  77735. * @returns The transform matrix used to create the shadow map
  77736. */
  77737. getTransformMatrix(): Matrix;
  77738. /**
  77739. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  77740. * Cube and 2D textures for instance.
  77741. */
  77742. recreateShadowMap(): void;
  77743. private _disposeBlurPostProcesses;
  77744. private _disposeRTTandPostProcesses;
  77745. /**
  77746. * Disposes the ShadowGenerator.
  77747. * Returns nothing.
  77748. */
  77749. dispose(): void;
  77750. /**
  77751. * Serializes the shadow generator setup to a json object.
  77752. * @returns The serialized JSON object
  77753. */
  77754. serialize(): any;
  77755. /**
  77756. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  77757. * @param parsedShadowGenerator The JSON object to parse
  77758. * @param scene The scene to create the shadow map for
  77759. * @returns The parsed shadow generator
  77760. */
  77761. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  77762. }
  77763. }
  77764. declare module BABYLON {
  77765. /**
  77766. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  77767. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  77768. * All meshes allow light to pass through them unless shadow generation is activated. The default number of lights allowed is four but this can be increased.
  77769. */
  77770. export abstract class Light extends Node {
  77771. /**
  77772. * Falloff Default: light is falling off following the material specification:
  77773. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  77774. */
  77775. static readonly FALLOFF_DEFAULT: number;
  77776. /**
  77777. * Falloff Physical: light is falling off following the inverse squared distance law.
  77778. */
  77779. static readonly FALLOFF_PHYSICAL: number;
  77780. /**
  77781. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  77782. * to enhance interoperability with other engines.
  77783. */
  77784. static readonly FALLOFF_GLTF: number;
  77785. /**
  77786. * Falloff Standard: light is falling off like in the standard material
  77787. * to enhance interoperability with other materials.
  77788. */
  77789. static readonly FALLOFF_STANDARD: number;
  77790. /**
  77791. * If every light affecting the material is in this lightmapMode,
  77792. * material.lightmapTexture adds or multiplies
  77793. * (depends on material.useLightmapAsShadowmap)
  77794. * after every other light calculations.
  77795. */
  77796. static readonly LIGHTMAP_DEFAULT: number;
  77797. /**
  77798. * material.lightmapTexture as only diffuse lighting from this light
  77799. * adds only specular lighting from this light
  77800. * adds dynamic shadows
  77801. */
  77802. static readonly LIGHTMAP_SPECULAR: number;
  77803. /**
  77804. * material.lightmapTexture as only lighting
  77805. * no light calculation from this light
  77806. * only adds dynamic shadows from this light
  77807. */
  77808. static readonly LIGHTMAP_SHADOWSONLY: number;
  77809. /**
  77810. * Each light type uses the default quantity according to its type:
  77811. * point/spot lights use luminous intensity
  77812. * directional lights use illuminance
  77813. */
  77814. static readonly INTENSITYMODE_AUTOMATIC: number;
  77815. /**
  77816. * lumen (lm)
  77817. */
  77818. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  77819. /**
  77820. * candela (lm/sr)
  77821. */
  77822. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  77823. /**
  77824. * lux (lm/m^2)
  77825. */
  77826. static readonly INTENSITYMODE_ILLUMINANCE: number;
  77827. /**
  77828. * nit (cd/m^2)
  77829. */
  77830. static readonly INTENSITYMODE_LUMINANCE: number;
  77831. /**
  77832. * Light type const id of the point light.
  77833. */
  77834. static readonly LIGHTTYPEID_POINTLIGHT: number;
  77835. /**
  77836. * Light type const id of the directional light.
  77837. */
  77838. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  77839. /**
  77840. * Light type const id of the spot light.
  77841. */
  77842. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  77843. /**
  77844. * Light type const id of the hemispheric light.
  77845. */
  77846. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  77847. /**
  77848. * Diffuse gives the basic color to an object.
  77849. */
  77850. diffuse: Color3;
  77851. /**
  77852. * Specular produces a highlight color on an object.
  77853. * Note: This is note affecting PBR materials.
  77854. */
  77855. specular: Color3;
  77856. /**
  77857. * Defines the falloff type for this light. This lets overrriding how punctual light are
  77858. * falling off base on range or angle.
  77859. * This can be set to any values in Light.FALLOFF_x.
  77860. *
  77861. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  77862. * other types of materials.
  77863. */
  77864. falloffType: number;
  77865. /**
  77866. * Strength of the light.
  77867. * Note: By default it is define in the framework own unit.
  77868. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  77869. */
  77870. intensity: number;
  77871. private _range;
  77872. protected _inverseSquaredRange: number;
  77873. /**
  77874. * Defines how far from the source the light is impacting in scene units.
  77875. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  77876. */
  77877. /**
  77878. * Defines how far from the source the light is impacting in scene units.
  77879. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  77880. */
  77881. range: number;
  77882. /**
  77883. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  77884. * of light.
  77885. */
  77886. private _photometricScale;
  77887. private _intensityMode;
  77888. /**
  77889. * Gets the photometric scale used to interpret the intensity.
  77890. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  77891. */
  77892. /**
  77893. * Sets the photometric scale used to interpret the intensity.
  77894. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  77895. */
  77896. intensityMode: number;
  77897. private _radius;
  77898. /**
  77899. * Gets the light radius used by PBR Materials to simulate soft area lights.
  77900. */
  77901. /**
  77902. * sets the light radius used by PBR Materials to simulate soft area lights.
  77903. */
  77904. radius: number;
  77905. private _renderPriority;
  77906. /**
  77907. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  77908. * exceeding the number allowed of the materials.
  77909. */
  77910. renderPriority: number;
  77911. private _shadowEnabled;
  77912. /**
  77913. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  77914. * the current shadow generator.
  77915. */
  77916. /**
  77917. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  77918. * the current shadow generator.
  77919. */
  77920. shadowEnabled: boolean;
  77921. private _includedOnlyMeshes;
  77922. /**
  77923. * Gets the only meshes impacted by this light.
  77924. */
  77925. /**
  77926. * Sets the only meshes impacted by this light.
  77927. */
  77928. includedOnlyMeshes: AbstractMesh[];
  77929. private _excludedMeshes;
  77930. /**
  77931. * Gets the meshes not impacted by this light.
  77932. */
  77933. /**
  77934. * Sets the meshes not impacted by this light.
  77935. */
  77936. excludedMeshes: AbstractMesh[];
  77937. private _excludeWithLayerMask;
  77938. /**
  77939. * Gets the layer id use to find what meshes are not impacted by the light.
  77940. * Inactive if 0
  77941. */
  77942. /**
  77943. * Sets the layer id use to find what meshes are not impacted by the light.
  77944. * Inactive if 0
  77945. */
  77946. excludeWithLayerMask: number;
  77947. private _includeOnlyWithLayerMask;
  77948. /**
  77949. * Gets the layer id use to find what meshes are impacted by the light.
  77950. * Inactive if 0
  77951. */
  77952. /**
  77953. * Sets the layer id use to find what meshes are impacted by the light.
  77954. * Inactive if 0
  77955. */
  77956. includeOnlyWithLayerMask: number;
  77957. private _lightmapMode;
  77958. /**
  77959. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  77960. */
  77961. /**
  77962. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  77963. */
  77964. lightmapMode: number;
  77965. /**
  77966. * Shadow generator associted to the light.
  77967. * @hidden Internal use only.
  77968. */
  77969. _shadowGenerator: Nullable<IShadowGenerator>;
  77970. /**
  77971. * @hidden Internal use only.
  77972. */
  77973. _excludedMeshesIds: string[];
  77974. /**
  77975. * @hidden Internal use only.
  77976. */
  77977. _includedOnlyMeshesIds: string[];
  77978. /**
  77979. * The current light unifom buffer.
  77980. * @hidden Internal use only.
  77981. */
  77982. _uniformBuffer: UniformBuffer;
  77983. /** @hidden */
  77984. _renderId: number;
  77985. /**
  77986. * Creates a Light object in the scene.
  77987. * Documentation : https://doc.babylonjs.com/babylon101/lights
  77988. * @param name The firendly name of the light
  77989. * @param scene The scene the light belongs too
  77990. */
  77991. constructor(name: string, scene: Scene);
  77992. protected abstract _buildUniformLayout(): void;
  77993. /**
  77994. * Sets the passed Effect "effect" with the Light information.
  77995. * @param effect The effect to update
  77996. * @param lightIndex The index of the light in the effect to update
  77997. * @returns The light
  77998. */
  77999. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  78000. /**
  78001. * Sets the passed Effect "effect" with the Light information.
  78002. * @param effect The effect to update
  78003. * @param lightDataUniformName The uniform used to store light data (position or direction)
  78004. * @returns The light
  78005. */
  78006. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  78007. /**
  78008. * Returns the string "Light".
  78009. * @returns the class name
  78010. */
  78011. getClassName(): string;
  78012. /** @hidden */
  78013. readonly _isLight: boolean;
  78014. /**
  78015. * Converts the light information to a readable string for debug purpose.
  78016. * @param fullDetails Supports for multiple levels of logging within scene loading
  78017. * @returns the human readable light info
  78018. */
  78019. toString(fullDetails?: boolean): string;
  78020. /** @hidden */
  78021. protected _syncParentEnabledState(): void;
  78022. /**
  78023. * Set the enabled state of this node.
  78024. * @param value - the new enabled state
  78025. */
  78026. setEnabled(value: boolean): void;
  78027. /**
  78028. * Returns the Light associated shadow generator if any.
  78029. * @return the associated shadow generator.
  78030. */
  78031. getShadowGenerator(): Nullable<IShadowGenerator>;
  78032. /**
  78033. * Returns a Vector3, the absolute light position in the World.
  78034. * @returns the world space position of the light
  78035. */
  78036. getAbsolutePosition(): Vector3;
  78037. /**
  78038. * Specifies if the light will affect the passed mesh.
  78039. * @param mesh The mesh to test against the light
  78040. * @return true the mesh is affected otherwise, false.
  78041. */
  78042. canAffectMesh(mesh: AbstractMesh): boolean;
  78043. /**
  78044. * Sort function to order lights for rendering.
  78045. * @param a First Light object to compare to second.
  78046. * @param b Second Light object to compare first.
  78047. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  78048. */
  78049. static CompareLightsPriority(a: Light, b: Light): number;
  78050. /**
  78051. * Releases resources associated with this node.
  78052. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  78053. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  78054. */
  78055. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  78056. /**
  78057. * Returns the light type ID (integer).
  78058. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  78059. */
  78060. getTypeID(): number;
  78061. /**
  78062. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  78063. * @returns the scaled intensity in intensity mode unit
  78064. */
  78065. getScaledIntensity(): number;
  78066. /**
  78067. * Returns a new Light object, named "name", from the current one.
  78068. * @param name The name of the cloned light
  78069. * @returns the new created light
  78070. */
  78071. clone(name: string): Nullable<Light>;
  78072. /**
  78073. * Serializes the current light into a Serialization object.
  78074. * @returns the serialized object.
  78075. */
  78076. serialize(): any;
  78077. /**
  78078. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  78079. * This new light is named "name" and added to the passed scene.
  78080. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  78081. * @param name The friendly name of the light
  78082. * @param scene The scene the new light will belong to
  78083. * @returns the constructor function
  78084. */
  78085. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  78086. /**
  78087. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  78088. * @param parsedLight The JSON representation of the light
  78089. * @param scene The scene to create the parsed light in
  78090. * @returns the created light after parsing
  78091. */
  78092. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  78093. private _hookArrayForExcluded;
  78094. private _hookArrayForIncludedOnly;
  78095. private _resyncMeshes;
  78096. /**
  78097. * Forces the meshes to update their light related information in their rendering used effects
  78098. * @hidden Internal Use Only
  78099. */
  78100. _markMeshesAsLightDirty(): void;
  78101. /**
  78102. * Recomputes the cached photometric scale if needed.
  78103. */
  78104. private _computePhotometricScale;
  78105. /**
  78106. * Returns the Photometric Scale according to the light type and intensity mode.
  78107. */
  78108. private _getPhotometricScale;
  78109. /**
  78110. * Reorder the light in the scene according to their defined priority.
  78111. * @hidden Internal Use Only
  78112. */
  78113. _reorderLightsInScene(): void;
  78114. /**
  78115. * Prepares the list of defines specific to the light type.
  78116. * @param defines the list of defines
  78117. * @param lightIndex defines the index of the light for the effect
  78118. */
  78119. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  78120. }
  78121. }
  78122. declare module BABYLON {
  78123. /**
  78124. * Interface used to define Action
  78125. */
  78126. export interface IAction {
  78127. /**
  78128. * Trigger for the action
  78129. */
  78130. trigger: number;
  78131. /** Options of the trigger */
  78132. triggerOptions: any;
  78133. /**
  78134. * Gets the trigger parameters
  78135. * @returns the trigger parameters
  78136. */
  78137. getTriggerParameter(): any;
  78138. /**
  78139. * Internal only - executes current action event
  78140. * @hidden
  78141. */
  78142. _executeCurrent(evt?: ActionEvent): void;
  78143. /**
  78144. * Serialize placeholder for child classes
  78145. * @param parent of child
  78146. * @returns the serialized object
  78147. */
  78148. serialize(parent: any): any;
  78149. /**
  78150. * Internal only
  78151. * @hidden
  78152. */
  78153. _prepare(): void;
  78154. /**
  78155. * Internal only - manager for action
  78156. * @hidden
  78157. */
  78158. _actionManager: AbstractActionManager;
  78159. /**
  78160. * Adds action to chain of actions, may be a DoNothingAction
  78161. * @param action defines the next action to execute
  78162. * @returns The action passed in
  78163. * @see https://www.babylonjs-playground.com/#1T30HR#0
  78164. */
  78165. then(action: IAction): IAction;
  78166. }
  78167. /**
  78168. * The action to be carried out following a trigger
  78169. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  78170. */
  78171. export class Action implements IAction {
  78172. /** the trigger, with or without parameters, for the action */
  78173. triggerOptions: any;
  78174. /**
  78175. * Trigger for the action
  78176. */
  78177. trigger: number;
  78178. /**
  78179. * Internal only - manager for action
  78180. * @hidden
  78181. */
  78182. _actionManager: ActionManager;
  78183. private _nextActiveAction;
  78184. private _child;
  78185. private _condition?;
  78186. private _triggerParameter;
  78187. /**
  78188. * An event triggered prior to action being executed.
  78189. */
  78190. onBeforeExecuteObservable: Observable<Action>;
  78191. /**
  78192. * Creates a new Action
  78193. * @param triggerOptions the trigger, with or without parameters, for the action
  78194. * @param condition an optional determinant of action
  78195. */
  78196. constructor(
  78197. /** the trigger, with or without parameters, for the action */
  78198. triggerOptions: any, condition?: Condition);
  78199. /**
  78200. * Internal only
  78201. * @hidden
  78202. */
  78203. _prepare(): void;
  78204. /**
  78205. * Gets the trigger parameters
  78206. * @returns the trigger parameters
  78207. */
  78208. getTriggerParameter(): any;
  78209. /**
  78210. * Internal only - executes current action event
  78211. * @hidden
  78212. */
  78213. _executeCurrent(evt?: ActionEvent): void;
  78214. /**
  78215. * Execute placeholder for child classes
  78216. * @param evt optional action event
  78217. */
  78218. execute(evt?: ActionEvent): void;
  78219. /**
  78220. * Skips to next active action
  78221. */
  78222. skipToNextActiveAction(): void;
  78223. /**
  78224. * Adds action to chain of actions, may be a DoNothingAction
  78225. * @param action defines the next action to execute
  78226. * @returns The action passed in
  78227. * @see https://www.babylonjs-playground.com/#1T30HR#0
  78228. */
  78229. then(action: Action): Action;
  78230. /**
  78231. * Internal only
  78232. * @hidden
  78233. */
  78234. _getProperty(propertyPath: string): string;
  78235. /**
  78236. * Internal only
  78237. * @hidden
  78238. */
  78239. _getEffectiveTarget(target: any, propertyPath: string): any;
  78240. /**
  78241. * Serialize placeholder for child classes
  78242. * @param parent of child
  78243. * @returns the serialized object
  78244. */
  78245. serialize(parent: any): any;
  78246. /**
  78247. * Internal only called by serialize
  78248. * @hidden
  78249. */
  78250. protected _serialize(serializedAction: any, parent?: any): any;
  78251. /**
  78252. * Internal only
  78253. * @hidden
  78254. */
  78255. static _SerializeValueAsString: (value: any) => string;
  78256. /**
  78257. * Internal only
  78258. * @hidden
  78259. */
  78260. static _GetTargetProperty: (target: Node | Scene) => {
  78261. name: string;
  78262. targetType: string;
  78263. value: string;
  78264. };
  78265. }
  78266. }
  78267. declare module BABYLON {
  78268. /**
  78269. * A Condition applied to an Action
  78270. */
  78271. export class Condition {
  78272. /**
  78273. * Internal only - manager for action
  78274. * @hidden
  78275. */
  78276. _actionManager: ActionManager;
  78277. /**
  78278. * Internal only
  78279. * @hidden
  78280. */
  78281. _evaluationId: number;
  78282. /**
  78283. * Internal only
  78284. * @hidden
  78285. */
  78286. _currentResult: boolean;
  78287. /**
  78288. * Creates a new Condition
  78289. * @param actionManager the manager of the action the condition is applied to
  78290. */
  78291. constructor(actionManager: ActionManager);
  78292. /**
  78293. * Check if the current condition is valid
  78294. * @returns a boolean
  78295. */
  78296. isValid(): boolean;
  78297. /**
  78298. * Internal only
  78299. * @hidden
  78300. */
  78301. _getProperty(propertyPath: string): string;
  78302. /**
  78303. * Internal only
  78304. * @hidden
  78305. */
  78306. _getEffectiveTarget(target: any, propertyPath: string): any;
  78307. /**
  78308. * Serialize placeholder for child classes
  78309. * @returns the serialized object
  78310. */
  78311. serialize(): any;
  78312. /**
  78313. * Internal only
  78314. * @hidden
  78315. */
  78316. protected _serialize(serializedCondition: any): any;
  78317. }
  78318. /**
  78319. * Defines specific conditional operators as extensions of Condition
  78320. */
  78321. export class ValueCondition extends Condition {
  78322. /** path to specify the property of the target the conditional operator uses */
  78323. propertyPath: string;
  78324. /** the value compared by the conditional operator against the current value of the property */
  78325. value: any;
  78326. /** the conditional operator, default ValueCondition.IsEqual */
  78327. operator: number;
  78328. /**
  78329. * Internal only
  78330. * @hidden
  78331. */
  78332. private static _IsEqual;
  78333. /**
  78334. * Internal only
  78335. * @hidden
  78336. */
  78337. private static _IsDifferent;
  78338. /**
  78339. * Internal only
  78340. * @hidden
  78341. */
  78342. private static _IsGreater;
  78343. /**
  78344. * Internal only
  78345. * @hidden
  78346. */
  78347. private static _IsLesser;
  78348. /**
  78349. * returns the number for IsEqual
  78350. */
  78351. static readonly IsEqual: number;
  78352. /**
  78353. * Returns the number for IsDifferent
  78354. */
  78355. static readonly IsDifferent: number;
  78356. /**
  78357. * Returns the number for IsGreater
  78358. */
  78359. static readonly IsGreater: number;
  78360. /**
  78361. * Returns the number for IsLesser
  78362. */
  78363. static readonly IsLesser: number;
  78364. /**
  78365. * Internal only The action manager for the condition
  78366. * @hidden
  78367. */
  78368. _actionManager: ActionManager;
  78369. /**
  78370. * Internal only
  78371. * @hidden
  78372. */
  78373. private _target;
  78374. /**
  78375. * Internal only
  78376. * @hidden
  78377. */
  78378. private _effectiveTarget;
  78379. /**
  78380. * Internal only
  78381. * @hidden
  78382. */
  78383. private _property;
  78384. /**
  78385. * Creates a new ValueCondition
  78386. * @param actionManager manager for the action the condition applies to
  78387. * @param target for the action
  78388. * @param propertyPath path to specify the property of the target the conditional operator uses
  78389. * @param value the value compared by the conditional operator against the current value of the property
  78390. * @param operator the conditional operator, default ValueCondition.IsEqual
  78391. */
  78392. constructor(actionManager: ActionManager, target: any,
  78393. /** path to specify the property of the target the conditional operator uses */
  78394. propertyPath: string,
  78395. /** the value compared by the conditional operator against the current value of the property */
  78396. value: any,
  78397. /** the conditional operator, default ValueCondition.IsEqual */
  78398. operator?: number);
  78399. /**
  78400. * Compares the given value with the property value for the specified conditional operator
  78401. * @returns the result of the comparison
  78402. */
  78403. isValid(): boolean;
  78404. /**
  78405. * Serialize the ValueCondition into a JSON compatible object
  78406. * @returns serialization object
  78407. */
  78408. serialize(): any;
  78409. /**
  78410. * Gets the name of the conditional operator for the ValueCondition
  78411. * @param operator the conditional operator
  78412. * @returns the name
  78413. */
  78414. static GetOperatorName(operator: number): string;
  78415. }
  78416. /**
  78417. * Defines a predicate condition as an extension of Condition
  78418. */
  78419. export class PredicateCondition extends Condition {
  78420. /** defines the predicate function used to validate the condition */
  78421. predicate: () => boolean;
  78422. /**
  78423. * Internal only - manager for action
  78424. * @hidden
  78425. */
  78426. _actionManager: ActionManager;
  78427. /**
  78428. * Creates a new PredicateCondition
  78429. * @param actionManager manager for the action the condition applies to
  78430. * @param predicate defines the predicate function used to validate the condition
  78431. */
  78432. constructor(actionManager: ActionManager,
  78433. /** defines the predicate function used to validate the condition */
  78434. predicate: () => boolean);
  78435. /**
  78436. * @returns the validity of the predicate condition
  78437. */
  78438. isValid(): boolean;
  78439. }
  78440. /**
  78441. * Defines a state condition as an extension of Condition
  78442. */
  78443. export class StateCondition extends Condition {
  78444. /** Value to compare with target state */
  78445. value: string;
  78446. /**
  78447. * Internal only - manager for action
  78448. * @hidden
  78449. */
  78450. _actionManager: ActionManager;
  78451. /**
  78452. * Internal only
  78453. * @hidden
  78454. */
  78455. private _target;
  78456. /**
  78457. * Creates a new StateCondition
  78458. * @param actionManager manager for the action the condition applies to
  78459. * @param target of the condition
  78460. * @param value to compare with target state
  78461. */
  78462. constructor(actionManager: ActionManager, target: any,
  78463. /** Value to compare with target state */
  78464. value: string);
  78465. /**
  78466. * Gets a boolean indicating if the current condition is met
  78467. * @returns the validity of the state
  78468. */
  78469. isValid(): boolean;
  78470. /**
  78471. * Serialize the StateCondition into a JSON compatible object
  78472. * @returns serialization object
  78473. */
  78474. serialize(): any;
  78475. }
  78476. }
  78477. declare module BABYLON {
  78478. /**
  78479. * This defines an action responsible to toggle a boolean once triggered.
  78480. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78481. */
  78482. export class SwitchBooleanAction extends Action {
  78483. /**
  78484. * The path to the boolean property in the target object
  78485. */
  78486. propertyPath: string;
  78487. private _target;
  78488. private _effectiveTarget;
  78489. private _property;
  78490. /**
  78491. * Instantiate the action
  78492. * @param triggerOptions defines the trigger options
  78493. * @param target defines the object containing the boolean
  78494. * @param propertyPath defines the path to the boolean property in the target object
  78495. * @param condition defines the trigger related conditions
  78496. */
  78497. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  78498. /** @hidden */
  78499. _prepare(): void;
  78500. /**
  78501. * Execute the action toggle the boolean value.
  78502. */
  78503. execute(): void;
  78504. /**
  78505. * Serializes the actions and its related information.
  78506. * @param parent defines the object to serialize in
  78507. * @returns the serialized object
  78508. */
  78509. serialize(parent: any): any;
  78510. }
  78511. /**
  78512. * This defines an action responsible to set a the state field of the target
  78513. * to a desired value once triggered.
  78514. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78515. */
  78516. export class SetStateAction extends Action {
  78517. /**
  78518. * The value to store in the state field.
  78519. */
  78520. value: string;
  78521. private _target;
  78522. /**
  78523. * Instantiate the action
  78524. * @param triggerOptions defines the trigger options
  78525. * @param target defines the object containing the state property
  78526. * @param value defines the value to store in the state field
  78527. * @param condition defines the trigger related conditions
  78528. */
  78529. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  78530. /**
  78531. * Execute the action and store the value on the target state property.
  78532. */
  78533. execute(): void;
  78534. /**
  78535. * Serializes the actions and its related information.
  78536. * @param parent defines the object to serialize in
  78537. * @returns the serialized object
  78538. */
  78539. serialize(parent: any): any;
  78540. }
  78541. /**
  78542. * This defines an action responsible to set a property of the target
  78543. * to a desired value once triggered.
  78544. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78545. */
  78546. export class SetValueAction extends Action {
  78547. /**
  78548. * The path of the property to set in the target.
  78549. */
  78550. propertyPath: string;
  78551. /**
  78552. * The value to set in the property
  78553. */
  78554. value: any;
  78555. private _target;
  78556. private _effectiveTarget;
  78557. private _property;
  78558. /**
  78559. * Instantiate the action
  78560. * @param triggerOptions defines the trigger options
  78561. * @param target defines the object containing the property
  78562. * @param propertyPath defines the path of the property to set in the target
  78563. * @param value defines the value to set in the property
  78564. * @param condition defines the trigger related conditions
  78565. */
  78566. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  78567. /** @hidden */
  78568. _prepare(): void;
  78569. /**
  78570. * Execute the action and set the targetted property to the desired value.
  78571. */
  78572. execute(): void;
  78573. /**
  78574. * Serializes the actions and its related information.
  78575. * @param parent defines the object to serialize in
  78576. * @returns the serialized object
  78577. */
  78578. serialize(parent: any): any;
  78579. }
  78580. /**
  78581. * This defines an action responsible to increment the target value
  78582. * to a desired value once triggered.
  78583. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78584. */
  78585. export class IncrementValueAction extends Action {
  78586. /**
  78587. * The path of the property to increment in the target.
  78588. */
  78589. propertyPath: string;
  78590. /**
  78591. * The value we should increment the property by.
  78592. */
  78593. value: any;
  78594. private _target;
  78595. private _effectiveTarget;
  78596. private _property;
  78597. /**
  78598. * Instantiate the action
  78599. * @param triggerOptions defines the trigger options
  78600. * @param target defines the object containing the property
  78601. * @param propertyPath defines the path of the property to increment in the target
  78602. * @param value defines the value value we should increment the property by
  78603. * @param condition defines the trigger related conditions
  78604. */
  78605. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  78606. /** @hidden */
  78607. _prepare(): void;
  78608. /**
  78609. * Execute the action and increment the target of the value amount.
  78610. */
  78611. execute(): void;
  78612. /**
  78613. * Serializes the actions and its related information.
  78614. * @param parent defines the object to serialize in
  78615. * @returns the serialized object
  78616. */
  78617. serialize(parent: any): any;
  78618. }
  78619. /**
  78620. * This defines an action responsible to start an animation once triggered.
  78621. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78622. */
  78623. export class PlayAnimationAction extends Action {
  78624. /**
  78625. * Where the animation should start (animation frame)
  78626. */
  78627. from: number;
  78628. /**
  78629. * Where the animation should stop (animation frame)
  78630. */
  78631. to: number;
  78632. /**
  78633. * Define if the animation should loop or stop after the first play.
  78634. */
  78635. loop?: boolean;
  78636. private _target;
  78637. /**
  78638. * Instantiate the action
  78639. * @param triggerOptions defines the trigger options
  78640. * @param target defines the target animation or animation name
  78641. * @param from defines from where the animation should start (animation frame)
  78642. * @param end defines where the animation should stop (animation frame)
  78643. * @param loop defines if the animation should loop or stop after the first play
  78644. * @param condition defines the trigger related conditions
  78645. */
  78646. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  78647. /** @hidden */
  78648. _prepare(): void;
  78649. /**
  78650. * Execute the action and play the animation.
  78651. */
  78652. execute(): void;
  78653. /**
  78654. * Serializes the actions and its related information.
  78655. * @param parent defines the object to serialize in
  78656. * @returns the serialized object
  78657. */
  78658. serialize(parent: any): any;
  78659. }
  78660. /**
  78661. * This defines an action responsible to stop an animation once triggered.
  78662. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78663. */
  78664. export class StopAnimationAction extends Action {
  78665. private _target;
  78666. /**
  78667. * Instantiate the action
  78668. * @param triggerOptions defines the trigger options
  78669. * @param target defines the target animation or animation name
  78670. * @param condition defines the trigger related conditions
  78671. */
  78672. constructor(triggerOptions: any, target: any, condition?: Condition);
  78673. /** @hidden */
  78674. _prepare(): void;
  78675. /**
  78676. * Execute the action and stop the animation.
  78677. */
  78678. execute(): void;
  78679. /**
  78680. * Serializes the actions and its related information.
  78681. * @param parent defines the object to serialize in
  78682. * @returns the serialized object
  78683. */
  78684. serialize(parent: any): any;
  78685. }
  78686. /**
  78687. * This defines an action responsible that does nothing once triggered.
  78688. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78689. */
  78690. export class DoNothingAction extends Action {
  78691. /**
  78692. * Instantiate the action
  78693. * @param triggerOptions defines the trigger options
  78694. * @param condition defines the trigger related conditions
  78695. */
  78696. constructor(triggerOptions?: any, condition?: Condition);
  78697. /**
  78698. * Execute the action and do nothing.
  78699. */
  78700. execute(): void;
  78701. /**
  78702. * Serializes the actions and its related information.
  78703. * @param parent defines the object to serialize in
  78704. * @returns the serialized object
  78705. */
  78706. serialize(parent: any): any;
  78707. }
  78708. /**
  78709. * This defines an action responsible to trigger several actions once triggered.
  78710. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78711. */
  78712. export class CombineAction extends Action {
  78713. /**
  78714. * The list of aggregated animations to run.
  78715. */
  78716. children: Action[];
  78717. /**
  78718. * Instantiate the action
  78719. * @param triggerOptions defines the trigger options
  78720. * @param children defines the list of aggregated animations to run
  78721. * @param condition defines the trigger related conditions
  78722. */
  78723. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  78724. /** @hidden */
  78725. _prepare(): void;
  78726. /**
  78727. * Execute the action and executes all the aggregated actions.
  78728. */
  78729. execute(evt: ActionEvent): void;
  78730. /**
  78731. * Serializes the actions and its related information.
  78732. * @param parent defines the object to serialize in
  78733. * @returns the serialized object
  78734. */
  78735. serialize(parent: any): any;
  78736. }
  78737. /**
  78738. * This defines an action responsible to run code (external event) once triggered.
  78739. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78740. */
  78741. export class ExecuteCodeAction extends Action {
  78742. /**
  78743. * The callback function to run.
  78744. */
  78745. func: (evt: ActionEvent) => void;
  78746. /**
  78747. * Instantiate the action
  78748. * @param triggerOptions defines the trigger options
  78749. * @param func defines the callback function to run
  78750. * @param condition defines the trigger related conditions
  78751. */
  78752. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  78753. /**
  78754. * Execute the action and run the attached code.
  78755. */
  78756. execute(evt: ActionEvent): void;
  78757. }
  78758. /**
  78759. * This defines an action responsible to set the parent property of the target once triggered.
  78760. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78761. */
  78762. export class SetParentAction extends Action {
  78763. private _parent;
  78764. private _target;
  78765. /**
  78766. * Instantiate the action
  78767. * @param triggerOptions defines the trigger options
  78768. * @param target defines the target containing the parent property
  78769. * @param parent defines from where the animation should start (animation frame)
  78770. * @param condition defines the trigger related conditions
  78771. */
  78772. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  78773. /** @hidden */
  78774. _prepare(): void;
  78775. /**
  78776. * Execute the action and set the parent property.
  78777. */
  78778. execute(): void;
  78779. /**
  78780. * Serializes the actions and its related information.
  78781. * @param parent defines the object to serialize in
  78782. * @returns the serialized object
  78783. */
  78784. serialize(parent: any): any;
  78785. }
  78786. }
  78787. declare module BABYLON {
  78788. /**
  78789. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  78790. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  78791. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78792. */
  78793. export class ActionManager extends AbstractActionManager {
  78794. /**
  78795. * Nothing
  78796. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78797. */
  78798. static readonly NothingTrigger: number;
  78799. /**
  78800. * On pick
  78801. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78802. */
  78803. static readonly OnPickTrigger: number;
  78804. /**
  78805. * On left pick
  78806. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78807. */
  78808. static readonly OnLeftPickTrigger: number;
  78809. /**
  78810. * On right pick
  78811. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78812. */
  78813. static readonly OnRightPickTrigger: number;
  78814. /**
  78815. * On center pick
  78816. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78817. */
  78818. static readonly OnCenterPickTrigger: number;
  78819. /**
  78820. * On pick down
  78821. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78822. */
  78823. static readonly OnPickDownTrigger: number;
  78824. /**
  78825. * On double pick
  78826. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78827. */
  78828. static readonly OnDoublePickTrigger: number;
  78829. /**
  78830. * On pick up
  78831. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78832. */
  78833. static readonly OnPickUpTrigger: number;
  78834. /**
  78835. * On pick out.
  78836. * This trigger will only be raised if you also declared a OnPickDown
  78837. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78838. */
  78839. static readonly OnPickOutTrigger: number;
  78840. /**
  78841. * On long press
  78842. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78843. */
  78844. static readonly OnLongPressTrigger: number;
  78845. /**
  78846. * On pointer over
  78847. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78848. */
  78849. static readonly OnPointerOverTrigger: number;
  78850. /**
  78851. * On pointer out
  78852. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78853. */
  78854. static readonly OnPointerOutTrigger: number;
  78855. /**
  78856. * On every frame
  78857. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78858. */
  78859. static readonly OnEveryFrameTrigger: number;
  78860. /**
  78861. * On intersection enter
  78862. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78863. */
  78864. static readonly OnIntersectionEnterTrigger: number;
  78865. /**
  78866. * On intersection exit
  78867. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78868. */
  78869. static readonly OnIntersectionExitTrigger: number;
  78870. /**
  78871. * On key down
  78872. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78873. */
  78874. static readonly OnKeyDownTrigger: number;
  78875. /**
  78876. * On key up
  78877. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  78878. */
  78879. static readonly OnKeyUpTrigger: number;
  78880. private _scene;
  78881. /**
  78882. * Creates a new action manager
  78883. * @param scene defines the hosting scene
  78884. */
  78885. constructor(scene: Scene);
  78886. /**
  78887. * Releases all associated resources
  78888. */
  78889. dispose(): void;
  78890. /**
  78891. * Gets hosting scene
  78892. * @returns the hosting scene
  78893. */
  78894. getScene(): Scene;
  78895. /**
  78896. * Does this action manager handles actions of any of the given triggers
  78897. * @param triggers defines the triggers to be tested
  78898. * @return a boolean indicating whether one (or more) of the triggers is handled
  78899. */
  78900. hasSpecificTriggers(triggers: number[]): boolean;
  78901. /**
  78902. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  78903. * speed.
  78904. * @param triggerA defines the trigger to be tested
  78905. * @param triggerB defines the trigger to be tested
  78906. * @return a boolean indicating whether one (or more) of the triggers is handled
  78907. */
  78908. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  78909. /**
  78910. * Does this action manager handles actions of a given trigger
  78911. * @param trigger defines the trigger to be tested
  78912. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  78913. * @return whether the trigger is handled
  78914. */
  78915. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  78916. /**
  78917. * Does this action manager has pointer triggers
  78918. */
  78919. readonly hasPointerTriggers: boolean;
  78920. /**
  78921. * Does this action manager has pick triggers
  78922. */
  78923. readonly hasPickTriggers: boolean;
  78924. /**
  78925. * Registers an action to this action manager
  78926. * @param action defines the action to be registered
  78927. * @return the action amended (prepared) after registration
  78928. */
  78929. registerAction(action: IAction): Nullable<IAction>;
  78930. /**
  78931. * Unregisters an action to this action manager
  78932. * @param action defines the action to be unregistered
  78933. * @return a boolean indicating whether the action has been unregistered
  78934. */
  78935. unregisterAction(action: IAction): Boolean;
  78936. /**
  78937. * Process a specific trigger
  78938. * @param trigger defines the trigger to process
  78939. * @param evt defines the event details to be processed
  78940. */
  78941. processTrigger(trigger: number, evt?: IActionEvent): void;
  78942. /** @hidden */
  78943. _getEffectiveTarget(target: any, propertyPath: string): any;
  78944. /** @hidden */
  78945. _getProperty(propertyPath: string): string;
  78946. /**
  78947. * Serialize this manager to a JSON object
  78948. * @param name defines the property name to store this manager
  78949. * @returns a JSON representation of this manager
  78950. */
  78951. serialize(name: string): any;
  78952. /**
  78953. * Creates a new ActionManager from a JSON data
  78954. * @param parsedActions defines the JSON data to read from
  78955. * @param object defines the hosting mesh
  78956. * @param scene defines the hosting scene
  78957. */
  78958. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  78959. /**
  78960. * Get a trigger name by index
  78961. * @param trigger defines the trigger index
  78962. * @returns a trigger name
  78963. */
  78964. static GetTriggerName(trigger: number): string;
  78965. }
  78966. }
  78967. declare module BABYLON {
  78968. /**
  78969. * Class representing a ray with position and direction
  78970. */
  78971. export class Ray {
  78972. /** origin point */
  78973. origin: Vector3;
  78974. /** direction */
  78975. direction: Vector3;
  78976. /** length of the ray */
  78977. length: number;
  78978. private static readonly TmpVector3;
  78979. private _tmpRay;
  78980. /**
  78981. * Creates a new ray
  78982. * @param origin origin point
  78983. * @param direction direction
  78984. * @param length length of the ray
  78985. */
  78986. constructor(
  78987. /** origin point */
  78988. origin: Vector3,
  78989. /** direction */
  78990. direction: Vector3,
  78991. /** length of the ray */
  78992. length?: number);
  78993. /**
  78994. * Checks if the ray intersects a box
  78995. * @param minimum bound of the box
  78996. * @param maximum bound of the box
  78997. * @param intersectionTreshold extra extend to be added to the box in all direction
  78998. * @returns if the box was hit
  78999. */
  79000. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  79001. /**
  79002. * Checks if the ray intersects a box
  79003. * @param box the bounding box to check
  79004. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  79005. * @returns if the box was hit
  79006. */
  79007. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  79008. /**
  79009. * If the ray hits a sphere
  79010. * @param sphere the bounding sphere to check
  79011. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  79012. * @returns true if it hits the sphere
  79013. */
  79014. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  79015. /**
  79016. * If the ray hits a triange
  79017. * @param vertex0 triangle vertex
  79018. * @param vertex1 triangle vertex
  79019. * @param vertex2 triangle vertex
  79020. * @returns intersection information if hit
  79021. */
  79022. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  79023. /**
  79024. * Checks if ray intersects a plane
  79025. * @param plane the plane to check
  79026. * @returns the distance away it was hit
  79027. */
  79028. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  79029. /**
  79030. * Calculate the intercept of a ray on a given axis
  79031. * @param axis to check 'x' | 'y' | 'z'
  79032. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  79033. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  79034. */
  79035. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  79036. /**
  79037. * Checks if ray intersects a mesh
  79038. * @param mesh the mesh to check
  79039. * @param fastCheck if only the bounding box should checked
  79040. * @returns picking info of the intersecton
  79041. */
  79042. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  79043. /**
  79044. * Checks if ray intersects a mesh
  79045. * @param meshes the meshes to check
  79046. * @param fastCheck if only the bounding box should checked
  79047. * @param results array to store result in
  79048. * @returns Array of picking infos
  79049. */
  79050. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  79051. private _comparePickingInfo;
  79052. private static smallnum;
  79053. private static rayl;
  79054. /**
  79055. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  79056. * @param sega the first point of the segment to test the intersection against
  79057. * @param segb the second point of the segment to test the intersection against
  79058. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  79059. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  79060. */
  79061. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  79062. /**
  79063. * Update the ray from viewport position
  79064. * @param x position
  79065. * @param y y position
  79066. * @param viewportWidth viewport width
  79067. * @param viewportHeight viewport height
  79068. * @param world world matrix
  79069. * @param view view matrix
  79070. * @param projection projection matrix
  79071. * @returns this ray updated
  79072. */
  79073. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  79074. /**
  79075. * Creates a ray with origin and direction of 0,0,0
  79076. * @returns the new ray
  79077. */
  79078. static Zero(): Ray;
  79079. /**
  79080. * Creates a new ray from screen space and viewport
  79081. * @param x position
  79082. * @param y y position
  79083. * @param viewportWidth viewport width
  79084. * @param viewportHeight viewport height
  79085. * @param world world matrix
  79086. * @param view view matrix
  79087. * @param projection projection matrix
  79088. * @returns new ray
  79089. */
  79090. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  79091. /**
  79092. * Function will create a new transformed ray starting from origin and ending at the end point. Ray's length will be set, and ray will be
  79093. * transformed to the given world matrix.
  79094. * @param origin The origin point
  79095. * @param end The end point
  79096. * @param world a matrix to transform the ray to. Default is the identity matrix.
  79097. * @returns the new ray
  79098. */
  79099. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  79100. /**
  79101. * Transforms a ray by a matrix
  79102. * @param ray ray to transform
  79103. * @param matrix matrix to apply
  79104. * @returns the resulting new ray
  79105. */
  79106. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  79107. /**
  79108. * Transforms a ray by a matrix
  79109. * @param ray ray to transform
  79110. * @param matrix matrix to apply
  79111. * @param result ray to store result in
  79112. */
  79113. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  79114. /**
  79115. * Unproject a ray from screen space to object space
  79116. * @param sourceX defines the screen space x coordinate to use
  79117. * @param sourceY defines the screen space y coordinate to use
  79118. * @param viewportWidth defines the current width of the viewport
  79119. * @param viewportHeight defines the current height of the viewport
  79120. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  79121. * @param view defines the view matrix to use
  79122. * @param projection defines the projection matrix to use
  79123. */
  79124. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  79125. }
  79126. /**
  79127. * Type used to define predicate used to select faces when a mesh intersection is detected
  79128. */
  79129. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  79130. interface Scene {
  79131. /** @hidden */
  79132. _tempPickingRay: Nullable<Ray>;
  79133. /** @hidden */
  79134. _cachedRayForTransform: Ray;
  79135. /** @hidden */
  79136. _pickWithRayInverseMatrix: Matrix;
  79137. /** @hidden */
  79138. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  79139. /** @hidden */
  79140. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  79141. }
  79142. }
  79143. declare module BABYLON {
  79144. /**
  79145. * Groups all the scene component constants in one place to ease maintenance.
  79146. * @hidden
  79147. */
  79148. export class SceneComponentConstants {
  79149. static readonly NAME_EFFECTLAYER: string;
  79150. static readonly NAME_LAYER: string;
  79151. static readonly NAME_LENSFLARESYSTEM: string;
  79152. static readonly NAME_BOUNDINGBOXRENDERER: string;
  79153. static readonly NAME_PARTICLESYSTEM: string;
  79154. static readonly NAME_GAMEPAD: string;
  79155. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  79156. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  79157. static readonly NAME_DEPTHRENDERER: string;
  79158. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  79159. static readonly NAME_SPRITE: string;
  79160. static readonly NAME_OUTLINERENDERER: string;
  79161. static readonly NAME_PROCEDURALTEXTURE: string;
  79162. static readonly NAME_SHADOWGENERATOR: string;
  79163. static readonly NAME_OCTREE: string;
  79164. static readonly NAME_PHYSICSENGINE: string;
  79165. static readonly NAME_AUDIO: string;
  79166. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  79167. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  79168. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  79169. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  79170. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  79171. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  79172. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  79173. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  79174. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  79175. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  79176. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  79177. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  79178. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  79179. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  79180. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  79181. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  79182. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  79183. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  79184. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  79185. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  79186. static readonly STEP_AFTERRENDER_AUDIO: number;
  79187. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  79188. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  79189. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  79190. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  79191. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  79192. static readonly STEP_POINTERMOVE_SPRITE: number;
  79193. static readonly STEP_POINTERDOWN_SPRITE: number;
  79194. static readonly STEP_POINTERUP_SPRITE: number;
  79195. }
  79196. /**
  79197. * This represents a scene component.
  79198. *
  79199. * This is used to decouple the dependency the scene is having on the different workloads like
  79200. * layers, post processes...
  79201. */
  79202. export interface ISceneComponent {
  79203. /**
  79204. * The name of the component. Each component must have a unique name.
  79205. */
  79206. name: string;
  79207. /**
  79208. * The scene the component belongs to.
  79209. */
  79210. scene: Scene;
  79211. /**
  79212. * Register the component to one instance of a scene.
  79213. */
  79214. register(): void;
  79215. /**
  79216. * Rebuilds the elements related to this component in case of
  79217. * context lost for instance.
  79218. */
  79219. rebuild(): void;
  79220. /**
  79221. * Disposes the component and the associated ressources.
  79222. */
  79223. dispose(): void;
  79224. }
  79225. /**
  79226. * This represents a SERIALIZABLE scene component.
  79227. *
  79228. * This extends Scene Component to add Serialization methods on top.
  79229. */
  79230. export interface ISceneSerializableComponent extends ISceneComponent {
  79231. /**
  79232. * Adds all the elements from the container to the scene
  79233. * @param container the container holding the elements
  79234. */
  79235. addFromContainer(container: AbstractScene): void;
  79236. /**
  79237. * Removes all the elements in the container from the scene
  79238. * @param container contains the elements to remove
  79239. * @param dispose if the removed element should be disposed (default: false)
  79240. */
  79241. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  79242. /**
  79243. * Serializes the component data to the specified json object
  79244. * @param serializationObject The object to serialize to
  79245. */
  79246. serialize(serializationObject: any): void;
  79247. }
  79248. /**
  79249. * Strong typing of a Mesh related stage step action
  79250. */
  79251. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  79252. /**
  79253. * Strong typing of a Evaluate Sub Mesh related stage step action
  79254. */
  79255. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  79256. /**
  79257. * Strong typing of a Active Mesh related stage step action
  79258. */
  79259. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  79260. /**
  79261. * Strong typing of a Camera related stage step action
  79262. */
  79263. export type CameraStageAction = (camera: Camera) => void;
  79264. /**
  79265. * Strong typing of a Camera Frame buffer related stage step action
  79266. */
  79267. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  79268. /**
  79269. * Strong typing of a Render Target related stage step action
  79270. */
  79271. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  79272. /**
  79273. * Strong typing of a RenderingGroup related stage step action
  79274. */
  79275. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  79276. /**
  79277. * Strong typing of a Mesh Render related stage step action
  79278. */
  79279. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  79280. /**
  79281. * Strong typing of a simple stage step action
  79282. */
  79283. export type SimpleStageAction = () => void;
  79284. /**
  79285. * Strong typing of a render target action.
  79286. */
  79287. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  79288. /**
  79289. * Strong typing of a pointer move action.
  79290. */
  79291. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  79292. /**
  79293. * Strong typing of a pointer up/down action.
  79294. */
  79295. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  79296. /**
  79297. * Representation of a stage in the scene (Basically a list of ordered steps)
  79298. * @hidden
  79299. */
  79300. export class Stage<T extends Function> extends Array<{
  79301. index: number;
  79302. component: ISceneComponent;
  79303. action: T;
  79304. }> {
  79305. /**
  79306. * Hide ctor from the rest of the world.
  79307. * @param items The items to add.
  79308. */
  79309. private constructor();
  79310. /**
  79311. * Creates a new Stage.
  79312. * @returns A new instance of a Stage
  79313. */
  79314. static Create<T extends Function>(): Stage<T>;
  79315. /**
  79316. * Registers a step in an ordered way in the targeted stage.
  79317. * @param index Defines the position to register the step in
  79318. * @param component Defines the component attached to the step
  79319. * @param action Defines the action to launch during the step
  79320. */
  79321. registerStep(index: number, component: ISceneComponent, action: T): void;
  79322. /**
  79323. * Clears all the steps from the stage.
  79324. */
  79325. clear(): void;
  79326. }
  79327. }
  79328. declare module BABYLON {
  79329. interface Scene {
  79330. /** @hidden */
  79331. _pointerOverSprite: Nullable<Sprite>;
  79332. /** @hidden */
  79333. _pickedDownSprite: Nullable<Sprite>;
  79334. /** @hidden */
  79335. _tempSpritePickingRay: Nullable<Ray>;
  79336. /**
  79337. * All of the sprite managers added to this scene
  79338. * @see http://doc.babylonjs.com/babylon101/sprites
  79339. */
  79340. spriteManagers: Array<ISpriteManager>;
  79341. /**
  79342. * An event triggered when sprites rendering is about to start
  79343. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  79344. */
  79345. onBeforeSpritesRenderingObservable: Observable<Scene>;
  79346. /**
  79347. * An event triggered when sprites rendering is done
  79348. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  79349. */
  79350. onAfterSpritesRenderingObservable: Observable<Scene>;
  79351. /** @hidden */
  79352. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79353. /** Launch a ray to try to pick a sprite in the scene
  79354. * @param x position on screen
  79355. * @param y position on screen
  79356. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  79357. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  79358. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  79359. * @returns a PickingInfo
  79360. */
  79361. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79362. /** Use the given ray to pick a sprite in the scene
  79363. * @param ray The ray (in world space) to use to pick meshes
  79364. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  79365. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  79366. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  79367. * @returns a PickingInfo
  79368. */
  79369. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79370. /** @hidden */
  79371. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79372. /** Launch a ray to try to pick sprites in the scene
  79373. * @param x position on screen
  79374. * @param y position on screen
  79375. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  79376. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  79377. * @returns a PickingInfo array
  79378. */
  79379. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79380. /** Use the given ray to pick sprites in the scene
  79381. * @param ray The ray (in world space) to use to pick meshes
  79382. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  79383. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  79384. * @returns a PickingInfo array
  79385. */
  79386. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79387. /**
  79388. * Force the sprite under the pointer
  79389. * @param sprite defines the sprite to use
  79390. */
  79391. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  79392. /**
  79393. * Gets the sprite under the pointer
  79394. * @returns a Sprite or null if no sprite is under the pointer
  79395. */
  79396. getPointerOverSprite(): Nullable<Sprite>;
  79397. }
  79398. /**
  79399. * Defines the sprite scene component responsible to manage sprites
  79400. * in a given scene.
  79401. */
  79402. export class SpriteSceneComponent implements ISceneComponent {
  79403. /**
  79404. * The component name helpfull to identify the component in the list of scene components.
  79405. */
  79406. readonly name: string;
  79407. /**
  79408. * The scene the component belongs to.
  79409. */
  79410. scene: Scene;
  79411. /** @hidden */
  79412. private _spritePredicate;
  79413. /**
  79414. * Creates a new instance of the component for the given scene
  79415. * @param scene Defines the scene to register the component in
  79416. */
  79417. constructor(scene: Scene);
  79418. /**
  79419. * Registers the component in a given scene
  79420. */
  79421. register(): void;
  79422. /**
  79423. * Rebuilds the elements related to this component in case of
  79424. * context lost for instance.
  79425. */
  79426. rebuild(): void;
  79427. /**
  79428. * Disposes the component and the associated ressources.
  79429. */
  79430. dispose(): void;
  79431. private _pickSpriteButKeepRay;
  79432. private _pointerMove;
  79433. private _pointerDown;
  79434. private _pointerUp;
  79435. }
  79436. }
  79437. declare module BABYLON {
  79438. /** @hidden */
  79439. export var fogFragmentDeclaration: {
  79440. name: string;
  79441. shader: string;
  79442. };
  79443. }
  79444. declare module BABYLON {
  79445. /** @hidden */
  79446. export var fogFragment: {
  79447. name: string;
  79448. shader: string;
  79449. };
  79450. }
  79451. declare module BABYLON {
  79452. /** @hidden */
  79453. export var spritesPixelShader: {
  79454. name: string;
  79455. shader: string;
  79456. };
  79457. }
  79458. declare module BABYLON {
  79459. /** @hidden */
  79460. export var fogVertexDeclaration: {
  79461. name: string;
  79462. shader: string;
  79463. };
  79464. }
  79465. declare module BABYLON {
  79466. /** @hidden */
  79467. export var spritesVertexShader: {
  79468. name: string;
  79469. shader: string;
  79470. };
  79471. }
  79472. declare module BABYLON {
  79473. /**
  79474. * Defines the minimum interface to fullfil in order to be a sprite manager.
  79475. */
  79476. export interface ISpriteManager extends IDisposable {
  79477. /**
  79478. * Restricts the camera to viewing objects with the same layerMask.
  79479. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  79480. */
  79481. layerMask: number;
  79482. /**
  79483. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  79484. */
  79485. isPickable: boolean;
  79486. /**
  79487. * Specifies the rendering group id for this mesh (0 by default)
  79488. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  79489. */
  79490. renderingGroupId: number;
  79491. /**
  79492. * Defines the list of sprites managed by the manager.
  79493. */
  79494. sprites: Array<Sprite>;
  79495. /**
  79496. * Tests the intersection of a sprite with a specific ray.
  79497. * @param ray The ray we are sending to test the collision
  79498. * @param camera The camera space we are sending rays in
  79499. * @param predicate A predicate allowing excluding sprites from the list of object to test
  79500. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  79501. * @returns picking info or null.
  79502. */
  79503. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  79504. /**
  79505. * Intersects the sprites with a ray
  79506. * @param ray defines the ray to intersect with
  79507. * @param camera defines the current active camera
  79508. * @param predicate defines a predicate used to select candidate sprites
  79509. * @returns null if no hit or a PickingInfo array
  79510. */
  79511. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  79512. /**
  79513. * Renders the list of sprites on screen.
  79514. */
  79515. render(): void;
  79516. }
  79517. /**
  79518. * Class used to manage multiple sprites on the same spritesheet
  79519. * @see http://doc.babylonjs.com/babylon101/sprites
  79520. */
  79521. export class SpriteManager implements ISpriteManager {
  79522. /** defines the manager's name */
  79523. name: string;
  79524. /** Gets the list of sprites */
  79525. sprites: Sprite[];
  79526. /** Gets or sets the rendering group id (0 by default) */
  79527. renderingGroupId: number;
  79528. /** Gets or sets camera layer mask */
  79529. layerMask: number;
  79530. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  79531. fogEnabled: boolean;
  79532. /** Gets or sets a boolean indicating if the sprites are pickable */
  79533. isPickable: boolean;
  79534. /** Defines the default width of a cell in the spritesheet */
  79535. cellWidth: number;
  79536. /** Defines the default height of a cell in the spritesheet */
  79537. cellHeight: number;
  79538. /** Associative array from JSON sprite data file */
  79539. private _cellData;
  79540. /** Array of sprite names from JSON sprite data file */
  79541. private _spriteMap;
  79542. /** True when packed cell data from JSON file is ready*/
  79543. private _packedAndReady;
  79544. /**
  79545. * An event triggered when the manager is disposed.
  79546. */
  79547. onDisposeObservable: Observable<SpriteManager>;
  79548. private _onDisposeObserver;
  79549. /**
  79550. * Callback called when the manager is disposed
  79551. */
  79552. onDispose: () => void;
  79553. private _capacity;
  79554. private _fromPacked;
  79555. private _spriteTexture;
  79556. private _epsilon;
  79557. private _scene;
  79558. private _vertexData;
  79559. private _buffer;
  79560. private _vertexBuffers;
  79561. private _indexBuffer;
  79562. private _effectBase;
  79563. private _effectFog;
  79564. /**
  79565. * Gets or sets the spritesheet texture
  79566. */
  79567. texture: Texture;
  79568. /**
  79569. * Creates a new sprite manager
  79570. * @param name defines the manager's name
  79571. * @param imgUrl defines the sprite sheet url
  79572. * @param capacity defines the maximum allowed number of sprites
  79573. * @param cellSize defines the size of a sprite cell
  79574. * @param scene defines the hosting scene
  79575. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  79576. * @param samplingMode defines the smapling mode to use with spritesheet
  79577. * @param fromPacked set to false; do not alter
  79578. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  79579. */
  79580. constructor(
  79581. /** defines the manager's name */
  79582. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  79583. private _makePacked;
  79584. private _appendSpriteVertex;
  79585. /**
  79586. * Intersects the sprites with a ray
  79587. * @param ray defines the ray to intersect with
  79588. * @param camera defines the current active camera
  79589. * @param predicate defines a predicate used to select candidate sprites
  79590. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  79591. * @returns null if no hit or a PickingInfo
  79592. */
  79593. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  79594. /**
  79595. * Intersects the sprites with a ray
  79596. * @param ray defines the ray to intersect with
  79597. * @param camera defines the current active camera
  79598. * @param predicate defines a predicate used to select candidate sprites
  79599. * @returns null if no hit or a PickingInfo array
  79600. */
  79601. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  79602. /**
  79603. * Render all child sprites
  79604. */
  79605. render(): void;
  79606. /**
  79607. * Release associated resources
  79608. */
  79609. dispose(): void;
  79610. }
  79611. }
  79612. declare module BABYLON {
  79613. /**
  79614. * Class used to represent a sprite
  79615. * @see http://doc.babylonjs.com/babylon101/sprites
  79616. */
  79617. export class Sprite {
  79618. /** defines the name */
  79619. name: string;
  79620. /** Gets or sets the current world position */
  79621. position: Vector3;
  79622. /** Gets or sets the main color */
  79623. color: Color4;
  79624. /** Gets or sets the width */
  79625. width: number;
  79626. /** Gets or sets the height */
  79627. height: number;
  79628. /** Gets or sets rotation angle */
  79629. angle: number;
  79630. /** Gets or sets the cell index in the sprite sheet */
  79631. cellIndex: number;
  79632. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  79633. cellRef: string;
  79634. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  79635. invertU: number;
  79636. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  79637. invertV: number;
  79638. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  79639. disposeWhenFinishedAnimating: boolean;
  79640. /** Gets the list of attached animations */
  79641. animations: Animation[];
  79642. /** Gets or sets a boolean indicating if the sprite can be picked */
  79643. isPickable: boolean;
  79644. /**
  79645. * Gets or sets the associated action manager
  79646. */
  79647. actionManager: Nullable<ActionManager>;
  79648. private _animationStarted;
  79649. private _loopAnimation;
  79650. private _fromIndex;
  79651. private _toIndex;
  79652. private _delay;
  79653. private _direction;
  79654. private _manager;
  79655. private _time;
  79656. private _onAnimationEnd;
  79657. /**
  79658. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  79659. */
  79660. isVisible: boolean;
  79661. /**
  79662. * Gets or sets the sprite size
  79663. */
  79664. size: number;
  79665. /**
  79666. * Creates a new Sprite
  79667. * @param name defines the name
  79668. * @param manager defines the manager
  79669. */
  79670. constructor(
  79671. /** defines the name */
  79672. name: string, manager: ISpriteManager);
  79673. /**
  79674. * Starts an animation
  79675. * @param from defines the initial key
  79676. * @param to defines the end key
  79677. * @param loop defines if the animation must loop
  79678. * @param delay defines the start delay (in ms)
  79679. * @param onAnimationEnd defines a callback to call when animation ends
  79680. */
  79681. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  79682. /** Stops current animation (if any) */
  79683. stopAnimation(): void;
  79684. /** @hidden */
  79685. _animate(deltaTime: number): void;
  79686. /** Release associated resources */
  79687. dispose(): void;
  79688. }
  79689. }
  79690. declare module BABYLON {
  79691. /**
  79692. * Information about the result of picking within a scene
  79693. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  79694. */
  79695. export class PickingInfo {
  79696. /** @hidden */
  79697. _pickingUnavailable: boolean;
  79698. /**
  79699. * If the pick collided with an object
  79700. */
  79701. hit: boolean;
  79702. /**
  79703. * Distance away where the pick collided
  79704. */
  79705. distance: number;
  79706. /**
  79707. * The location of pick collision
  79708. */
  79709. pickedPoint: Nullable<Vector3>;
  79710. /**
  79711. * The mesh corresponding the the pick collision
  79712. */
  79713. pickedMesh: Nullable<AbstractMesh>;
  79714. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  79715. bu: number;
  79716. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  79717. bv: number;
  79718. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  79719. faceId: number;
  79720. /** Id of the the submesh that was picked */
  79721. subMeshId: number;
  79722. /** If a sprite was picked, this will be the sprite the pick collided with */
  79723. pickedSprite: Nullable<Sprite>;
  79724. /**
  79725. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  79726. */
  79727. originMesh: Nullable<AbstractMesh>;
  79728. /**
  79729. * The ray that was used to perform the picking.
  79730. */
  79731. ray: Nullable<Ray>;
  79732. /**
  79733. * Gets the normal correspodning to the face the pick collided with
  79734. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  79735. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  79736. * @returns The normal correspodning to the face the pick collided with
  79737. */
  79738. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  79739. /**
  79740. * Gets the texture coordinates of where the pick occured
  79741. * @returns the vector containing the coordnates of the texture
  79742. */
  79743. getTextureCoordinates(): Nullable<Vector2>;
  79744. }
  79745. }
  79746. declare module BABYLON {
  79747. /**
  79748. * Gather the list of pointer event types as constants.
  79749. */
  79750. export class PointerEventTypes {
  79751. /**
  79752. * The pointerdown event is fired when a pointer becomes active. For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed. For touch, it is fired when physical contact is made with the digitizer. For pen, it is fired when the stylus makes physical contact with the digitizer.
  79753. */
  79754. static readonly POINTERDOWN: number;
  79755. /**
  79756. * The pointerup event is fired when a pointer is no longer active.
  79757. */
  79758. static readonly POINTERUP: number;
  79759. /**
  79760. * The pointermove event is fired when a pointer changes coordinates.
  79761. */
  79762. static readonly POINTERMOVE: number;
  79763. /**
  79764. * The pointerwheel event is fired when a mouse wheel has been rotated.
  79765. */
  79766. static readonly POINTERWHEEL: number;
  79767. /**
  79768. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  79769. */
  79770. static readonly POINTERPICK: number;
  79771. /**
  79772. * The pointertap event is fired when a the object has been touched and released without drag.
  79773. */
  79774. static readonly POINTERTAP: number;
  79775. /**
  79776. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  79777. */
  79778. static readonly POINTERDOUBLETAP: number;
  79779. }
  79780. /**
  79781. * Base class of pointer info types.
  79782. */
  79783. export class PointerInfoBase {
  79784. /**
  79785. * Defines the type of event (PointerEventTypes)
  79786. */
  79787. type: number;
  79788. /**
  79789. * Defines the related dom event
  79790. */
  79791. event: PointerEvent | MouseWheelEvent;
  79792. /**
  79793. * Instantiates the base class of pointers info.
  79794. * @param type Defines the type of event (PointerEventTypes)
  79795. * @param event Defines the related dom event
  79796. */
  79797. constructor(
  79798. /**
  79799. * Defines the type of event (PointerEventTypes)
  79800. */
  79801. type: number,
  79802. /**
  79803. * Defines the related dom event
  79804. */
  79805. event: PointerEvent | MouseWheelEvent);
  79806. }
  79807. /**
  79808. * This class is used to store pointer related info for the onPrePointerObservable event.
  79809. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  79810. */
  79811. export class PointerInfoPre extends PointerInfoBase {
  79812. /**
  79813. * Ray from a pointer if availible (eg. 6dof controller)
  79814. */
  79815. ray: Nullable<Ray>;
  79816. /**
  79817. * Defines the local position of the pointer on the canvas.
  79818. */
  79819. localPosition: Vector2;
  79820. /**
  79821. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  79822. */
  79823. skipOnPointerObservable: boolean;
  79824. /**
  79825. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  79826. * @param type Defines the type of event (PointerEventTypes)
  79827. * @param event Defines the related dom event
  79828. * @param localX Defines the local x coordinates of the pointer when the event occured
  79829. * @param localY Defines the local y coordinates of the pointer when the event occured
  79830. */
  79831. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  79832. }
  79833. /**
  79834. * This type contains all the data related to a pointer event in Babylon.js.
  79835. * The event member is an instance of PointerEvent for all types except PointerWheel and is of type MouseWheelEvent when type equals PointerWheel. The different event types can be found in the PointerEventTypes class.
  79836. */
  79837. export class PointerInfo extends PointerInfoBase {
  79838. /**
  79839. * Defines the picking info associated to the info (if any)\
  79840. */
  79841. pickInfo: Nullable<PickingInfo>;
  79842. /**
  79843. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  79844. * @param type Defines the type of event (PointerEventTypes)
  79845. * @param event Defines the related dom event
  79846. * @param pickInfo Defines the picking info associated to the info (if any)\
  79847. */
  79848. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  79849. /**
  79850. * Defines the picking info associated to the info (if any)\
  79851. */
  79852. pickInfo: Nullable<PickingInfo>);
  79853. }
  79854. /**
  79855. * Data relating to a touch event on the screen.
  79856. */
  79857. export interface PointerTouch {
  79858. /**
  79859. * X coordinate of touch.
  79860. */
  79861. x: number;
  79862. /**
  79863. * Y coordinate of touch.
  79864. */
  79865. y: number;
  79866. /**
  79867. * Id of touch. Unique for each finger.
  79868. */
  79869. pointerId: number;
  79870. /**
  79871. * Event type passed from DOM.
  79872. */
  79873. type: any;
  79874. }
  79875. }
  79876. declare module BABYLON {
  79877. /**
  79878. * Manage the mouse inputs to control the movement of a free camera.
  79879. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79880. */
  79881. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  79882. /**
  79883. * Define if touch is enabled in the mouse input
  79884. */
  79885. touchEnabled: boolean;
  79886. /**
  79887. * Defines the camera the input is attached to.
  79888. */
  79889. camera: FreeCamera;
  79890. /**
  79891. * Defines the buttons associated with the input to handle camera move.
  79892. */
  79893. buttons: number[];
  79894. /**
  79895. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  79896. */
  79897. angularSensibility: number;
  79898. private _pointerInput;
  79899. private _onMouseMove;
  79900. private _observer;
  79901. private previousPosition;
  79902. /**
  79903. * Observable for when a pointer move event occurs containing the move offset
  79904. */
  79905. onPointerMovedObservable: Observable<{
  79906. offsetX: number;
  79907. offsetY: number;
  79908. }>;
  79909. /**
  79910. * @hidden
  79911. * If the camera should be rotated automatically based on pointer movement
  79912. */
  79913. _allowCameraRotation: boolean;
  79914. /**
  79915. * Manage the mouse inputs to control the movement of a free camera.
  79916. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79917. * @param touchEnabled Defines if touch is enabled or not
  79918. */
  79919. constructor(
  79920. /**
  79921. * Define if touch is enabled in the mouse input
  79922. */
  79923. touchEnabled?: boolean);
  79924. /**
  79925. * Attach the input controls to a specific dom element to get the input from.
  79926. * @param element Defines the element the controls should be listened from
  79927. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  79928. */
  79929. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  79930. /**
  79931. * Called on JS contextmenu event.
  79932. * Override this method to provide functionality.
  79933. */
  79934. protected onContextMenu(evt: PointerEvent): void;
  79935. /**
  79936. * Detach the current controls from the specified dom element.
  79937. * @param element Defines the element to stop listening the inputs from
  79938. */
  79939. detachControl(element: Nullable<HTMLElement>): void;
  79940. /**
  79941. * Gets the class name of the current intput.
  79942. * @returns the class name
  79943. */
  79944. getClassName(): string;
  79945. /**
  79946. * Get the friendly name associated with the input class.
  79947. * @returns the input friendly name
  79948. */
  79949. getSimpleName(): string;
  79950. }
  79951. }
  79952. declare module BABYLON {
  79953. /**
  79954. * Manage the touch inputs to control the movement of a free camera.
  79955. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  79956. */
  79957. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  79958. /**
  79959. * Defines the camera the input is attached to.
  79960. */
  79961. camera: FreeCamera;
  79962. /**
  79963. * Defines the touch sensibility for rotation.
  79964. * The higher the faster.
  79965. */
  79966. touchAngularSensibility: number;
  79967. /**
  79968. * Defines the touch sensibility for move.
  79969. * The higher the faster.
  79970. */
  79971. touchMoveSensibility: number;
  79972. private _offsetX;
  79973. private _offsetY;
  79974. private _pointerPressed;
  79975. private _pointerInput;
  79976. private _observer;
  79977. private _onLostFocus;
  79978. /**
  79979. * Attach the input controls to a specific dom element to get the input from.
  79980. * @param element Defines the element the controls should be listened from
  79981. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  79982. */
  79983. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  79984. /**
  79985. * Detach the current controls from the specified dom element.
  79986. * @param element Defines the element to stop listening the inputs from
  79987. */
  79988. detachControl(element: Nullable<HTMLElement>): void;
  79989. /**
  79990. * Update the current camera state depending on the inputs that have been used this frame.
  79991. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  79992. */
  79993. checkInputs(): void;
  79994. /**
  79995. * Gets the class name of the current intput.
  79996. * @returns the class name
  79997. */
  79998. getClassName(): string;
  79999. /**
  80000. * Get the friendly name associated with the input class.
  80001. * @returns the input friendly name
  80002. */
  80003. getSimpleName(): string;
  80004. }
  80005. }
  80006. declare module BABYLON {
  80007. /**
  80008. * Default Inputs manager for the FreeCamera.
  80009. * It groups all the default supported inputs for ease of use.
  80010. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  80011. */
  80012. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  80013. /**
  80014. * @hidden
  80015. */
  80016. _mouseInput: Nullable<FreeCameraMouseInput>;
  80017. /**
  80018. * Instantiates a new FreeCameraInputsManager.
  80019. * @param camera Defines the camera the inputs belong to
  80020. */
  80021. constructor(camera: FreeCamera);
  80022. /**
  80023. * Add keyboard input support to the input manager.
  80024. * @returns the current input manager
  80025. */
  80026. addKeyboard(): FreeCameraInputsManager;
  80027. /**
  80028. * Add mouse input support to the input manager.
  80029. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  80030. * @returns the current input manager
  80031. */
  80032. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  80033. /**
  80034. * Removes the mouse input support from the manager
  80035. * @returns the current input manager
  80036. */
  80037. removeMouse(): FreeCameraInputsManager;
  80038. /**
  80039. * Add touch input support to the input manager.
  80040. * @returns the current input manager
  80041. */
  80042. addTouch(): FreeCameraInputsManager;
  80043. /**
  80044. * Remove all attached input methods from a camera
  80045. */
  80046. clear(): void;
  80047. }
  80048. }
  80049. declare module BABYLON {
  80050. /**
  80051. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  80052. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  80053. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  80054. */
  80055. export class FreeCamera extends TargetCamera {
  80056. /**
  80057. * Define the collision ellipsoid of the camera.
  80058. * This is helpful to simulate a camera body like the player body around the camera
  80059. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  80060. */
  80061. ellipsoid: Vector3;
  80062. /**
  80063. * Define an offset for the position of the ellipsoid around the camera.
  80064. * This can be helpful to determine the center of the body near the gravity center of the body
  80065. * instead of its head.
  80066. */
  80067. ellipsoidOffset: Vector3;
  80068. /**
  80069. * Enable or disable collisions of the camera with the rest of the scene objects.
  80070. */
  80071. checkCollisions: boolean;
  80072. /**
  80073. * Enable or disable gravity on the camera.
  80074. */
  80075. applyGravity: boolean;
  80076. /**
  80077. * Define the input manager associated to the camera.
  80078. */
  80079. inputs: FreeCameraInputsManager;
  80080. /**
  80081. * Gets the input sensibility for a mouse input. (default is 2000.0)
  80082. * Higher values reduce sensitivity.
  80083. */
  80084. /**
  80085. * Sets the input sensibility for a mouse input. (default is 2000.0)
  80086. * Higher values reduce sensitivity.
  80087. */
  80088. angularSensibility: number;
  80089. /**
  80090. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  80091. */
  80092. keysUp: number[];
  80093. /**
  80094. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  80095. */
  80096. keysDown: number[];
  80097. /**
  80098. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  80099. */
  80100. keysLeft: number[];
  80101. /**
  80102. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  80103. */
  80104. keysRight: number[];
  80105. /**
  80106. * Event raised when the camera collide with a mesh in the scene.
  80107. */
  80108. onCollide: (collidedMesh: AbstractMesh) => void;
  80109. private _collider;
  80110. private _needMoveForGravity;
  80111. private _oldPosition;
  80112. private _diffPosition;
  80113. private _newPosition;
  80114. /** @hidden */
  80115. _localDirection: Vector3;
  80116. /** @hidden */
  80117. _transformedDirection: Vector3;
  80118. /**
  80119. * Instantiates a Free Camera.
  80120. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  80121. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  80122. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  80123. * @param name Define the name of the camera in the scene
  80124. * @param position Define the start position of the camera in the scene
  80125. * @param scene Define the scene the camera belongs to
  80126. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  80127. */
  80128. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  80129. /**
  80130. * Attached controls to the current camera.
  80131. * @param element Defines the element the controls should be listened from
  80132. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  80133. */
  80134. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  80135. /**
  80136. * Detach the current controls from the camera.
  80137. * The camera will stop reacting to inputs.
  80138. * @param element Defines the element to stop listening the inputs from
  80139. */
  80140. detachControl(element: HTMLElement): void;
  80141. private _collisionMask;
  80142. /**
  80143. * Define a collision mask to limit the list of object the camera can collide with
  80144. */
  80145. collisionMask: number;
  80146. /** @hidden */
  80147. _collideWithWorld(displacement: Vector3): void;
  80148. private _onCollisionPositionChange;
  80149. /** @hidden */
  80150. _checkInputs(): void;
  80151. /** @hidden */
  80152. _decideIfNeedsToMove(): boolean;
  80153. /** @hidden */
  80154. _updatePosition(): void;
  80155. /**
  80156. * Destroy the camera and release the current resources hold by it.
  80157. */
  80158. dispose(): void;
  80159. /**
  80160. * Gets the current object class name.
  80161. * @return the class name
  80162. */
  80163. getClassName(): string;
  80164. }
  80165. }
  80166. declare module BABYLON {
  80167. /**
  80168. * Represents a gamepad control stick position
  80169. */
  80170. export class StickValues {
  80171. /**
  80172. * The x component of the control stick
  80173. */
  80174. x: number;
  80175. /**
  80176. * The y component of the control stick
  80177. */
  80178. y: number;
  80179. /**
  80180. * Initializes the gamepad x and y control stick values
  80181. * @param x The x component of the gamepad control stick value
  80182. * @param y The y component of the gamepad control stick value
  80183. */
  80184. constructor(
  80185. /**
  80186. * The x component of the control stick
  80187. */
  80188. x: number,
  80189. /**
  80190. * The y component of the control stick
  80191. */
  80192. y: number);
  80193. }
  80194. /**
  80195. * An interface which manages callbacks for gamepad button changes
  80196. */
  80197. export interface GamepadButtonChanges {
  80198. /**
  80199. * Called when a gamepad has been changed
  80200. */
  80201. changed: boolean;
  80202. /**
  80203. * Called when a gamepad press event has been triggered
  80204. */
  80205. pressChanged: boolean;
  80206. /**
  80207. * Called when a touch event has been triggered
  80208. */
  80209. touchChanged: boolean;
  80210. /**
  80211. * Called when a value has changed
  80212. */
  80213. valueChanged: boolean;
  80214. }
  80215. /**
  80216. * Represents a gamepad
  80217. */
  80218. export class Gamepad {
  80219. /**
  80220. * The id of the gamepad
  80221. */
  80222. id: string;
  80223. /**
  80224. * The index of the gamepad
  80225. */
  80226. index: number;
  80227. /**
  80228. * The browser gamepad
  80229. */
  80230. browserGamepad: any;
  80231. /**
  80232. * Specifies what type of gamepad this represents
  80233. */
  80234. type: number;
  80235. private _leftStick;
  80236. private _rightStick;
  80237. /** @hidden */
  80238. _isConnected: boolean;
  80239. private _leftStickAxisX;
  80240. private _leftStickAxisY;
  80241. private _rightStickAxisX;
  80242. private _rightStickAxisY;
  80243. /**
  80244. * Triggered when the left control stick has been changed
  80245. */
  80246. private _onleftstickchanged;
  80247. /**
  80248. * Triggered when the right control stick has been changed
  80249. */
  80250. private _onrightstickchanged;
  80251. /**
  80252. * Represents a gamepad controller
  80253. */
  80254. static GAMEPAD: number;
  80255. /**
  80256. * Represents a generic controller
  80257. */
  80258. static GENERIC: number;
  80259. /**
  80260. * Represents an XBox controller
  80261. */
  80262. static XBOX: number;
  80263. /**
  80264. * Represents a pose-enabled controller
  80265. */
  80266. static POSE_ENABLED: number;
  80267. /**
  80268. * Represents an Dual Shock controller
  80269. */
  80270. static DUALSHOCK: number;
  80271. /**
  80272. * Specifies whether the left control stick should be Y-inverted
  80273. */
  80274. protected _invertLeftStickY: boolean;
  80275. /**
  80276. * Specifies if the gamepad has been connected
  80277. */
  80278. readonly isConnected: boolean;
  80279. /**
  80280. * Initializes the gamepad
  80281. * @param id The id of the gamepad
  80282. * @param index The index of the gamepad
  80283. * @param browserGamepad The browser gamepad
  80284. * @param leftStickX The x component of the left joystick
  80285. * @param leftStickY The y component of the left joystick
  80286. * @param rightStickX The x component of the right joystick
  80287. * @param rightStickY The y component of the right joystick
  80288. */
  80289. constructor(
  80290. /**
  80291. * The id of the gamepad
  80292. */
  80293. id: string,
  80294. /**
  80295. * The index of the gamepad
  80296. */
  80297. index: number,
  80298. /**
  80299. * The browser gamepad
  80300. */
  80301. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  80302. /**
  80303. * Callback triggered when the left joystick has changed
  80304. * @param callback
  80305. */
  80306. onleftstickchanged(callback: (values: StickValues) => void): void;
  80307. /**
  80308. * Callback triggered when the right joystick has changed
  80309. * @param callback
  80310. */
  80311. onrightstickchanged(callback: (values: StickValues) => void): void;
  80312. /**
  80313. * Gets the left joystick
  80314. */
  80315. /**
  80316. * Sets the left joystick values
  80317. */
  80318. leftStick: StickValues;
  80319. /**
  80320. * Gets the right joystick
  80321. */
  80322. /**
  80323. * Sets the right joystick value
  80324. */
  80325. rightStick: StickValues;
  80326. /**
  80327. * Updates the gamepad joystick positions
  80328. */
  80329. update(): void;
  80330. /**
  80331. * Disposes the gamepad
  80332. */
  80333. dispose(): void;
  80334. }
  80335. /**
  80336. * Represents a generic gamepad
  80337. */
  80338. export class GenericPad extends Gamepad {
  80339. private _buttons;
  80340. private _onbuttondown;
  80341. private _onbuttonup;
  80342. /**
  80343. * Observable triggered when a button has been pressed
  80344. */
  80345. onButtonDownObservable: Observable<number>;
  80346. /**
  80347. * Observable triggered when a button has been released
  80348. */
  80349. onButtonUpObservable: Observable<number>;
  80350. /**
  80351. * Callback triggered when a button has been pressed
  80352. * @param callback Called when a button has been pressed
  80353. */
  80354. onbuttondown(callback: (buttonPressed: number) => void): void;
  80355. /**
  80356. * Callback triggered when a button has been released
  80357. * @param callback Called when a button has been released
  80358. */
  80359. onbuttonup(callback: (buttonReleased: number) => void): void;
  80360. /**
  80361. * Initializes the generic gamepad
  80362. * @param id The id of the generic gamepad
  80363. * @param index The index of the generic gamepad
  80364. * @param browserGamepad The browser gamepad
  80365. */
  80366. constructor(id: string, index: number, browserGamepad: any);
  80367. private _setButtonValue;
  80368. /**
  80369. * Updates the generic gamepad
  80370. */
  80371. update(): void;
  80372. /**
  80373. * Disposes the generic gamepad
  80374. */
  80375. dispose(): void;
  80376. }
  80377. }
  80378. declare module BABYLON {
  80379. interface Engine {
  80380. /**
  80381. * Creates a raw texture
  80382. * @param data defines the data to store in the texture
  80383. * @param width defines the width of the texture
  80384. * @param height defines the height of the texture
  80385. * @param format defines the format of the data
  80386. * @param generateMipMaps defines if the engine should generate the mip levels
  80387. * @param invertY defines if data must be stored with Y axis inverted
  80388. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  80389. * @param compression defines the compression used (null by default)
  80390. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80391. * @returns the raw texture inside an InternalTexture
  80392. */
  80393. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  80394. /**
  80395. * Update a raw texture
  80396. * @param texture defines the texture to update
  80397. * @param data defines the data to store in the texture
  80398. * @param format defines the format of the data
  80399. * @param invertY defines if data must be stored with Y axis inverted
  80400. */
  80401. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80402. /**
  80403. * Update a raw texture
  80404. * @param texture defines the texture to update
  80405. * @param data defines the data to store in the texture
  80406. * @param format defines the format of the data
  80407. * @param invertY defines if data must be stored with Y axis inverted
  80408. * @param compression defines the compression used (null by default)
  80409. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80410. */
  80411. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  80412. /**
  80413. * Creates a new raw cube texture
  80414. * @param data defines the array of data to use to create each face
  80415. * @param size defines the size of the textures
  80416. * @param format defines the format of the data
  80417. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80418. * @param generateMipMaps defines if the engine should generate the mip levels
  80419. * @param invertY defines if data must be stored with Y axis inverted
  80420. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80421. * @param compression defines the compression used (null by default)
  80422. * @returns the cube texture as an InternalTexture
  80423. */
  80424. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  80425. /**
  80426. * Update a raw cube texture
  80427. * @param texture defines the texture to udpdate
  80428. * @param data defines the data to store
  80429. * @param format defines the data format
  80430. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80431. * @param invertY defines if data must be stored with Y axis inverted
  80432. */
  80433. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  80434. /**
  80435. * Update a raw cube texture
  80436. * @param texture defines the texture to udpdate
  80437. * @param data defines the data to store
  80438. * @param format defines the data format
  80439. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80440. * @param invertY defines if data must be stored with Y axis inverted
  80441. * @param compression defines the compression used (null by default)
  80442. */
  80443. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  80444. /**
  80445. * Update a raw cube texture
  80446. * @param texture defines the texture to udpdate
  80447. * @param data defines the data to store
  80448. * @param format defines the data format
  80449. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80450. * @param invertY defines if data must be stored with Y axis inverted
  80451. * @param compression defines the compression used (null by default)
  80452. * @param level defines which level of the texture to update
  80453. */
  80454. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  80455. /**
  80456. * Creates a new raw cube texture from a specified url
  80457. * @param url defines the url where the data is located
  80458. * @param scene defines the current scene
  80459. * @param size defines the size of the textures
  80460. * @param format defines the format of the data
  80461. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80462. * @param noMipmap defines if the engine should avoid generating the mip levels
  80463. * @param callback defines a callback used to extract texture data from loaded data
  80464. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  80465. * @param onLoad defines a callback called when texture is loaded
  80466. * @param onError defines a callback called if there is an error
  80467. * @returns the cube texture as an InternalTexture
  80468. */
  80469. createRawCubeTextureFromUrl(url: string, scene: Scene, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  80470. /**
  80471. * Creates a new raw cube texture from a specified url
  80472. * @param url defines the url where the data is located
  80473. * @param scene defines the current scene
  80474. * @param size defines the size of the textures
  80475. * @param format defines the format of the data
  80476. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80477. * @param noMipmap defines if the engine should avoid generating the mip levels
  80478. * @param callback defines a callback used to extract texture data from loaded data
  80479. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  80480. * @param onLoad defines a callback called when texture is loaded
  80481. * @param onError defines a callback called if there is an error
  80482. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80483. * @param invertY defines if data must be stored with Y axis inverted
  80484. * @returns the cube texture as an InternalTexture
  80485. */
  80486. createRawCubeTextureFromUrl(url: string, scene: Scene, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  80487. /**
  80488. * Creates a new raw 3D texture
  80489. * @param data defines the data used to create the texture
  80490. * @param width defines the width of the texture
  80491. * @param height defines the height of the texture
  80492. * @param depth defines the depth of the texture
  80493. * @param format defines the format of the texture
  80494. * @param generateMipMaps defines if the engine must generate mip levels
  80495. * @param invertY defines if data must be stored with Y axis inverted
  80496. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80497. * @param compression defines the compressed used (can be null)
  80498. * @param textureType defines the compressed used (can be null)
  80499. * @returns a new raw 3D texture (stored in an InternalTexture)
  80500. */
  80501. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  80502. /**
  80503. * Update a raw 3D texture
  80504. * @param texture defines the texture to update
  80505. * @param data defines the data to store
  80506. * @param format defines the data format
  80507. * @param invertY defines if data must be stored with Y axis inverted
  80508. */
  80509. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80510. /**
  80511. * Update a raw 3D texture
  80512. * @param texture defines the texture to update
  80513. * @param data defines the data to store
  80514. * @param format defines the data format
  80515. * @param invertY defines if data must be stored with Y axis inverted
  80516. * @param compression defines the used compression (can be null)
  80517. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  80518. */
  80519. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  80520. /**
  80521. * Creates a new raw 2D array texture
  80522. * @param data defines the data used to create the texture
  80523. * @param width defines the width of the texture
  80524. * @param height defines the height of the texture
  80525. * @param depth defines the number of layers of the texture
  80526. * @param format defines the format of the texture
  80527. * @param generateMipMaps defines if the engine must generate mip levels
  80528. * @param invertY defines if data must be stored with Y axis inverted
  80529. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80530. * @param compression defines the compressed used (can be null)
  80531. * @param textureType defines the compressed used (can be null)
  80532. * @returns a new raw 2D array texture (stored in an InternalTexture)
  80533. */
  80534. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  80535. /**
  80536. * Update a raw 2D array texture
  80537. * @param texture defines the texture to update
  80538. * @param data defines the data to store
  80539. * @param format defines the data format
  80540. * @param invertY defines if data must be stored with Y axis inverted
  80541. */
  80542. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80543. /**
  80544. * Update a raw 2D array texture
  80545. * @param texture defines the texture to update
  80546. * @param data defines the data to store
  80547. * @param format defines the data format
  80548. * @param invertY defines if data must be stored with Y axis inverted
  80549. * @param compression defines the used compression (can be null)
  80550. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  80551. */
  80552. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  80553. }
  80554. }
  80555. declare module BABYLON {
  80556. /**
  80557. * Raw texture can help creating a texture directly from an array of data.
  80558. * This can be super useful if you either get the data from an uncompressed source or
  80559. * if you wish to create your texture pixel by pixel.
  80560. */
  80561. export class RawTexture extends Texture {
  80562. /**
  80563. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80564. */
  80565. format: number;
  80566. private _engine;
  80567. /**
  80568. * Instantiates a new RawTexture.
  80569. * Raw texture can help creating a texture directly from an array of data.
  80570. * This can be super useful if you either get the data from an uncompressed source or
  80571. * if you wish to create your texture pixel by pixel.
  80572. * @param data define the array of data to use to create the texture
  80573. * @param width define the width of the texture
  80574. * @param height define the height of the texture
  80575. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80576. * @param scene define the scene the texture belongs to
  80577. * @param generateMipMaps define whether mip maps should be generated or not
  80578. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80579. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80580. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80581. */
  80582. constructor(data: ArrayBufferView, width: number, height: number,
  80583. /**
  80584. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80585. */
  80586. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  80587. /**
  80588. * Updates the texture underlying data.
  80589. * @param data Define the new data of the texture
  80590. */
  80591. update(data: ArrayBufferView): void;
  80592. /**
  80593. * Creates a luminance texture from some data.
  80594. * @param data Define the texture data
  80595. * @param width Define the width of the texture
  80596. * @param height Define the height of the texture
  80597. * @param scene Define the scene the texture belongs to
  80598. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80599. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80600. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80601. * @returns the luminance texture
  80602. */
  80603. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80604. /**
  80605. * Creates a luminance alpha texture from some data.
  80606. * @param data Define the texture data
  80607. * @param width Define the width of the texture
  80608. * @param height Define the height of the texture
  80609. * @param scene Define the scene the texture belongs to
  80610. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80611. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80612. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80613. * @returns the luminance alpha texture
  80614. */
  80615. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80616. /**
  80617. * Creates an alpha texture from some data.
  80618. * @param data Define the texture data
  80619. * @param width Define the width of the texture
  80620. * @param height Define the height of the texture
  80621. * @param scene Define the scene the texture belongs to
  80622. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80623. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80624. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80625. * @returns the alpha texture
  80626. */
  80627. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80628. /**
  80629. * Creates a RGB texture from some data.
  80630. * @param data Define the texture data
  80631. * @param width Define the width of the texture
  80632. * @param height Define the height of the texture
  80633. * @param scene Define the scene the texture belongs to
  80634. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80635. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80636. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80637. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80638. * @returns the RGB alpha texture
  80639. */
  80640. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  80641. /**
  80642. * Creates a RGBA texture from some data.
  80643. * @param data Define the texture data
  80644. * @param width Define the width of the texture
  80645. * @param height Define the height of the texture
  80646. * @param scene Define the scene the texture belongs to
  80647. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80648. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80649. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80650. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80651. * @returns the RGBA texture
  80652. */
  80653. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  80654. /**
  80655. * Creates a R texture from some data.
  80656. * @param data Define the texture data
  80657. * @param width Define the width of the texture
  80658. * @param height Define the height of the texture
  80659. * @param scene Define the scene the texture belongs to
  80660. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80661. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80662. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80663. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80664. * @returns the R texture
  80665. */
  80666. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  80667. }
  80668. }
  80669. declare module BABYLON {
  80670. /**
  80671. * Interface for the size containing width and height
  80672. */
  80673. export interface ISize {
  80674. /**
  80675. * Width
  80676. */
  80677. width: number;
  80678. /**
  80679. * Heighht
  80680. */
  80681. height: number;
  80682. }
  80683. /**
  80684. * Size containing widht and height
  80685. */
  80686. export class Size implements ISize {
  80687. /**
  80688. * Width
  80689. */
  80690. width: number;
  80691. /**
  80692. * Height
  80693. */
  80694. height: number;
  80695. /**
  80696. * Creates a Size object from the given width and height (floats).
  80697. * @param width width of the new size
  80698. * @param height height of the new size
  80699. */
  80700. constructor(width: number, height: number);
  80701. /**
  80702. * Returns a string with the Size width and height
  80703. * @returns a string with the Size width and height
  80704. */
  80705. toString(): string;
  80706. /**
  80707. * "Size"
  80708. * @returns the string "Size"
  80709. */
  80710. getClassName(): string;
  80711. /**
  80712. * Returns the Size hash code.
  80713. * @returns a hash code for a unique width and height
  80714. */
  80715. getHashCode(): number;
  80716. /**
  80717. * Updates the current size from the given one.
  80718. * @param src the given size
  80719. */
  80720. copyFrom(src: Size): void;
  80721. /**
  80722. * Updates in place the current Size from the given floats.
  80723. * @param width width of the new size
  80724. * @param height height of the new size
  80725. * @returns the updated Size.
  80726. */
  80727. copyFromFloats(width: number, height: number): Size;
  80728. /**
  80729. * Updates in place the current Size from the given floats.
  80730. * @param width width to set
  80731. * @param height height to set
  80732. * @returns the updated Size.
  80733. */
  80734. set(width: number, height: number): Size;
  80735. /**
  80736. * Multiplies the width and height by numbers
  80737. * @param w factor to multiple the width by
  80738. * @param h factor to multiple the height by
  80739. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  80740. */
  80741. multiplyByFloats(w: number, h: number): Size;
  80742. /**
  80743. * Clones the size
  80744. * @returns a new Size copied from the given one.
  80745. */
  80746. clone(): Size;
  80747. /**
  80748. * True if the current Size and the given one width and height are strictly equal.
  80749. * @param other the other size to compare against
  80750. * @returns True if the current Size and the given one width and height are strictly equal.
  80751. */
  80752. equals(other: Size): boolean;
  80753. /**
  80754. * The surface of the Size : width * height (float).
  80755. */
  80756. readonly surface: number;
  80757. /**
  80758. * Create a new size of zero
  80759. * @returns a new Size set to (0.0, 0.0)
  80760. */
  80761. static Zero(): Size;
  80762. /**
  80763. * Sums the width and height of two sizes
  80764. * @param otherSize size to add to this size
  80765. * @returns a new Size set as the addition result of the current Size and the given one.
  80766. */
  80767. add(otherSize: Size): Size;
  80768. /**
  80769. * Subtracts the width and height of two
  80770. * @param otherSize size to subtract to this size
  80771. * @returns a new Size set as the subtraction result of the given one from the current Size.
  80772. */
  80773. subtract(otherSize: Size): Size;
  80774. /**
  80775. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  80776. * @param start starting size to lerp between
  80777. * @param end end size to lerp between
  80778. * @param amount amount to lerp between the start and end values
  80779. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  80780. */
  80781. static Lerp(start: Size, end: Size, amount: number): Size;
  80782. }
  80783. }
  80784. declare module BABYLON {
  80785. /**
  80786. * Defines a runtime animation
  80787. */
  80788. export class RuntimeAnimation {
  80789. private _events;
  80790. /**
  80791. * The current frame of the runtime animation
  80792. */
  80793. private _currentFrame;
  80794. /**
  80795. * The animation used by the runtime animation
  80796. */
  80797. private _animation;
  80798. /**
  80799. * The target of the runtime animation
  80800. */
  80801. private _target;
  80802. /**
  80803. * The initiating animatable
  80804. */
  80805. private _host;
  80806. /**
  80807. * The original value of the runtime animation
  80808. */
  80809. private _originalValue;
  80810. /**
  80811. * The original blend value of the runtime animation
  80812. */
  80813. private _originalBlendValue;
  80814. /**
  80815. * The offsets cache of the runtime animation
  80816. */
  80817. private _offsetsCache;
  80818. /**
  80819. * The high limits cache of the runtime animation
  80820. */
  80821. private _highLimitsCache;
  80822. /**
  80823. * Specifies if the runtime animation has been stopped
  80824. */
  80825. private _stopped;
  80826. /**
  80827. * The blending factor of the runtime animation
  80828. */
  80829. private _blendingFactor;
  80830. /**
  80831. * The BabylonJS scene
  80832. */
  80833. private _scene;
  80834. /**
  80835. * The current value of the runtime animation
  80836. */
  80837. private _currentValue;
  80838. /** @hidden */
  80839. _animationState: _IAnimationState;
  80840. /**
  80841. * The active target of the runtime animation
  80842. */
  80843. private _activeTargets;
  80844. private _currentActiveTarget;
  80845. private _directTarget;
  80846. /**
  80847. * The target path of the runtime animation
  80848. */
  80849. private _targetPath;
  80850. /**
  80851. * The weight of the runtime animation
  80852. */
  80853. private _weight;
  80854. /**
  80855. * The ratio offset of the runtime animation
  80856. */
  80857. private _ratioOffset;
  80858. /**
  80859. * The previous delay of the runtime animation
  80860. */
  80861. private _previousDelay;
  80862. /**
  80863. * The previous ratio of the runtime animation
  80864. */
  80865. private _previousRatio;
  80866. private _enableBlending;
  80867. private _keys;
  80868. private _minFrame;
  80869. private _maxFrame;
  80870. private _minValue;
  80871. private _maxValue;
  80872. private _targetIsArray;
  80873. /**
  80874. * Gets the current frame of the runtime animation
  80875. */
  80876. readonly currentFrame: number;
  80877. /**
  80878. * Gets the weight of the runtime animation
  80879. */
  80880. readonly weight: number;
  80881. /**
  80882. * Gets the current value of the runtime animation
  80883. */
  80884. readonly currentValue: any;
  80885. /**
  80886. * Gets the target path of the runtime animation
  80887. */
  80888. readonly targetPath: string;
  80889. /**
  80890. * Gets the actual target of the runtime animation
  80891. */
  80892. readonly target: any;
  80893. /** @hidden */
  80894. _onLoop: () => void;
  80895. /**
  80896. * Create a new RuntimeAnimation object
  80897. * @param target defines the target of the animation
  80898. * @param animation defines the source animation object
  80899. * @param scene defines the hosting scene
  80900. * @param host defines the initiating Animatable
  80901. */
  80902. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  80903. private _preparePath;
  80904. /**
  80905. * Gets the animation from the runtime animation
  80906. */
  80907. readonly animation: Animation;
  80908. /**
  80909. * Resets the runtime animation to the beginning
  80910. * @param restoreOriginal defines whether to restore the target property to the original value
  80911. */
  80912. reset(restoreOriginal?: boolean): void;
  80913. /**
  80914. * Specifies if the runtime animation is stopped
  80915. * @returns Boolean specifying if the runtime animation is stopped
  80916. */
  80917. isStopped(): boolean;
  80918. /**
  80919. * Disposes of the runtime animation
  80920. */
  80921. dispose(): void;
  80922. /**
  80923. * Apply the interpolated value to the target
  80924. * @param currentValue defines the value computed by the animation
  80925. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  80926. */
  80927. setValue(currentValue: any, weight: number): void;
  80928. private _getOriginalValues;
  80929. private _setValue;
  80930. /**
  80931. * Gets the loop pmode of the runtime animation
  80932. * @returns Loop Mode
  80933. */
  80934. private _getCorrectLoopMode;
  80935. /**
  80936. * Move the current animation to a given frame
  80937. * @param frame defines the frame to move to
  80938. */
  80939. goToFrame(frame: number): void;
  80940. /**
  80941. * @hidden Internal use only
  80942. */
  80943. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  80944. /**
  80945. * Execute the current animation
  80946. * @param delay defines the delay to add to the current frame
  80947. * @param from defines the lower bound of the animation range
  80948. * @param to defines the upper bound of the animation range
  80949. * @param loop defines if the current animation must loop
  80950. * @param speedRatio defines the current speed ratio
  80951. * @param weight defines the weight of the animation (default is -1 so no weight)
  80952. * @param onLoop optional callback called when animation loops
  80953. * @returns a boolean indicating if the animation is running
  80954. */
  80955. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  80956. }
  80957. }
  80958. declare module BABYLON {
  80959. /**
  80960. * Class used to store an actual running animation
  80961. */
  80962. export class Animatable {
  80963. /** defines the target object */
  80964. target: any;
  80965. /** defines the starting frame number (default is 0) */
  80966. fromFrame: number;
  80967. /** defines the ending frame number (default is 100) */
  80968. toFrame: number;
  80969. /** defines if the animation must loop (default is false) */
  80970. loopAnimation: boolean;
  80971. /** defines a callback to call when animation ends if it is not looping */
  80972. onAnimationEnd?: (() => void) | null | undefined;
  80973. /** defines a callback to call when animation loops */
  80974. onAnimationLoop?: (() => void) | null | undefined;
  80975. private _localDelayOffset;
  80976. private _pausedDelay;
  80977. private _runtimeAnimations;
  80978. private _paused;
  80979. private _scene;
  80980. private _speedRatio;
  80981. private _weight;
  80982. private _syncRoot;
  80983. /**
  80984. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  80985. * This will only apply for non looping animation (default is true)
  80986. */
  80987. disposeOnEnd: boolean;
  80988. /**
  80989. * Gets a boolean indicating if the animation has started
  80990. */
  80991. animationStarted: boolean;
  80992. /**
  80993. * Observer raised when the animation ends
  80994. */
  80995. onAnimationEndObservable: Observable<Animatable>;
  80996. /**
  80997. * Observer raised when the animation loops
  80998. */
  80999. onAnimationLoopObservable: Observable<Animatable>;
  81000. /**
  81001. * Gets the root Animatable used to synchronize and normalize animations
  81002. */
  81003. readonly syncRoot: Nullable<Animatable>;
  81004. /**
  81005. * Gets the current frame of the first RuntimeAnimation
  81006. * Used to synchronize Animatables
  81007. */
  81008. readonly masterFrame: number;
  81009. /**
  81010. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  81011. */
  81012. weight: number;
  81013. /**
  81014. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  81015. */
  81016. speedRatio: number;
  81017. /**
  81018. * Creates a new Animatable
  81019. * @param scene defines the hosting scene
  81020. * @param target defines the target object
  81021. * @param fromFrame defines the starting frame number (default is 0)
  81022. * @param toFrame defines the ending frame number (default is 100)
  81023. * @param loopAnimation defines if the animation must loop (default is false)
  81024. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  81025. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  81026. * @param animations defines a group of animation to add to the new Animatable
  81027. * @param onAnimationLoop defines a callback to call when animation loops
  81028. */
  81029. constructor(scene: Scene,
  81030. /** defines the target object */
  81031. target: any,
  81032. /** defines the starting frame number (default is 0) */
  81033. fromFrame?: number,
  81034. /** defines the ending frame number (default is 100) */
  81035. toFrame?: number,
  81036. /** defines if the animation must loop (default is false) */
  81037. loopAnimation?: boolean, speedRatio?: number,
  81038. /** defines a callback to call when animation ends if it is not looping */
  81039. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  81040. /** defines a callback to call when animation loops */
  81041. onAnimationLoop?: (() => void) | null | undefined);
  81042. /**
  81043. * Synchronize and normalize current Animatable with a source Animatable
  81044. * This is useful when using animation weights and when animations are not of the same length
  81045. * @param root defines the root Animatable to synchronize with
  81046. * @returns the current Animatable
  81047. */
  81048. syncWith(root: Animatable): Animatable;
  81049. /**
  81050. * Gets the list of runtime animations
  81051. * @returns an array of RuntimeAnimation
  81052. */
  81053. getAnimations(): RuntimeAnimation[];
  81054. /**
  81055. * Adds more animations to the current animatable
  81056. * @param target defines the target of the animations
  81057. * @param animations defines the new animations to add
  81058. */
  81059. appendAnimations(target: any, animations: Animation[]): void;
  81060. /**
  81061. * Gets the source animation for a specific property
  81062. * @param property defines the propertyu to look for
  81063. * @returns null or the source animation for the given property
  81064. */
  81065. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  81066. /**
  81067. * Gets the runtime animation for a specific property
  81068. * @param property defines the propertyu to look for
  81069. * @returns null or the runtime animation for the given property
  81070. */
  81071. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  81072. /**
  81073. * Resets the animatable to its original state
  81074. */
  81075. reset(): void;
  81076. /**
  81077. * Allows the animatable to blend with current running animations
  81078. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81079. * @param blendingSpeed defines the blending speed to use
  81080. */
  81081. enableBlending(blendingSpeed: number): void;
  81082. /**
  81083. * Disable animation blending
  81084. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81085. */
  81086. disableBlending(): void;
  81087. /**
  81088. * Jump directly to a given frame
  81089. * @param frame defines the frame to jump to
  81090. */
  81091. goToFrame(frame: number): void;
  81092. /**
  81093. * Pause the animation
  81094. */
  81095. pause(): void;
  81096. /**
  81097. * Restart the animation
  81098. */
  81099. restart(): void;
  81100. private _raiseOnAnimationEnd;
  81101. /**
  81102. * Stop and delete the current animation
  81103. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  81104. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  81105. */
  81106. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  81107. /**
  81108. * Wait asynchronously for the animation to end
  81109. * @returns a promise which will be fullfilled when the animation ends
  81110. */
  81111. waitAsync(): Promise<Animatable>;
  81112. /** @hidden */
  81113. _animate(delay: number): boolean;
  81114. }
  81115. interface Scene {
  81116. /** @hidden */
  81117. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  81118. /** @hidden */
  81119. _processLateAnimationBindingsForMatrices(holder: {
  81120. totalWeight: number;
  81121. animations: RuntimeAnimation[];
  81122. originalValue: Matrix;
  81123. }): any;
  81124. /** @hidden */
  81125. _processLateAnimationBindingsForQuaternions(holder: {
  81126. totalWeight: number;
  81127. animations: RuntimeAnimation[];
  81128. originalValue: Quaternion;
  81129. }, refQuaternion: Quaternion): Quaternion;
  81130. /** @hidden */
  81131. _processLateAnimationBindings(): void;
  81132. /**
  81133. * Will start the animation sequence of a given target
  81134. * @param target defines the target
  81135. * @param from defines from which frame should animation start
  81136. * @param to defines until which frame should animation run.
  81137. * @param weight defines the weight to apply to the animation (1.0 by default)
  81138. * @param loop defines if the animation loops
  81139. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  81140. * @param onAnimationEnd defines the function to be executed when the animation ends
  81141. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  81142. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  81143. * @param onAnimationLoop defines the callback to call when an animation loops
  81144. * @returns the animatable object created for this animation
  81145. */
  81146. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  81147. /**
  81148. * Will start the animation sequence of a given target
  81149. * @param target defines the target
  81150. * @param from defines from which frame should animation start
  81151. * @param to defines until which frame should animation run.
  81152. * @param loop defines if the animation loops
  81153. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  81154. * @param onAnimationEnd defines the function to be executed when the animation ends
  81155. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  81156. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  81157. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  81158. * @param onAnimationLoop defines the callback to call when an animation loops
  81159. * @returns the animatable object created for this animation
  81160. */
  81161. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  81162. /**
  81163. * Will start the animation sequence of a given target and its hierarchy
  81164. * @param target defines the target
  81165. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  81166. * @param from defines from which frame should animation start
  81167. * @param to defines until which frame should animation run.
  81168. * @param loop defines if the animation loops
  81169. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  81170. * @param onAnimationEnd defines the function to be executed when the animation ends
  81171. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  81172. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  81173. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  81174. * @param onAnimationLoop defines the callback to call when an animation loops
  81175. * @returns the list of created animatables
  81176. */
  81177. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable[];
  81178. /**
  81179. * Begin a new animation on a given node
  81180. * @param target defines the target where the animation will take place
  81181. * @param animations defines the list of animations to start
  81182. * @param from defines the initial value
  81183. * @param to defines the final value
  81184. * @param loop defines if you want animation to loop (off by default)
  81185. * @param speedRatio defines the speed ratio to apply to all animations
  81186. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  81187. * @param onAnimationLoop defines the callback to call when an animation loops
  81188. * @returns the list of created animatables
  81189. */
  81190. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  81191. /**
  81192. * Begin a new animation on a given node and its hierarchy
  81193. * @param target defines the root node where the animation will take place
  81194. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  81195. * @param animations defines the list of animations to start
  81196. * @param from defines the initial value
  81197. * @param to defines the final value
  81198. * @param loop defines if you want animation to loop (off by default)
  81199. * @param speedRatio defines the speed ratio to apply to all animations
  81200. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  81201. * @param onAnimationLoop defines the callback to call when an animation loops
  81202. * @returns the list of animatables created for all nodes
  81203. */
  81204. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  81205. /**
  81206. * Gets the animatable associated with a specific target
  81207. * @param target defines the target of the animatable
  81208. * @returns the required animatable if found
  81209. */
  81210. getAnimatableByTarget(target: any): Nullable<Animatable>;
  81211. /**
  81212. * Gets all animatables associated with a given target
  81213. * @param target defines the target to look animatables for
  81214. * @returns an array of Animatables
  81215. */
  81216. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  81217. /**
  81218. * Stops and removes all animations that have been applied to the scene
  81219. */
  81220. stopAllAnimations(): void;
  81221. /**
  81222. * Gets the current delta time used by animation engine
  81223. */
  81224. deltaTime: number;
  81225. }
  81226. interface Bone {
  81227. /**
  81228. * Copy an animation range from another bone
  81229. * @param source defines the source bone
  81230. * @param rangeName defines the range name to copy
  81231. * @param frameOffset defines the frame offset
  81232. * @param rescaleAsRequired defines if rescaling must be applied if required
  81233. * @param skelDimensionsRatio defines the scaling ratio
  81234. * @returns true if operation was successful
  81235. */
  81236. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  81237. }
  81238. }
  81239. declare module BABYLON {
  81240. /**
  81241. * Class used to override all child animations of a given target
  81242. */
  81243. export class AnimationPropertiesOverride {
  81244. /**
  81245. * Gets or sets a value indicating if animation blending must be used
  81246. */
  81247. enableBlending: boolean;
  81248. /**
  81249. * Gets or sets the blending speed to use when enableBlending is true
  81250. */
  81251. blendingSpeed: number;
  81252. /**
  81253. * Gets or sets the default loop mode to use
  81254. */
  81255. loopMode: number;
  81256. }
  81257. }
  81258. declare module BABYLON {
  81259. /**
  81260. * Class used to handle skinning animations
  81261. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  81262. */
  81263. export class Skeleton implements IAnimatable {
  81264. /** defines the skeleton name */
  81265. name: string;
  81266. /** defines the skeleton Id */
  81267. id: string;
  81268. /**
  81269. * Defines the list of child bones
  81270. */
  81271. bones: Bone[];
  81272. /**
  81273. * Defines an estimate of the dimension of the skeleton at rest
  81274. */
  81275. dimensionsAtRest: Vector3;
  81276. /**
  81277. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  81278. */
  81279. needInitialSkinMatrix: boolean;
  81280. /**
  81281. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  81282. */
  81283. overrideMesh: Nullable<AbstractMesh>;
  81284. /**
  81285. * Gets the list of animations attached to this skeleton
  81286. */
  81287. animations: Array<Animation>;
  81288. private _scene;
  81289. private _isDirty;
  81290. private _transformMatrices;
  81291. private _transformMatrixTexture;
  81292. private _meshesWithPoseMatrix;
  81293. private _animatables;
  81294. private _identity;
  81295. private _synchronizedWithMesh;
  81296. private _ranges;
  81297. private _lastAbsoluteTransformsUpdateId;
  81298. private _canUseTextureForBones;
  81299. private _uniqueId;
  81300. /** @hidden */
  81301. _numBonesWithLinkedTransformNode: number;
  81302. /** @hidden */
  81303. _hasWaitingData: Nullable<boolean>;
  81304. /**
  81305. * Specifies if the skeleton should be serialized
  81306. */
  81307. doNotSerialize: boolean;
  81308. private _useTextureToStoreBoneMatrices;
  81309. /**
  81310. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  81311. * Please note that this option is not available if the hardware does not support it
  81312. */
  81313. useTextureToStoreBoneMatrices: boolean;
  81314. private _animationPropertiesOverride;
  81315. /**
  81316. * Gets or sets the animation properties override
  81317. */
  81318. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  81319. /**
  81320. * List of inspectable custom properties (used by the Inspector)
  81321. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  81322. */
  81323. inspectableCustomProperties: IInspectable[];
  81324. /**
  81325. * An observable triggered before computing the skeleton's matrices
  81326. */
  81327. onBeforeComputeObservable: Observable<Skeleton>;
  81328. /**
  81329. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  81330. */
  81331. readonly isUsingTextureForMatrices: boolean;
  81332. /**
  81333. * Gets the unique ID of this skeleton
  81334. */
  81335. readonly uniqueId: number;
  81336. /**
  81337. * Creates a new skeleton
  81338. * @param name defines the skeleton name
  81339. * @param id defines the skeleton Id
  81340. * @param scene defines the hosting scene
  81341. */
  81342. constructor(
  81343. /** defines the skeleton name */
  81344. name: string,
  81345. /** defines the skeleton Id */
  81346. id: string, scene: Scene);
  81347. /**
  81348. * Gets the current object class name.
  81349. * @return the class name
  81350. */
  81351. getClassName(): string;
  81352. /**
  81353. * Returns an array containing the root bones
  81354. * @returns an array containing the root bones
  81355. */
  81356. getChildren(): Array<Bone>;
  81357. /**
  81358. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  81359. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  81360. * @returns a Float32Array containing matrices data
  81361. */
  81362. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  81363. /**
  81364. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  81365. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  81366. * @returns a raw texture containing the data
  81367. */
  81368. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  81369. /**
  81370. * Gets the current hosting scene
  81371. * @returns a scene object
  81372. */
  81373. getScene(): Scene;
  81374. /**
  81375. * Gets a string representing the current skeleton data
  81376. * @param fullDetails defines a boolean indicating if we want a verbose version
  81377. * @returns a string representing the current skeleton data
  81378. */
  81379. toString(fullDetails?: boolean): string;
  81380. /**
  81381. * Get bone's index searching by name
  81382. * @param name defines bone's name to search for
  81383. * @return the indice of the bone. Returns -1 if not found
  81384. */
  81385. getBoneIndexByName(name: string): number;
  81386. /**
  81387. * Creater a new animation range
  81388. * @param name defines the name of the range
  81389. * @param from defines the start key
  81390. * @param to defines the end key
  81391. */
  81392. createAnimationRange(name: string, from: number, to: number): void;
  81393. /**
  81394. * Delete a specific animation range
  81395. * @param name defines the name of the range
  81396. * @param deleteFrames defines if frames must be removed as well
  81397. */
  81398. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  81399. /**
  81400. * Gets a specific animation range
  81401. * @param name defines the name of the range to look for
  81402. * @returns the requested animation range or null if not found
  81403. */
  81404. getAnimationRange(name: string): Nullable<AnimationRange>;
  81405. /**
  81406. * Gets the list of all animation ranges defined on this skeleton
  81407. * @returns an array
  81408. */
  81409. getAnimationRanges(): Nullable<AnimationRange>[];
  81410. /**
  81411. * Copy animation range from a source skeleton.
  81412. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  81413. * @param source defines the source skeleton
  81414. * @param name defines the name of the range to copy
  81415. * @param rescaleAsRequired defines if rescaling must be applied if required
  81416. * @returns true if operation was successful
  81417. */
  81418. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  81419. /**
  81420. * Forces the skeleton to go to rest pose
  81421. */
  81422. returnToRest(): void;
  81423. private _getHighestAnimationFrame;
  81424. /**
  81425. * Begin a specific animation range
  81426. * @param name defines the name of the range to start
  81427. * @param loop defines if looping must be turned on (false by default)
  81428. * @param speedRatio defines the speed ratio to apply (1 by default)
  81429. * @param onAnimationEnd defines a callback which will be called when animation will end
  81430. * @returns a new animatable
  81431. */
  81432. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  81433. /** @hidden */
  81434. _markAsDirty(): void;
  81435. /** @hidden */
  81436. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  81437. /** @hidden */
  81438. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  81439. private _computeTransformMatrices;
  81440. /**
  81441. * Build all resources required to render a skeleton
  81442. */
  81443. prepare(): void;
  81444. /**
  81445. * Gets the list of animatables currently running for this skeleton
  81446. * @returns an array of animatables
  81447. */
  81448. getAnimatables(): IAnimatable[];
  81449. /**
  81450. * Clone the current skeleton
  81451. * @param name defines the name of the new skeleton
  81452. * @param id defines the id of the new skeleton
  81453. * @returns the new skeleton
  81454. */
  81455. clone(name: string, id?: string): Skeleton;
  81456. /**
  81457. * Enable animation blending for this skeleton
  81458. * @param blendingSpeed defines the blending speed to apply
  81459. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81460. */
  81461. enableBlending(blendingSpeed?: number): void;
  81462. /**
  81463. * Releases all resources associated with the current skeleton
  81464. */
  81465. dispose(): void;
  81466. /**
  81467. * Serialize the skeleton in a JSON object
  81468. * @returns a JSON object
  81469. */
  81470. serialize(): any;
  81471. /**
  81472. * Creates a new skeleton from serialized data
  81473. * @param parsedSkeleton defines the serialized data
  81474. * @param scene defines the hosting scene
  81475. * @returns a new skeleton
  81476. */
  81477. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  81478. /**
  81479. * Compute all node absolute transforms
  81480. * @param forceUpdate defines if computation must be done even if cache is up to date
  81481. */
  81482. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  81483. /**
  81484. * Gets the root pose matrix
  81485. * @returns a matrix
  81486. */
  81487. getPoseMatrix(): Nullable<Matrix>;
  81488. /**
  81489. * Sorts bones per internal index
  81490. */
  81491. sortBones(): void;
  81492. private _sortBones;
  81493. }
  81494. }
  81495. declare module BABYLON {
  81496. /**
  81497. * Class used to store bone information
  81498. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  81499. */
  81500. export class Bone extends Node {
  81501. /**
  81502. * defines the bone name
  81503. */
  81504. name: string;
  81505. private static _tmpVecs;
  81506. private static _tmpQuat;
  81507. private static _tmpMats;
  81508. /**
  81509. * Gets the list of child bones
  81510. */
  81511. children: Bone[];
  81512. /** Gets the animations associated with this bone */
  81513. animations: Animation[];
  81514. /**
  81515. * Gets or sets bone length
  81516. */
  81517. length: number;
  81518. /**
  81519. * @hidden Internal only
  81520. * Set this value to map this bone to a different index in the transform matrices
  81521. * Set this value to -1 to exclude the bone from the transform matrices
  81522. */
  81523. _index: Nullable<number>;
  81524. private _skeleton;
  81525. private _localMatrix;
  81526. private _restPose;
  81527. private _baseMatrix;
  81528. private _absoluteTransform;
  81529. private _invertedAbsoluteTransform;
  81530. private _parent;
  81531. private _scalingDeterminant;
  81532. private _worldTransform;
  81533. private _localScaling;
  81534. private _localRotation;
  81535. private _localPosition;
  81536. private _needToDecompose;
  81537. private _needToCompose;
  81538. /** @hidden */
  81539. _linkedTransformNode: Nullable<TransformNode>;
  81540. /** @hidden */
  81541. _waitingTransformNodeId: Nullable<string>;
  81542. /** @hidden */
  81543. /** @hidden */
  81544. _matrix: Matrix;
  81545. /**
  81546. * Create a new bone
  81547. * @param name defines the bone name
  81548. * @param skeleton defines the parent skeleton
  81549. * @param parentBone defines the parent (can be null if the bone is the root)
  81550. * @param localMatrix defines the local matrix
  81551. * @param restPose defines the rest pose matrix
  81552. * @param baseMatrix defines the base matrix
  81553. * @param index defines index of the bone in the hiearchy
  81554. */
  81555. constructor(
  81556. /**
  81557. * defines the bone name
  81558. */
  81559. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  81560. /**
  81561. * Gets the current object class name.
  81562. * @return the class name
  81563. */
  81564. getClassName(): string;
  81565. /**
  81566. * Gets the parent skeleton
  81567. * @returns a skeleton
  81568. */
  81569. getSkeleton(): Skeleton;
  81570. /**
  81571. * Gets parent bone
  81572. * @returns a bone or null if the bone is the root of the bone hierarchy
  81573. */
  81574. getParent(): Nullable<Bone>;
  81575. /**
  81576. * Returns an array containing the root bones
  81577. * @returns an array containing the root bones
  81578. */
  81579. getChildren(): Array<Bone>;
  81580. /**
  81581. * Gets the node index in matrix array generated for rendering
  81582. * @returns the node index
  81583. */
  81584. getIndex(): number;
  81585. /**
  81586. * Sets the parent bone
  81587. * @param parent defines the parent (can be null if the bone is the root)
  81588. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  81589. */
  81590. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  81591. /**
  81592. * Gets the local matrix
  81593. * @returns a matrix
  81594. */
  81595. getLocalMatrix(): Matrix;
  81596. /**
  81597. * Gets the base matrix (initial matrix which remains unchanged)
  81598. * @returns a matrix
  81599. */
  81600. getBaseMatrix(): Matrix;
  81601. /**
  81602. * Gets the rest pose matrix
  81603. * @returns a matrix
  81604. */
  81605. getRestPose(): Matrix;
  81606. /**
  81607. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  81608. */
  81609. getWorldMatrix(): Matrix;
  81610. /**
  81611. * Sets the local matrix to rest pose matrix
  81612. */
  81613. returnToRest(): void;
  81614. /**
  81615. * Gets the inverse of the absolute transform matrix.
  81616. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  81617. * @returns a matrix
  81618. */
  81619. getInvertedAbsoluteTransform(): Matrix;
  81620. /**
  81621. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  81622. * @returns a matrix
  81623. */
  81624. getAbsoluteTransform(): Matrix;
  81625. /**
  81626. * Links with the given transform node.
  81627. * The local matrix of this bone is copied from the transform node every frame.
  81628. * @param transformNode defines the transform node to link to
  81629. */
  81630. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  81631. /**
  81632. * Gets the node used to drive the bone's transformation
  81633. * @returns a transform node or null
  81634. */
  81635. getTransformNode(): Nullable<TransformNode>;
  81636. /** Gets or sets current position (in local space) */
  81637. position: Vector3;
  81638. /** Gets or sets current rotation (in local space) */
  81639. rotation: Vector3;
  81640. /** Gets or sets current rotation quaternion (in local space) */
  81641. rotationQuaternion: Quaternion;
  81642. /** Gets or sets current scaling (in local space) */
  81643. scaling: Vector3;
  81644. /**
  81645. * Gets the animation properties override
  81646. */
  81647. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  81648. private _decompose;
  81649. private _compose;
  81650. /**
  81651. * Update the base and local matrices
  81652. * @param matrix defines the new base or local matrix
  81653. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  81654. * @param updateLocalMatrix defines if the local matrix should be updated
  81655. */
  81656. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  81657. /** @hidden */
  81658. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  81659. /**
  81660. * Flag the bone as dirty (Forcing it to update everything)
  81661. */
  81662. markAsDirty(): void;
  81663. /** @hidden */
  81664. _markAsDirtyAndCompose(): void;
  81665. private _markAsDirtyAndDecompose;
  81666. /**
  81667. * Translate the bone in local or world space
  81668. * @param vec The amount to translate the bone
  81669. * @param space The space that the translation is in
  81670. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81671. */
  81672. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  81673. /**
  81674. * Set the postion of the bone in local or world space
  81675. * @param position The position to set the bone
  81676. * @param space The space that the position is in
  81677. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81678. */
  81679. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  81680. /**
  81681. * Set the absolute position of the bone (world space)
  81682. * @param position The position to set the bone
  81683. * @param mesh The mesh that this bone is attached to
  81684. */
  81685. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  81686. /**
  81687. * Scale the bone on the x, y and z axes (in local space)
  81688. * @param x The amount to scale the bone on the x axis
  81689. * @param y The amount to scale the bone on the y axis
  81690. * @param z The amount to scale the bone on the z axis
  81691. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  81692. */
  81693. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  81694. /**
  81695. * Set the bone scaling in local space
  81696. * @param scale defines the scaling vector
  81697. */
  81698. setScale(scale: Vector3): void;
  81699. /**
  81700. * Gets the current scaling in local space
  81701. * @returns the current scaling vector
  81702. */
  81703. getScale(): Vector3;
  81704. /**
  81705. * Gets the current scaling in local space and stores it in a target vector
  81706. * @param result defines the target vector
  81707. */
  81708. getScaleToRef(result: Vector3): void;
  81709. /**
  81710. * Set the yaw, pitch, and roll of the bone in local or world space
  81711. * @param yaw The rotation of the bone on the y axis
  81712. * @param pitch The rotation of the bone on the x axis
  81713. * @param roll The rotation of the bone on the z axis
  81714. * @param space The space that the axes of rotation are in
  81715. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81716. */
  81717. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  81718. /**
  81719. * Add a rotation to the bone on an axis in local or world space
  81720. * @param axis The axis to rotate the bone on
  81721. * @param amount The amount to rotate the bone
  81722. * @param space The space that the axis is in
  81723. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81724. */
  81725. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  81726. /**
  81727. * Set the rotation of the bone to a particular axis angle in local or world space
  81728. * @param axis The axis to rotate the bone on
  81729. * @param angle The angle that the bone should be rotated to
  81730. * @param space The space that the axis is in
  81731. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81732. */
  81733. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  81734. /**
  81735. * Set the euler rotation of the bone in local of world space
  81736. * @param rotation The euler rotation that the bone should be set to
  81737. * @param space The space that the rotation is in
  81738. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81739. */
  81740. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  81741. /**
  81742. * Set the quaternion rotation of the bone in local of world space
  81743. * @param quat The quaternion rotation that the bone should be set to
  81744. * @param space The space that the rotation is in
  81745. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81746. */
  81747. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  81748. /**
  81749. * Set the rotation matrix of the bone in local of world space
  81750. * @param rotMat The rotation matrix that the bone should be set to
  81751. * @param space The space that the rotation is in
  81752. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81753. */
  81754. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  81755. private _rotateWithMatrix;
  81756. private _getNegativeRotationToRef;
  81757. /**
  81758. * Get the position of the bone in local or world space
  81759. * @param space The space that the returned position is in
  81760. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81761. * @returns The position of the bone
  81762. */
  81763. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  81764. /**
  81765. * Copy the position of the bone to a vector3 in local or world space
  81766. * @param space The space that the returned position is in
  81767. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81768. * @param result The vector3 to copy the position to
  81769. */
  81770. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  81771. /**
  81772. * Get the absolute position of the bone (world space)
  81773. * @param mesh The mesh that this bone is attached to
  81774. * @returns The absolute position of the bone
  81775. */
  81776. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  81777. /**
  81778. * Copy the absolute position of the bone (world space) to the result param
  81779. * @param mesh The mesh that this bone is attached to
  81780. * @param result The vector3 to copy the absolute position to
  81781. */
  81782. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  81783. /**
  81784. * Compute the absolute transforms of this bone and its children
  81785. */
  81786. computeAbsoluteTransforms(): void;
  81787. /**
  81788. * Get the world direction from an axis that is in the local space of the bone
  81789. * @param localAxis The local direction that is used to compute the world direction
  81790. * @param mesh The mesh that this bone is attached to
  81791. * @returns The world direction
  81792. */
  81793. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  81794. /**
  81795. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  81796. * @param localAxis The local direction that is used to compute the world direction
  81797. * @param mesh The mesh that this bone is attached to
  81798. * @param result The vector3 that the world direction will be copied to
  81799. */
  81800. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81801. /**
  81802. * Get the euler rotation of the bone in local or world space
  81803. * @param space The space that the rotation should be in
  81804. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81805. * @returns The euler rotation
  81806. */
  81807. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  81808. /**
  81809. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  81810. * @param space The space that the rotation should be in
  81811. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81812. * @param result The vector3 that the rotation should be copied to
  81813. */
  81814. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81815. /**
  81816. * Get the quaternion rotation of the bone in either local or world space
  81817. * @param space The space that the rotation should be in
  81818. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81819. * @returns The quaternion rotation
  81820. */
  81821. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  81822. /**
  81823. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  81824. * @param space The space that the rotation should be in
  81825. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81826. * @param result The quaternion that the rotation should be copied to
  81827. */
  81828. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  81829. /**
  81830. * Get the rotation matrix of the bone in local or world space
  81831. * @param space The space that the rotation should be in
  81832. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81833. * @returns The rotation matrix
  81834. */
  81835. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  81836. /**
  81837. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  81838. * @param space The space that the rotation should be in
  81839. * @param mesh The mesh that this bone is attached to. This is only used in world space
  81840. * @param result The quaternion that the rotation should be copied to
  81841. */
  81842. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  81843. /**
  81844. * Get the world position of a point that is in the local space of the bone
  81845. * @param position The local position
  81846. * @param mesh The mesh that this bone is attached to
  81847. * @returns The world position
  81848. */
  81849. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  81850. /**
  81851. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  81852. * @param position The local position
  81853. * @param mesh The mesh that this bone is attached to
  81854. * @param result The vector3 that the world position should be copied to
  81855. */
  81856. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81857. /**
  81858. * Get the local position of a point that is in world space
  81859. * @param position The world position
  81860. * @param mesh The mesh that this bone is attached to
  81861. * @returns The local position
  81862. */
  81863. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  81864. /**
  81865. * Get the local position of a point that is in world space and copy it to the result param
  81866. * @param position The world position
  81867. * @param mesh The mesh that this bone is attached to
  81868. * @param result The vector3 that the local position should be copied to
  81869. */
  81870. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  81871. }
  81872. }
  81873. declare module BABYLON {
  81874. /**
  81875. * A TransformNode is an object that is not rendered but can be used as a center of transformation. This can decrease memory usage and increase rendering speed compared to using an empty mesh as a parent and is less complicated than using a pivot matrix.
  81876. * @see https://doc.babylonjs.com/how_to/transformnode
  81877. */
  81878. export class TransformNode extends Node {
  81879. /**
  81880. * Object will not rotate to face the camera
  81881. */
  81882. static BILLBOARDMODE_NONE: number;
  81883. /**
  81884. * Object will rotate to face the camera but only on the x axis
  81885. */
  81886. static BILLBOARDMODE_X: number;
  81887. /**
  81888. * Object will rotate to face the camera but only on the y axis
  81889. */
  81890. static BILLBOARDMODE_Y: number;
  81891. /**
  81892. * Object will rotate to face the camera but only on the z axis
  81893. */
  81894. static BILLBOARDMODE_Z: number;
  81895. /**
  81896. * Object will rotate to face the camera
  81897. */
  81898. static BILLBOARDMODE_ALL: number;
  81899. /**
  81900. * Object will rotate to face the camera's position instead of orientation
  81901. */
  81902. static BILLBOARDMODE_USE_POSITION: number;
  81903. private _forward;
  81904. private _forwardInverted;
  81905. private _up;
  81906. private _right;
  81907. private _rightInverted;
  81908. private _position;
  81909. private _rotation;
  81910. private _rotationQuaternion;
  81911. protected _scaling: Vector3;
  81912. protected _isDirty: boolean;
  81913. private _transformToBoneReferal;
  81914. private _isAbsoluteSynced;
  81915. private _billboardMode;
  81916. /**
  81917. * Gets or sets the billboard mode. Default is 0.
  81918. *
  81919. * | Value | Type | Description |
  81920. * | --- | --- | --- |
  81921. * | 0 | BILLBOARDMODE_NONE | |
  81922. * | 1 | BILLBOARDMODE_X | |
  81923. * | 2 | BILLBOARDMODE_Y | |
  81924. * | 4 | BILLBOARDMODE_Z | |
  81925. * | 7 | BILLBOARDMODE_ALL | |
  81926. *
  81927. */
  81928. billboardMode: number;
  81929. private _preserveParentRotationForBillboard;
  81930. /**
  81931. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  81932. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  81933. */
  81934. preserveParentRotationForBillboard: boolean;
  81935. /**
  81936. * Multiplication factor on scale x/y/z when computing the world matrix. Eg. for a 1x1x1 cube setting this to 2 will make it a 2x2x2 cube
  81937. */
  81938. scalingDeterminant: number;
  81939. private _infiniteDistance;
  81940. /**
  81941. * Gets or sets the distance of the object to max, often used by skybox
  81942. */
  81943. infiniteDistance: boolean;
  81944. /**
  81945. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  81946. * By default the system will update normals to compensate
  81947. */
  81948. ignoreNonUniformScaling: boolean;
  81949. /**
  81950. * Gets or sets a boolean indicating that even if rotationQuaternion is defined, you can keep updating rotation property and Babylon.js will just mix both
  81951. */
  81952. reIntegrateRotationIntoRotationQuaternion: boolean;
  81953. /** @hidden */
  81954. _poseMatrix: Nullable<Matrix>;
  81955. /** @hidden */
  81956. _localMatrix: Matrix;
  81957. private _usePivotMatrix;
  81958. private _absolutePosition;
  81959. private _absoluteScaling;
  81960. private _absoluteRotationQuaternion;
  81961. private _pivotMatrix;
  81962. private _pivotMatrixInverse;
  81963. protected _postMultiplyPivotMatrix: boolean;
  81964. protected _isWorldMatrixFrozen: boolean;
  81965. /** @hidden */
  81966. _indexInSceneTransformNodesArray: number;
  81967. /**
  81968. * An event triggered after the world matrix is updated
  81969. */
  81970. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  81971. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  81972. /**
  81973. * Gets a string identifying the name of the class
  81974. * @returns "TransformNode" string
  81975. */
  81976. getClassName(): string;
  81977. /**
  81978. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  81979. */
  81980. position: Vector3;
  81981. /**
  81982. * Gets or sets the rotation property : a Vector3 defining the rotation value in radians around each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  81983. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  81984. */
  81985. rotation: Vector3;
  81986. /**
  81987. * Gets or sets the scaling property : a Vector3 defining the node scaling along each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  81988. */
  81989. scaling: Vector3;
  81990. /**
  81991. * Gets or sets the rotation Quaternion property : this a Quaternion object defining the node rotation by using a unit quaternion (undefined by default, but can be null).
  81992. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  81993. */
  81994. rotationQuaternion: Nullable<Quaternion>;
  81995. /**
  81996. * The forward direction of that transform in world space.
  81997. */
  81998. readonly forward: Vector3;
  81999. /**
  82000. * The up direction of that transform in world space.
  82001. */
  82002. readonly up: Vector3;
  82003. /**
  82004. * The right direction of that transform in world space.
  82005. */
  82006. readonly right: Vector3;
  82007. /**
  82008. * Copies the parameter passed Matrix into the mesh Pose matrix.
  82009. * @param matrix the matrix to copy the pose from
  82010. * @returns this TransformNode.
  82011. */
  82012. updatePoseMatrix(matrix: Matrix): TransformNode;
  82013. /**
  82014. * Returns the mesh Pose matrix.
  82015. * @returns the pose matrix
  82016. */
  82017. getPoseMatrix(): Matrix;
  82018. /** @hidden */
  82019. _isSynchronized(): boolean;
  82020. /** @hidden */
  82021. _initCache(): void;
  82022. /**
  82023. * Flag the transform node as dirty (Forcing it to update everything)
  82024. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  82025. * @returns this transform node
  82026. */
  82027. markAsDirty(property: string): TransformNode;
  82028. /**
  82029. * Returns the current mesh absolute position.
  82030. * Returns a Vector3.
  82031. */
  82032. readonly absolutePosition: Vector3;
  82033. /**
  82034. * Returns the current mesh absolute scaling.
  82035. * Returns a Vector3.
  82036. */
  82037. readonly absoluteScaling: Vector3;
  82038. /**
  82039. * Returns the current mesh absolute rotation.
  82040. * Returns a Quaternion.
  82041. */
  82042. readonly absoluteRotationQuaternion: Quaternion;
  82043. /**
  82044. * Sets a new matrix to apply before all other transformation
  82045. * @param matrix defines the transform matrix
  82046. * @returns the current TransformNode
  82047. */
  82048. setPreTransformMatrix(matrix: Matrix): TransformNode;
  82049. /**
  82050. * Sets a new pivot matrix to the current node
  82051. * @param matrix defines the new pivot matrix to use
  82052. * @param postMultiplyPivotMatrix defines if the pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect
  82053. * @returns the current TransformNode
  82054. */
  82055. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  82056. /**
  82057. * Returns the mesh pivot matrix.
  82058. * Default : Identity.
  82059. * @returns the matrix
  82060. */
  82061. getPivotMatrix(): Matrix;
  82062. /**
  82063. * Instantiate (when possible) or clone that node with its hierarchy
  82064. * @param newParent defines the new parent to use for the instance (or clone)
  82065. * @param options defines options to configure how copy is done
  82066. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  82067. * @returns an instance (or a clone) of the current node with its hiearchy
  82068. */
  82069. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  82070. doNotInstantiate: boolean;
  82071. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  82072. /**
  82073. * Prevents the World matrix to be computed any longer
  82074. * @param newWorldMatrix defines an optional matrix to use as world matrix
  82075. * @returns the TransformNode.
  82076. */
  82077. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  82078. /**
  82079. * Allows back the World matrix computation.
  82080. * @returns the TransformNode.
  82081. */
  82082. unfreezeWorldMatrix(): this;
  82083. /**
  82084. * True if the World matrix has been frozen.
  82085. */
  82086. readonly isWorldMatrixFrozen: boolean;
  82087. /**
  82088. * Retuns the mesh absolute position in the World.
  82089. * @returns a Vector3.
  82090. */
  82091. getAbsolutePosition(): Vector3;
  82092. /**
  82093. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  82094. * @param absolutePosition the absolute position to set
  82095. * @returns the TransformNode.
  82096. */
  82097. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  82098. /**
  82099. * Sets the mesh position in its local space.
  82100. * @param vector3 the position to set in localspace
  82101. * @returns the TransformNode.
  82102. */
  82103. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  82104. /**
  82105. * Returns the mesh position in the local space from the current World matrix values.
  82106. * @returns a new Vector3.
  82107. */
  82108. getPositionExpressedInLocalSpace(): Vector3;
  82109. /**
  82110. * Translates the mesh along the passed Vector3 in its local space.
  82111. * @param vector3 the distance to translate in localspace
  82112. * @returns the TransformNode.
  82113. */
  82114. locallyTranslate(vector3: Vector3): TransformNode;
  82115. private static _lookAtVectorCache;
  82116. /**
  82117. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  82118. * @param targetPoint the position (must be in same space as current mesh) to look at
  82119. * @param yawCor optional yaw (y-axis) correction in radians
  82120. * @param pitchCor optional pitch (x-axis) correction in radians
  82121. * @param rollCor optional roll (z-axis) correction in radians
  82122. * @param space the choosen space of the target
  82123. * @returns the TransformNode.
  82124. */
  82125. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  82126. /**
  82127. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  82128. * This Vector3 is expressed in the World space.
  82129. * @param localAxis axis to rotate
  82130. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  82131. */
  82132. getDirection(localAxis: Vector3): Vector3;
  82133. /**
  82134. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  82135. * localAxis is expressed in the mesh local space.
  82136. * result is computed in the Wordl space from the mesh World matrix.
  82137. * @param localAxis axis to rotate
  82138. * @param result the resulting transformnode
  82139. * @returns this TransformNode.
  82140. */
  82141. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  82142. /**
  82143. * Sets this transform node rotation to the given local axis.
  82144. * @param localAxis the axis in local space
  82145. * @param yawCor optional yaw (y-axis) correction in radians
  82146. * @param pitchCor optional pitch (x-axis) correction in radians
  82147. * @param rollCor optional roll (z-axis) correction in radians
  82148. * @returns this TransformNode
  82149. */
  82150. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  82151. /**
  82152. * Sets a new pivot point to the current node
  82153. * @param point defines the new pivot point to use
  82154. * @param space defines if the point is in world or local space (local by default)
  82155. * @returns the current TransformNode
  82156. */
  82157. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  82158. /**
  82159. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  82160. * @returns the pivot point
  82161. */
  82162. getPivotPoint(): Vector3;
  82163. /**
  82164. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  82165. * @param result the vector3 to store the result
  82166. * @returns this TransformNode.
  82167. */
  82168. getPivotPointToRef(result: Vector3): TransformNode;
  82169. /**
  82170. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  82171. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  82172. */
  82173. getAbsolutePivotPoint(): Vector3;
  82174. /**
  82175. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  82176. * @param result vector3 to store the result
  82177. * @returns this TransformNode.
  82178. */
  82179. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  82180. /**
  82181. * Defines the passed node as the parent of the current node.
  82182. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  82183. * @see https://doc.babylonjs.com/how_to/parenting
  82184. * @param node the node ot set as the parent
  82185. * @returns this TransformNode.
  82186. */
  82187. setParent(node: Nullable<Node>): TransformNode;
  82188. private _nonUniformScaling;
  82189. /**
  82190. * True if the scaling property of this object is non uniform eg. (1,2,1)
  82191. */
  82192. readonly nonUniformScaling: boolean;
  82193. /** @hidden */
  82194. _updateNonUniformScalingState(value: boolean): boolean;
  82195. /**
  82196. * Attach the current TransformNode to another TransformNode associated with a bone
  82197. * @param bone Bone affecting the TransformNode
  82198. * @param affectedTransformNode TransformNode associated with the bone
  82199. * @returns this object
  82200. */
  82201. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  82202. /**
  82203. * Detach the transform node if its associated with a bone
  82204. * @returns this object
  82205. */
  82206. detachFromBone(): TransformNode;
  82207. private static _rotationAxisCache;
  82208. /**
  82209. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  82210. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  82211. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  82212. * The passed axis is also normalized.
  82213. * @param axis the axis to rotate around
  82214. * @param amount the amount to rotate in radians
  82215. * @param space Space to rotate in (Default: local)
  82216. * @returns the TransformNode.
  82217. */
  82218. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  82219. /**
  82220. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  82221. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  82222. * The passed axis is also normalized. .
  82223. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  82224. * @param point the point to rotate around
  82225. * @param axis the axis to rotate around
  82226. * @param amount the amount to rotate in radians
  82227. * @returns the TransformNode
  82228. */
  82229. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  82230. /**
  82231. * Translates the mesh along the axis vector for the passed distance in the given space.
  82232. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  82233. * @param axis the axis to translate in
  82234. * @param distance the distance to translate
  82235. * @param space Space to rotate in (Default: local)
  82236. * @returns the TransformNode.
  82237. */
  82238. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  82239. /**
  82240. * Adds a rotation step to the mesh current rotation.
  82241. * x, y, z are Euler angles expressed in radians.
  82242. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  82243. * This means this rotation is made in the mesh local space only.
  82244. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  82245. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  82246. * ```javascript
  82247. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  82248. * ```
  82249. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  82250. * Under the hood, only quaternions are used. So it's a little faster is you use .rotationQuaternion because it doesn't need to translate them back to Euler angles.
  82251. * @param x Rotation to add
  82252. * @param y Rotation to add
  82253. * @param z Rotation to add
  82254. * @returns the TransformNode.
  82255. */
  82256. addRotation(x: number, y: number, z: number): TransformNode;
  82257. /**
  82258. * @hidden
  82259. */
  82260. protected _getEffectiveParent(): Nullable<Node>;
  82261. /**
  82262. * Computes the world matrix of the node
  82263. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  82264. * @returns the world matrix
  82265. */
  82266. computeWorldMatrix(force?: boolean): Matrix;
  82267. protected _afterComputeWorldMatrix(): void;
  82268. /**
  82269. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  82270. * @param func callback function to add
  82271. *
  82272. * @returns the TransformNode.
  82273. */
  82274. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  82275. /**
  82276. * Removes a registered callback function.
  82277. * @param func callback function to remove
  82278. * @returns the TransformNode.
  82279. */
  82280. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  82281. /**
  82282. * Gets the position of the current mesh in camera space
  82283. * @param camera defines the camera to use
  82284. * @returns a position
  82285. */
  82286. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  82287. /**
  82288. * Returns the distance from the mesh to the active camera
  82289. * @param camera defines the camera to use
  82290. * @returns the distance
  82291. */
  82292. getDistanceToCamera(camera?: Nullable<Camera>): number;
  82293. /**
  82294. * Clone the current transform node
  82295. * @param name Name of the new clone
  82296. * @param newParent New parent for the clone
  82297. * @param doNotCloneChildren Do not clone children hierarchy
  82298. * @returns the new transform node
  82299. */
  82300. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  82301. /**
  82302. * Serializes the objects information.
  82303. * @param currentSerializationObject defines the object to serialize in
  82304. * @returns the serialized object
  82305. */
  82306. serialize(currentSerializationObject?: any): any;
  82307. /**
  82308. * Returns a new TransformNode object parsed from the source provided.
  82309. * @param parsedTransformNode is the source.
  82310. * @param scene the scne the object belongs to
  82311. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  82312. * @returns a new TransformNode object parsed from the source provided.
  82313. */
  82314. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  82315. /**
  82316. * Get all child-transformNodes of this node
  82317. * @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
  82318. * @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
  82319. * @returns an array of TransformNode
  82320. */
  82321. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  82322. /**
  82323. * Releases resources associated with this transform node.
  82324. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  82325. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  82326. */
  82327. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  82328. /**
  82329. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  82330. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  82331. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  82332. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  82333. * @returns the current mesh
  82334. */
  82335. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  82336. private _syncAbsoluteScalingAndRotation;
  82337. }
  82338. }
  82339. declare module BABYLON {
  82340. /**
  82341. * Defines the types of pose enabled controllers that are supported
  82342. */
  82343. export enum PoseEnabledControllerType {
  82344. /**
  82345. * HTC Vive
  82346. */
  82347. VIVE = 0,
  82348. /**
  82349. * Oculus Rift
  82350. */
  82351. OCULUS = 1,
  82352. /**
  82353. * Windows mixed reality
  82354. */
  82355. WINDOWS = 2,
  82356. /**
  82357. * Samsung gear VR
  82358. */
  82359. GEAR_VR = 3,
  82360. /**
  82361. * Google Daydream
  82362. */
  82363. DAYDREAM = 4,
  82364. /**
  82365. * Generic
  82366. */
  82367. GENERIC = 5
  82368. }
  82369. /**
  82370. * Defines the MutableGamepadButton interface for the state of a gamepad button
  82371. */
  82372. export interface MutableGamepadButton {
  82373. /**
  82374. * Value of the button/trigger
  82375. */
  82376. value: number;
  82377. /**
  82378. * If the button/trigger is currently touched
  82379. */
  82380. touched: boolean;
  82381. /**
  82382. * If the button/trigger is currently pressed
  82383. */
  82384. pressed: boolean;
  82385. }
  82386. /**
  82387. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  82388. * @hidden
  82389. */
  82390. export interface ExtendedGamepadButton extends GamepadButton {
  82391. /**
  82392. * If the button/trigger is currently pressed
  82393. */
  82394. readonly pressed: boolean;
  82395. /**
  82396. * If the button/trigger is currently touched
  82397. */
  82398. readonly touched: boolean;
  82399. /**
  82400. * Value of the button/trigger
  82401. */
  82402. readonly value: number;
  82403. }
  82404. /** @hidden */
  82405. export interface _GamePadFactory {
  82406. /**
  82407. * Returns wether or not the current gamepad can be created for this type of controller.
  82408. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  82409. * @returns true if it can be created, otherwise false
  82410. */
  82411. canCreate(gamepadInfo: any): boolean;
  82412. /**
  82413. * Creates a new instance of the Gamepad.
  82414. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  82415. * @returns the new gamepad instance
  82416. */
  82417. create(gamepadInfo: any): Gamepad;
  82418. }
  82419. /**
  82420. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  82421. */
  82422. export class PoseEnabledControllerHelper {
  82423. /** @hidden */
  82424. static _ControllerFactories: _GamePadFactory[];
  82425. /** @hidden */
  82426. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  82427. /**
  82428. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  82429. * @param vrGamepad the gamepad to initialized
  82430. * @returns a vr controller of the type the gamepad identified as
  82431. */
  82432. static InitiateController(vrGamepad: any): Gamepad;
  82433. }
  82434. /**
  82435. * Defines the PoseEnabledController object that contains state of a vr capable controller
  82436. */
  82437. export class PoseEnabledController extends Gamepad implements PoseControlled {
  82438. /**
  82439. * If the controller is used in a webXR session
  82440. */
  82441. isXR: boolean;
  82442. private _deviceRoomPosition;
  82443. private _deviceRoomRotationQuaternion;
  82444. /**
  82445. * The device position in babylon space
  82446. */
  82447. devicePosition: Vector3;
  82448. /**
  82449. * The device rotation in babylon space
  82450. */
  82451. deviceRotationQuaternion: Quaternion;
  82452. /**
  82453. * The scale factor of the device in babylon space
  82454. */
  82455. deviceScaleFactor: number;
  82456. /**
  82457. * (Likely devicePosition should be used instead) The device position in its room space
  82458. */
  82459. position: Vector3;
  82460. /**
  82461. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  82462. */
  82463. rotationQuaternion: Quaternion;
  82464. /**
  82465. * The type of controller (Eg. Windows mixed reality)
  82466. */
  82467. controllerType: PoseEnabledControllerType;
  82468. protected _calculatedPosition: Vector3;
  82469. private _calculatedRotation;
  82470. /**
  82471. * The raw pose from the device
  82472. */
  82473. rawPose: DevicePose;
  82474. private _trackPosition;
  82475. private _maxRotationDistFromHeadset;
  82476. private _draggedRoomRotation;
  82477. /**
  82478. * @hidden
  82479. */
  82480. _disableTrackPosition(fixedPosition: Vector3): void;
  82481. /**
  82482. * Internal, the mesh attached to the controller
  82483. * @hidden
  82484. */
  82485. _mesh: Nullable<AbstractMesh>;
  82486. private _poseControlledCamera;
  82487. private _leftHandSystemQuaternion;
  82488. /**
  82489. * Internal, matrix used to convert room space to babylon space
  82490. * @hidden
  82491. */
  82492. _deviceToWorld: Matrix;
  82493. /**
  82494. * Node to be used when casting a ray from the controller
  82495. * @hidden
  82496. */
  82497. _pointingPoseNode: Nullable<TransformNode>;
  82498. /**
  82499. * Name of the child mesh that can be used to cast a ray from the controller
  82500. */
  82501. static readonly POINTING_POSE: string;
  82502. /**
  82503. * Creates a new PoseEnabledController from a gamepad
  82504. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  82505. */
  82506. constructor(browserGamepad: any);
  82507. private _workingMatrix;
  82508. /**
  82509. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  82510. */
  82511. update(): void;
  82512. /**
  82513. * Updates only the pose device and mesh without doing any button event checking
  82514. */
  82515. protected _updatePoseAndMesh(): void;
  82516. /**
  82517. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  82518. * @param poseData raw pose fromthe device
  82519. */
  82520. updateFromDevice(poseData: DevicePose): void;
  82521. /**
  82522. * @hidden
  82523. */
  82524. _meshAttachedObservable: Observable<AbstractMesh>;
  82525. /**
  82526. * Attaches a mesh to the controller
  82527. * @param mesh the mesh to be attached
  82528. */
  82529. attachToMesh(mesh: AbstractMesh): void;
  82530. /**
  82531. * Attaches the controllers mesh to a camera
  82532. * @param camera the camera the mesh should be attached to
  82533. */
  82534. attachToPoseControlledCamera(camera: TargetCamera): void;
  82535. /**
  82536. * Disposes of the controller
  82537. */
  82538. dispose(): void;
  82539. /**
  82540. * The mesh that is attached to the controller
  82541. */
  82542. readonly mesh: Nullable<AbstractMesh>;
  82543. /**
  82544. * Gets the ray of the controller in the direction the controller is pointing
  82545. * @param length the length the resulting ray should be
  82546. * @returns a ray in the direction the controller is pointing
  82547. */
  82548. getForwardRay(length?: number): Ray;
  82549. }
  82550. }
  82551. declare module BABYLON {
  82552. /**
  82553. * Defines the WebVRController object that represents controllers tracked in 3D space
  82554. */
  82555. export abstract class WebVRController extends PoseEnabledController {
  82556. /**
  82557. * Internal, the default controller model for the controller
  82558. */
  82559. protected _defaultModel: Nullable<AbstractMesh>;
  82560. /**
  82561. * Fired when the trigger state has changed
  82562. */
  82563. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  82564. /**
  82565. * Fired when the main button state has changed
  82566. */
  82567. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  82568. /**
  82569. * Fired when the secondary button state has changed
  82570. */
  82571. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  82572. /**
  82573. * Fired when the pad state has changed
  82574. */
  82575. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  82576. /**
  82577. * Fired when controllers stick values have changed
  82578. */
  82579. onPadValuesChangedObservable: Observable<StickValues>;
  82580. /**
  82581. * Array of button availible on the controller
  82582. */
  82583. protected _buttons: Array<MutableGamepadButton>;
  82584. private _onButtonStateChange;
  82585. /**
  82586. * Fired when a controller button's state has changed
  82587. * @param callback the callback containing the button that was modified
  82588. */
  82589. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  82590. /**
  82591. * X and Y axis corresponding to the controllers joystick
  82592. */
  82593. pad: StickValues;
  82594. /**
  82595. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  82596. */
  82597. hand: string;
  82598. /**
  82599. * The default controller model for the controller
  82600. */
  82601. readonly defaultModel: Nullable<AbstractMesh>;
  82602. /**
  82603. * Creates a new WebVRController from a gamepad
  82604. * @param vrGamepad the gamepad that the WebVRController should be created from
  82605. */
  82606. constructor(vrGamepad: any);
  82607. /**
  82608. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  82609. */
  82610. update(): void;
  82611. /**
  82612. * Function to be called when a button is modified
  82613. */
  82614. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  82615. /**
  82616. * Loads a mesh and attaches it to the controller
  82617. * @param scene the scene the mesh should be added to
  82618. * @param meshLoaded callback for when the mesh has been loaded
  82619. */
  82620. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  82621. private _setButtonValue;
  82622. private _changes;
  82623. private _checkChanges;
  82624. /**
  82625. * Disposes of th webVRCOntroller
  82626. */
  82627. dispose(): void;
  82628. }
  82629. }
  82630. declare module BABYLON {
  82631. /**
  82632. * The HemisphericLight simulates the ambient environment light,
  82633. * so the passed direction is the light reflection direction, not the incoming direction.
  82634. */
  82635. export class HemisphericLight extends Light {
  82636. /**
  82637. * The groundColor is the light in the opposite direction to the one specified during creation.
  82638. * You can think of the diffuse and specular light as coming from the centre of the object in the given direction and the groundColor light in the opposite direction.
  82639. */
  82640. groundColor: Color3;
  82641. /**
  82642. * The light reflection direction, not the incoming direction.
  82643. */
  82644. direction: Vector3;
  82645. /**
  82646. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  82647. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  82648. * The HemisphericLight can't cast shadows.
  82649. * Documentation : https://doc.babylonjs.com/babylon101/lights
  82650. * @param name The friendly name of the light
  82651. * @param direction The direction of the light reflection
  82652. * @param scene The scene the light belongs to
  82653. */
  82654. constructor(name: string, direction: Vector3, scene: Scene);
  82655. protected _buildUniformLayout(): void;
  82656. /**
  82657. * Returns the string "HemisphericLight".
  82658. * @return The class name
  82659. */
  82660. getClassName(): string;
  82661. /**
  82662. * Sets the HemisphericLight direction towards the passed target (Vector3).
  82663. * Returns the updated direction.
  82664. * @param target The target the direction should point to
  82665. * @return The computed direction
  82666. */
  82667. setDirectionToTarget(target: Vector3): Vector3;
  82668. /**
  82669. * Returns the shadow generator associated to the light.
  82670. * @returns Always null for hemispheric lights because it does not support shadows.
  82671. */
  82672. getShadowGenerator(): Nullable<IShadowGenerator>;
  82673. /**
  82674. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  82675. * @param effect The effect to update
  82676. * @param lightIndex The index of the light in the effect to update
  82677. * @returns The hemispheric light
  82678. */
  82679. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  82680. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  82681. /**
  82682. * Computes the world matrix of the node
  82683. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  82684. * @param useWasUpdatedFlag defines a reserved property
  82685. * @returns the world matrix
  82686. */
  82687. computeWorldMatrix(): Matrix;
  82688. /**
  82689. * Returns the integer 3.
  82690. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  82691. */
  82692. getTypeID(): number;
  82693. /**
  82694. * Prepares the list of defines specific to the light type.
  82695. * @param defines the list of defines
  82696. * @param lightIndex defines the index of the light for the effect
  82697. */
  82698. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  82699. }
  82700. }
  82701. declare module BABYLON {
  82702. /** @hidden */
  82703. export var vrMultiviewToSingleviewPixelShader: {
  82704. name: string;
  82705. shader: string;
  82706. };
  82707. }
  82708. declare module BABYLON {
  82709. /**
  82710. * Renders to multiple views with a single draw call
  82711. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  82712. */
  82713. export class MultiviewRenderTarget extends RenderTargetTexture {
  82714. /**
  82715. * Creates a multiview render target
  82716. * @param scene scene used with the render target
  82717. * @param size the size of the render target (used for each view)
  82718. */
  82719. constructor(scene: Scene, size?: number | {
  82720. width: number;
  82721. height: number;
  82722. } | {
  82723. ratio: number;
  82724. });
  82725. /**
  82726. * @hidden
  82727. * @param faceIndex the face index, if its a cube texture
  82728. */
  82729. _bindFrameBuffer(faceIndex?: number): void;
  82730. /**
  82731. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  82732. * @returns the view count
  82733. */
  82734. getViewCount(): number;
  82735. }
  82736. }
  82737. declare module BABYLON {
  82738. /**
  82739. * Represents a camera frustum
  82740. */
  82741. export class Frustum {
  82742. /**
  82743. * Gets the planes representing the frustum
  82744. * @param transform matrix to be applied to the returned planes
  82745. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  82746. */
  82747. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  82748. /**
  82749. * Gets the near frustum plane transformed by the transform matrix
  82750. * @param transform transformation matrix to be applied to the resulting frustum plane
  82751. * @param frustumPlane the resuling frustum plane
  82752. */
  82753. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82754. /**
  82755. * Gets the far frustum plane transformed by the transform matrix
  82756. * @param transform transformation matrix to be applied to the resulting frustum plane
  82757. * @param frustumPlane the resuling frustum plane
  82758. */
  82759. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82760. /**
  82761. * Gets the left frustum plane transformed by the transform matrix
  82762. * @param transform transformation matrix to be applied to the resulting frustum plane
  82763. * @param frustumPlane the resuling frustum plane
  82764. */
  82765. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82766. /**
  82767. * Gets the right frustum plane transformed by the transform matrix
  82768. * @param transform transformation matrix to be applied to the resulting frustum plane
  82769. * @param frustumPlane the resuling frustum plane
  82770. */
  82771. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82772. /**
  82773. * Gets the top frustum plane transformed by the transform matrix
  82774. * @param transform transformation matrix to be applied to the resulting frustum plane
  82775. * @param frustumPlane the resuling frustum plane
  82776. */
  82777. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82778. /**
  82779. * Gets the bottom frustum plane transformed by the transform matrix
  82780. * @param transform transformation matrix to be applied to the resulting frustum plane
  82781. * @param frustumPlane the resuling frustum plane
  82782. */
  82783. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  82784. /**
  82785. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  82786. * @param transform transformation matrix to be applied to the resulting frustum planes
  82787. * @param frustumPlanes the resuling frustum planes
  82788. */
  82789. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  82790. }
  82791. }
  82792. declare module BABYLON {
  82793. interface Engine {
  82794. /**
  82795. * Creates a new multiview render target
  82796. * @param width defines the width of the texture
  82797. * @param height defines the height of the texture
  82798. * @returns the created multiview texture
  82799. */
  82800. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  82801. /**
  82802. * Binds a multiview framebuffer to be drawn to
  82803. * @param multiviewTexture texture to bind
  82804. */
  82805. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  82806. }
  82807. interface Camera {
  82808. /**
  82809. * @hidden
  82810. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  82811. */
  82812. _useMultiviewToSingleView: boolean;
  82813. /**
  82814. * @hidden
  82815. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  82816. */
  82817. _multiviewTexture: Nullable<RenderTargetTexture>;
  82818. /**
  82819. * @hidden
  82820. * ensures the multiview texture of the camera exists and has the specified width/height
  82821. * @param width height to set on the multiview texture
  82822. * @param height width to set on the multiview texture
  82823. */
  82824. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  82825. }
  82826. interface Scene {
  82827. /** @hidden */
  82828. _transformMatrixR: Matrix;
  82829. /** @hidden */
  82830. _multiviewSceneUbo: Nullable<UniformBuffer>;
  82831. /** @hidden */
  82832. _createMultiviewUbo(): void;
  82833. /** @hidden */
  82834. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  82835. /** @hidden */
  82836. _renderMultiviewToSingleView(camera: Camera): void;
  82837. }
  82838. }
  82839. declare module BABYLON {
  82840. /**
  82841. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  82842. * This will not be used for webXR as it supports displaying texture arrays directly
  82843. */
  82844. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  82845. /**
  82846. * Initializes a VRMultiviewToSingleview
  82847. * @param name name of the post process
  82848. * @param camera camera to be applied to
  82849. * @param scaleFactor scaling factor to the size of the output texture
  82850. */
  82851. constructor(name: string, camera: Camera, scaleFactor: number);
  82852. }
  82853. }
  82854. declare module BABYLON {
  82855. /**
  82856. * Interface used to define additional presentation attributes
  82857. */
  82858. export interface IVRPresentationAttributes {
  82859. /**
  82860. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  82861. */
  82862. highRefreshRate: boolean;
  82863. /**
  82864. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  82865. */
  82866. foveationLevel: number;
  82867. }
  82868. interface Engine {
  82869. /** @hidden */
  82870. _vrDisplay: any;
  82871. /** @hidden */
  82872. _vrSupported: boolean;
  82873. /** @hidden */
  82874. _oldSize: Size;
  82875. /** @hidden */
  82876. _oldHardwareScaleFactor: number;
  82877. /** @hidden */
  82878. _vrExclusivePointerMode: boolean;
  82879. /** @hidden */
  82880. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  82881. /** @hidden */
  82882. _onVRDisplayPointerRestricted: () => void;
  82883. /** @hidden */
  82884. _onVRDisplayPointerUnrestricted: () => void;
  82885. /** @hidden */
  82886. _onVrDisplayConnect: Nullable<(display: any) => void>;
  82887. /** @hidden */
  82888. _onVrDisplayDisconnect: Nullable<() => void>;
  82889. /** @hidden */
  82890. _onVrDisplayPresentChange: Nullable<() => void>;
  82891. /**
  82892. * Observable signaled when VR display mode changes
  82893. */
  82894. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  82895. /**
  82896. * Observable signaled when VR request present is complete
  82897. */
  82898. onVRRequestPresentComplete: Observable<boolean>;
  82899. /**
  82900. * Observable signaled when VR request present starts
  82901. */
  82902. onVRRequestPresentStart: Observable<Engine>;
  82903. /**
  82904. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  82905. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  82906. */
  82907. isInVRExclusivePointerMode: boolean;
  82908. /**
  82909. * Gets a boolean indicating if a webVR device was detected
  82910. * @returns true if a webVR device was detected
  82911. */
  82912. isVRDevicePresent(): boolean;
  82913. /**
  82914. * Gets the current webVR device
  82915. * @returns the current webVR device (or null)
  82916. */
  82917. getVRDevice(): any;
  82918. /**
  82919. * Initializes a webVR display and starts listening to display change events
  82920. * The onVRDisplayChangedObservable will be notified upon these changes
  82921. * @returns A promise containing a VRDisplay and if vr is supported
  82922. */
  82923. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  82924. /** @hidden */
  82925. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  82926. /**
  82927. * Gets or sets the presentation attributes used to configure VR rendering
  82928. */
  82929. vrPresentationAttributes?: IVRPresentationAttributes;
  82930. /**
  82931. * Call this function to switch to webVR mode
  82932. * Will do nothing if webVR is not supported or if there is no webVR device
  82933. * @see http://doc.babylonjs.com/how_to/webvr_camera
  82934. */
  82935. enableVR(): void;
  82936. /** @hidden */
  82937. _onVRFullScreenTriggered(): void;
  82938. }
  82939. }
  82940. declare module BABYLON {
  82941. /**
  82942. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  82943. * IMPORTANT!! The data is right-hand data.
  82944. * @export
  82945. * @interface DevicePose
  82946. */
  82947. export interface DevicePose {
  82948. /**
  82949. * The position of the device, values in array are [x,y,z].
  82950. */
  82951. readonly position: Nullable<Float32Array>;
  82952. /**
  82953. * The linearVelocity of the device, values in array are [x,y,z].
  82954. */
  82955. readonly linearVelocity: Nullable<Float32Array>;
  82956. /**
  82957. * The linearAcceleration of the device, values in array are [x,y,z].
  82958. */
  82959. readonly linearAcceleration: Nullable<Float32Array>;
  82960. /**
  82961. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  82962. */
  82963. readonly orientation: Nullable<Float32Array>;
  82964. /**
  82965. * The angularVelocity of the device, values in array are [x,y,z].
  82966. */
  82967. readonly angularVelocity: Nullable<Float32Array>;
  82968. /**
  82969. * The angularAcceleration of the device, values in array are [x,y,z].
  82970. */
  82971. readonly angularAcceleration: Nullable<Float32Array>;
  82972. }
  82973. /**
  82974. * Interface representing a pose controlled object in Babylon.
  82975. * A pose controlled object has both regular pose values as well as pose values
  82976. * from an external device such as a VR head mounted display
  82977. */
  82978. export interface PoseControlled {
  82979. /**
  82980. * The position of the object in babylon space.
  82981. */
  82982. position: Vector3;
  82983. /**
  82984. * The rotation quaternion of the object in babylon space.
  82985. */
  82986. rotationQuaternion: Quaternion;
  82987. /**
  82988. * The position of the device in babylon space.
  82989. */
  82990. devicePosition?: Vector3;
  82991. /**
  82992. * The rotation quaternion of the device in babylon space.
  82993. */
  82994. deviceRotationQuaternion: Quaternion;
  82995. /**
  82996. * The raw pose coming from the device.
  82997. */
  82998. rawPose: Nullable<DevicePose>;
  82999. /**
  83000. * The scale of the device to be used when translating from device space to babylon space.
  83001. */
  83002. deviceScaleFactor: number;
  83003. /**
  83004. * Updates the poseControlled values based on the input device pose.
  83005. * @param poseData the pose data to update the object with
  83006. */
  83007. updateFromDevice(poseData: DevicePose): void;
  83008. }
  83009. /**
  83010. * Set of options to customize the webVRCamera
  83011. */
  83012. export interface WebVROptions {
  83013. /**
  83014. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  83015. */
  83016. trackPosition?: boolean;
  83017. /**
  83018. * Sets the scale of the vrDevice in babylon space. (default: 1)
  83019. */
  83020. positionScale?: number;
  83021. /**
  83022. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  83023. */
  83024. displayName?: string;
  83025. /**
  83026. * Should the native controller meshes be initialized. (default: true)
  83027. */
  83028. controllerMeshes?: boolean;
  83029. /**
  83030. * Creating a default HemiLight only on controllers. (default: true)
  83031. */
  83032. defaultLightingOnControllers?: boolean;
  83033. /**
  83034. * If you don't want to use the default VR button of the helper. (default: false)
  83035. */
  83036. useCustomVRButton?: boolean;
  83037. /**
  83038. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  83039. */
  83040. customVRButton?: HTMLButtonElement;
  83041. /**
  83042. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  83043. */
  83044. rayLength?: number;
  83045. /**
  83046. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  83047. */
  83048. defaultHeight?: number;
  83049. /**
  83050. * If multiview should be used if availible (default: false)
  83051. */
  83052. useMultiview?: boolean;
  83053. }
  83054. /**
  83055. * This represents a WebVR camera.
  83056. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  83057. * @example http://doc.babylonjs.com/how_to/webvr_camera
  83058. */
  83059. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  83060. private webVROptions;
  83061. /**
  83062. * @hidden
  83063. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  83064. */
  83065. _vrDevice: any;
  83066. /**
  83067. * The rawPose of the vrDevice.
  83068. */
  83069. rawPose: Nullable<DevicePose>;
  83070. private _onVREnabled;
  83071. private _specsVersion;
  83072. private _attached;
  83073. private _frameData;
  83074. protected _descendants: Array<Node>;
  83075. private _deviceRoomPosition;
  83076. /** @hidden */
  83077. _deviceRoomRotationQuaternion: Quaternion;
  83078. private _standingMatrix;
  83079. /**
  83080. * Represents device position in babylon space.
  83081. */
  83082. devicePosition: Vector3;
  83083. /**
  83084. * Represents device rotation in babylon space.
  83085. */
  83086. deviceRotationQuaternion: Quaternion;
  83087. /**
  83088. * The scale of the device to be used when translating from device space to babylon space.
  83089. */
  83090. deviceScaleFactor: number;
  83091. private _deviceToWorld;
  83092. private _worldToDevice;
  83093. /**
  83094. * References to the webVR controllers for the vrDevice.
  83095. */
  83096. controllers: Array<WebVRController>;
  83097. /**
  83098. * Emits an event when a controller is attached.
  83099. */
  83100. onControllersAttachedObservable: Observable<WebVRController[]>;
  83101. /**
  83102. * Emits an event when a controller's mesh has been loaded;
  83103. */
  83104. onControllerMeshLoadedObservable: Observable<WebVRController>;
  83105. /**
  83106. * Emits an event when the HMD's pose has been updated.
  83107. */
  83108. onPoseUpdatedFromDeviceObservable: Observable<any>;
  83109. private _poseSet;
  83110. /**
  83111. * If the rig cameras be used as parent instead of this camera.
  83112. */
  83113. rigParenting: boolean;
  83114. private _lightOnControllers;
  83115. private _defaultHeight?;
  83116. /**
  83117. * Instantiates a WebVRFreeCamera.
  83118. * @param name The name of the WebVRFreeCamera
  83119. * @param position The starting anchor position for the camera
  83120. * @param scene The scene the camera belongs to
  83121. * @param webVROptions a set of customizable options for the webVRCamera
  83122. */
  83123. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  83124. /**
  83125. * Gets the device distance from the ground in meters.
  83126. * @returns the distance in meters from the vrDevice to ground in device space. If standing matrix is not supported for the vrDevice 0 is returned.
  83127. */
  83128. deviceDistanceToRoomGround(): number;
  83129. /**
  83130. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  83131. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  83132. */
  83133. useStandingMatrix(callback?: (bool: boolean) => void): void;
  83134. /**
  83135. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  83136. * @returns A promise with a boolean set to if the standing matrix is supported.
  83137. */
  83138. useStandingMatrixAsync(): Promise<boolean>;
  83139. /**
  83140. * Disposes the camera
  83141. */
  83142. dispose(): void;
  83143. /**
  83144. * Gets a vrController by name.
  83145. * @param name The name of the controller to retreive
  83146. * @returns the controller matching the name specified or null if not found
  83147. */
  83148. getControllerByName(name: string): Nullable<WebVRController>;
  83149. private _leftController;
  83150. /**
  83151. * The controller corresponding to the users left hand.
  83152. */
  83153. readonly leftController: Nullable<WebVRController>;
  83154. private _rightController;
  83155. /**
  83156. * The controller corresponding to the users right hand.
  83157. */
  83158. readonly rightController: Nullable<WebVRController>;
  83159. /**
  83160. * Casts a ray forward from the vrCamera's gaze.
  83161. * @param length Length of the ray (default: 100)
  83162. * @returns the ray corresponding to the gaze
  83163. */
  83164. getForwardRay(length?: number): Ray;
  83165. /**
  83166. * @hidden
  83167. * Updates the camera based on device's frame data
  83168. */
  83169. _checkInputs(): void;
  83170. /**
  83171. * Updates the poseControlled values based on the input device pose.
  83172. * @param poseData Pose coming from the device
  83173. */
  83174. updateFromDevice(poseData: DevicePose): void;
  83175. private _htmlElementAttached;
  83176. private _detachIfAttached;
  83177. /**
  83178. * WebVR's attach control will start broadcasting frames to the device.
  83179. * Note that in certain browsers (chrome for example) this function must be called
  83180. * within a user-interaction callback. Example:
  83181. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  83182. *
  83183. * @param element html element to attach the vrDevice to
  83184. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  83185. */
  83186. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  83187. /**
  83188. * Detaches the camera from the html element and disables VR
  83189. *
  83190. * @param element html element to detach from
  83191. */
  83192. detachControl(element: HTMLElement): void;
  83193. /**
  83194. * @returns the name of this class
  83195. */
  83196. getClassName(): string;
  83197. /**
  83198. * Calls resetPose on the vrDisplay
  83199. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  83200. */
  83201. resetToCurrentRotation(): void;
  83202. /**
  83203. * @hidden
  83204. * Updates the rig cameras (left and right eye)
  83205. */
  83206. _updateRigCameras(): void;
  83207. private _workingVector;
  83208. private _oneVector;
  83209. private _workingMatrix;
  83210. private updateCacheCalled;
  83211. private _correctPositionIfNotTrackPosition;
  83212. /**
  83213. * @hidden
  83214. * Updates the cached values of the camera
  83215. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  83216. */
  83217. _updateCache(ignoreParentClass?: boolean): void;
  83218. /**
  83219. * @hidden
  83220. * Get current device position in babylon world
  83221. */
  83222. _computeDevicePosition(): void;
  83223. /**
  83224. * Updates the current device position and rotation in the babylon world
  83225. */
  83226. update(): void;
  83227. /**
  83228. * @hidden
  83229. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  83230. * @returns an identity matrix
  83231. */
  83232. _getViewMatrix(): Matrix;
  83233. private _tmpMatrix;
  83234. /**
  83235. * This function is called by the two RIG cameras.
  83236. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  83237. * @hidden
  83238. */
  83239. _getWebVRViewMatrix(): Matrix;
  83240. /** @hidden */
  83241. _getWebVRProjectionMatrix(): Matrix;
  83242. private _onGamepadConnectedObserver;
  83243. private _onGamepadDisconnectedObserver;
  83244. private _updateCacheWhenTrackingDisabledObserver;
  83245. /**
  83246. * Initializes the controllers and their meshes
  83247. */
  83248. initControllers(): void;
  83249. }
  83250. }
  83251. declare module BABYLON {
  83252. /**
  83253. * Size options for a post process
  83254. */
  83255. export type PostProcessOptions = {
  83256. width: number;
  83257. height: number;
  83258. };
  83259. /**
  83260. * PostProcess can be used to apply a shader to a texture after it has been rendered
  83261. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  83262. */
  83263. export class PostProcess {
  83264. /** Name of the PostProcess. */
  83265. name: string;
  83266. /**
  83267. * Gets or sets the unique id of the post process
  83268. */
  83269. uniqueId: number;
  83270. /**
  83271. * Width of the texture to apply the post process on
  83272. */
  83273. width: number;
  83274. /**
  83275. * Height of the texture to apply the post process on
  83276. */
  83277. height: number;
  83278. /**
  83279. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  83280. * @hidden
  83281. */
  83282. _outputTexture: Nullable<InternalTexture>;
  83283. /**
  83284. * Sampling mode used by the shader
  83285. * See https://doc.babylonjs.com/classes/3.1/texture
  83286. */
  83287. renderTargetSamplingMode: number;
  83288. /**
  83289. * Clear color to use when screen clearing
  83290. */
  83291. clearColor: Color4;
  83292. /**
  83293. * If the buffer needs to be cleared before applying the post process. (default: true)
  83294. * Should be set to false if shader will overwrite all previous pixels.
  83295. */
  83296. autoClear: boolean;
  83297. /**
  83298. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  83299. */
  83300. alphaMode: number;
  83301. /**
  83302. * Sets the setAlphaBlendConstants of the babylon engine
  83303. */
  83304. alphaConstants: Color4;
  83305. /**
  83306. * Animations to be used for the post processing
  83307. */
  83308. animations: Animation[];
  83309. /**
  83310. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  83311. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  83312. */
  83313. enablePixelPerfectMode: boolean;
  83314. /**
  83315. * Force the postprocess to be applied without taking in account viewport
  83316. */
  83317. forceFullscreenViewport: boolean;
  83318. /**
  83319. * List of inspectable custom properties (used by the Inspector)
  83320. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  83321. */
  83322. inspectableCustomProperties: IInspectable[];
  83323. /**
  83324. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  83325. *
  83326. * | Value | Type | Description |
  83327. * | ----- | ----------------------------------- | ----------- |
  83328. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  83329. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  83330. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  83331. *
  83332. */
  83333. scaleMode: number;
  83334. /**
  83335. * Force textures to be a power of two (default: false)
  83336. */
  83337. alwaysForcePOT: boolean;
  83338. private _samples;
  83339. /**
  83340. * Number of sample textures (default: 1)
  83341. */
  83342. samples: number;
  83343. /**
  83344. * Modify the scale of the post process to be the same as the viewport (default: false)
  83345. */
  83346. adaptScaleToCurrentViewport: boolean;
  83347. private _camera;
  83348. private _scene;
  83349. private _engine;
  83350. private _options;
  83351. private _reusable;
  83352. private _textureType;
  83353. /**
  83354. * Smart array of input and output textures for the post process.
  83355. * @hidden
  83356. */
  83357. _textures: SmartArray<InternalTexture>;
  83358. /**
  83359. * The index in _textures that corresponds to the output texture.
  83360. * @hidden
  83361. */
  83362. _currentRenderTextureInd: number;
  83363. private _effect;
  83364. private _samplers;
  83365. private _fragmentUrl;
  83366. private _vertexUrl;
  83367. private _parameters;
  83368. private _scaleRatio;
  83369. protected _indexParameters: any;
  83370. private _shareOutputWithPostProcess;
  83371. private _texelSize;
  83372. private _forcedOutputTexture;
  83373. /**
  83374. * Returns the fragment url or shader name used in the post process.
  83375. * @returns the fragment url or name in the shader store.
  83376. */
  83377. getEffectName(): string;
  83378. /**
  83379. * An event triggered when the postprocess is activated.
  83380. */
  83381. onActivateObservable: Observable<Camera>;
  83382. private _onActivateObserver;
  83383. /**
  83384. * A function that is added to the onActivateObservable
  83385. */
  83386. onActivate: Nullable<(camera: Camera) => void>;
  83387. /**
  83388. * An event triggered when the postprocess changes its size.
  83389. */
  83390. onSizeChangedObservable: Observable<PostProcess>;
  83391. private _onSizeChangedObserver;
  83392. /**
  83393. * A function that is added to the onSizeChangedObservable
  83394. */
  83395. onSizeChanged: (postProcess: PostProcess) => void;
  83396. /**
  83397. * An event triggered when the postprocess applies its effect.
  83398. */
  83399. onApplyObservable: Observable<Effect>;
  83400. private _onApplyObserver;
  83401. /**
  83402. * A function that is added to the onApplyObservable
  83403. */
  83404. onApply: (effect: Effect) => void;
  83405. /**
  83406. * An event triggered before rendering the postprocess
  83407. */
  83408. onBeforeRenderObservable: Observable<Effect>;
  83409. private _onBeforeRenderObserver;
  83410. /**
  83411. * A function that is added to the onBeforeRenderObservable
  83412. */
  83413. onBeforeRender: (effect: Effect) => void;
  83414. /**
  83415. * An event triggered after rendering the postprocess
  83416. */
  83417. onAfterRenderObservable: Observable<Effect>;
  83418. private _onAfterRenderObserver;
  83419. /**
  83420. * A function that is added to the onAfterRenderObservable
  83421. */
  83422. onAfterRender: (efect: Effect) => void;
  83423. /**
  83424. * The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will
  83425. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  83426. */
  83427. inputTexture: InternalTexture;
  83428. /**
  83429. * Gets the camera which post process is applied to.
  83430. * @returns The camera the post process is applied to.
  83431. */
  83432. getCamera(): Camera;
  83433. /**
  83434. * Gets the texel size of the postprocess.
  83435. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  83436. */
  83437. readonly texelSize: Vector2;
  83438. /**
  83439. * Creates a new instance PostProcess
  83440. * @param name The name of the PostProcess.
  83441. * @param fragmentUrl The url of the fragment shader to be used.
  83442. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  83443. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  83444. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  83445. * @param camera The camera to apply the render pass to.
  83446. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  83447. * @param engine The engine which the post process will be applied. (default: current engine)
  83448. * @param reusable If the post process can be reused on the same frame. (default: false)
  83449. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  83450. * @param textureType Type of textures used when performing the post process. (default: 0)
  83451. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  83452. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  83453. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  83454. */
  83455. constructor(
  83456. /** Name of the PostProcess. */
  83457. name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean);
  83458. /**
  83459. * Gets a string idenfifying the name of the class
  83460. * @returns "PostProcess" string
  83461. */
  83462. getClassName(): string;
  83463. /**
  83464. * Gets the engine which this post process belongs to.
  83465. * @returns The engine the post process was enabled with.
  83466. */
  83467. getEngine(): Engine;
  83468. /**
  83469. * The effect that is created when initializing the post process.
  83470. * @returns The created effect corresponding the the postprocess.
  83471. */
  83472. getEffect(): Effect;
  83473. /**
  83474. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  83475. * @param postProcess The post process to share the output with.
  83476. * @returns This post process.
  83477. */
  83478. shareOutputWith(postProcess: PostProcess): PostProcess;
  83479. /**
  83480. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  83481. * This should be called if the post process that shares output with this post process is disabled/disposed.
  83482. */
  83483. useOwnOutput(): void;
  83484. /**
  83485. * Updates the effect with the current post process compile time values and recompiles the shader.
  83486. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  83487. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  83488. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  83489. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  83490. * @param onCompiled Called when the shader has been compiled.
  83491. * @param onError Called if there is an error when compiling a shader.
  83492. */
  83493. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83494. /**
  83495. * The post process is reusable if it can be used multiple times within one frame.
  83496. * @returns If the post process is reusable
  83497. */
  83498. isReusable(): boolean;
  83499. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  83500. markTextureDirty(): void;
  83501. /**
  83502. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  83503. * When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.
  83504. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  83505. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  83506. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  83507. * @returns The target texture that was bound to be written to.
  83508. */
  83509. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  83510. /**
  83511. * If the post process is supported.
  83512. */
  83513. readonly isSupported: boolean;
  83514. /**
  83515. * The aspect ratio of the output texture.
  83516. */
  83517. readonly aspectRatio: number;
  83518. /**
  83519. * Get a value indicating if the post-process is ready to be used
  83520. * @returns true if the post-process is ready (shader is compiled)
  83521. */
  83522. isReady(): boolean;
  83523. /**
  83524. * Binds all textures and uniforms to the shader, this will be run on every pass.
  83525. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  83526. */
  83527. apply(): Nullable<Effect>;
  83528. private _disposeTextures;
  83529. /**
  83530. * Disposes the post process.
  83531. * @param camera The camera to dispose the post process on.
  83532. */
  83533. dispose(camera?: Camera): void;
  83534. }
  83535. }
  83536. declare module BABYLON {
  83537. /** @hidden */
  83538. export var kernelBlurVaryingDeclaration: {
  83539. name: string;
  83540. shader: string;
  83541. };
  83542. }
  83543. declare module BABYLON {
  83544. /** @hidden */
  83545. export var kernelBlurFragment: {
  83546. name: string;
  83547. shader: string;
  83548. };
  83549. }
  83550. declare module BABYLON {
  83551. /** @hidden */
  83552. export var kernelBlurFragment2: {
  83553. name: string;
  83554. shader: string;
  83555. };
  83556. }
  83557. declare module BABYLON {
  83558. /** @hidden */
  83559. export var kernelBlurPixelShader: {
  83560. name: string;
  83561. shader: string;
  83562. };
  83563. }
  83564. declare module BABYLON {
  83565. /** @hidden */
  83566. export var kernelBlurVertex: {
  83567. name: string;
  83568. shader: string;
  83569. };
  83570. }
  83571. declare module BABYLON {
  83572. /** @hidden */
  83573. export var kernelBlurVertexShader: {
  83574. name: string;
  83575. shader: string;
  83576. };
  83577. }
  83578. declare module BABYLON {
  83579. /**
  83580. * The Blur Post Process which blurs an image based on a kernel and direction.
  83581. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  83582. */
  83583. export class BlurPostProcess extends PostProcess {
  83584. /** The direction in which to blur the image. */
  83585. direction: Vector2;
  83586. private blockCompilation;
  83587. protected _kernel: number;
  83588. protected _idealKernel: number;
  83589. protected _packedFloat: boolean;
  83590. private _staticDefines;
  83591. /**
  83592. * Sets the length in pixels of the blur sample region
  83593. */
  83594. /**
  83595. * Gets the length in pixels of the blur sample region
  83596. */
  83597. kernel: number;
  83598. /**
  83599. * Sets wether or not the blur needs to unpack/repack floats
  83600. */
  83601. /**
  83602. * Gets wether or not the blur is unpacking/repacking floats
  83603. */
  83604. packedFloat: boolean;
  83605. /**
  83606. * Creates a new instance BlurPostProcess
  83607. * @param name The name of the effect.
  83608. * @param direction The direction in which to blur the image.
  83609. * @param kernel The size of the kernel to be used when computing the blur. eg. Size of 3 will blur the center pixel by 2 pixels surrounding it.
  83610. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  83611. * @param camera The camera to apply the render pass to.
  83612. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  83613. * @param engine The engine which the post process will be applied. (default: current engine)
  83614. * @param reusable If the post process can be reused on the same frame. (default: false)
  83615. * @param textureType Type of textures used when performing the post process. (default: 0)
  83616. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  83617. */
  83618. constructor(name: string,
  83619. /** The direction in which to blur the image. */
  83620. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  83621. /**
  83622. * Updates the effect with the current post process compile time values and recompiles the shader.
  83623. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  83624. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  83625. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  83626. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  83627. * @param onCompiled Called when the shader has been compiled.
  83628. * @param onError Called if there is an error when compiling a shader.
  83629. */
  83630. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83631. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83632. /**
  83633. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  83634. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  83635. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  83636. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  83637. * The gaps between physical kernels are compensated for in the weighting of the samples
  83638. * @param idealKernel Ideal blur kernel.
  83639. * @return Nearest best kernel.
  83640. */
  83641. protected _nearestBestKernel(idealKernel: number): number;
  83642. /**
  83643. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  83644. * @param x The point on the Gaussian distribution to sample.
  83645. * @return the value of the Gaussian function at x.
  83646. */
  83647. protected _gaussianWeight(x: number): number;
  83648. /**
  83649. * Generates a string that can be used as a floating point number in GLSL.
  83650. * @param x Value to print.
  83651. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  83652. * @return GLSL float string.
  83653. */
  83654. protected _glslFloat(x: number, decimalFigures?: number): string;
  83655. }
  83656. }
  83657. declare module BABYLON {
  83658. /**
  83659. * Mirror texture can be used to simulate the view from a mirror in a scene.
  83660. * It will dynamically be rendered every frame to adapt to the camera point of view.
  83661. * You can then easily use it as a reflectionTexture on a flat surface.
  83662. * In case the surface is not a plane, please consider relying on reflection probes.
  83663. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  83664. */
  83665. export class MirrorTexture extends RenderTargetTexture {
  83666. private scene;
  83667. /**
  83668. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  83669. * It is possible to directly set the mirrorPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the mirrorPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the reflector as stated in the doc.
  83670. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  83671. */
  83672. mirrorPlane: Plane;
  83673. /**
  83674. * Define the blur ratio used to blur the reflection if needed.
  83675. */
  83676. blurRatio: number;
  83677. /**
  83678. * Define the adaptive blur kernel used to blur the reflection if needed.
  83679. * This will autocompute the closest best match for the `blurKernel`
  83680. */
  83681. adaptiveBlurKernel: number;
  83682. /**
  83683. * Define the blur kernel used to blur the reflection if needed.
  83684. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  83685. */
  83686. blurKernel: number;
  83687. /**
  83688. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  83689. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  83690. */
  83691. blurKernelX: number;
  83692. /**
  83693. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  83694. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  83695. */
  83696. blurKernelY: number;
  83697. private _autoComputeBlurKernel;
  83698. protected _onRatioRescale(): void;
  83699. private _updateGammaSpace;
  83700. private _imageProcessingConfigChangeObserver;
  83701. private _transformMatrix;
  83702. private _mirrorMatrix;
  83703. private _savedViewMatrix;
  83704. private _blurX;
  83705. private _blurY;
  83706. private _adaptiveBlurKernel;
  83707. private _blurKernelX;
  83708. private _blurKernelY;
  83709. private _blurRatio;
  83710. /**
  83711. * Instantiates a Mirror Texture.
  83712. * Mirror texture can be used to simulate the view from a mirror in a scene.
  83713. * It will dynamically be rendered every frame to adapt to the camera point of view.
  83714. * You can then easily use it as a reflectionTexture on a flat surface.
  83715. * In case the surface is not a plane, please consider relying on reflection probes.
  83716. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  83717. * @param name
  83718. * @param size
  83719. * @param scene
  83720. * @param generateMipMaps
  83721. * @param type
  83722. * @param samplingMode
  83723. * @param generateDepthBuffer
  83724. */
  83725. constructor(name: string, size: number | {
  83726. width: number;
  83727. height: number;
  83728. } | {
  83729. ratio: number;
  83730. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  83731. private _preparePostProcesses;
  83732. /**
  83733. * Clone the mirror texture.
  83734. * @returns the cloned texture
  83735. */
  83736. clone(): MirrorTexture;
  83737. /**
  83738. * Serialize the texture to a JSON representation you could use in Parse later on
  83739. * @returns the serialized JSON representation
  83740. */
  83741. serialize(): any;
  83742. /**
  83743. * Dispose the texture and release its associated resources.
  83744. */
  83745. dispose(): void;
  83746. }
  83747. }
  83748. declare module BABYLON {
  83749. /**
  83750. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  83751. * @see http://doc.babylonjs.com/babylon101/materials#texture
  83752. */
  83753. export class Texture extends BaseTexture {
  83754. /**
  83755. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  83756. */
  83757. static SerializeBuffers: boolean;
  83758. /** @hidden */
  83759. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  83760. /** @hidden */
  83761. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  83762. /** @hidden */
  83763. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  83764. /** nearest is mag = nearest and min = nearest and mip = linear */
  83765. static readonly NEAREST_SAMPLINGMODE: number;
  83766. /** nearest is mag = nearest and min = nearest and mip = linear */
  83767. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  83768. /** Bilinear is mag = linear and min = linear and mip = nearest */
  83769. static readonly BILINEAR_SAMPLINGMODE: number;
  83770. /** Bilinear is mag = linear and min = linear and mip = nearest */
  83771. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  83772. /** Trilinear is mag = linear and min = linear and mip = linear */
  83773. static readonly TRILINEAR_SAMPLINGMODE: number;
  83774. /** Trilinear is mag = linear and min = linear and mip = linear */
  83775. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  83776. /** mag = nearest and min = nearest and mip = nearest */
  83777. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  83778. /** mag = nearest and min = linear and mip = nearest */
  83779. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  83780. /** mag = nearest and min = linear and mip = linear */
  83781. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  83782. /** mag = nearest and min = linear and mip = none */
  83783. static readonly NEAREST_LINEAR: number;
  83784. /** mag = nearest and min = nearest and mip = none */
  83785. static readonly NEAREST_NEAREST: number;
  83786. /** mag = linear and min = nearest and mip = nearest */
  83787. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  83788. /** mag = linear and min = nearest and mip = linear */
  83789. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  83790. /** mag = linear and min = linear and mip = none */
  83791. static readonly LINEAR_LINEAR: number;
  83792. /** mag = linear and min = nearest and mip = none */
  83793. static readonly LINEAR_NEAREST: number;
  83794. /** Explicit coordinates mode */
  83795. static readonly EXPLICIT_MODE: number;
  83796. /** Spherical coordinates mode */
  83797. static readonly SPHERICAL_MODE: number;
  83798. /** Planar coordinates mode */
  83799. static readonly PLANAR_MODE: number;
  83800. /** Cubic coordinates mode */
  83801. static readonly CUBIC_MODE: number;
  83802. /** Projection coordinates mode */
  83803. static readonly PROJECTION_MODE: number;
  83804. /** Inverse Cubic coordinates mode */
  83805. static readonly SKYBOX_MODE: number;
  83806. /** Inverse Cubic coordinates mode */
  83807. static readonly INVCUBIC_MODE: number;
  83808. /** Equirectangular coordinates mode */
  83809. static readonly EQUIRECTANGULAR_MODE: number;
  83810. /** Equirectangular Fixed coordinates mode */
  83811. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  83812. /** Equirectangular Fixed Mirrored coordinates mode */
  83813. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  83814. /** Texture is not repeating outside of 0..1 UVs */
  83815. static readonly CLAMP_ADDRESSMODE: number;
  83816. /** Texture is repeating outside of 0..1 UVs */
  83817. static readonly WRAP_ADDRESSMODE: number;
  83818. /** Texture is repeating and mirrored */
  83819. static readonly MIRROR_ADDRESSMODE: number;
  83820. /**
  83821. * Gets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file
  83822. */
  83823. static UseSerializedUrlIfAny: boolean;
  83824. /**
  83825. * Define the url of the texture.
  83826. */
  83827. url: Nullable<string>;
  83828. /**
  83829. * Define an offset on the texture to offset the u coordinates of the UVs
  83830. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  83831. */
  83832. uOffset: number;
  83833. /**
  83834. * Define an offset on the texture to offset the v coordinates of the UVs
  83835. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  83836. */
  83837. vOffset: number;
  83838. /**
  83839. * Define an offset on the texture to scale the u coordinates of the UVs
  83840. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  83841. */
  83842. uScale: number;
  83843. /**
  83844. * Define an offset on the texture to scale the v coordinates of the UVs
  83845. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  83846. */
  83847. vScale: number;
  83848. /**
  83849. * Define an offset on the texture to rotate around the u coordinates of the UVs
  83850. * @see http://doc.babylonjs.com/how_to/more_materials
  83851. */
  83852. uAng: number;
  83853. /**
  83854. * Define an offset on the texture to rotate around the v coordinates of the UVs
  83855. * @see http://doc.babylonjs.com/how_to/more_materials
  83856. */
  83857. vAng: number;
  83858. /**
  83859. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  83860. * @see http://doc.babylonjs.com/how_to/more_materials
  83861. */
  83862. wAng: number;
  83863. /**
  83864. * Defines the center of rotation (U)
  83865. */
  83866. uRotationCenter: number;
  83867. /**
  83868. * Defines the center of rotation (V)
  83869. */
  83870. vRotationCenter: number;
  83871. /**
  83872. * Defines the center of rotation (W)
  83873. */
  83874. wRotationCenter: number;
  83875. /**
  83876. * Are mip maps generated for this texture or not.
  83877. */
  83878. readonly noMipmap: boolean;
  83879. /**
  83880. * List of inspectable custom properties (used by the Inspector)
  83881. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  83882. */
  83883. inspectableCustomProperties: Nullable<IInspectable[]>;
  83884. private _noMipmap;
  83885. /** @hidden */
  83886. _invertY: boolean;
  83887. private _rowGenerationMatrix;
  83888. private _cachedTextureMatrix;
  83889. private _projectionModeMatrix;
  83890. private _t0;
  83891. private _t1;
  83892. private _t2;
  83893. private _cachedUOffset;
  83894. private _cachedVOffset;
  83895. private _cachedUScale;
  83896. private _cachedVScale;
  83897. private _cachedUAng;
  83898. private _cachedVAng;
  83899. private _cachedWAng;
  83900. private _cachedProjectionMatrixId;
  83901. private _cachedCoordinatesMode;
  83902. /** @hidden */
  83903. protected _initialSamplingMode: number;
  83904. /** @hidden */
  83905. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  83906. private _deleteBuffer;
  83907. protected _format: Nullable<number>;
  83908. private _delayedOnLoad;
  83909. private _delayedOnError;
  83910. private _mimeType?;
  83911. /**
  83912. * Observable triggered once the texture has been loaded.
  83913. */
  83914. onLoadObservable: Observable<Texture>;
  83915. protected _isBlocking: boolean;
  83916. /**
  83917. * Is the texture preventing material to render while loading.
  83918. * If false, a default texture will be used instead of the loading one during the preparation step.
  83919. */
  83920. isBlocking: boolean;
  83921. /**
  83922. * Get the current sampling mode associated with the texture.
  83923. */
  83924. readonly samplingMode: number;
  83925. /**
  83926. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  83927. */
  83928. readonly invertY: boolean;
  83929. /**
  83930. * Instantiates a new texture.
  83931. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  83932. * @see http://doc.babylonjs.com/babylon101/materials#texture
  83933. * @param url defines the url of the picture to load as a texture
  83934. * @param scene defines the scene or engine the texture will belong to
  83935. * @param noMipmap defines if the texture will require mip maps or not
  83936. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  83937. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  83938. * @param onLoad defines a callback triggered when the texture has been loaded
  83939. * @param onError defines a callback triggered when an error occurred during the loading session
  83940. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  83941. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  83942. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  83943. * @param mimeType defines an optional mime type information
  83944. */
  83945. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string);
  83946. /**
  83947. * Update the url (and optional buffer) of this texture if url was null during construction.
  83948. * @param url the url of the texture
  83949. * @param buffer the buffer of the texture (defaults to null)
  83950. * @param onLoad callback called when the texture is loaded (defaults to null)
  83951. */
  83952. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  83953. /**
  83954. * Finish the loading sequence of a texture flagged as delayed load.
  83955. * @hidden
  83956. */
  83957. delayLoad(): void;
  83958. private _prepareRowForTextureGeneration;
  83959. /**
  83960. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  83961. * @returns the transform matrix of the texture.
  83962. */
  83963. getTextureMatrix(): Matrix;
  83964. /**
  83965. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  83966. * @returns The reflection texture transform
  83967. */
  83968. getReflectionTextureMatrix(): Matrix;
  83969. /**
  83970. * Clones the texture.
  83971. * @returns the cloned texture
  83972. */
  83973. clone(): Texture;
  83974. /**
  83975. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  83976. * @returns The JSON representation of the texture
  83977. */
  83978. serialize(): any;
  83979. /**
  83980. * Get the current class name of the texture useful for serialization or dynamic coding.
  83981. * @returns "Texture"
  83982. */
  83983. getClassName(): string;
  83984. /**
  83985. * Dispose the texture and release its associated resources.
  83986. */
  83987. dispose(): void;
  83988. /**
  83989. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  83990. * @param parsedTexture Define the JSON representation of the texture
  83991. * @param scene Define the scene the parsed texture should be instantiated in
  83992. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  83993. * @returns The parsed texture if successful
  83994. */
  83995. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  83996. /**
  83997. * Creates a texture from its base 64 representation.
  83998. * @param data Define the base64 payload without the data: prefix
  83999. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  84000. * @param scene Define the scene the texture should belong to
  84001. * @param noMipmap Forces the texture to not create mip map information if true
  84002. * @param invertY define if the texture needs to be inverted on the y axis during loading
  84003. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  84004. * @param onLoad define a callback triggered when the texture has been loaded
  84005. * @param onError define a callback triggered when an error occurred during the loading session
  84006. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  84007. * @returns the created texture
  84008. */
  84009. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  84010. /**
  84011. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  84012. * @param data Define the base64 payload without the data: prefix
  84013. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  84014. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  84015. * @param scene Define the scene the texture should belong to
  84016. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  84017. * @param noMipmap Forces the texture to not create mip map information if true
  84018. * @param invertY define if the texture needs to be inverted on the y axis during loading
  84019. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  84020. * @param onLoad define a callback triggered when the texture has been loaded
  84021. * @param onError define a callback triggered when an error occurred during the loading session
  84022. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  84023. * @returns the created texture
  84024. */
  84025. static LoadFromDataString(name: string, buffer: any, scene: Scene, deleteBuffer?: boolean, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number): Texture;
  84026. }
  84027. }
  84028. declare module BABYLON {
  84029. /**
  84030. * PostProcessManager is used to manage one or more post processes or post process pipelines
  84031. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  84032. */
  84033. export class PostProcessManager {
  84034. private _scene;
  84035. private _indexBuffer;
  84036. private _vertexBuffers;
  84037. /**
  84038. * Creates a new instance PostProcess
  84039. * @param scene The scene that the post process is associated with.
  84040. */
  84041. constructor(scene: Scene);
  84042. private _prepareBuffers;
  84043. private _buildIndexBuffer;
  84044. /**
  84045. * Rebuilds the vertex buffers of the manager.
  84046. * @hidden
  84047. */
  84048. _rebuild(): void;
  84049. /**
  84050. * Prepares a frame to be run through a post process.
  84051. * @param sourceTexture The input texture to the post procesess. (default: null)
  84052. * @param postProcesses An array of post processes to be run. (default: null)
  84053. * @returns True if the post processes were able to be run.
  84054. * @hidden
  84055. */
  84056. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  84057. /**
  84058. * Manually render a set of post processes to a texture.
  84059. * @param postProcesses An array of post processes to be run.
  84060. * @param targetTexture The target texture to render to.
  84061. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  84062. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  84063. * @param lodLevel defines which lod of the texture to render to
  84064. */
  84065. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  84066. /**
  84067. * Finalize the result of the output of the postprocesses.
  84068. * @param doNotPresent If true the result will not be displayed to the screen.
  84069. * @param targetTexture The target texture to render to.
  84070. * @param faceIndex The index of the face to bind the target texture to.
  84071. * @param postProcesses The array of post processes to render.
  84072. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  84073. * @hidden
  84074. */
  84075. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  84076. /**
  84077. * Disposes of the post process manager.
  84078. */
  84079. dispose(): void;
  84080. }
  84081. }
  84082. declare module BABYLON {
  84083. /** Interface used by value gradients (color, factor, ...) */
  84084. export interface IValueGradient {
  84085. /**
  84086. * Gets or sets the gradient value (between 0 and 1)
  84087. */
  84088. gradient: number;
  84089. }
  84090. /** Class used to store color4 gradient */
  84091. export class ColorGradient implements IValueGradient {
  84092. /**
  84093. * Gets or sets the gradient value (between 0 and 1)
  84094. */
  84095. gradient: number;
  84096. /**
  84097. * Gets or sets first associated color
  84098. */
  84099. color1: Color4;
  84100. /**
  84101. * Gets or sets second associated color
  84102. */
  84103. color2?: Color4;
  84104. /**
  84105. * Will get a color picked randomly between color1 and color2.
  84106. * If color2 is undefined then color1 will be used
  84107. * @param result defines the target Color4 to store the result in
  84108. */
  84109. getColorToRef(result: Color4): void;
  84110. }
  84111. /** Class used to store color 3 gradient */
  84112. export class Color3Gradient implements IValueGradient {
  84113. /**
  84114. * Gets or sets the gradient value (between 0 and 1)
  84115. */
  84116. gradient: number;
  84117. /**
  84118. * Gets or sets the associated color
  84119. */
  84120. color: Color3;
  84121. }
  84122. /** Class used to store factor gradient */
  84123. export class FactorGradient implements IValueGradient {
  84124. /**
  84125. * Gets or sets the gradient value (between 0 and 1)
  84126. */
  84127. gradient: number;
  84128. /**
  84129. * Gets or sets first associated factor
  84130. */
  84131. factor1: number;
  84132. /**
  84133. * Gets or sets second associated factor
  84134. */
  84135. factor2?: number;
  84136. /**
  84137. * Will get a number picked randomly between factor1 and factor2.
  84138. * If factor2 is undefined then factor1 will be used
  84139. * @returns the picked number
  84140. */
  84141. getFactor(): number;
  84142. }
  84143. /**
  84144. * Helper used to simplify some generic gradient tasks
  84145. */
  84146. export class GradientHelper {
  84147. /**
  84148. * Gets the current gradient from an array of IValueGradient
  84149. * @param ratio defines the current ratio to get
  84150. * @param gradients defines the array of IValueGradient
  84151. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  84152. */
  84153. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  84154. }
  84155. }
  84156. declare module BABYLON {
  84157. interface ThinEngine {
  84158. /**
  84159. * Creates a dynamic texture
  84160. * @param width defines the width of the texture
  84161. * @param height defines the height of the texture
  84162. * @param generateMipMaps defines if the engine should generate the mip levels
  84163. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  84164. * @returns the dynamic texture inside an InternalTexture
  84165. */
  84166. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  84167. /**
  84168. * Update the content of a dynamic texture
  84169. * @param texture defines the texture to update
  84170. * @param canvas defines the canvas containing the source
  84171. * @param invertY defines if data must be stored with Y axis inverted
  84172. * @param premulAlpha defines if alpha is stored as premultiplied
  84173. * @param format defines the format of the data
  84174. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  84175. */
  84176. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  84177. }
  84178. }
  84179. declare module BABYLON {
  84180. /**
  84181. * Helper class used to generate a canvas to manipulate images
  84182. */
  84183. export class CanvasGenerator {
  84184. /**
  84185. * Create a new canvas (or offscreen canvas depending on the context)
  84186. * @param width defines the expected width
  84187. * @param height defines the expected height
  84188. * @return a new canvas or offscreen canvas
  84189. */
  84190. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  84191. }
  84192. }
  84193. declare module BABYLON {
  84194. /**
  84195. * A class extending Texture allowing drawing on a texture
  84196. * @see http://doc.babylonjs.com/how_to/dynamictexture
  84197. */
  84198. export class DynamicTexture extends Texture {
  84199. private _generateMipMaps;
  84200. private _canvas;
  84201. private _context;
  84202. private _engine;
  84203. /**
  84204. * Creates a DynamicTexture
  84205. * @param name defines the name of the texture
  84206. * @param options provides 3 alternatives for width and height of texture, a canvas, object with width and height properties, number for both width and height
  84207. * @param scene defines the scene where you want the texture
  84208. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  84209. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  84210. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  84211. */
  84212. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  84213. /**
  84214. * Get the current class name of the texture useful for serialization or dynamic coding.
  84215. * @returns "DynamicTexture"
  84216. */
  84217. getClassName(): string;
  84218. /**
  84219. * Gets the current state of canRescale
  84220. */
  84221. readonly canRescale: boolean;
  84222. private _recreate;
  84223. /**
  84224. * Scales the texture
  84225. * @param ratio the scale factor to apply to both width and height
  84226. */
  84227. scale(ratio: number): void;
  84228. /**
  84229. * Resizes the texture
  84230. * @param width the new width
  84231. * @param height the new height
  84232. */
  84233. scaleTo(width: number, height: number): void;
  84234. /**
  84235. * Gets the context of the canvas used by the texture
  84236. * @returns the canvas context of the dynamic texture
  84237. */
  84238. getContext(): CanvasRenderingContext2D;
  84239. /**
  84240. * Clears the texture
  84241. */
  84242. clear(): void;
  84243. /**
  84244. * Updates the texture
  84245. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  84246. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  84247. */
  84248. update(invertY?: boolean, premulAlpha?: boolean): void;
  84249. /**
  84250. * Draws text onto the texture
  84251. * @param text defines the text to be drawn
  84252. * @param x defines the placement of the text from the left
  84253. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  84254. * @param font defines the font to be used with font-style, font-size, font-name
  84255. * @param color defines the color used for the text
  84256. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  84257. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  84258. * @param update defines whether texture is immediately update (default is true)
  84259. */
  84260. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  84261. /**
  84262. * Clones the texture
  84263. * @returns the clone of the texture.
  84264. */
  84265. clone(): DynamicTexture;
  84266. /**
  84267. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  84268. * @returns a serialized dynamic texture object
  84269. */
  84270. serialize(): any;
  84271. /** @hidden */
  84272. _rebuild(): void;
  84273. }
  84274. }
  84275. declare module BABYLON {
  84276. interface AbstractScene {
  84277. /**
  84278. * The list of procedural textures added to the scene
  84279. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84280. */
  84281. proceduralTextures: Array<ProceduralTexture>;
  84282. }
  84283. /**
  84284. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  84285. * in a given scene.
  84286. */
  84287. export class ProceduralTextureSceneComponent implements ISceneComponent {
  84288. /**
  84289. * The component name helpfull to identify the component in the list of scene components.
  84290. */
  84291. readonly name: string;
  84292. /**
  84293. * The scene the component belongs to.
  84294. */
  84295. scene: Scene;
  84296. /**
  84297. * Creates a new instance of the component for the given scene
  84298. * @param scene Defines the scene to register the component in
  84299. */
  84300. constructor(scene: Scene);
  84301. /**
  84302. * Registers the component in a given scene
  84303. */
  84304. register(): void;
  84305. /**
  84306. * Rebuilds the elements related to this component in case of
  84307. * context lost for instance.
  84308. */
  84309. rebuild(): void;
  84310. /**
  84311. * Disposes the component and the associated ressources.
  84312. */
  84313. dispose(): void;
  84314. private _beforeClear;
  84315. }
  84316. }
  84317. declare module BABYLON {
  84318. interface ThinEngine {
  84319. /**
  84320. * Creates a new render target cube texture
  84321. * @param size defines the size of the texture
  84322. * @param options defines the options used to create the texture
  84323. * @returns a new render target cube texture stored in an InternalTexture
  84324. */
  84325. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  84326. }
  84327. }
  84328. declare module BABYLON {
  84329. /** @hidden */
  84330. export var proceduralVertexShader: {
  84331. name: string;
  84332. shader: string;
  84333. };
  84334. }
  84335. declare module BABYLON {
  84336. /**
  84337. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes calmpler' images.
  84338. * This is the base class of any Procedural texture and contains most of the shareable code.
  84339. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84340. */
  84341. export class ProceduralTexture extends Texture {
  84342. isCube: boolean;
  84343. /**
  84344. * Define if the texture is enabled or not (disabled texture will not render)
  84345. */
  84346. isEnabled: boolean;
  84347. /**
  84348. * Define if the texture must be cleared before rendering (default is true)
  84349. */
  84350. autoClear: boolean;
  84351. /**
  84352. * Callback called when the texture is generated
  84353. */
  84354. onGenerated: () => void;
  84355. /**
  84356. * Event raised when the texture is generated
  84357. */
  84358. onGeneratedObservable: Observable<ProceduralTexture>;
  84359. /** @hidden */
  84360. _generateMipMaps: boolean;
  84361. /** @hidden **/
  84362. _effect: Effect;
  84363. /** @hidden */
  84364. _textures: {
  84365. [key: string]: Texture;
  84366. };
  84367. private _size;
  84368. private _currentRefreshId;
  84369. private _refreshRate;
  84370. private _vertexBuffers;
  84371. private _indexBuffer;
  84372. private _uniforms;
  84373. private _samplers;
  84374. private _fragment;
  84375. private _floats;
  84376. private _ints;
  84377. private _floatsArrays;
  84378. private _colors3;
  84379. private _colors4;
  84380. private _vectors2;
  84381. private _vectors3;
  84382. private _matrices;
  84383. private _fallbackTexture;
  84384. private _fallbackTextureUsed;
  84385. private _engine;
  84386. private _cachedDefines;
  84387. private _contentUpdateId;
  84388. private _contentData;
  84389. /**
  84390. * Instantiates a new procedural texture.
  84391. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  84392. * This is the base class of any Procedural texture and contains most of the shareable code.
  84393. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84394. * @param name Define the name of the texture
  84395. * @param size Define the size of the texture to create
  84396. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  84397. * @param scene Define the scene the texture belongs to
  84398. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  84399. * @param generateMipMaps Define if the texture should creates mip maps or not
  84400. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  84401. */
  84402. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  84403. /**
  84404. * The effect that is created when initializing the post process.
  84405. * @returns The created effect corresponding the the postprocess.
  84406. */
  84407. getEffect(): Effect;
  84408. /**
  84409. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  84410. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  84411. */
  84412. getContent(): Nullable<ArrayBufferView>;
  84413. private _createIndexBuffer;
  84414. /** @hidden */
  84415. _rebuild(): void;
  84416. /**
  84417. * Resets the texture in order to recreate its associated resources.
  84418. * This can be called in case of context loss
  84419. */
  84420. reset(): void;
  84421. protected _getDefines(): string;
  84422. /**
  84423. * Is the texture ready to be used ? (rendered at least once)
  84424. * @returns true if ready, otherwise, false.
  84425. */
  84426. isReady(): boolean;
  84427. /**
  84428. * Resets the refresh counter of the texture and start bak from scratch.
  84429. * Could be useful to regenerate the texture if it is setup to render only once.
  84430. */
  84431. resetRefreshCounter(): void;
  84432. /**
  84433. * Set the fragment shader to use in order to render the texture.
  84434. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  84435. */
  84436. setFragment(fragment: any): void;
  84437. /**
  84438. * Define the refresh rate of the texture or the rendering frequency.
  84439. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  84440. */
  84441. refreshRate: number;
  84442. /** @hidden */
  84443. _shouldRender(): boolean;
  84444. /**
  84445. * Get the size the texture is rendering at.
  84446. * @returns the size (texture is always squared)
  84447. */
  84448. getRenderSize(): number;
  84449. /**
  84450. * Resize the texture to new value.
  84451. * @param size Define the new size the texture should have
  84452. * @param generateMipMaps Define whether the new texture should create mip maps
  84453. */
  84454. resize(size: number, generateMipMaps: boolean): void;
  84455. private _checkUniform;
  84456. /**
  84457. * Set a texture in the shader program used to render.
  84458. * @param name Define the name of the uniform samplers as defined in the shader
  84459. * @param texture Define the texture to bind to this sampler
  84460. * @return the texture itself allowing "fluent" like uniform updates
  84461. */
  84462. setTexture(name: string, texture: Texture): ProceduralTexture;
  84463. /**
  84464. * Set a float in the shader.
  84465. * @param name Define the name of the uniform as defined in the shader
  84466. * @param value Define the value to give to the uniform
  84467. * @return the texture itself allowing "fluent" like uniform updates
  84468. */
  84469. setFloat(name: string, value: number): ProceduralTexture;
  84470. /**
  84471. * Set a int in the shader.
  84472. * @param name Define the name of the uniform as defined in the shader
  84473. * @param value Define the value to give to the uniform
  84474. * @return the texture itself allowing "fluent" like uniform updates
  84475. */
  84476. setInt(name: string, value: number): ProceduralTexture;
  84477. /**
  84478. * Set an array of floats in the shader.
  84479. * @param name Define the name of the uniform as defined in the shader
  84480. * @param value Define the value to give to the uniform
  84481. * @return the texture itself allowing "fluent" like uniform updates
  84482. */
  84483. setFloats(name: string, value: number[]): ProceduralTexture;
  84484. /**
  84485. * Set a vec3 in the shader from a Color3.
  84486. * @param name Define the name of the uniform as defined in the shader
  84487. * @param value Define the value to give to the uniform
  84488. * @return the texture itself allowing "fluent" like uniform updates
  84489. */
  84490. setColor3(name: string, value: Color3): ProceduralTexture;
  84491. /**
  84492. * Set a vec4 in the shader from a Color4.
  84493. * @param name Define the name of the uniform as defined in the shader
  84494. * @param value Define the value to give to the uniform
  84495. * @return the texture itself allowing "fluent" like uniform updates
  84496. */
  84497. setColor4(name: string, value: Color4): ProceduralTexture;
  84498. /**
  84499. * Set a vec2 in the shader from a Vector2.
  84500. * @param name Define the name of the uniform as defined in the shader
  84501. * @param value Define the value to give to the uniform
  84502. * @return the texture itself allowing "fluent" like uniform updates
  84503. */
  84504. setVector2(name: string, value: Vector2): ProceduralTexture;
  84505. /**
  84506. * Set a vec3 in the shader from a Vector3.
  84507. * @param name Define the name of the uniform as defined in the shader
  84508. * @param value Define the value to give to the uniform
  84509. * @return the texture itself allowing "fluent" like uniform updates
  84510. */
  84511. setVector3(name: string, value: Vector3): ProceduralTexture;
  84512. /**
  84513. * Set a mat4 in the shader from a MAtrix.
  84514. * @param name Define the name of the uniform as defined in the shader
  84515. * @param value Define the value to give to the uniform
  84516. * @return the texture itself allowing "fluent" like uniform updates
  84517. */
  84518. setMatrix(name: string, value: Matrix): ProceduralTexture;
  84519. /**
  84520. * Render the texture to its associated render target.
  84521. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  84522. */
  84523. render(useCameraPostProcess?: boolean): void;
  84524. /**
  84525. * Clone the texture.
  84526. * @returns the cloned texture
  84527. */
  84528. clone(): ProceduralTexture;
  84529. /**
  84530. * Dispose the texture and release its asoociated resources.
  84531. */
  84532. dispose(): void;
  84533. }
  84534. }
  84535. declare module BABYLON {
  84536. /**
  84537. * This represents the base class for particle system in Babylon.
  84538. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  84539. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  84540. * @example https://doc.babylonjs.com/babylon101/particles
  84541. */
  84542. export class BaseParticleSystem {
  84543. /**
  84544. * Source color is added to the destination color without alpha affecting the result
  84545. */
  84546. static BLENDMODE_ONEONE: number;
  84547. /**
  84548. * Blend current color and particle color using particle’s alpha
  84549. */
  84550. static BLENDMODE_STANDARD: number;
  84551. /**
  84552. * Add current color and particle color multiplied by particle’s alpha
  84553. */
  84554. static BLENDMODE_ADD: number;
  84555. /**
  84556. * Multiply current color with particle color
  84557. */
  84558. static BLENDMODE_MULTIPLY: number;
  84559. /**
  84560. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  84561. */
  84562. static BLENDMODE_MULTIPLYADD: number;
  84563. /**
  84564. * List of animations used by the particle system.
  84565. */
  84566. animations: Animation[];
  84567. /**
  84568. * The id of the Particle system.
  84569. */
  84570. id: string;
  84571. /**
  84572. * The friendly name of the Particle system.
  84573. */
  84574. name: string;
  84575. /**
  84576. * The rendering group used by the Particle system to chose when to render.
  84577. */
  84578. renderingGroupId: number;
  84579. /**
  84580. * The emitter represents the Mesh or position we are attaching the particle system to.
  84581. */
  84582. emitter: Nullable<AbstractMesh | Vector3>;
  84583. /**
  84584. * The maximum number of particles to emit per frame
  84585. */
  84586. emitRate: number;
  84587. /**
  84588. * If you want to launch only a few particles at once, that can be done, as well.
  84589. */
  84590. manualEmitCount: number;
  84591. /**
  84592. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  84593. */
  84594. updateSpeed: number;
  84595. /**
  84596. * The amount of time the particle system is running (depends of the overall update speed).
  84597. */
  84598. targetStopDuration: number;
  84599. /**
  84600. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  84601. */
  84602. disposeOnStop: boolean;
  84603. /**
  84604. * Minimum power of emitting particles.
  84605. */
  84606. minEmitPower: number;
  84607. /**
  84608. * Maximum power of emitting particles.
  84609. */
  84610. maxEmitPower: number;
  84611. /**
  84612. * Minimum life time of emitting particles.
  84613. */
  84614. minLifeTime: number;
  84615. /**
  84616. * Maximum life time of emitting particles.
  84617. */
  84618. maxLifeTime: number;
  84619. /**
  84620. * Minimum Size of emitting particles.
  84621. */
  84622. minSize: number;
  84623. /**
  84624. * Maximum Size of emitting particles.
  84625. */
  84626. maxSize: number;
  84627. /**
  84628. * Minimum scale of emitting particles on X axis.
  84629. */
  84630. minScaleX: number;
  84631. /**
  84632. * Maximum scale of emitting particles on X axis.
  84633. */
  84634. maxScaleX: number;
  84635. /**
  84636. * Minimum scale of emitting particles on Y axis.
  84637. */
  84638. minScaleY: number;
  84639. /**
  84640. * Maximum scale of emitting particles on Y axis.
  84641. */
  84642. maxScaleY: number;
  84643. /**
  84644. * Gets or sets the minimal initial rotation in radians.
  84645. */
  84646. minInitialRotation: number;
  84647. /**
  84648. * Gets or sets the maximal initial rotation in radians.
  84649. */
  84650. maxInitialRotation: number;
  84651. /**
  84652. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  84653. */
  84654. minAngularSpeed: number;
  84655. /**
  84656. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  84657. */
  84658. maxAngularSpeed: number;
  84659. /**
  84660. * The texture used to render each particle. (this can be a spritesheet)
  84661. */
  84662. particleTexture: Nullable<Texture>;
  84663. /**
  84664. * The layer mask we are rendering the particles through.
  84665. */
  84666. layerMask: number;
  84667. /**
  84668. * This can help using your own shader to render the particle system.
  84669. * The according effect will be created
  84670. */
  84671. customShader: any;
  84672. /**
  84673. * By default particle system starts as soon as they are created. This prevents the
  84674. * automatic start to happen and let you decide when to start emitting particles.
  84675. */
  84676. preventAutoStart: boolean;
  84677. private _noiseTexture;
  84678. /**
  84679. * Gets or sets a texture used to add random noise to particle positions
  84680. */
  84681. noiseTexture: Nullable<ProceduralTexture>;
  84682. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  84683. noiseStrength: Vector3;
  84684. /**
  84685. * Callback triggered when the particle animation is ending.
  84686. */
  84687. onAnimationEnd: Nullable<() => void>;
  84688. /**
  84689. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  84690. */
  84691. blendMode: number;
  84692. /**
  84693. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  84694. * to override the particles.
  84695. */
  84696. forceDepthWrite: boolean;
  84697. /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
  84698. preWarmCycles: number;
  84699. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  84700. preWarmStepOffset: number;
  84701. /**
  84702. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  84703. */
  84704. spriteCellChangeSpeed: number;
  84705. /**
  84706. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  84707. */
  84708. startSpriteCellID: number;
  84709. /**
  84710. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  84711. */
  84712. endSpriteCellID: number;
  84713. /**
  84714. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  84715. */
  84716. spriteCellWidth: number;
  84717. /**
  84718. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  84719. */
  84720. spriteCellHeight: number;
  84721. /**
  84722. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  84723. */
  84724. spriteRandomStartCell: boolean;
  84725. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  84726. translationPivot: Vector2;
  84727. /** @hidden */
  84728. protected _isAnimationSheetEnabled: boolean;
  84729. /**
  84730. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  84731. */
  84732. beginAnimationOnStart: boolean;
  84733. /**
  84734. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  84735. */
  84736. beginAnimationFrom: number;
  84737. /**
  84738. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  84739. */
  84740. beginAnimationTo: number;
  84741. /**
  84742. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  84743. */
  84744. beginAnimationLoop: boolean;
  84745. /**
  84746. * Gets or sets a world offset applied to all particles
  84747. */
  84748. worldOffset: Vector3;
  84749. /**
  84750. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  84751. */
  84752. isAnimationSheetEnabled: boolean;
  84753. /**
  84754. * Get hosting scene
  84755. * @returns the scene
  84756. */
  84757. getScene(): Scene;
  84758. /**
  84759. * You can use gravity if you want to give an orientation to your particles.
  84760. */
  84761. gravity: Vector3;
  84762. protected _colorGradients: Nullable<Array<ColorGradient>>;
  84763. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  84764. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  84765. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  84766. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  84767. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  84768. protected _dragGradients: Nullable<Array<FactorGradient>>;
  84769. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  84770. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  84771. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  84772. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  84773. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  84774. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  84775. /**
  84776. * Defines the delay in milliseconds before starting the system (0 by default)
  84777. */
  84778. startDelay: number;
  84779. /**
  84780. * Gets the current list of drag gradients.
  84781. * You must use addDragGradient and removeDragGradient to udpate this list
  84782. * @returns the list of drag gradients
  84783. */
  84784. getDragGradients(): Nullable<Array<FactorGradient>>;
  84785. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  84786. limitVelocityDamping: number;
  84787. /**
  84788. * Gets the current list of limit velocity gradients.
  84789. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  84790. * @returns the list of limit velocity gradients
  84791. */
  84792. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  84793. /**
  84794. * Gets the current list of color gradients.
  84795. * You must use addColorGradient and removeColorGradient to udpate this list
  84796. * @returns the list of color gradients
  84797. */
  84798. getColorGradients(): Nullable<Array<ColorGradient>>;
  84799. /**
  84800. * Gets the current list of size gradients.
  84801. * You must use addSizeGradient and removeSizeGradient to udpate this list
  84802. * @returns the list of size gradients
  84803. */
  84804. getSizeGradients(): Nullable<Array<FactorGradient>>;
  84805. /**
  84806. * Gets the current list of color remap gradients.
  84807. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  84808. * @returns the list of color remap gradients
  84809. */
  84810. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  84811. /**
  84812. * Gets the current list of alpha remap gradients.
  84813. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  84814. * @returns the list of alpha remap gradients
  84815. */
  84816. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  84817. /**
  84818. * Gets the current list of life time gradients.
  84819. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  84820. * @returns the list of life time gradients
  84821. */
  84822. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  84823. /**
  84824. * Gets the current list of angular speed gradients.
  84825. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  84826. * @returns the list of angular speed gradients
  84827. */
  84828. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  84829. /**
  84830. * Gets the current list of velocity gradients.
  84831. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  84832. * @returns the list of velocity gradients
  84833. */
  84834. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  84835. /**
  84836. * Gets the current list of start size gradients.
  84837. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  84838. * @returns the list of start size gradients
  84839. */
  84840. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  84841. /**
  84842. * Gets the current list of emit rate gradients.
  84843. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  84844. * @returns the list of emit rate gradients
  84845. */
  84846. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  84847. /**
  84848. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  84849. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84850. */
  84851. direction1: Vector3;
  84852. /**
  84853. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  84854. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84855. */
  84856. direction2: Vector3;
  84857. /**
  84858. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  84859. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84860. */
  84861. minEmitBox: Vector3;
  84862. /**
  84863. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  84864. * This only works when particleEmitterTyps is a BoxParticleEmitter
  84865. */
  84866. maxEmitBox: Vector3;
  84867. /**
  84868. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  84869. */
  84870. color1: Color4;
  84871. /**
  84872. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  84873. */
  84874. color2: Color4;
  84875. /**
  84876. * Color the particle will have at the end of its lifetime
  84877. */
  84878. colorDead: Color4;
  84879. /**
  84880. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  84881. */
  84882. textureMask: Color4;
  84883. /**
  84884. * The particle emitter type defines the emitter used by the particle system.
  84885. * It can be for example box, sphere, or cone...
  84886. */
  84887. particleEmitterType: IParticleEmitterType;
  84888. /** @hidden */
  84889. _isSubEmitter: boolean;
  84890. /**
  84891. * Gets or sets the billboard mode to use when isBillboardBased = true.
  84892. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  84893. */
  84894. billboardMode: number;
  84895. protected _isBillboardBased: boolean;
  84896. /**
  84897. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  84898. */
  84899. isBillboardBased: boolean;
  84900. /**
  84901. * The scene the particle system belongs to.
  84902. */
  84903. protected _scene: Scene;
  84904. /**
  84905. * Local cache of defines for image processing.
  84906. */
  84907. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  84908. /**
  84909. * Default configuration related to image processing available in the standard Material.
  84910. */
  84911. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  84912. /**
  84913. * Gets the image processing configuration used either in this material.
  84914. */
  84915. /**
  84916. * Sets the Default image processing configuration used either in the this material.
  84917. *
  84918. * If sets to null, the scene one is in use.
  84919. */
  84920. imageProcessingConfiguration: ImageProcessingConfiguration;
  84921. /**
  84922. * Attaches a new image processing configuration to the Standard Material.
  84923. * @param configuration
  84924. */
  84925. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  84926. /** @hidden */
  84927. protected _reset(): void;
  84928. /** @hidden */
  84929. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  84930. /**
  84931. * Instantiates a particle system.
  84932. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  84933. * @param name The name of the particle system
  84934. */
  84935. constructor(name: string);
  84936. /**
  84937. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  84938. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  84939. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  84940. * @returns the emitter
  84941. */
  84942. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  84943. /**
  84944. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  84945. * @param radius The radius of the hemisphere to emit from
  84946. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  84947. * @returns the emitter
  84948. */
  84949. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  84950. /**
  84951. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  84952. * @param radius The radius of the sphere to emit from
  84953. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  84954. * @returns the emitter
  84955. */
  84956. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  84957. /**
  84958. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  84959. * @param radius The radius of the sphere to emit from
  84960. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  84961. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  84962. * @returns the emitter
  84963. */
  84964. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  84965. /**
  84966. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  84967. * @param radius The radius of the emission cylinder
  84968. * @param height The height of the emission cylinder
  84969. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  84970. * @param directionRandomizer How much to randomize the particle direction [0-1]
  84971. * @returns the emitter
  84972. */
  84973. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  84974. /**
  84975. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  84976. * @param radius The radius of the cylinder to emit from
  84977. * @param height The height of the emission cylinder
  84978. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  84979. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  84980. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  84981. * @returns the emitter
  84982. */
  84983. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  84984. /**
  84985. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  84986. * @param radius The radius of the cone to emit from
  84987. * @param angle The base angle of the cone
  84988. * @returns the emitter
  84989. */
  84990. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  84991. /**
  84992. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  84993. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  84994. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  84995. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  84996. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  84997. * @returns the emitter
  84998. */
  84999. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  85000. }
  85001. }
  85002. declare module BABYLON {
  85003. /**
  85004. * Type of sub emitter
  85005. */
  85006. export enum SubEmitterType {
  85007. /**
  85008. * Attached to the particle over it's lifetime
  85009. */
  85010. ATTACHED = 0,
  85011. /**
  85012. * Created when the particle dies
  85013. */
  85014. END = 1
  85015. }
  85016. /**
  85017. * Sub emitter class used to emit particles from an existing particle
  85018. */
  85019. export class SubEmitter {
  85020. /**
  85021. * the particle system to be used by the sub emitter
  85022. */
  85023. particleSystem: ParticleSystem;
  85024. /**
  85025. * Type of the submitter (Default: END)
  85026. */
  85027. type: SubEmitterType;
  85028. /**
  85029. * If the particle should inherit the direction from the particle it's attached to. (+Y will face the direction the particle is moving) (Default: false)
  85030. * Note: This only is supported when using an emitter of type Mesh
  85031. */
  85032. inheritDirection: boolean;
  85033. /**
  85034. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  85035. */
  85036. inheritedVelocityAmount: number;
  85037. /**
  85038. * Creates a sub emitter
  85039. * @param particleSystem the particle system to be used by the sub emitter
  85040. */
  85041. constructor(
  85042. /**
  85043. * the particle system to be used by the sub emitter
  85044. */
  85045. particleSystem: ParticleSystem);
  85046. /**
  85047. * Clones the sub emitter
  85048. * @returns the cloned sub emitter
  85049. */
  85050. clone(): SubEmitter;
  85051. /**
  85052. * Serialize current object to a JSON object
  85053. * @returns the serialized object
  85054. */
  85055. serialize(): any;
  85056. /** @hidden */
  85057. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  85058. /**
  85059. * Creates a new SubEmitter from a serialized JSON version
  85060. * @param serializationObject defines the JSON object to read from
  85061. * @param scene defines the hosting scene
  85062. * @param rootUrl defines the rootUrl for data loading
  85063. * @returns a new SubEmitter
  85064. */
  85065. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  85066. /** Release associated resources */
  85067. dispose(): void;
  85068. }
  85069. }
  85070. declare module BABYLON {
  85071. /** @hidden */
  85072. export var clipPlaneFragmentDeclaration: {
  85073. name: string;
  85074. shader: string;
  85075. };
  85076. }
  85077. declare module BABYLON {
  85078. /** @hidden */
  85079. export var imageProcessingDeclaration: {
  85080. name: string;
  85081. shader: string;
  85082. };
  85083. }
  85084. declare module BABYLON {
  85085. /** @hidden */
  85086. export var imageProcessingFunctions: {
  85087. name: string;
  85088. shader: string;
  85089. };
  85090. }
  85091. declare module BABYLON {
  85092. /** @hidden */
  85093. export var clipPlaneFragment: {
  85094. name: string;
  85095. shader: string;
  85096. };
  85097. }
  85098. declare module BABYLON {
  85099. /** @hidden */
  85100. export var particlesPixelShader: {
  85101. name: string;
  85102. shader: string;
  85103. };
  85104. }
  85105. declare module BABYLON {
  85106. /** @hidden */
  85107. export var clipPlaneVertexDeclaration: {
  85108. name: string;
  85109. shader: string;
  85110. };
  85111. }
  85112. declare module BABYLON {
  85113. /** @hidden */
  85114. export var clipPlaneVertex: {
  85115. name: string;
  85116. shader: string;
  85117. };
  85118. }
  85119. declare module BABYLON {
  85120. /** @hidden */
  85121. export var particlesVertexShader: {
  85122. name: string;
  85123. shader: string;
  85124. };
  85125. }
  85126. declare module BABYLON {
  85127. /**
  85128. * This represents a particle system in Babylon.
  85129. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  85130. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  85131. * @example https://doc.babylonjs.com/babylon101/particles
  85132. */
  85133. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  85134. /**
  85135. * Billboard mode will only apply to Y axis
  85136. */
  85137. static readonly BILLBOARDMODE_Y: number;
  85138. /**
  85139. * Billboard mode will apply to all axes
  85140. */
  85141. static readonly BILLBOARDMODE_ALL: number;
  85142. /**
  85143. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  85144. */
  85145. static readonly BILLBOARDMODE_STRETCHED: number;
  85146. /**
  85147. * This function can be defined to provide custom update for active particles.
  85148. * This function will be called instead of regular update (age, position, color, etc.).
  85149. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  85150. */
  85151. updateFunction: (particles: Particle[]) => void;
  85152. private _emitterWorldMatrix;
  85153. /**
  85154. * This function can be defined to specify initial direction for every new particle.
  85155. * It by default use the emitterType defined function
  85156. */
  85157. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  85158. /**
  85159. * This function can be defined to specify initial position for every new particle.
  85160. * It by default use the emitterType defined function
  85161. */
  85162. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  85163. /**
  85164. * @hidden
  85165. */
  85166. _inheritedVelocityOffset: Vector3;
  85167. /**
  85168. * An event triggered when the system is disposed
  85169. */
  85170. onDisposeObservable: Observable<ParticleSystem>;
  85171. private _onDisposeObserver;
  85172. /**
  85173. * Sets a callback that will be triggered when the system is disposed
  85174. */
  85175. onDispose: () => void;
  85176. private _particles;
  85177. private _epsilon;
  85178. private _capacity;
  85179. private _stockParticles;
  85180. private _newPartsExcess;
  85181. private _vertexData;
  85182. private _vertexBuffer;
  85183. private _vertexBuffers;
  85184. private _spriteBuffer;
  85185. private _indexBuffer;
  85186. private _effect;
  85187. private _customEffect;
  85188. private _cachedDefines;
  85189. private _scaledColorStep;
  85190. private _colorDiff;
  85191. private _scaledDirection;
  85192. private _scaledGravity;
  85193. private _currentRenderId;
  85194. private _alive;
  85195. private _useInstancing;
  85196. private _started;
  85197. private _stopped;
  85198. private _actualFrame;
  85199. private _scaledUpdateSpeed;
  85200. private _vertexBufferSize;
  85201. /** @hidden */
  85202. _currentEmitRateGradient: Nullable<FactorGradient>;
  85203. /** @hidden */
  85204. _currentEmitRate1: number;
  85205. /** @hidden */
  85206. _currentEmitRate2: number;
  85207. /** @hidden */
  85208. _currentStartSizeGradient: Nullable<FactorGradient>;
  85209. /** @hidden */
  85210. _currentStartSize1: number;
  85211. /** @hidden */
  85212. _currentStartSize2: number;
  85213. private readonly _rawTextureWidth;
  85214. private _rampGradientsTexture;
  85215. private _useRampGradients;
  85216. /** Gets or sets a boolean indicating that ramp gradients must be used
  85217. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  85218. */
  85219. useRampGradients: boolean;
  85220. /**
  85221. * The Sub-emitters templates that will be used to generate the sub particle system to be associated with the system, this property is used by the root particle system only.
  85222. * When a particle is spawned, an array will be chosen at random and all the emitters in that array will be attached to the particle. (Default: [])
  85223. */
  85224. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  85225. private _subEmitters;
  85226. /**
  85227. * @hidden
  85228. * If the particle systems emitter should be disposed when the particle system is disposed
  85229. */
  85230. _disposeEmitterOnDispose: boolean;
  85231. /**
  85232. * The current active Sub-systems, this property is used by the root particle system only.
  85233. */
  85234. activeSubSystems: Array<ParticleSystem>;
  85235. private _rootParticleSystem;
  85236. /**
  85237. * Gets the current list of active particles
  85238. */
  85239. readonly particles: Particle[];
  85240. /**
  85241. * Returns the string "ParticleSystem"
  85242. * @returns a string containing the class name
  85243. */
  85244. getClassName(): string;
  85245. /**
  85246. * Instantiates a particle system.
  85247. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  85248. * @param name The name of the particle system
  85249. * @param capacity The max number of particles alive at the same time
  85250. * @param scene The scene the particle system belongs to
  85251. * @param customEffect a custom effect used to change the way particles are rendered by default
  85252. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  85253. * @param epsilon Offset used to render the particles
  85254. */
  85255. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  85256. private _addFactorGradient;
  85257. private _removeFactorGradient;
  85258. /**
  85259. * Adds a new life time gradient
  85260. * @param gradient defines the gradient to use (between 0 and 1)
  85261. * @param factor defines the life time factor to affect to the specified gradient
  85262. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85263. * @returns the current particle system
  85264. */
  85265. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85266. /**
  85267. * Remove a specific life time gradient
  85268. * @param gradient defines the gradient to remove
  85269. * @returns the current particle system
  85270. */
  85271. removeLifeTimeGradient(gradient: number): IParticleSystem;
  85272. /**
  85273. * Adds a new size gradient
  85274. * @param gradient defines the gradient to use (between 0 and 1)
  85275. * @param factor defines the size factor to affect to the specified gradient
  85276. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85277. * @returns the current particle system
  85278. */
  85279. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85280. /**
  85281. * Remove a specific size gradient
  85282. * @param gradient defines the gradient to remove
  85283. * @returns the current particle system
  85284. */
  85285. removeSizeGradient(gradient: number): IParticleSystem;
  85286. /**
  85287. * Adds a new color remap gradient
  85288. * @param gradient defines the gradient to use (between 0 and 1)
  85289. * @param min defines the color remap minimal range
  85290. * @param max defines the color remap maximal range
  85291. * @returns the current particle system
  85292. */
  85293. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  85294. /**
  85295. * Remove a specific color remap gradient
  85296. * @param gradient defines the gradient to remove
  85297. * @returns the current particle system
  85298. */
  85299. removeColorRemapGradient(gradient: number): IParticleSystem;
  85300. /**
  85301. * Adds a new alpha remap gradient
  85302. * @param gradient defines the gradient to use (between 0 and 1)
  85303. * @param min defines the alpha remap minimal range
  85304. * @param max defines the alpha remap maximal range
  85305. * @returns the current particle system
  85306. */
  85307. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  85308. /**
  85309. * Remove a specific alpha remap gradient
  85310. * @param gradient defines the gradient to remove
  85311. * @returns the current particle system
  85312. */
  85313. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  85314. /**
  85315. * Adds a new angular speed gradient
  85316. * @param gradient defines the gradient to use (between 0 and 1)
  85317. * @param factor defines the angular speed to affect to the specified gradient
  85318. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85319. * @returns the current particle system
  85320. */
  85321. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85322. /**
  85323. * Remove a specific angular speed gradient
  85324. * @param gradient defines the gradient to remove
  85325. * @returns the current particle system
  85326. */
  85327. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  85328. /**
  85329. * Adds a new velocity gradient
  85330. * @param gradient defines the gradient to use (between 0 and 1)
  85331. * @param factor defines the velocity to affect to the specified gradient
  85332. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85333. * @returns the current particle system
  85334. */
  85335. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85336. /**
  85337. * Remove a specific velocity gradient
  85338. * @param gradient defines the gradient to remove
  85339. * @returns the current particle system
  85340. */
  85341. removeVelocityGradient(gradient: number): IParticleSystem;
  85342. /**
  85343. * Adds a new limit velocity gradient
  85344. * @param gradient defines the gradient to use (between 0 and 1)
  85345. * @param factor defines the limit velocity value to affect to the specified gradient
  85346. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85347. * @returns the current particle system
  85348. */
  85349. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85350. /**
  85351. * Remove a specific limit velocity gradient
  85352. * @param gradient defines the gradient to remove
  85353. * @returns the current particle system
  85354. */
  85355. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  85356. /**
  85357. * Adds a new drag gradient
  85358. * @param gradient defines the gradient to use (between 0 and 1)
  85359. * @param factor defines the drag value to affect to the specified gradient
  85360. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85361. * @returns the current particle system
  85362. */
  85363. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85364. /**
  85365. * Remove a specific drag gradient
  85366. * @param gradient defines the gradient to remove
  85367. * @returns the current particle system
  85368. */
  85369. removeDragGradient(gradient: number): IParticleSystem;
  85370. /**
  85371. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  85372. * @param gradient defines the gradient to use (between 0 and 1)
  85373. * @param factor defines the emit rate value to affect to the specified gradient
  85374. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85375. * @returns the current particle system
  85376. */
  85377. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85378. /**
  85379. * Remove a specific emit rate gradient
  85380. * @param gradient defines the gradient to remove
  85381. * @returns the current particle system
  85382. */
  85383. removeEmitRateGradient(gradient: number): IParticleSystem;
  85384. /**
  85385. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  85386. * @param gradient defines the gradient to use (between 0 and 1)
  85387. * @param factor defines the start size value to affect to the specified gradient
  85388. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85389. * @returns the current particle system
  85390. */
  85391. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85392. /**
  85393. * Remove a specific start size gradient
  85394. * @param gradient defines the gradient to remove
  85395. * @returns the current particle system
  85396. */
  85397. removeStartSizeGradient(gradient: number): IParticleSystem;
  85398. private _createRampGradientTexture;
  85399. /**
  85400. * Gets the current list of ramp gradients.
  85401. * You must use addRampGradient and removeRampGradient to udpate this list
  85402. * @returns the list of ramp gradients
  85403. */
  85404. getRampGradients(): Nullable<Array<Color3Gradient>>;
  85405. /**
  85406. * Adds a new ramp gradient used to remap particle colors
  85407. * @param gradient defines the gradient to use (between 0 and 1)
  85408. * @param color defines the color to affect to the specified gradient
  85409. * @returns the current particle system
  85410. */
  85411. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  85412. /**
  85413. * Remove a specific ramp gradient
  85414. * @param gradient defines the gradient to remove
  85415. * @returns the current particle system
  85416. */
  85417. removeRampGradient(gradient: number): ParticleSystem;
  85418. /**
  85419. * Adds a new color gradient
  85420. * @param gradient defines the gradient to use (between 0 and 1)
  85421. * @param color1 defines the color to affect to the specified gradient
  85422. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  85423. * @returns this particle system
  85424. */
  85425. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  85426. /**
  85427. * Remove a specific color gradient
  85428. * @param gradient defines the gradient to remove
  85429. * @returns this particle system
  85430. */
  85431. removeColorGradient(gradient: number): IParticleSystem;
  85432. private _fetchR;
  85433. protected _reset(): void;
  85434. private _resetEffect;
  85435. private _createVertexBuffers;
  85436. private _createIndexBuffer;
  85437. /**
  85438. * Gets the maximum number of particles active at the same time.
  85439. * @returns The max number of active particles.
  85440. */
  85441. getCapacity(): number;
  85442. /**
  85443. * Gets whether there are still active particles in the system.
  85444. * @returns True if it is alive, otherwise false.
  85445. */
  85446. isAlive(): boolean;
  85447. /**
  85448. * Gets if the system has been started. (Note: this will still be true after stop is called)
  85449. * @returns True if it has been started, otherwise false.
  85450. */
  85451. isStarted(): boolean;
  85452. private _prepareSubEmitterInternalArray;
  85453. /**
  85454. * Starts the particle system and begins to emit
  85455. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  85456. */
  85457. start(delay?: number): void;
  85458. /**
  85459. * Stops the particle system.
  85460. * @param stopSubEmitters if true it will stop the current system and all created sub-Systems if false it will stop the current root system only, this param is used by the root particle system only. the default value is true.
  85461. */
  85462. stop(stopSubEmitters?: boolean): void;
  85463. /**
  85464. * Remove all active particles
  85465. */
  85466. reset(): void;
  85467. /**
  85468. * @hidden (for internal use only)
  85469. */
  85470. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  85471. /**
  85472. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  85473. * Its lifetime will start back at 0.
  85474. */
  85475. recycleParticle: (particle: Particle) => void;
  85476. private _stopSubEmitters;
  85477. private _createParticle;
  85478. private _removeFromRoot;
  85479. private _emitFromParticle;
  85480. private _update;
  85481. /** @hidden */
  85482. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  85483. /** @hidden */
  85484. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  85485. /** @hidden */
  85486. private _getEffect;
  85487. /**
  85488. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  85489. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  85490. */
  85491. animate(preWarmOnly?: boolean): void;
  85492. private _appendParticleVertices;
  85493. /**
  85494. * Rebuilds the particle system.
  85495. */
  85496. rebuild(): void;
  85497. /**
  85498. * Is this system ready to be used/rendered
  85499. * @return true if the system is ready
  85500. */
  85501. isReady(): boolean;
  85502. private _render;
  85503. /**
  85504. * Renders the particle system in its current state.
  85505. * @returns the current number of particles
  85506. */
  85507. render(): number;
  85508. /**
  85509. * Disposes the particle system and free the associated resources
  85510. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  85511. */
  85512. dispose(disposeTexture?: boolean): void;
  85513. /**
  85514. * Clones the particle system.
  85515. * @param name The name of the cloned object
  85516. * @param newEmitter The new emitter to use
  85517. * @returns the cloned particle system
  85518. */
  85519. clone(name: string, newEmitter: any): ParticleSystem;
  85520. /**
  85521. * Serializes the particle system to a JSON object.
  85522. * @returns the JSON object
  85523. */
  85524. serialize(): any;
  85525. /** @hidden */
  85526. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  85527. /** @hidden */
  85528. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  85529. /**
  85530. * Parses a JSON object to create a particle system.
  85531. * @param parsedParticleSystem The JSON object to parse
  85532. * @param scene The scene to create the particle system in
  85533. * @param rootUrl The root url to use to load external dependencies like texture
  85534. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  85535. * @returns the Parsed particle system
  85536. */
  85537. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  85538. }
  85539. }
  85540. declare module BABYLON {
  85541. /**
  85542. * A particle represents one of the element emitted by a particle system.
  85543. * This is mainly define by its coordinates, direction, velocity and age.
  85544. */
  85545. export class Particle {
  85546. /**
  85547. * The particle system the particle belongs to.
  85548. */
  85549. particleSystem: ParticleSystem;
  85550. private static _Count;
  85551. /**
  85552. * Unique ID of the particle
  85553. */
  85554. id: number;
  85555. /**
  85556. * The world position of the particle in the scene.
  85557. */
  85558. position: Vector3;
  85559. /**
  85560. * The world direction of the particle in the scene.
  85561. */
  85562. direction: Vector3;
  85563. /**
  85564. * The color of the particle.
  85565. */
  85566. color: Color4;
  85567. /**
  85568. * The color change of the particle per step.
  85569. */
  85570. colorStep: Color4;
  85571. /**
  85572. * Defines how long will the life of the particle be.
  85573. */
  85574. lifeTime: number;
  85575. /**
  85576. * The current age of the particle.
  85577. */
  85578. age: number;
  85579. /**
  85580. * The current size of the particle.
  85581. */
  85582. size: number;
  85583. /**
  85584. * The current scale of the particle.
  85585. */
  85586. scale: Vector2;
  85587. /**
  85588. * The current angle of the particle.
  85589. */
  85590. angle: number;
  85591. /**
  85592. * Defines how fast is the angle changing.
  85593. */
  85594. angularSpeed: number;
  85595. /**
  85596. * Defines the cell index used by the particle to be rendered from a sprite.
  85597. */
  85598. cellIndex: number;
  85599. /**
  85600. * The information required to support color remapping
  85601. */
  85602. remapData: Vector4;
  85603. /** @hidden */
  85604. _randomCellOffset?: number;
  85605. /** @hidden */
  85606. _initialDirection: Nullable<Vector3>;
  85607. /** @hidden */
  85608. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  85609. /** @hidden */
  85610. _initialStartSpriteCellID: number;
  85611. /** @hidden */
  85612. _initialEndSpriteCellID: number;
  85613. /** @hidden */
  85614. _currentColorGradient: Nullable<ColorGradient>;
  85615. /** @hidden */
  85616. _currentColor1: Color4;
  85617. /** @hidden */
  85618. _currentColor2: Color4;
  85619. /** @hidden */
  85620. _currentSizeGradient: Nullable<FactorGradient>;
  85621. /** @hidden */
  85622. _currentSize1: number;
  85623. /** @hidden */
  85624. _currentSize2: number;
  85625. /** @hidden */
  85626. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  85627. /** @hidden */
  85628. _currentAngularSpeed1: number;
  85629. /** @hidden */
  85630. _currentAngularSpeed2: number;
  85631. /** @hidden */
  85632. _currentVelocityGradient: Nullable<FactorGradient>;
  85633. /** @hidden */
  85634. _currentVelocity1: number;
  85635. /** @hidden */
  85636. _currentVelocity2: number;
  85637. /** @hidden */
  85638. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  85639. /** @hidden */
  85640. _currentLimitVelocity1: number;
  85641. /** @hidden */
  85642. _currentLimitVelocity2: number;
  85643. /** @hidden */
  85644. _currentDragGradient: Nullable<FactorGradient>;
  85645. /** @hidden */
  85646. _currentDrag1: number;
  85647. /** @hidden */
  85648. _currentDrag2: number;
  85649. /** @hidden */
  85650. _randomNoiseCoordinates1: Vector3;
  85651. /** @hidden */
  85652. _randomNoiseCoordinates2: Vector3;
  85653. /**
  85654. * Creates a new instance Particle
  85655. * @param particleSystem the particle system the particle belongs to
  85656. */
  85657. constructor(
  85658. /**
  85659. * The particle system the particle belongs to.
  85660. */
  85661. particleSystem: ParticleSystem);
  85662. private updateCellInfoFromSystem;
  85663. /**
  85664. * Defines how the sprite cell index is updated for the particle
  85665. */
  85666. updateCellIndex(): void;
  85667. /** @hidden */
  85668. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  85669. /** @hidden */
  85670. _inheritParticleInfoToSubEmitters(): void;
  85671. /** @hidden */
  85672. _reset(): void;
  85673. /**
  85674. * Copy the properties of particle to another one.
  85675. * @param other the particle to copy the information to.
  85676. */
  85677. copyTo(other: Particle): void;
  85678. }
  85679. }
  85680. declare module BABYLON {
  85681. /**
  85682. * Particle emitter represents a volume emitting particles.
  85683. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  85684. */
  85685. export interface IParticleEmitterType {
  85686. /**
  85687. * Called by the particle System when the direction is computed for the created particle.
  85688. * @param worldMatrix is the world matrix of the particle system
  85689. * @param directionToUpdate is the direction vector to update with the result
  85690. * @param particle is the particle we are computed the direction for
  85691. */
  85692. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85693. /**
  85694. * Called by the particle System when the position is computed for the created particle.
  85695. * @param worldMatrix is the world matrix of the particle system
  85696. * @param positionToUpdate is the position vector to update with the result
  85697. * @param particle is the particle we are computed the position for
  85698. */
  85699. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85700. /**
  85701. * Clones the current emitter and returns a copy of it
  85702. * @returns the new emitter
  85703. */
  85704. clone(): IParticleEmitterType;
  85705. /**
  85706. * Called by the GPUParticleSystem to setup the update shader
  85707. * @param effect defines the update shader
  85708. */
  85709. applyToShader(effect: Effect): void;
  85710. /**
  85711. * Returns a string to use to update the GPU particles update shader
  85712. * @returns the effect defines string
  85713. */
  85714. getEffectDefines(): string;
  85715. /**
  85716. * Returns a string representing the class name
  85717. * @returns a string containing the class name
  85718. */
  85719. getClassName(): string;
  85720. /**
  85721. * Serializes the particle system to a JSON object.
  85722. * @returns the JSON object
  85723. */
  85724. serialize(): any;
  85725. /**
  85726. * Parse properties from a JSON object
  85727. * @param serializationObject defines the JSON object
  85728. */
  85729. parse(serializationObject: any): void;
  85730. }
  85731. }
  85732. declare module BABYLON {
  85733. /**
  85734. * Particle emitter emitting particles from the inside of a box.
  85735. * It emits the particles randomly between 2 given directions.
  85736. */
  85737. export class BoxParticleEmitter implements IParticleEmitterType {
  85738. /**
  85739. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85740. */
  85741. direction1: Vector3;
  85742. /**
  85743. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85744. */
  85745. direction2: Vector3;
  85746. /**
  85747. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  85748. */
  85749. minEmitBox: Vector3;
  85750. /**
  85751. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  85752. */
  85753. maxEmitBox: Vector3;
  85754. /**
  85755. * Creates a new instance BoxParticleEmitter
  85756. */
  85757. constructor();
  85758. /**
  85759. * Called by the particle System when the direction is computed for the created particle.
  85760. * @param worldMatrix is the world matrix of the particle system
  85761. * @param directionToUpdate is the direction vector to update with the result
  85762. * @param particle is the particle we are computed the direction for
  85763. */
  85764. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85765. /**
  85766. * Called by the particle System when the position is computed for the created particle.
  85767. * @param worldMatrix is the world matrix of the particle system
  85768. * @param positionToUpdate is the position vector to update with the result
  85769. * @param particle is the particle we are computed the position for
  85770. */
  85771. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85772. /**
  85773. * Clones the current emitter and returns a copy of it
  85774. * @returns the new emitter
  85775. */
  85776. clone(): BoxParticleEmitter;
  85777. /**
  85778. * Called by the GPUParticleSystem to setup the update shader
  85779. * @param effect defines the update shader
  85780. */
  85781. applyToShader(effect: Effect): void;
  85782. /**
  85783. * Returns a string to use to update the GPU particles update shader
  85784. * @returns a string containng the defines string
  85785. */
  85786. getEffectDefines(): string;
  85787. /**
  85788. * Returns the string "BoxParticleEmitter"
  85789. * @returns a string containing the class name
  85790. */
  85791. getClassName(): string;
  85792. /**
  85793. * Serializes the particle system to a JSON object.
  85794. * @returns the JSON object
  85795. */
  85796. serialize(): any;
  85797. /**
  85798. * Parse properties from a JSON object
  85799. * @param serializationObject defines the JSON object
  85800. */
  85801. parse(serializationObject: any): void;
  85802. }
  85803. }
  85804. declare module BABYLON {
  85805. /**
  85806. * Particle emitter emitting particles from the inside of a cone.
  85807. * It emits the particles alongside the cone volume from the base to the particle.
  85808. * The emission direction might be randomized.
  85809. */
  85810. export class ConeParticleEmitter implements IParticleEmitterType {
  85811. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  85812. directionRandomizer: number;
  85813. private _radius;
  85814. private _angle;
  85815. private _height;
  85816. /**
  85817. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  85818. */
  85819. radiusRange: number;
  85820. /**
  85821. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  85822. */
  85823. heightRange: number;
  85824. /**
  85825. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  85826. */
  85827. emitFromSpawnPointOnly: boolean;
  85828. /**
  85829. * Gets or sets the radius of the emission cone
  85830. */
  85831. radius: number;
  85832. /**
  85833. * Gets or sets the angle of the emission cone
  85834. */
  85835. angle: number;
  85836. private _buildHeight;
  85837. /**
  85838. * Creates a new instance ConeParticleEmitter
  85839. * @param radius the radius of the emission cone (1 by default)
  85840. * @param angle the cone base angle (PI by default)
  85841. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  85842. */
  85843. constructor(radius?: number, angle?: number,
  85844. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  85845. directionRandomizer?: number);
  85846. /**
  85847. * Called by the particle System when the direction is computed for the created particle.
  85848. * @param worldMatrix is the world matrix of the particle system
  85849. * @param directionToUpdate is the direction vector to update with the result
  85850. * @param particle is the particle we are computed the direction for
  85851. */
  85852. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85853. /**
  85854. * Called by the particle System when the position is computed for the created particle.
  85855. * @param worldMatrix is the world matrix of the particle system
  85856. * @param positionToUpdate is the position vector to update with the result
  85857. * @param particle is the particle we are computed the position for
  85858. */
  85859. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85860. /**
  85861. * Clones the current emitter and returns a copy of it
  85862. * @returns the new emitter
  85863. */
  85864. clone(): ConeParticleEmitter;
  85865. /**
  85866. * Called by the GPUParticleSystem to setup the update shader
  85867. * @param effect defines the update shader
  85868. */
  85869. applyToShader(effect: Effect): void;
  85870. /**
  85871. * Returns a string to use to update the GPU particles update shader
  85872. * @returns a string containng the defines string
  85873. */
  85874. getEffectDefines(): string;
  85875. /**
  85876. * Returns the string "ConeParticleEmitter"
  85877. * @returns a string containing the class name
  85878. */
  85879. getClassName(): string;
  85880. /**
  85881. * Serializes the particle system to a JSON object.
  85882. * @returns the JSON object
  85883. */
  85884. serialize(): any;
  85885. /**
  85886. * Parse properties from a JSON object
  85887. * @param serializationObject defines the JSON object
  85888. */
  85889. parse(serializationObject: any): void;
  85890. }
  85891. }
  85892. declare module BABYLON {
  85893. /**
  85894. * Particle emitter emitting particles from the inside of a cylinder.
  85895. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  85896. */
  85897. export class CylinderParticleEmitter implements IParticleEmitterType {
  85898. /**
  85899. * The radius of the emission cylinder.
  85900. */
  85901. radius: number;
  85902. /**
  85903. * The height of the emission cylinder.
  85904. */
  85905. height: number;
  85906. /**
  85907. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85908. */
  85909. radiusRange: number;
  85910. /**
  85911. * How much to randomize the particle direction [0-1].
  85912. */
  85913. directionRandomizer: number;
  85914. /**
  85915. * Creates a new instance CylinderParticleEmitter
  85916. * @param radius the radius of the emission cylinder (1 by default)
  85917. * @param height the height of the emission cylinder (1 by default)
  85918. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85919. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  85920. */
  85921. constructor(
  85922. /**
  85923. * The radius of the emission cylinder.
  85924. */
  85925. radius?: number,
  85926. /**
  85927. * The height of the emission cylinder.
  85928. */
  85929. height?: number,
  85930. /**
  85931. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  85932. */
  85933. radiusRange?: number,
  85934. /**
  85935. * How much to randomize the particle direction [0-1].
  85936. */
  85937. directionRandomizer?: number);
  85938. /**
  85939. * Called by the particle System when the direction is computed for the created particle.
  85940. * @param worldMatrix is the world matrix of the particle system
  85941. * @param directionToUpdate is the direction vector to update with the result
  85942. * @param particle is the particle we are computed the direction for
  85943. */
  85944. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  85945. /**
  85946. * Called by the particle System when the position is computed for the created particle.
  85947. * @param worldMatrix is the world matrix of the particle system
  85948. * @param positionToUpdate is the position vector to update with the result
  85949. * @param particle is the particle we are computed the position for
  85950. */
  85951. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  85952. /**
  85953. * Clones the current emitter and returns a copy of it
  85954. * @returns the new emitter
  85955. */
  85956. clone(): CylinderParticleEmitter;
  85957. /**
  85958. * Called by the GPUParticleSystem to setup the update shader
  85959. * @param effect defines the update shader
  85960. */
  85961. applyToShader(effect: Effect): void;
  85962. /**
  85963. * Returns a string to use to update the GPU particles update shader
  85964. * @returns a string containng the defines string
  85965. */
  85966. getEffectDefines(): string;
  85967. /**
  85968. * Returns the string "CylinderParticleEmitter"
  85969. * @returns a string containing the class name
  85970. */
  85971. getClassName(): string;
  85972. /**
  85973. * Serializes the particle system to a JSON object.
  85974. * @returns the JSON object
  85975. */
  85976. serialize(): any;
  85977. /**
  85978. * Parse properties from a JSON object
  85979. * @param serializationObject defines the JSON object
  85980. */
  85981. parse(serializationObject: any): void;
  85982. }
  85983. /**
  85984. * Particle emitter emitting particles from the inside of a cylinder.
  85985. * It emits the particles randomly between two vectors.
  85986. */
  85987. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  85988. /**
  85989. * The min limit of the emission direction.
  85990. */
  85991. direction1: Vector3;
  85992. /**
  85993. * The max limit of the emission direction.
  85994. */
  85995. direction2: Vector3;
  85996. /**
  85997. * Creates a new instance CylinderDirectedParticleEmitter
  85998. * @param radius the radius of the emission cylinder (1 by default)
  85999. * @param height the height of the emission cylinder (1 by default)
  86000. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86001. * @param direction1 the min limit of the emission direction (up vector by default)
  86002. * @param direction2 the max limit of the emission direction (up vector by default)
  86003. */
  86004. constructor(radius?: number, height?: number, radiusRange?: number,
  86005. /**
  86006. * The min limit of the emission direction.
  86007. */
  86008. direction1?: Vector3,
  86009. /**
  86010. * The max limit of the emission direction.
  86011. */
  86012. direction2?: Vector3);
  86013. /**
  86014. * Called by the particle System when the direction is computed for the created particle.
  86015. * @param worldMatrix is the world matrix of the particle system
  86016. * @param directionToUpdate is the direction vector to update with the result
  86017. * @param particle is the particle we are computed the direction for
  86018. */
  86019. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86020. /**
  86021. * Clones the current emitter and returns a copy of it
  86022. * @returns the new emitter
  86023. */
  86024. clone(): CylinderDirectedParticleEmitter;
  86025. /**
  86026. * Called by the GPUParticleSystem to setup the update shader
  86027. * @param effect defines the update shader
  86028. */
  86029. applyToShader(effect: Effect): void;
  86030. /**
  86031. * Returns a string to use to update the GPU particles update shader
  86032. * @returns a string containng the defines string
  86033. */
  86034. getEffectDefines(): string;
  86035. /**
  86036. * Returns the string "CylinderDirectedParticleEmitter"
  86037. * @returns a string containing the class name
  86038. */
  86039. getClassName(): string;
  86040. /**
  86041. * Serializes the particle system to a JSON object.
  86042. * @returns the JSON object
  86043. */
  86044. serialize(): any;
  86045. /**
  86046. * Parse properties from a JSON object
  86047. * @param serializationObject defines the JSON object
  86048. */
  86049. parse(serializationObject: any): void;
  86050. }
  86051. }
  86052. declare module BABYLON {
  86053. /**
  86054. * Particle emitter emitting particles from the inside of a hemisphere.
  86055. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  86056. */
  86057. export class HemisphericParticleEmitter implements IParticleEmitterType {
  86058. /**
  86059. * The radius of the emission hemisphere.
  86060. */
  86061. radius: number;
  86062. /**
  86063. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86064. */
  86065. radiusRange: number;
  86066. /**
  86067. * How much to randomize the particle direction [0-1].
  86068. */
  86069. directionRandomizer: number;
  86070. /**
  86071. * Creates a new instance HemisphericParticleEmitter
  86072. * @param radius the radius of the emission hemisphere (1 by default)
  86073. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86074. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  86075. */
  86076. constructor(
  86077. /**
  86078. * The radius of the emission hemisphere.
  86079. */
  86080. radius?: number,
  86081. /**
  86082. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86083. */
  86084. radiusRange?: number,
  86085. /**
  86086. * How much to randomize the particle direction [0-1].
  86087. */
  86088. directionRandomizer?: number);
  86089. /**
  86090. * Called by the particle System when the direction is computed for the created particle.
  86091. * @param worldMatrix is the world matrix of the particle system
  86092. * @param directionToUpdate is the direction vector to update with the result
  86093. * @param particle is the particle we are computed the direction for
  86094. */
  86095. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86096. /**
  86097. * Called by the particle System when the position is computed for the created particle.
  86098. * @param worldMatrix is the world matrix of the particle system
  86099. * @param positionToUpdate is the position vector to update with the result
  86100. * @param particle is the particle we are computed the position for
  86101. */
  86102. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86103. /**
  86104. * Clones the current emitter and returns a copy of it
  86105. * @returns the new emitter
  86106. */
  86107. clone(): HemisphericParticleEmitter;
  86108. /**
  86109. * Called by the GPUParticleSystem to setup the update shader
  86110. * @param effect defines the update shader
  86111. */
  86112. applyToShader(effect: Effect): void;
  86113. /**
  86114. * Returns a string to use to update the GPU particles update shader
  86115. * @returns a string containng the defines string
  86116. */
  86117. getEffectDefines(): string;
  86118. /**
  86119. * Returns the string "HemisphericParticleEmitter"
  86120. * @returns a string containing the class name
  86121. */
  86122. getClassName(): string;
  86123. /**
  86124. * Serializes the particle system to a JSON object.
  86125. * @returns the JSON object
  86126. */
  86127. serialize(): any;
  86128. /**
  86129. * Parse properties from a JSON object
  86130. * @param serializationObject defines the JSON object
  86131. */
  86132. parse(serializationObject: any): void;
  86133. }
  86134. }
  86135. declare module BABYLON {
  86136. /**
  86137. * Particle emitter emitting particles from a point.
  86138. * It emits the particles randomly between 2 given directions.
  86139. */
  86140. export class PointParticleEmitter implements IParticleEmitterType {
  86141. /**
  86142. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  86143. */
  86144. direction1: Vector3;
  86145. /**
  86146. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  86147. */
  86148. direction2: Vector3;
  86149. /**
  86150. * Creates a new instance PointParticleEmitter
  86151. */
  86152. constructor();
  86153. /**
  86154. * Called by the particle System when the direction is computed for the created particle.
  86155. * @param worldMatrix is the world matrix of the particle system
  86156. * @param directionToUpdate is the direction vector to update with the result
  86157. * @param particle is the particle we are computed the direction for
  86158. */
  86159. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86160. /**
  86161. * Called by the particle System when the position is computed for the created particle.
  86162. * @param worldMatrix is the world matrix of the particle system
  86163. * @param positionToUpdate is the position vector to update with the result
  86164. * @param particle is the particle we are computed the position for
  86165. */
  86166. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86167. /**
  86168. * Clones the current emitter and returns a copy of it
  86169. * @returns the new emitter
  86170. */
  86171. clone(): PointParticleEmitter;
  86172. /**
  86173. * Called by the GPUParticleSystem to setup the update shader
  86174. * @param effect defines the update shader
  86175. */
  86176. applyToShader(effect: Effect): void;
  86177. /**
  86178. * Returns a string to use to update the GPU particles update shader
  86179. * @returns a string containng the defines string
  86180. */
  86181. getEffectDefines(): string;
  86182. /**
  86183. * Returns the string "PointParticleEmitter"
  86184. * @returns a string containing the class name
  86185. */
  86186. getClassName(): string;
  86187. /**
  86188. * Serializes the particle system to a JSON object.
  86189. * @returns the JSON object
  86190. */
  86191. serialize(): any;
  86192. /**
  86193. * Parse properties from a JSON object
  86194. * @param serializationObject defines the JSON object
  86195. */
  86196. parse(serializationObject: any): void;
  86197. }
  86198. }
  86199. declare module BABYLON {
  86200. /**
  86201. * Particle emitter emitting particles from the inside of a sphere.
  86202. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  86203. */
  86204. export class SphereParticleEmitter implements IParticleEmitterType {
  86205. /**
  86206. * The radius of the emission sphere.
  86207. */
  86208. radius: number;
  86209. /**
  86210. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86211. */
  86212. radiusRange: number;
  86213. /**
  86214. * How much to randomize the particle direction [0-1].
  86215. */
  86216. directionRandomizer: number;
  86217. /**
  86218. * Creates a new instance SphereParticleEmitter
  86219. * @param radius the radius of the emission sphere (1 by default)
  86220. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86221. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  86222. */
  86223. constructor(
  86224. /**
  86225. * The radius of the emission sphere.
  86226. */
  86227. radius?: number,
  86228. /**
  86229. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86230. */
  86231. radiusRange?: number,
  86232. /**
  86233. * How much to randomize the particle direction [0-1].
  86234. */
  86235. directionRandomizer?: number);
  86236. /**
  86237. * Called by the particle System when the direction is computed for the created particle.
  86238. * @param worldMatrix is the world matrix of the particle system
  86239. * @param directionToUpdate is the direction vector to update with the result
  86240. * @param particle is the particle we are computed the direction for
  86241. */
  86242. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86243. /**
  86244. * Called by the particle System when the position is computed for the created particle.
  86245. * @param worldMatrix is the world matrix of the particle system
  86246. * @param positionToUpdate is the position vector to update with the result
  86247. * @param particle is the particle we are computed the position for
  86248. */
  86249. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86250. /**
  86251. * Clones the current emitter and returns a copy of it
  86252. * @returns the new emitter
  86253. */
  86254. clone(): SphereParticleEmitter;
  86255. /**
  86256. * Called by the GPUParticleSystem to setup the update shader
  86257. * @param effect defines the update shader
  86258. */
  86259. applyToShader(effect: Effect): void;
  86260. /**
  86261. * Returns a string to use to update the GPU particles update shader
  86262. * @returns a string containng the defines string
  86263. */
  86264. getEffectDefines(): string;
  86265. /**
  86266. * Returns the string "SphereParticleEmitter"
  86267. * @returns a string containing the class name
  86268. */
  86269. getClassName(): string;
  86270. /**
  86271. * Serializes the particle system to a JSON object.
  86272. * @returns the JSON object
  86273. */
  86274. serialize(): any;
  86275. /**
  86276. * Parse properties from a JSON object
  86277. * @param serializationObject defines the JSON object
  86278. */
  86279. parse(serializationObject: any): void;
  86280. }
  86281. /**
  86282. * Particle emitter emitting particles from the inside of a sphere.
  86283. * It emits the particles randomly between two vectors.
  86284. */
  86285. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  86286. /**
  86287. * The min limit of the emission direction.
  86288. */
  86289. direction1: Vector3;
  86290. /**
  86291. * The max limit of the emission direction.
  86292. */
  86293. direction2: Vector3;
  86294. /**
  86295. * Creates a new instance SphereDirectedParticleEmitter
  86296. * @param radius the radius of the emission sphere (1 by default)
  86297. * @param direction1 the min limit of the emission direction (up vector by default)
  86298. * @param direction2 the max limit of the emission direction (up vector by default)
  86299. */
  86300. constructor(radius?: number,
  86301. /**
  86302. * The min limit of the emission direction.
  86303. */
  86304. direction1?: Vector3,
  86305. /**
  86306. * The max limit of the emission direction.
  86307. */
  86308. direction2?: Vector3);
  86309. /**
  86310. * Called by the particle System when the direction is computed for the created particle.
  86311. * @param worldMatrix is the world matrix of the particle system
  86312. * @param directionToUpdate is the direction vector to update with the result
  86313. * @param particle is the particle we are computed the direction for
  86314. */
  86315. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86316. /**
  86317. * Clones the current emitter and returns a copy of it
  86318. * @returns the new emitter
  86319. */
  86320. clone(): SphereDirectedParticleEmitter;
  86321. /**
  86322. * Called by the GPUParticleSystem to setup the update shader
  86323. * @param effect defines the update shader
  86324. */
  86325. applyToShader(effect: Effect): void;
  86326. /**
  86327. * Returns a string to use to update the GPU particles update shader
  86328. * @returns a string containng the defines string
  86329. */
  86330. getEffectDefines(): string;
  86331. /**
  86332. * Returns the string "SphereDirectedParticleEmitter"
  86333. * @returns a string containing the class name
  86334. */
  86335. getClassName(): string;
  86336. /**
  86337. * Serializes the particle system to a JSON object.
  86338. * @returns the JSON object
  86339. */
  86340. serialize(): any;
  86341. /**
  86342. * Parse properties from a JSON object
  86343. * @param serializationObject defines the JSON object
  86344. */
  86345. parse(serializationObject: any): void;
  86346. }
  86347. }
  86348. declare module BABYLON {
  86349. /**
  86350. * Interface representing a particle system in Babylon.js.
  86351. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  86352. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  86353. */
  86354. export interface IParticleSystem {
  86355. /**
  86356. * List of animations used by the particle system.
  86357. */
  86358. animations: Animation[];
  86359. /**
  86360. * The id of the Particle system.
  86361. */
  86362. id: string;
  86363. /**
  86364. * The name of the Particle system.
  86365. */
  86366. name: string;
  86367. /**
  86368. * The emitter represents the Mesh or position we are attaching the particle system to.
  86369. */
  86370. emitter: Nullable<AbstractMesh | Vector3>;
  86371. /**
  86372. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  86373. */
  86374. isBillboardBased: boolean;
  86375. /**
  86376. * The rendering group used by the Particle system to chose when to render.
  86377. */
  86378. renderingGroupId: number;
  86379. /**
  86380. * The layer mask we are rendering the particles through.
  86381. */
  86382. layerMask: number;
  86383. /**
  86384. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  86385. */
  86386. updateSpeed: number;
  86387. /**
  86388. * The amount of time the particle system is running (depends of the overall update speed).
  86389. */
  86390. targetStopDuration: number;
  86391. /**
  86392. * The texture used to render each particle. (this can be a spritesheet)
  86393. */
  86394. particleTexture: Nullable<Texture>;
  86395. /**
  86396. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  86397. */
  86398. blendMode: number;
  86399. /**
  86400. * Minimum life time of emitting particles.
  86401. */
  86402. minLifeTime: number;
  86403. /**
  86404. * Maximum life time of emitting particles.
  86405. */
  86406. maxLifeTime: number;
  86407. /**
  86408. * Minimum Size of emitting particles.
  86409. */
  86410. minSize: number;
  86411. /**
  86412. * Maximum Size of emitting particles.
  86413. */
  86414. maxSize: number;
  86415. /**
  86416. * Minimum scale of emitting particles on X axis.
  86417. */
  86418. minScaleX: number;
  86419. /**
  86420. * Maximum scale of emitting particles on X axis.
  86421. */
  86422. maxScaleX: number;
  86423. /**
  86424. * Minimum scale of emitting particles on Y axis.
  86425. */
  86426. minScaleY: number;
  86427. /**
  86428. * Maximum scale of emitting particles on Y axis.
  86429. */
  86430. maxScaleY: number;
  86431. /**
  86432. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  86433. */
  86434. color1: Color4;
  86435. /**
  86436. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  86437. */
  86438. color2: Color4;
  86439. /**
  86440. * Color the particle will have at the end of its lifetime.
  86441. */
  86442. colorDead: Color4;
  86443. /**
  86444. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  86445. */
  86446. emitRate: number;
  86447. /**
  86448. * You can use gravity if you want to give an orientation to your particles.
  86449. */
  86450. gravity: Vector3;
  86451. /**
  86452. * Minimum power of emitting particles.
  86453. */
  86454. minEmitPower: number;
  86455. /**
  86456. * Maximum power of emitting particles.
  86457. */
  86458. maxEmitPower: number;
  86459. /**
  86460. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  86461. */
  86462. minAngularSpeed: number;
  86463. /**
  86464. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  86465. */
  86466. maxAngularSpeed: number;
  86467. /**
  86468. * Gets or sets the minimal initial rotation in radians.
  86469. */
  86470. minInitialRotation: number;
  86471. /**
  86472. * Gets or sets the maximal initial rotation in radians.
  86473. */
  86474. maxInitialRotation: number;
  86475. /**
  86476. * The particle emitter type defines the emitter used by the particle system.
  86477. * It can be for example box, sphere, or cone...
  86478. */
  86479. particleEmitterType: Nullable<IParticleEmitterType>;
  86480. /**
  86481. * Defines the delay in milliseconds before starting the system (0 by default)
  86482. */
  86483. startDelay: number;
  86484. /**
  86485. * Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0
  86486. */
  86487. preWarmCycles: number;
  86488. /**
  86489. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  86490. */
  86491. preWarmStepOffset: number;
  86492. /**
  86493. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  86494. */
  86495. spriteCellChangeSpeed: number;
  86496. /**
  86497. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  86498. */
  86499. startSpriteCellID: number;
  86500. /**
  86501. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  86502. */
  86503. endSpriteCellID: number;
  86504. /**
  86505. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  86506. */
  86507. spriteCellWidth: number;
  86508. /**
  86509. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  86510. */
  86511. spriteCellHeight: number;
  86512. /**
  86513. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  86514. */
  86515. spriteRandomStartCell: boolean;
  86516. /**
  86517. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  86518. */
  86519. isAnimationSheetEnabled: boolean;
  86520. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  86521. translationPivot: Vector2;
  86522. /**
  86523. * Gets or sets a texture used to add random noise to particle positions
  86524. */
  86525. noiseTexture: Nullable<BaseTexture>;
  86526. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  86527. noiseStrength: Vector3;
  86528. /**
  86529. * Gets or sets the billboard mode to use when isBillboardBased = true.
  86530. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  86531. */
  86532. billboardMode: number;
  86533. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  86534. limitVelocityDamping: number;
  86535. /**
  86536. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  86537. */
  86538. beginAnimationOnStart: boolean;
  86539. /**
  86540. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  86541. */
  86542. beginAnimationFrom: number;
  86543. /**
  86544. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  86545. */
  86546. beginAnimationTo: number;
  86547. /**
  86548. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  86549. */
  86550. beginAnimationLoop: boolean;
  86551. /**
  86552. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  86553. */
  86554. disposeOnStop: boolean;
  86555. /**
  86556. * Gets the maximum number of particles active at the same time.
  86557. * @returns The max number of active particles.
  86558. */
  86559. getCapacity(): number;
  86560. /**
  86561. * Gets if the system has been started. (Note: this will still be true after stop is called)
  86562. * @returns True if it has been started, otherwise false.
  86563. */
  86564. isStarted(): boolean;
  86565. /**
  86566. * Animates the particle system for this frame.
  86567. */
  86568. animate(): void;
  86569. /**
  86570. * Renders the particle system in its current state.
  86571. * @returns the current number of particles
  86572. */
  86573. render(): number;
  86574. /**
  86575. * Dispose the particle system and frees its associated resources.
  86576. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  86577. */
  86578. dispose(disposeTexture?: boolean): void;
  86579. /**
  86580. * Clones the particle system.
  86581. * @param name The name of the cloned object
  86582. * @param newEmitter The new emitter to use
  86583. * @returns the cloned particle system
  86584. */
  86585. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  86586. /**
  86587. * Serializes the particle system to a JSON object.
  86588. * @returns the JSON object
  86589. */
  86590. serialize(): any;
  86591. /**
  86592. * Rebuild the particle system
  86593. */
  86594. rebuild(): void;
  86595. /**
  86596. * Starts the particle system and begins to emit
  86597. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  86598. */
  86599. start(delay?: number): void;
  86600. /**
  86601. * Stops the particle system.
  86602. */
  86603. stop(): void;
  86604. /**
  86605. * Remove all active particles
  86606. */
  86607. reset(): void;
  86608. /**
  86609. * Is this system ready to be used/rendered
  86610. * @return true if the system is ready
  86611. */
  86612. isReady(): boolean;
  86613. /**
  86614. * Adds a new color gradient
  86615. * @param gradient defines the gradient to use (between 0 and 1)
  86616. * @param color1 defines the color to affect to the specified gradient
  86617. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  86618. * @returns the current particle system
  86619. */
  86620. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  86621. /**
  86622. * Remove a specific color gradient
  86623. * @param gradient defines the gradient to remove
  86624. * @returns the current particle system
  86625. */
  86626. removeColorGradient(gradient: number): IParticleSystem;
  86627. /**
  86628. * Adds a new size gradient
  86629. * @param gradient defines the gradient to use (between 0 and 1)
  86630. * @param factor defines the size factor to affect to the specified gradient
  86631. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86632. * @returns the current particle system
  86633. */
  86634. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86635. /**
  86636. * Remove a specific size gradient
  86637. * @param gradient defines the gradient to remove
  86638. * @returns the current particle system
  86639. */
  86640. removeSizeGradient(gradient: number): IParticleSystem;
  86641. /**
  86642. * Gets the current list of color gradients.
  86643. * You must use addColorGradient and removeColorGradient to udpate this list
  86644. * @returns the list of color gradients
  86645. */
  86646. getColorGradients(): Nullable<Array<ColorGradient>>;
  86647. /**
  86648. * Gets the current list of size gradients.
  86649. * You must use addSizeGradient and removeSizeGradient to udpate this list
  86650. * @returns the list of size gradients
  86651. */
  86652. getSizeGradients(): Nullable<Array<FactorGradient>>;
  86653. /**
  86654. * Gets the current list of angular speed gradients.
  86655. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  86656. * @returns the list of angular speed gradients
  86657. */
  86658. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  86659. /**
  86660. * Adds a new angular speed gradient
  86661. * @param gradient defines the gradient to use (between 0 and 1)
  86662. * @param factor defines the angular speed to affect to the specified gradient
  86663. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86664. * @returns the current particle system
  86665. */
  86666. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86667. /**
  86668. * Remove a specific angular speed gradient
  86669. * @param gradient defines the gradient to remove
  86670. * @returns the current particle system
  86671. */
  86672. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  86673. /**
  86674. * Gets the current list of velocity gradients.
  86675. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  86676. * @returns the list of velocity gradients
  86677. */
  86678. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  86679. /**
  86680. * Adds a new velocity gradient
  86681. * @param gradient defines the gradient to use (between 0 and 1)
  86682. * @param factor defines the velocity to affect to the specified gradient
  86683. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86684. * @returns the current particle system
  86685. */
  86686. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86687. /**
  86688. * Remove a specific velocity gradient
  86689. * @param gradient defines the gradient to remove
  86690. * @returns the current particle system
  86691. */
  86692. removeVelocityGradient(gradient: number): IParticleSystem;
  86693. /**
  86694. * Gets the current list of limit velocity gradients.
  86695. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  86696. * @returns the list of limit velocity gradients
  86697. */
  86698. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  86699. /**
  86700. * Adds a new limit velocity gradient
  86701. * @param gradient defines the gradient to use (between 0 and 1)
  86702. * @param factor defines the limit velocity to affect to the specified gradient
  86703. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86704. * @returns the current particle system
  86705. */
  86706. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86707. /**
  86708. * Remove a specific limit velocity gradient
  86709. * @param gradient defines the gradient to remove
  86710. * @returns the current particle system
  86711. */
  86712. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  86713. /**
  86714. * Adds a new drag gradient
  86715. * @param gradient defines the gradient to use (between 0 and 1)
  86716. * @param factor defines the drag to affect to the specified gradient
  86717. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86718. * @returns the current particle system
  86719. */
  86720. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86721. /**
  86722. * Remove a specific drag gradient
  86723. * @param gradient defines the gradient to remove
  86724. * @returns the current particle system
  86725. */
  86726. removeDragGradient(gradient: number): IParticleSystem;
  86727. /**
  86728. * Gets the current list of drag gradients.
  86729. * You must use addDragGradient and removeDragGradient to udpate this list
  86730. * @returns the list of drag gradients
  86731. */
  86732. getDragGradients(): Nullable<Array<FactorGradient>>;
  86733. /**
  86734. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  86735. * @param gradient defines the gradient to use (between 0 and 1)
  86736. * @param factor defines the emit rate to affect to the specified gradient
  86737. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86738. * @returns the current particle system
  86739. */
  86740. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86741. /**
  86742. * Remove a specific emit rate gradient
  86743. * @param gradient defines the gradient to remove
  86744. * @returns the current particle system
  86745. */
  86746. removeEmitRateGradient(gradient: number): IParticleSystem;
  86747. /**
  86748. * Gets the current list of emit rate gradients.
  86749. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  86750. * @returns the list of emit rate gradients
  86751. */
  86752. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  86753. /**
  86754. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  86755. * @param gradient defines the gradient to use (between 0 and 1)
  86756. * @param factor defines the start size to affect to the specified gradient
  86757. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86758. * @returns the current particle system
  86759. */
  86760. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86761. /**
  86762. * Remove a specific start size gradient
  86763. * @param gradient defines the gradient to remove
  86764. * @returns the current particle system
  86765. */
  86766. removeStartSizeGradient(gradient: number): IParticleSystem;
  86767. /**
  86768. * Gets the current list of start size gradients.
  86769. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  86770. * @returns the list of start size gradients
  86771. */
  86772. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  86773. /**
  86774. * Adds a new life time gradient
  86775. * @param gradient defines the gradient to use (between 0 and 1)
  86776. * @param factor defines the life time factor to affect to the specified gradient
  86777. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86778. * @returns the current particle system
  86779. */
  86780. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86781. /**
  86782. * Remove a specific life time gradient
  86783. * @param gradient defines the gradient to remove
  86784. * @returns the current particle system
  86785. */
  86786. removeLifeTimeGradient(gradient: number): IParticleSystem;
  86787. /**
  86788. * Gets the current list of life time gradients.
  86789. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  86790. * @returns the list of life time gradients
  86791. */
  86792. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  86793. /**
  86794. * Gets the current list of color gradients.
  86795. * You must use addColorGradient and removeColorGradient to udpate this list
  86796. * @returns the list of color gradients
  86797. */
  86798. getColorGradients(): Nullable<Array<ColorGradient>>;
  86799. /**
  86800. * Adds a new ramp gradient used to remap particle colors
  86801. * @param gradient defines the gradient to use (between 0 and 1)
  86802. * @param color defines the color to affect to the specified gradient
  86803. * @returns the current particle system
  86804. */
  86805. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  86806. /**
  86807. * Gets the current list of ramp gradients.
  86808. * You must use addRampGradient and removeRampGradient to udpate this list
  86809. * @returns the list of ramp gradients
  86810. */
  86811. getRampGradients(): Nullable<Array<Color3Gradient>>;
  86812. /** Gets or sets a boolean indicating that ramp gradients must be used
  86813. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  86814. */
  86815. useRampGradients: boolean;
  86816. /**
  86817. * Adds a new color remap gradient
  86818. * @param gradient defines the gradient to use (between 0 and 1)
  86819. * @param min defines the color remap minimal range
  86820. * @param max defines the color remap maximal range
  86821. * @returns the current particle system
  86822. */
  86823. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  86824. /**
  86825. * Gets the current list of color remap gradients.
  86826. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  86827. * @returns the list of color remap gradients
  86828. */
  86829. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  86830. /**
  86831. * Adds a new alpha remap gradient
  86832. * @param gradient defines the gradient to use (between 0 and 1)
  86833. * @param min defines the alpha remap minimal range
  86834. * @param max defines the alpha remap maximal range
  86835. * @returns the current particle system
  86836. */
  86837. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  86838. /**
  86839. * Gets the current list of alpha remap gradients.
  86840. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  86841. * @returns the list of alpha remap gradients
  86842. */
  86843. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  86844. /**
  86845. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  86846. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  86847. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  86848. * @returns the emitter
  86849. */
  86850. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  86851. /**
  86852. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  86853. * @param radius The radius of the hemisphere to emit from
  86854. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  86855. * @returns the emitter
  86856. */
  86857. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  86858. /**
  86859. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  86860. * @param radius The radius of the sphere to emit from
  86861. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  86862. * @returns the emitter
  86863. */
  86864. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  86865. /**
  86866. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  86867. * @param radius The radius of the sphere to emit from
  86868. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  86869. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  86870. * @returns the emitter
  86871. */
  86872. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  86873. /**
  86874. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  86875. * @param radius The radius of the emission cylinder
  86876. * @param height The height of the emission cylinder
  86877. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  86878. * @param directionRandomizer How much to randomize the particle direction [0-1]
  86879. * @returns the emitter
  86880. */
  86881. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  86882. /**
  86883. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  86884. * @param radius The radius of the cylinder to emit from
  86885. * @param height The height of the emission cylinder
  86886. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86887. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  86888. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  86889. * @returns the emitter
  86890. */
  86891. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  86892. /**
  86893. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  86894. * @param radius The radius of the cone to emit from
  86895. * @param angle The base angle of the cone
  86896. * @returns the emitter
  86897. */
  86898. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  86899. /**
  86900. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  86901. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  86902. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  86903. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  86904. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  86905. * @returns the emitter
  86906. */
  86907. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  86908. /**
  86909. * Get hosting scene
  86910. * @returns the scene
  86911. */
  86912. getScene(): Scene;
  86913. }
  86914. }
  86915. declare module BABYLON {
  86916. /**
  86917. * Creates an instance based on a source mesh.
  86918. */
  86919. export class InstancedMesh extends AbstractMesh {
  86920. private _sourceMesh;
  86921. private _currentLOD;
  86922. /** @hidden */
  86923. _indexInSourceMeshInstanceArray: number;
  86924. constructor(name: string, source: Mesh);
  86925. /**
  86926. * Returns the string "InstancedMesh".
  86927. */
  86928. getClassName(): string;
  86929. /** Gets the list of lights affecting that mesh */
  86930. readonly lightSources: Light[];
  86931. _resyncLightSources(): void;
  86932. _resyncLighSource(light: Light): void;
  86933. _removeLightSource(light: Light, dispose: boolean): void;
  86934. /**
  86935. * If the source mesh receives shadows
  86936. */
  86937. readonly receiveShadows: boolean;
  86938. /**
  86939. * The material of the source mesh
  86940. */
  86941. readonly material: Nullable<Material>;
  86942. /**
  86943. * Visibility of the source mesh
  86944. */
  86945. readonly visibility: number;
  86946. /**
  86947. * Skeleton of the source mesh
  86948. */
  86949. readonly skeleton: Nullable<Skeleton>;
  86950. /**
  86951. * Rendering ground id of the source mesh
  86952. */
  86953. renderingGroupId: number;
  86954. /**
  86955. * Returns the total number of vertices (integer).
  86956. */
  86957. getTotalVertices(): number;
  86958. /**
  86959. * Returns a positive integer : the total number of indices in this mesh geometry.
  86960. * @returns the numner of indices or zero if the mesh has no geometry.
  86961. */
  86962. getTotalIndices(): number;
  86963. /**
  86964. * The source mesh of the instance
  86965. */
  86966. readonly sourceMesh: Mesh;
  86967. /**
  86968. * Is this node ready to be used/rendered
  86969. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  86970. * @return {boolean} is it ready
  86971. */
  86972. isReady(completeCheck?: boolean): boolean;
  86973. /**
  86974. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  86975. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  86976. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  86977. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  86978. */
  86979. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  86980. /**
  86981. * Sets the vertex data of the mesh geometry for the requested `kind`.
  86982. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  86983. * The `data` are either a numeric array either a Float32Array.
  86984. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  86985. * The parameter `stride` is an optional positive integer, it is usually automatically deducted from the `kind` (3 for positions or normals, 2 for UV, etc).
  86986. * Note that a new underlying VertexBuffer object is created each call.
  86987. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  86988. *
  86989. * Possible `kind` values :
  86990. * - VertexBuffer.PositionKind
  86991. * - VertexBuffer.UVKind
  86992. * - VertexBuffer.UV2Kind
  86993. * - VertexBuffer.UV3Kind
  86994. * - VertexBuffer.UV4Kind
  86995. * - VertexBuffer.UV5Kind
  86996. * - VertexBuffer.UV6Kind
  86997. * - VertexBuffer.ColorKind
  86998. * - VertexBuffer.MatricesIndicesKind
  86999. * - VertexBuffer.MatricesIndicesExtraKind
  87000. * - VertexBuffer.MatricesWeightsKind
  87001. * - VertexBuffer.MatricesWeightsExtraKind
  87002. *
  87003. * Returns the Mesh.
  87004. */
  87005. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  87006. /**
  87007. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  87008. * If the mesh has no geometry, it is simply returned as it is.
  87009. * The `data` are either a numeric array either a Float32Array.
  87010. * No new underlying VertexBuffer object is created.
  87011. * If the `kind` is the `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  87012. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  87013. *
  87014. * Possible `kind` values :
  87015. * - VertexBuffer.PositionKind
  87016. * - VertexBuffer.UVKind
  87017. * - VertexBuffer.UV2Kind
  87018. * - VertexBuffer.UV3Kind
  87019. * - VertexBuffer.UV4Kind
  87020. * - VertexBuffer.UV5Kind
  87021. * - VertexBuffer.UV6Kind
  87022. * - VertexBuffer.ColorKind
  87023. * - VertexBuffer.MatricesIndicesKind
  87024. * - VertexBuffer.MatricesIndicesExtraKind
  87025. * - VertexBuffer.MatricesWeightsKind
  87026. * - VertexBuffer.MatricesWeightsExtraKind
  87027. *
  87028. * Returns the Mesh.
  87029. */
  87030. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  87031. /**
  87032. * Sets the mesh indices.
  87033. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  87034. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  87035. * This method creates a new index buffer each call.
  87036. * Returns the Mesh.
  87037. */
  87038. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  87039. /**
  87040. * Boolean : True if the mesh owns the requested kind of data.
  87041. */
  87042. isVerticesDataPresent(kind: string): boolean;
  87043. /**
  87044. * Returns an array of indices (IndicesArray).
  87045. */
  87046. getIndices(): Nullable<IndicesArray>;
  87047. readonly _positions: Nullable<Vector3[]>;
  87048. /**
  87049. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  87050. * This means the mesh underlying bounding box and sphere are recomputed.
  87051. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  87052. * @returns the current mesh
  87053. */
  87054. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  87055. /** @hidden */
  87056. _preActivate(): InstancedMesh;
  87057. /** @hidden */
  87058. _activate(renderId: number, intermediateRendering: boolean): boolean;
  87059. /** @hidden */
  87060. _postActivate(): void;
  87061. getWorldMatrix(): Matrix;
  87062. readonly isAnInstance: boolean;
  87063. /**
  87064. * Returns the current associated LOD AbstractMesh.
  87065. */
  87066. getLOD(camera: Camera): AbstractMesh;
  87067. /** @hidden */
  87068. _syncSubMeshes(): InstancedMesh;
  87069. /** @hidden */
  87070. _generatePointsArray(): boolean;
  87071. /**
  87072. * Creates a new InstancedMesh from the current mesh.
  87073. * - name (string) : the cloned mesh name
  87074. * - newParent (optional Node) : the optional Node to parent the clone to.
  87075. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  87076. *
  87077. * Returns the clone.
  87078. */
  87079. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  87080. /**
  87081. * Disposes the InstancedMesh.
  87082. * Returns nothing.
  87083. */
  87084. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  87085. }
  87086. interface Mesh {
  87087. /**
  87088. * Register a custom buffer that will be instanced
  87089. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  87090. * @param kind defines the buffer kind
  87091. * @param stride defines the stride in floats
  87092. */
  87093. registerInstancedBuffer(kind: string, stride: number): void;
  87094. /** @hidden */
  87095. _userInstancedBuffersStorage: {
  87096. data: {
  87097. [key: string]: Float32Array;
  87098. };
  87099. sizes: {
  87100. [key: string]: number;
  87101. };
  87102. vertexBuffers: {
  87103. [key: string]: Nullable<VertexBuffer>;
  87104. };
  87105. strides: {
  87106. [key: string]: number;
  87107. };
  87108. };
  87109. }
  87110. interface AbstractMesh {
  87111. /**
  87112. * Object used to store instanced buffers defined by user
  87113. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  87114. */
  87115. instancedBuffers: {
  87116. [key: string]: any;
  87117. };
  87118. }
  87119. }
  87120. declare module BABYLON {
  87121. /**
  87122. * Defines the options associated with the creation of a shader material.
  87123. */
  87124. export interface IShaderMaterialOptions {
  87125. /**
  87126. * Does the material work in alpha blend mode
  87127. */
  87128. needAlphaBlending: boolean;
  87129. /**
  87130. * Does the material work in alpha test mode
  87131. */
  87132. needAlphaTesting: boolean;
  87133. /**
  87134. * The list of attribute names used in the shader
  87135. */
  87136. attributes: string[];
  87137. /**
  87138. * The list of unifrom names used in the shader
  87139. */
  87140. uniforms: string[];
  87141. /**
  87142. * The list of UBO names used in the shader
  87143. */
  87144. uniformBuffers: string[];
  87145. /**
  87146. * The list of sampler names used in the shader
  87147. */
  87148. samplers: string[];
  87149. /**
  87150. * The list of defines used in the shader
  87151. */
  87152. defines: string[];
  87153. }
  87154. /**
  87155. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  87156. *
  87157. * This returned material effects how the mesh will look based on the code in the shaders.
  87158. *
  87159. * @see http://doc.babylonjs.com/how_to/shader_material
  87160. */
  87161. export class ShaderMaterial extends Material {
  87162. private _shaderPath;
  87163. private _options;
  87164. private _textures;
  87165. private _textureArrays;
  87166. private _floats;
  87167. private _ints;
  87168. private _floatsArrays;
  87169. private _colors3;
  87170. private _colors3Arrays;
  87171. private _colors4;
  87172. private _colors4Arrays;
  87173. private _vectors2;
  87174. private _vectors3;
  87175. private _vectors4;
  87176. private _matrices;
  87177. private _matrixArrays;
  87178. private _matrices3x3;
  87179. private _matrices2x2;
  87180. private _vectors2Arrays;
  87181. private _vectors3Arrays;
  87182. private _vectors4Arrays;
  87183. private _cachedWorldViewMatrix;
  87184. private _cachedWorldViewProjectionMatrix;
  87185. private _renderId;
  87186. /**
  87187. * Instantiate a new shader material.
  87188. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  87189. * This returned material effects how the mesh will look based on the code in the shaders.
  87190. * @see http://doc.babylonjs.com/how_to/shader_material
  87191. * @param name Define the name of the material in the scene
  87192. * @param scene Define the scene the material belongs to
  87193. * @param shaderPath Defines the route to the shader code in one of three ways:
  87194. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  87195. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  87196. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  87197. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  87198. * @param options Define the options used to create the shader
  87199. */
  87200. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  87201. /**
  87202. * Gets the shader path used to define the shader code
  87203. * It can be modified to trigger a new compilation
  87204. */
  87205. /**
  87206. * Sets the shader path used to define the shader code
  87207. * It can be modified to trigger a new compilation
  87208. */
  87209. shaderPath: any;
  87210. /**
  87211. * Gets the options used to compile the shader.
  87212. * They can be modified to trigger a new compilation
  87213. */
  87214. readonly options: IShaderMaterialOptions;
  87215. /**
  87216. * Gets the current class name of the material e.g. "ShaderMaterial"
  87217. * Mainly use in serialization.
  87218. * @returns the class name
  87219. */
  87220. getClassName(): string;
  87221. /**
  87222. * Specifies if the material will require alpha blending
  87223. * @returns a boolean specifying if alpha blending is needed
  87224. */
  87225. needAlphaBlending(): boolean;
  87226. /**
  87227. * Specifies if this material should be rendered in alpha test mode
  87228. * @returns a boolean specifying if an alpha test is needed.
  87229. */
  87230. needAlphaTesting(): boolean;
  87231. private _checkUniform;
  87232. /**
  87233. * Set a texture in the shader.
  87234. * @param name Define the name of the uniform samplers as defined in the shader
  87235. * @param texture Define the texture to bind to this sampler
  87236. * @return the material itself allowing "fluent" like uniform updates
  87237. */
  87238. setTexture(name: string, texture: Texture): ShaderMaterial;
  87239. /**
  87240. * Set a texture array in the shader.
  87241. * @param name Define the name of the uniform sampler array as defined in the shader
  87242. * @param textures Define the list of textures to bind to this sampler
  87243. * @return the material itself allowing "fluent" like uniform updates
  87244. */
  87245. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  87246. /**
  87247. * Set a float in the shader.
  87248. * @param name Define the name of the uniform as defined in the shader
  87249. * @param value Define the value to give to the uniform
  87250. * @return the material itself allowing "fluent" like uniform updates
  87251. */
  87252. setFloat(name: string, value: number): ShaderMaterial;
  87253. /**
  87254. * Set a int in the shader.
  87255. * @param name Define the name of the uniform as defined in the shader
  87256. * @param value Define the value to give to the uniform
  87257. * @return the material itself allowing "fluent" like uniform updates
  87258. */
  87259. setInt(name: string, value: number): ShaderMaterial;
  87260. /**
  87261. * Set an array of floats in the shader.
  87262. * @param name Define the name of the uniform as defined in the shader
  87263. * @param value Define the value to give to the uniform
  87264. * @return the material itself allowing "fluent" like uniform updates
  87265. */
  87266. setFloats(name: string, value: number[]): ShaderMaterial;
  87267. /**
  87268. * Set a vec3 in the shader from a Color3.
  87269. * @param name Define the name of the uniform as defined in the shader
  87270. * @param value Define the value to give to the uniform
  87271. * @return the material itself allowing "fluent" like uniform updates
  87272. */
  87273. setColor3(name: string, value: Color3): ShaderMaterial;
  87274. /**
  87275. * Set a vec3 array in the shader from a Color3 array.
  87276. * @param name Define the name of the uniform as defined in the shader
  87277. * @param value Define the value to give to the uniform
  87278. * @return the material itself allowing "fluent" like uniform updates
  87279. */
  87280. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  87281. /**
  87282. * Set a vec4 in the shader from a Color4.
  87283. * @param name Define the name of the uniform as defined in the shader
  87284. * @param value Define the value to give to the uniform
  87285. * @return the material itself allowing "fluent" like uniform updates
  87286. */
  87287. setColor4(name: string, value: Color4): ShaderMaterial;
  87288. /**
  87289. * Set a vec4 array in the shader from a Color4 array.
  87290. * @param name Define the name of the uniform as defined in the shader
  87291. * @param value Define the value to give to the uniform
  87292. * @return the material itself allowing "fluent" like uniform updates
  87293. */
  87294. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  87295. /**
  87296. * Set a vec2 in the shader from a Vector2.
  87297. * @param name Define the name of the uniform as defined in the shader
  87298. * @param value Define the value to give to the uniform
  87299. * @return the material itself allowing "fluent" like uniform updates
  87300. */
  87301. setVector2(name: string, value: Vector2): ShaderMaterial;
  87302. /**
  87303. * Set a vec3 in the shader from a Vector3.
  87304. * @param name Define the name of the uniform as defined in the shader
  87305. * @param value Define the value to give to the uniform
  87306. * @return the material itself allowing "fluent" like uniform updates
  87307. */
  87308. setVector3(name: string, value: Vector3): ShaderMaterial;
  87309. /**
  87310. * Set a vec4 in the shader from a Vector4.
  87311. * @param name Define the name of the uniform as defined in the shader
  87312. * @param value Define the value to give to the uniform
  87313. * @return the material itself allowing "fluent" like uniform updates
  87314. */
  87315. setVector4(name: string, value: Vector4): ShaderMaterial;
  87316. /**
  87317. * Set a mat4 in the shader from a Matrix.
  87318. * @param name Define the name of the uniform as defined in the shader
  87319. * @param value Define the value to give to the uniform
  87320. * @return the material itself allowing "fluent" like uniform updates
  87321. */
  87322. setMatrix(name: string, value: Matrix): ShaderMaterial;
  87323. /**
  87324. * Set a float32Array in the shader from a matrix array.
  87325. * @param name Define the name of the uniform as defined in the shader
  87326. * @param value Define the value to give to the uniform
  87327. * @return the material itself allowing "fluent" like uniform updates
  87328. */
  87329. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  87330. /**
  87331. * Set a mat3 in the shader from a Float32Array.
  87332. * @param name Define the name of the uniform as defined in the shader
  87333. * @param value Define the value to give to the uniform
  87334. * @return the material itself allowing "fluent" like uniform updates
  87335. */
  87336. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  87337. /**
  87338. * Set a mat2 in the shader from a Float32Array.
  87339. * @param name Define the name of the uniform as defined in the shader
  87340. * @param value Define the value to give to the uniform
  87341. * @return the material itself allowing "fluent" like uniform updates
  87342. */
  87343. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  87344. /**
  87345. * Set a vec2 array in the shader from a number array.
  87346. * @param name Define the name of the uniform as defined in the shader
  87347. * @param value Define the value to give to the uniform
  87348. * @return the material itself allowing "fluent" like uniform updates
  87349. */
  87350. setArray2(name: string, value: number[]): ShaderMaterial;
  87351. /**
  87352. * Set a vec3 array in the shader from a number array.
  87353. * @param name Define the name of the uniform as defined in the shader
  87354. * @param value Define the value to give to the uniform
  87355. * @return the material itself allowing "fluent" like uniform updates
  87356. */
  87357. setArray3(name: string, value: number[]): ShaderMaterial;
  87358. /**
  87359. * Set a vec4 array in the shader from a number array.
  87360. * @param name Define the name of the uniform as defined in the shader
  87361. * @param value Define the value to give to the uniform
  87362. * @return the material itself allowing "fluent" like uniform updates
  87363. */
  87364. setArray4(name: string, value: number[]): ShaderMaterial;
  87365. private _checkCache;
  87366. /**
  87367. * Specifies that the submesh is ready to be used
  87368. * @param mesh defines the mesh to check
  87369. * @param subMesh defines which submesh to check
  87370. * @param useInstances specifies that instances should be used
  87371. * @returns a boolean indicating that the submesh is ready or not
  87372. */
  87373. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  87374. /**
  87375. * Checks if the material is ready to render the requested mesh
  87376. * @param mesh Define the mesh to render
  87377. * @param useInstances Define whether or not the material is used with instances
  87378. * @returns true if ready, otherwise false
  87379. */
  87380. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  87381. /**
  87382. * Binds the world matrix to the material
  87383. * @param world defines the world transformation matrix
  87384. */
  87385. bindOnlyWorldMatrix(world: Matrix): void;
  87386. /**
  87387. * Binds the material to the mesh
  87388. * @param world defines the world transformation matrix
  87389. * @param mesh defines the mesh to bind the material to
  87390. */
  87391. bind(world: Matrix, mesh?: Mesh): void;
  87392. /**
  87393. * Gets the active textures from the material
  87394. * @returns an array of textures
  87395. */
  87396. getActiveTextures(): BaseTexture[];
  87397. /**
  87398. * Specifies if the material uses a texture
  87399. * @param texture defines the texture to check against the material
  87400. * @returns a boolean specifying if the material uses the texture
  87401. */
  87402. hasTexture(texture: BaseTexture): boolean;
  87403. /**
  87404. * Makes a duplicate of the material, and gives it a new name
  87405. * @param name defines the new name for the duplicated material
  87406. * @returns the cloned material
  87407. */
  87408. clone(name: string): ShaderMaterial;
  87409. /**
  87410. * Disposes the material
  87411. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  87412. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  87413. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  87414. */
  87415. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  87416. /**
  87417. * Serializes this material in a JSON representation
  87418. * @returns the serialized material object
  87419. */
  87420. serialize(): any;
  87421. /**
  87422. * Creates a shader material from parsed shader material data
  87423. * @param source defines the JSON represnetation of the material
  87424. * @param scene defines the hosting scene
  87425. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  87426. * @returns a new material
  87427. */
  87428. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  87429. }
  87430. }
  87431. declare module BABYLON {
  87432. /** @hidden */
  87433. export var colorPixelShader: {
  87434. name: string;
  87435. shader: string;
  87436. };
  87437. }
  87438. declare module BABYLON {
  87439. /** @hidden */
  87440. export var colorVertexShader: {
  87441. name: string;
  87442. shader: string;
  87443. };
  87444. }
  87445. declare module BABYLON {
  87446. /**
  87447. * Line mesh
  87448. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  87449. */
  87450. export class LinesMesh extends Mesh {
  87451. /**
  87452. * If vertex color should be applied to the mesh
  87453. */
  87454. readonly useVertexColor?: boolean | undefined;
  87455. /**
  87456. * If vertex alpha should be applied to the mesh
  87457. */
  87458. readonly useVertexAlpha?: boolean | undefined;
  87459. /**
  87460. * Color of the line (Default: White)
  87461. */
  87462. color: Color3;
  87463. /**
  87464. * Alpha of the line (Default: 1)
  87465. */
  87466. alpha: number;
  87467. /**
  87468. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  87469. * This margin is expressed in world space coordinates, so its value may vary.
  87470. * Default value is 0.1
  87471. */
  87472. intersectionThreshold: number;
  87473. private _colorShader;
  87474. private color4;
  87475. /**
  87476. * Creates a new LinesMesh
  87477. * @param name defines the name
  87478. * @param scene defines the hosting scene
  87479. * @param parent defines the parent mesh if any
  87480. * @param source defines the optional source LinesMesh used to clone data from
  87481. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  87482. * When false, achieved by calling a clone(), also passing False.
  87483. * This will make creation of children, recursive.
  87484. * @param useVertexColor defines if this LinesMesh supports vertex color
  87485. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  87486. */
  87487. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  87488. /**
  87489. * If vertex color should be applied to the mesh
  87490. */
  87491. useVertexColor?: boolean | undefined,
  87492. /**
  87493. * If vertex alpha should be applied to the mesh
  87494. */
  87495. useVertexAlpha?: boolean | undefined);
  87496. private _addClipPlaneDefine;
  87497. private _removeClipPlaneDefine;
  87498. isReady(): boolean;
  87499. /**
  87500. * Returns the string "LineMesh"
  87501. */
  87502. getClassName(): string;
  87503. /**
  87504. * @hidden
  87505. */
  87506. /**
  87507. * @hidden
  87508. */
  87509. material: Material;
  87510. /**
  87511. * @hidden
  87512. */
  87513. readonly checkCollisions: boolean;
  87514. /** @hidden */
  87515. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  87516. /** @hidden */
  87517. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  87518. /**
  87519. * Disposes of the line mesh
  87520. * @param doNotRecurse If children should be disposed
  87521. */
  87522. dispose(doNotRecurse?: boolean): void;
  87523. /**
  87524. * Returns a new LineMesh object cloned from the current one.
  87525. */
  87526. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  87527. /**
  87528. * Creates a new InstancedLinesMesh object from the mesh model.
  87529. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  87530. * @param name defines the name of the new instance
  87531. * @returns a new InstancedLinesMesh
  87532. */
  87533. createInstance(name: string): InstancedLinesMesh;
  87534. }
  87535. /**
  87536. * Creates an instance based on a source LinesMesh
  87537. */
  87538. export class InstancedLinesMesh extends InstancedMesh {
  87539. /**
  87540. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  87541. * This margin is expressed in world space coordinates, so its value may vary.
  87542. * Initilized with the intersectionThreshold value of the source LinesMesh
  87543. */
  87544. intersectionThreshold: number;
  87545. constructor(name: string, source: LinesMesh);
  87546. /**
  87547. * Returns the string "InstancedLinesMesh".
  87548. */
  87549. getClassName(): string;
  87550. }
  87551. }
  87552. declare module BABYLON {
  87553. /** @hidden */
  87554. export var linePixelShader: {
  87555. name: string;
  87556. shader: string;
  87557. };
  87558. }
  87559. declare module BABYLON {
  87560. /** @hidden */
  87561. export var lineVertexShader: {
  87562. name: string;
  87563. shader: string;
  87564. };
  87565. }
  87566. declare module BABYLON {
  87567. interface AbstractMesh {
  87568. /**
  87569. * Gets the edgesRenderer associated with the mesh
  87570. */
  87571. edgesRenderer: Nullable<EdgesRenderer>;
  87572. }
  87573. interface LinesMesh {
  87574. /**
  87575. * Enables the edge rendering mode on the mesh.
  87576. * This mode makes the mesh edges visible
  87577. * @param epsilon defines the maximal distance between two angles to detect a face
  87578. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  87579. * @returns the currentAbstractMesh
  87580. * @see https://www.babylonjs-playground.com/#19O9TU#0
  87581. */
  87582. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  87583. }
  87584. interface InstancedLinesMesh {
  87585. /**
  87586. * Enables the edge rendering mode on the mesh.
  87587. * This mode makes the mesh edges visible
  87588. * @param epsilon defines the maximal distance between two angles to detect a face
  87589. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  87590. * @returns the current InstancedLinesMesh
  87591. * @see https://www.babylonjs-playground.com/#19O9TU#0
  87592. */
  87593. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  87594. }
  87595. /**
  87596. * Defines the minimum contract an Edges renderer should follow.
  87597. */
  87598. export interface IEdgesRenderer extends IDisposable {
  87599. /**
  87600. * Gets or sets a boolean indicating if the edgesRenderer is active
  87601. */
  87602. isEnabled: boolean;
  87603. /**
  87604. * Renders the edges of the attached mesh,
  87605. */
  87606. render(): void;
  87607. /**
  87608. * Checks wether or not the edges renderer is ready to render.
  87609. * @return true if ready, otherwise false.
  87610. */
  87611. isReady(): boolean;
  87612. }
  87613. /**
  87614. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  87615. */
  87616. export class EdgesRenderer implements IEdgesRenderer {
  87617. /**
  87618. * Define the size of the edges with an orthographic camera
  87619. */
  87620. edgesWidthScalerForOrthographic: number;
  87621. /**
  87622. * Define the size of the edges with a perspective camera
  87623. */
  87624. edgesWidthScalerForPerspective: number;
  87625. protected _source: AbstractMesh;
  87626. protected _linesPositions: number[];
  87627. protected _linesNormals: number[];
  87628. protected _linesIndices: number[];
  87629. protected _epsilon: number;
  87630. protected _indicesCount: number;
  87631. protected _lineShader: ShaderMaterial;
  87632. protected _ib: DataBuffer;
  87633. protected _buffers: {
  87634. [key: string]: Nullable<VertexBuffer>;
  87635. };
  87636. protected _checkVerticesInsteadOfIndices: boolean;
  87637. private _meshRebuildObserver;
  87638. private _meshDisposeObserver;
  87639. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  87640. isEnabled: boolean;
  87641. /**
  87642. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  87643. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  87644. * @param source Mesh used to create edges
  87645. * @param epsilon sum of angles in adjacency to check for edge
  87646. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  87647. * @param generateEdgesLines - should generate Lines or only prepare resources.
  87648. */
  87649. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  87650. protected _prepareRessources(): void;
  87651. /** @hidden */
  87652. _rebuild(): void;
  87653. /**
  87654. * Releases the required resources for the edges renderer
  87655. */
  87656. dispose(): void;
  87657. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  87658. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  87659. /**
  87660. * Checks if the pair of p0 and p1 is en edge
  87661. * @param faceIndex
  87662. * @param edge
  87663. * @param faceNormals
  87664. * @param p0
  87665. * @param p1
  87666. * @private
  87667. */
  87668. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  87669. /**
  87670. * push line into the position, normal and index buffer
  87671. * @protected
  87672. */
  87673. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  87674. /**
  87675. * Generates lines edges from adjacencjes
  87676. * @private
  87677. */
  87678. _generateEdgesLines(): void;
  87679. /**
  87680. * Checks wether or not the edges renderer is ready to render.
  87681. * @return true if ready, otherwise false.
  87682. */
  87683. isReady(): boolean;
  87684. /**
  87685. * Renders the edges of the attached mesh,
  87686. */
  87687. render(): void;
  87688. }
  87689. /**
  87690. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  87691. */
  87692. export class LineEdgesRenderer extends EdgesRenderer {
  87693. /**
  87694. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  87695. * @param source LineMesh used to generate edges
  87696. * @param epsilon not important (specified angle for edge detection)
  87697. * @param checkVerticesInsteadOfIndices not important for LineMesh
  87698. */
  87699. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  87700. /**
  87701. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  87702. */
  87703. _generateEdgesLines(): void;
  87704. }
  87705. }
  87706. declare module BABYLON {
  87707. /**
  87708. * This represents the object necessary to create a rendering group.
  87709. * This is exclusively used and created by the rendering manager.
  87710. * To modify the behavior, you use the available helpers in your scene or meshes.
  87711. * @hidden
  87712. */
  87713. export class RenderingGroup {
  87714. index: number;
  87715. private static _zeroVector;
  87716. private _scene;
  87717. private _opaqueSubMeshes;
  87718. private _transparentSubMeshes;
  87719. private _alphaTestSubMeshes;
  87720. private _depthOnlySubMeshes;
  87721. private _particleSystems;
  87722. private _spriteManagers;
  87723. private _opaqueSortCompareFn;
  87724. private _alphaTestSortCompareFn;
  87725. private _transparentSortCompareFn;
  87726. private _renderOpaque;
  87727. private _renderAlphaTest;
  87728. private _renderTransparent;
  87729. /** @hidden */
  87730. _edgesRenderers: SmartArray<IEdgesRenderer>;
  87731. onBeforeTransparentRendering: () => void;
  87732. /**
  87733. * Set the opaque sort comparison function.
  87734. * If null the sub meshes will be render in the order they were created
  87735. */
  87736. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  87737. /**
  87738. * Set the alpha test sort comparison function.
  87739. * If null the sub meshes will be render in the order they were created
  87740. */
  87741. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  87742. /**
  87743. * Set the transparent sort comparison function.
  87744. * If null the sub meshes will be render in the order they were created
  87745. */
  87746. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  87747. /**
  87748. * Creates a new rendering group.
  87749. * @param index The rendering group index
  87750. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  87751. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  87752. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  87753. */
  87754. constructor(index: number, scene: Scene, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>);
  87755. /**
  87756. * Render all the sub meshes contained in the group.
  87757. * @param customRenderFunction Used to override the default render behaviour of the group.
  87758. * @returns true if rendered some submeshes.
  87759. */
  87760. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  87761. /**
  87762. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  87763. * @param subMeshes The submeshes to render
  87764. */
  87765. private renderOpaqueSorted;
  87766. /**
  87767. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  87768. * @param subMeshes The submeshes to render
  87769. */
  87770. private renderAlphaTestSorted;
  87771. /**
  87772. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  87773. * @param subMeshes The submeshes to render
  87774. */
  87775. private renderTransparentSorted;
  87776. /**
  87777. * Renders the submeshes in a specified order.
  87778. * @param subMeshes The submeshes to sort before render
  87779. * @param sortCompareFn The comparison function use to sort
  87780. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  87781. * @param transparent Specifies to activate blending if true
  87782. */
  87783. private static renderSorted;
  87784. /**
  87785. * Renders the submeshes in the order they were dispatched (no sort applied).
  87786. * @param subMeshes The submeshes to render
  87787. */
  87788. private static renderUnsorted;
  87789. /**
  87790. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  87791. * are rendered back to front if in the same alpha index.
  87792. *
  87793. * @param a The first submesh
  87794. * @param b The second submesh
  87795. * @returns The result of the comparison
  87796. */
  87797. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  87798. /**
  87799. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  87800. * are rendered back to front.
  87801. *
  87802. * @param a The first submesh
  87803. * @param b The second submesh
  87804. * @returns The result of the comparison
  87805. */
  87806. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  87807. /**
  87808. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  87809. * are rendered front to back (prevent overdraw).
  87810. *
  87811. * @param a The first submesh
  87812. * @param b The second submesh
  87813. * @returns The result of the comparison
  87814. */
  87815. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  87816. /**
  87817. * Resets the different lists of submeshes to prepare a new frame.
  87818. */
  87819. prepare(): void;
  87820. dispose(): void;
  87821. /**
  87822. * Inserts the submesh in its correct queue depending on its material.
  87823. * @param subMesh The submesh to dispatch
  87824. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  87825. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  87826. */
  87827. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  87828. dispatchSprites(spriteManager: ISpriteManager): void;
  87829. dispatchParticles(particleSystem: IParticleSystem): void;
  87830. private _renderParticles;
  87831. private _renderSprites;
  87832. }
  87833. }
  87834. declare module BABYLON {
  87835. /**
  87836. * Interface describing the different options available in the rendering manager
  87837. * regarding Auto Clear between groups.
  87838. */
  87839. export interface IRenderingManagerAutoClearSetup {
  87840. /**
  87841. * Defines whether or not autoclear is enable.
  87842. */
  87843. autoClear: boolean;
  87844. /**
  87845. * Defines whether or not to autoclear the depth buffer.
  87846. */
  87847. depth: boolean;
  87848. /**
  87849. * Defines whether or not to autoclear the stencil buffer.
  87850. */
  87851. stencil: boolean;
  87852. }
  87853. /**
  87854. * This class is used by the onRenderingGroupObservable
  87855. */
  87856. export class RenderingGroupInfo {
  87857. /**
  87858. * The Scene that being rendered
  87859. */
  87860. scene: Scene;
  87861. /**
  87862. * The camera currently used for the rendering pass
  87863. */
  87864. camera: Nullable<Camera>;
  87865. /**
  87866. * The ID of the renderingGroup being processed
  87867. */
  87868. renderingGroupId: number;
  87869. }
  87870. /**
  87871. * This is the manager responsible of all the rendering for meshes sprites and particles.
  87872. * It is enable to manage the different groups as well as the different necessary sort functions.
  87873. * This should not be used directly aside of the few static configurations
  87874. */
  87875. export class RenderingManager {
  87876. /**
  87877. * The max id used for rendering groups (not included)
  87878. */
  87879. static MAX_RENDERINGGROUPS: number;
  87880. /**
  87881. * The min id used for rendering groups (included)
  87882. */
  87883. static MIN_RENDERINGGROUPS: number;
  87884. /**
  87885. * Used to globally prevent autoclearing scenes.
  87886. */
  87887. static AUTOCLEAR: boolean;
  87888. /**
  87889. * @hidden
  87890. */
  87891. _useSceneAutoClearSetup: boolean;
  87892. private _scene;
  87893. private _renderingGroups;
  87894. private _depthStencilBufferAlreadyCleaned;
  87895. private _autoClearDepthStencil;
  87896. private _customOpaqueSortCompareFn;
  87897. private _customAlphaTestSortCompareFn;
  87898. private _customTransparentSortCompareFn;
  87899. private _renderingGroupInfo;
  87900. /**
  87901. * Instantiates a new rendering group for a particular scene
  87902. * @param scene Defines the scene the groups belongs to
  87903. */
  87904. constructor(scene: Scene);
  87905. private _clearDepthStencilBuffer;
  87906. /**
  87907. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  87908. * @hidden
  87909. */
  87910. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  87911. /**
  87912. * Resets the different information of the group to prepare a new frame
  87913. * @hidden
  87914. */
  87915. reset(): void;
  87916. /**
  87917. * Dispose and release the group and its associated resources.
  87918. * @hidden
  87919. */
  87920. dispose(): void;
  87921. /**
  87922. * Clear the info related to rendering groups preventing retention points during dispose.
  87923. */
  87924. freeRenderingGroups(): void;
  87925. private _prepareRenderingGroup;
  87926. /**
  87927. * Add a sprite manager to the rendering manager in order to render it this frame.
  87928. * @param spriteManager Define the sprite manager to render
  87929. */
  87930. dispatchSprites(spriteManager: ISpriteManager): void;
  87931. /**
  87932. * Add a particle system to the rendering manager in order to render it this frame.
  87933. * @param particleSystem Define the particle system to render
  87934. */
  87935. dispatchParticles(particleSystem: IParticleSystem): void;
  87936. /**
  87937. * Add a submesh to the manager in order to render it this frame
  87938. * @param subMesh The submesh to dispatch
  87939. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  87940. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  87941. */
  87942. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  87943. /**
  87944. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  87945. * This allowed control for front to back rendering or reversly depending of the special needs.
  87946. *
  87947. * @param renderingGroupId The rendering group id corresponding to its index
  87948. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  87949. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  87950. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  87951. */
  87952. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  87953. /**
  87954. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  87955. *
  87956. * @param renderingGroupId The rendering group id corresponding to its index
  87957. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  87958. * @param depth Automatically clears depth between groups if true and autoClear is true.
  87959. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  87960. */
  87961. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  87962. /**
  87963. * Gets the current auto clear configuration for one rendering group of the rendering
  87964. * manager.
  87965. * @param index the rendering group index to get the information for
  87966. * @returns The auto clear setup for the requested rendering group
  87967. */
  87968. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  87969. }
  87970. }
  87971. declare module BABYLON {
  87972. /**
  87973. * This Helps creating a texture that will be created from a camera in your scene.
  87974. * It is basically a dynamic texture that could be used to create special effects for instance.
  87975. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  87976. */
  87977. export class RenderTargetTexture extends Texture {
  87978. isCube: boolean;
  87979. /**
  87980. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  87981. */
  87982. static readonly REFRESHRATE_RENDER_ONCE: number;
  87983. /**
  87984. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  87985. */
  87986. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  87987. /**
  87988. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  87989. * the central point of your effect and can save a lot of performances.
  87990. */
  87991. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  87992. /**
  87993. * Use this predicate to dynamically define the list of mesh you want to render.
  87994. * If set, the renderList property will be overwritten.
  87995. */
  87996. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  87997. private _renderList;
  87998. /**
  87999. * Use this list to define the list of mesh you want to render.
  88000. */
  88001. renderList: Nullable<Array<AbstractMesh>>;
  88002. private _hookArray;
  88003. /**
  88004. * Define if particles should be rendered in your texture.
  88005. */
  88006. renderParticles: boolean;
  88007. /**
  88008. * Define if sprites should be rendered in your texture.
  88009. */
  88010. renderSprites: boolean;
  88011. /**
  88012. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  88013. */
  88014. coordinatesMode: number;
  88015. /**
  88016. * Define the camera used to render the texture.
  88017. */
  88018. activeCamera: Nullable<Camera>;
  88019. /**
  88020. * Override the render function of the texture with your own one.
  88021. */
  88022. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  88023. /**
  88024. * Define if camera post processes should be use while rendering the texture.
  88025. */
  88026. useCameraPostProcesses: boolean;
  88027. /**
  88028. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  88029. */
  88030. ignoreCameraViewport: boolean;
  88031. private _postProcessManager;
  88032. private _postProcesses;
  88033. private _resizeObserver;
  88034. /**
  88035. * An event triggered when the texture is unbind.
  88036. */
  88037. onBeforeBindObservable: Observable<RenderTargetTexture>;
  88038. /**
  88039. * An event triggered when the texture is unbind.
  88040. */
  88041. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  88042. private _onAfterUnbindObserver;
  88043. /**
  88044. * Set a after unbind callback in the texture.
  88045. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  88046. */
  88047. onAfterUnbind: () => void;
  88048. /**
  88049. * An event triggered before rendering the texture
  88050. */
  88051. onBeforeRenderObservable: Observable<number>;
  88052. private _onBeforeRenderObserver;
  88053. /**
  88054. * Set a before render callback in the texture.
  88055. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  88056. */
  88057. onBeforeRender: (faceIndex: number) => void;
  88058. /**
  88059. * An event triggered after rendering the texture
  88060. */
  88061. onAfterRenderObservable: Observable<number>;
  88062. private _onAfterRenderObserver;
  88063. /**
  88064. * Set a after render callback in the texture.
  88065. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  88066. */
  88067. onAfterRender: (faceIndex: number) => void;
  88068. /**
  88069. * An event triggered after the texture clear
  88070. */
  88071. onClearObservable: Observable<Engine>;
  88072. private _onClearObserver;
  88073. /**
  88074. * Set a clear callback in the texture.
  88075. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  88076. */
  88077. onClear: (Engine: Engine) => void;
  88078. /**
  88079. * An event triggered when the texture is resized.
  88080. */
  88081. onResizeObservable: Observable<RenderTargetTexture>;
  88082. /**
  88083. * Define the clear color of the Render Target if it should be different from the scene.
  88084. */
  88085. clearColor: Color4;
  88086. protected _size: number | {
  88087. width: number;
  88088. height: number;
  88089. };
  88090. protected _initialSizeParameter: number | {
  88091. width: number;
  88092. height: number;
  88093. } | {
  88094. ratio: number;
  88095. };
  88096. protected _sizeRatio: Nullable<number>;
  88097. /** @hidden */
  88098. _generateMipMaps: boolean;
  88099. protected _renderingManager: RenderingManager;
  88100. /** @hidden */
  88101. _waitingRenderList: string[];
  88102. protected _doNotChangeAspectRatio: boolean;
  88103. protected _currentRefreshId: number;
  88104. protected _refreshRate: number;
  88105. protected _textureMatrix: Matrix;
  88106. protected _samples: number;
  88107. protected _renderTargetOptions: RenderTargetCreationOptions;
  88108. /**
  88109. * Gets render target creation options that were used.
  88110. */
  88111. readonly renderTargetOptions: RenderTargetCreationOptions;
  88112. protected _engine: Engine;
  88113. protected _onRatioRescale(): void;
  88114. /**
  88115. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  88116. * It must define where the camera used to render the texture is set
  88117. */
  88118. boundingBoxPosition: Vector3;
  88119. private _boundingBoxSize;
  88120. /**
  88121. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  88122. * When defined, the cubemap will switch to local mode
  88123. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  88124. * @example https://www.babylonjs-playground.com/#RNASML
  88125. */
  88126. boundingBoxSize: Vector3;
  88127. /**
  88128. * In case the RTT has been created with a depth texture, get the associated
  88129. * depth texture.
  88130. * Otherwise, return null.
  88131. */
  88132. depthStencilTexture: Nullable<InternalTexture>;
  88133. /**
  88134. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  88135. * or used a shadow, depth texture...
  88136. * @param name The friendly name of the texture
  88137. * @param size The size of the RTT (number if square, or {width: number, height:number} or {ratio:} to define a ratio from the main scene)
  88138. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  88139. * @param generateMipMaps True if mip maps need to be generated after render.
  88140. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  88141. * @param type The type of the buffer in the RTT (int, half float, float...)
  88142. * @param isCube True if a cube texture needs to be created
  88143. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  88144. * @param generateDepthBuffer True to generate a depth buffer
  88145. * @param generateStencilBuffer True to generate a stencil buffer
  88146. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  88147. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  88148. * @param delayAllocation if the texture allocation should be delayed (default: false)
  88149. */
  88150. constructor(name: string, size: number | {
  88151. width: number;
  88152. height: number;
  88153. } | {
  88154. ratio: number;
  88155. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  88156. /**
  88157. * Creates a depth stencil texture.
  88158. * This is only available in WebGL 2 or with the depth texture extension available.
  88159. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  88160. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  88161. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  88162. */
  88163. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  88164. private _processSizeParameter;
  88165. /**
  88166. * Define the number of samples to use in case of MSAA.
  88167. * It defaults to one meaning no MSAA has been enabled.
  88168. */
  88169. samples: number;
  88170. /**
  88171. * Resets the refresh counter of the texture and start bak from scratch.
  88172. * Could be useful to regenerate the texture if it is setup to render only once.
  88173. */
  88174. resetRefreshCounter(): void;
  88175. /**
  88176. * Define the refresh rate of the texture or the rendering frequency.
  88177. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  88178. */
  88179. refreshRate: number;
  88180. /**
  88181. * Adds a post process to the render target rendering passes.
  88182. * @param postProcess define the post process to add
  88183. */
  88184. addPostProcess(postProcess: PostProcess): void;
  88185. /**
  88186. * Clear all the post processes attached to the render target
  88187. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  88188. */
  88189. clearPostProcesses(dispose?: boolean): void;
  88190. /**
  88191. * Remove one of the post process from the list of attached post processes to the texture
  88192. * @param postProcess define the post process to remove from the list
  88193. */
  88194. removePostProcess(postProcess: PostProcess): void;
  88195. /** @hidden */
  88196. _shouldRender(): boolean;
  88197. /**
  88198. * Gets the actual render size of the texture.
  88199. * @returns the width of the render size
  88200. */
  88201. getRenderSize(): number;
  88202. /**
  88203. * Gets the actual render width of the texture.
  88204. * @returns the width of the render size
  88205. */
  88206. getRenderWidth(): number;
  88207. /**
  88208. * Gets the actual render height of the texture.
  88209. * @returns the height of the render size
  88210. */
  88211. getRenderHeight(): number;
  88212. /**
  88213. * Get if the texture can be rescaled or not.
  88214. */
  88215. readonly canRescale: boolean;
  88216. /**
  88217. * Resize the texture using a ratio.
  88218. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  88219. */
  88220. scale(ratio: number): void;
  88221. /**
  88222. * Get the texture reflection matrix used to rotate/transform the reflection.
  88223. * @returns the reflection matrix
  88224. */
  88225. getReflectionTextureMatrix(): Matrix;
  88226. /**
  88227. * Resize the texture to a new desired size.
  88228. * Be carrefull as it will recreate all the data in the new texture.
  88229. * @param size Define the new size. It can be:
  88230. * - a number for squared texture,
  88231. * - an object containing { width: number, height: number }
  88232. * - or an object containing a ratio { ratio: number }
  88233. */
  88234. resize(size: number | {
  88235. width: number;
  88236. height: number;
  88237. } | {
  88238. ratio: number;
  88239. }): void;
  88240. /**
  88241. * Renders all the objects from the render list into the texture.
  88242. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  88243. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  88244. */
  88245. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  88246. private _bestReflectionRenderTargetDimension;
  88247. /**
  88248. * @hidden
  88249. * @param faceIndex face index to bind to if this is a cubetexture
  88250. */
  88251. _bindFrameBuffer(faceIndex?: number): void;
  88252. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  88253. private renderToTarget;
  88254. /**
  88255. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  88256. * This allowed control for front to back rendering or reversly depending of the special needs.
  88257. *
  88258. * @param renderingGroupId The rendering group id corresponding to its index
  88259. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  88260. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  88261. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  88262. */
  88263. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  88264. /**
  88265. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  88266. *
  88267. * @param renderingGroupId The rendering group id corresponding to its index
  88268. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  88269. */
  88270. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  88271. /**
  88272. * Clones the texture.
  88273. * @returns the cloned texture
  88274. */
  88275. clone(): RenderTargetTexture;
  88276. /**
  88277. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  88278. * @returns The JSON representation of the texture
  88279. */
  88280. serialize(): any;
  88281. /**
  88282. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  88283. */
  88284. disposeFramebufferObjects(): void;
  88285. /**
  88286. * Dispose the texture and release its associated resources.
  88287. */
  88288. dispose(): void;
  88289. /** @hidden */
  88290. _rebuild(): void;
  88291. /**
  88292. * Clear the info related to rendering groups preventing retention point in material dispose.
  88293. */
  88294. freeRenderingGroups(): void;
  88295. /**
  88296. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  88297. * @returns the view count
  88298. */
  88299. getViewCount(): number;
  88300. }
  88301. }
  88302. declare module BABYLON {
  88303. /**
  88304. * Options for compiling materials.
  88305. */
  88306. export interface IMaterialCompilationOptions {
  88307. /**
  88308. * Defines whether clip planes are enabled.
  88309. */
  88310. clipPlane: boolean;
  88311. /**
  88312. * Defines whether instances are enabled.
  88313. */
  88314. useInstances: boolean;
  88315. }
  88316. /**
  88317. * Base class for the main features of a material in Babylon.js
  88318. */
  88319. export class Material implements IAnimatable {
  88320. /**
  88321. * Returns the triangle fill mode
  88322. */
  88323. static readonly TriangleFillMode: number;
  88324. /**
  88325. * Returns the wireframe mode
  88326. */
  88327. static readonly WireFrameFillMode: number;
  88328. /**
  88329. * Returns the point fill mode
  88330. */
  88331. static readonly PointFillMode: number;
  88332. /**
  88333. * Returns the point list draw mode
  88334. */
  88335. static readonly PointListDrawMode: number;
  88336. /**
  88337. * Returns the line list draw mode
  88338. */
  88339. static readonly LineListDrawMode: number;
  88340. /**
  88341. * Returns the line loop draw mode
  88342. */
  88343. static readonly LineLoopDrawMode: number;
  88344. /**
  88345. * Returns the line strip draw mode
  88346. */
  88347. static readonly LineStripDrawMode: number;
  88348. /**
  88349. * Returns the triangle strip draw mode
  88350. */
  88351. static readonly TriangleStripDrawMode: number;
  88352. /**
  88353. * Returns the triangle fan draw mode
  88354. */
  88355. static readonly TriangleFanDrawMode: number;
  88356. /**
  88357. * Stores the clock-wise side orientation
  88358. */
  88359. static readonly ClockWiseSideOrientation: number;
  88360. /**
  88361. * Stores the counter clock-wise side orientation
  88362. */
  88363. static readonly CounterClockWiseSideOrientation: number;
  88364. /**
  88365. * The dirty texture flag value
  88366. */
  88367. static readonly TextureDirtyFlag: number;
  88368. /**
  88369. * The dirty light flag value
  88370. */
  88371. static readonly LightDirtyFlag: number;
  88372. /**
  88373. * The dirty fresnel flag value
  88374. */
  88375. static readonly FresnelDirtyFlag: number;
  88376. /**
  88377. * The dirty attribute flag value
  88378. */
  88379. static readonly AttributesDirtyFlag: number;
  88380. /**
  88381. * The dirty misc flag value
  88382. */
  88383. static readonly MiscDirtyFlag: number;
  88384. /**
  88385. * The all dirty flag value
  88386. */
  88387. static readonly AllDirtyFlag: number;
  88388. /**
  88389. * The ID of the material
  88390. */
  88391. id: string;
  88392. /**
  88393. * Gets or sets the unique id of the material
  88394. */
  88395. uniqueId: number;
  88396. /**
  88397. * The name of the material
  88398. */
  88399. name: string;
  88400. /**
  88401. * Gets or sets user defined metadata
  88402. */
  88403. metadata: any;
  88404. /**
  88405. * For internal use only. Please do not use.
  88406. */
  88407. reservedDataStore: any;
  88408. /**
  88409. * Specifies if the ready state should be checked on each call
  88410. */
  88411. checkReadyOnEveryCall: boolean;
  88412. /**
  88413. * Specifies if the ready state should be checked once
  88414. */
  88415. checkReadyOnlyOnce: boolean;
  88416. /**
  88417. * The state of the material
  88418. */
  88419. state: string;
  88420. /**
  88421. * The alpha value of the material
  88422. */
  88423. protected _alpha: number;
  88424. /**
  88425. * List of inspectable custom properties (used by the Inspector)
  88426. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  88427. */
  88428. inspectableCustomProperties: IInspectable[];
  88429. /**
  88430. * Sets the alpha value of the material
  88431. */
  88432. /**
  88433. * Gets the alpha value of the material
  88434. */
  88435. alpha: number;
  88436. /**
  88437. * Specifies if back face culling is enabled
  88438. */
  88439. protected _backFaceCulling: boolean;
  88440. /**
  88441. * Sets the back-face culling state
  88442. */
  88443. /**
  88444. * Gets the back-face culling state
  88445. */
  88446. backFaceCulling: boolean;
  88447. /**
  88448. * Stores the value for side orientation
  88449. */
  88450. sideOrientation: number;
  88451. /**
  88452. * Callback triggered when the material is compiled
  88453. */
  88454. onCompiled: Nullable<(effect: Effect) => void>;
  88455. /**
  88456. * Callback triggered when an error occurs
  88457. */
  88458. onError: Nullable<(effect: Effect, errors: string) => void>;
  88459. /**
  88460. * Callback triggered to get the render target textures
  88461. */
  88462. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  88463. /**
  88464. * Gets a boolean indicating that current material needs to register RTT
  88465. */
  88466. readonly hasRenderTargetTextures: boolean;
  88467. /**
  88468. * Specifies if the material should be serialized
  88469. */
  88470. doNotSerialize: boolean;
  88471. /**
  88472. * @hidden
  88473. */
  88474. _storeEffectOnSubMeshes: boolean;
  88475. /**
  88476. * Stores the animations for the material
  88477. */
  88478. animations: Nullable<Array<Animation>>;
  88479. /**
  88480. * An event triggered when the material is disposed
  88481. */
  88482. onDisposeObservable: Observable<Material>;
  88483. /**
  88484. * An observer which watches for dispose events
  88485. */
  88486. private _onDisposeObserver;
  88487. private _onUnBindObservable;
  88488. /**
  88489. * Called during a dispose event
  88490. */
  88491. onDispose: () => void;
  88492. private _onBindObservable;
  88493. /**
  88494. * An event triggered when the material is bound
  88495. */
  88496. readonly onBindObservable: Observable<AbstractMesh>;
  88497. /**
  88498. * An observer which watches for bind events
  88499. */
  88500. private _onBindObserver;
  88501. /**
  88502. * Called during a bind event
  88503. */
  88504. onBind: (Mesh: AbstractMesh) => void;
  88505. /**
  88506. * An event triggered when the material is unbound
  88507. */
  88508. readonly onUnBindObservable: Observable<Material>;
  88509. /**
  88510. * Stores the value of the alpha mode
  88511. */
  88512. private _alphaMode;
  88513. /**
  88514. * Sets the value of the alpha mode.
  88515. *
  88516. * | Value | Type | Description |
  88517. * | --- | --- | --- |
  88518. * | 0 | ALPHA_DISABLE | |
  88519. * | 1 | ALPHA_ADD | |
  88520. * | 2 | ALPHA_COMBINE | |
  88521. * | 3 | ALPHA_SUBTRACT | |
  88522. * | 4 | ALPHA_MULTIPLY | |
  88523. * | 5 | ALPHA_MAXIMIZED | |
  88524. * | 6 | ALPHA_ONEONE | |
  88525. * | 7 | ALPHA_PREMULTIPLIED | |
  88526. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  88527. * | 9 | ALPHA_INTERPOLATE | |
  88528. * | 10 | ALPHA_SCREENMODE | |
  88529. *
  88530. */
  88531. /**
  88532. * Gets the value of the alpha mode
  88533. */
  88534. alphaMode: number;
  88535. /**
  88536. * Stores the state of the need depth pre-pass value
  88537. */
  88538. private _needDepthPrePass;
  88539. /**
  88540. * Sets the need depth pre-pass value
  88541. */
  88542. /**
  88543. * Gets the depth pre-pass value
  88544. */
  88545. needDepthPrePass: boolean;
  88546. /**
  88547. * Specifies if depth writing should be disabled
  88548. */
  88549. disableDepthWrite: boolean;
  88550. /**
  88551. * Specifies if depth writing should be forced
  88552. */
  88553. forceDepthWrite: boolean;
  88554. /**
  88555. * Specifies if there should be a separate pass for culling
  88556. */
  88557. separateCullingPass: boolean;
  88558. /**
  88559. * Stores the state specifing if fog should be enabled
  88560. */
  88561. private _fogEnabled;
  88562. /**
  88563. * Sets the state for enabling fog
  88564. */
  88565. /**
  88566. * Gets the value of the fog enabled state
  88567. */
  88568. fogEnabled: boolean;
  88569. /**
  88570. * Stores the size of points
  88571. */
  88572. pointSize: number;
  88573. /**
  88574. * Stores the z offset value
  88575. */
  88576. zOffset: number;
  88577. /**
  88578. * Gets a value specifying if wireframe mode is enabled
  88579. */
  88580. /**
  88581. * Sets the state of wireframe mode
  88582. */
  88583. wireframe: boolean;
  88584. /**
  88585. * Gets the value specifying if point clouds are enabled
  88586. */
  88587. /**
  88588. * Sets the state of point cloud mode
  88589. */
  88590. pointsCloud: boolean;
  88591. /**
  88592. * Gets the material fill mode
  88593. */
  88594. /**
  88595. * Sets the material fill mode
  88596. */
  88597. fillMode: number;
  88598. /**
  88599. * @hidden
  88600. * Stores the effects for the material
  88601. */
  88602. _effect: Nullable<Effect>;
  88603. /**
  88604. * @hidden
  88605. * Specifies if the material was previously ready
  88606. */
  88607. _wasPreviouslyReady: boolean;
  88608. /**
  88609. * Specifies if uniform buffers should be used
  88610. */
  88611. private _useUBO;
  88612. /**
  88613. * Stores a reference to the scene
  88614. */
  88615. private _scene;
  88616. /**
  88617. * Stores the fill mode state
  88618. */
  88619. private _fillMode;
  88620. /**
  88621. * Specifies if the depth write state should be cached
  88622. */
  88623. private _cachedDepthWriteState;
  88624. /**
  88625. * Stores the uniform buffer
  88626. */
  88627. protected _uniformBuffer: UniformBuffer;
  88628. /** @hidden */
  88629. _indexInSceneMaterialArray: number;
  88630. /** @hidden */
  88631. meshMap: Nullable<{
  88632. [id: string]: AbstractMesh | undefined;
  88633. }>;
  88634. /**
  88635. * Creates a material instance
  88636. * @param name defines the name of the material
  88637. * @param scene defines the scene to reference
  88638. * @param doNotAdd specifies if the material should be added to the scene
  88639. */
  88640. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  88641. /**
  88642. * Returns a string representation of the current material
  88643. * @param fullDetails defines a boolean indicating which levels of logging is desired
  88644. * @returns a string with material information
  88645. */
  88646. toString(fullDetails?: boolean): string;
  88647. /**
  88648. * Gets the class name of the material
  88649. * @returns a string with the class name of the material
  88650. */
  88651. getClassName(): string;
  88652. /**
  88653. * Specifies if updates for the material been locked
  88654. */
  88655. readonly isFrozen: boolean;
  88656. /**
  88657. * Locks updates for the material
  88658. */
  88659. freeze(): void;
  88660. /**
  88661. * Unlocks updates for the material
  88662. */
  88663. unfreeze(): void;
  88664. /**
  88665. * Specifies if the material is ready to be used
  88666. * @param mesh defines the mesh to check
  88667. * @param useInstances specifies if instances should be used
  88668. * @returns a boolean indicating if the material is ready to be used
  88669. */
  88670. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  88671. /**
  88672. * Specifies that the submesh is ready to be used
  88673. * @param mesh defines the mesh to check
  88674. * @param subMesh defines which submesh to check
  88675. * @param useInstances specifies that instances should be used
  88676. * @returns a boolean indicating that the submesh is ready or not
  88677. */
  88678. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  88679. /**
  88680. * Returns the material effect
  88681. * @returns the effect associated with the material
  88682. */
  88683. getEffect(): Nullable<Effect>;
  88684. /**
  88685. * Returns the current scene
  88686. * @returns a Scene
  88687. */
  88688. getScene(): Scene;
  88689. /**
  88690. * Specifies if the material will require alpha blending
  88691. * @returns a boolean specifying if alpha blending is needed
  88692. */
  88693. needAlphaBlending(): boolean;
  88694. /**
  88695. * Specifies if the mesh will require alpha blending
  88696. * @param mesh defines the mesh to check
  88697. * @returns a boolean specifying if alpha blending is needed for the mesh
  88698. */
  88699. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  88700. /**
  88701. * Specifies if this material should be rendered in alpha test mode
  88702. * @returns a boolean specifying if an alpha test is needed.
  88703. */
  88704. needAlphaTesting(): boolean;
  88705. /**
  88706. * Gets the texture used for the alpha test
  88707. * @returns the texture to use for alpha testing
  88708. */
  88709. getAlphaTestTexture(): Nullable<BaseTexture>;
  88710. /**
  88711. * Marks the material to indicate that it needs to be re-calculated
  88712. */
  88713. markDirty(): void;
  88714. /** @hidden */
  88715. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  88716. /**
  88717. * Binds the material to the mesh
  88718. * @param world defines the world transformation matrix
  88719. * @param mesh defines the mesh to bind the material to
  88720. */
  88721. bind(world: Matrix, mesh?: Mesh): void;
  88722. /**
  88723. * Binds the submesh to the material
  88724. * @param world defines the world transformation matrix
  88725. * @param mesh defines the mesh containing the submesh
  88726. * @param subMesh defines the submesh to bind the material to
  88727. */
  88728. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  88729. /**
  88730. * Binds the world matrix to the material
  88731. * @param world defines the world transformation matrix
  88732. */
  88733. bindOnlyWorldMatrix(world: Matrix): void;
  88734. /**
  88735. * Binds the scene's uniform buffer to the effect.
  88736. * @param effect defines the effect to bind to the scene uniform buffer
  88737. * @param sceneUbo defines the uniform buffer storing scene data
  88738. */
  88739. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  88740. /**
  88741. * Binds the view matrix to the effect
  88742. * @param effect defines the effect to bind the view matrix to
  88743. */
  88744. bindView(effect: Effect): void;
  88745. /**
  88746. * Binds the view projection matrix to the effect
  88747. * @param effect defines the effect to bind the view projection matrix to
  88748. */
  88749. bindViewProjection(effect: Effect): void;
  88750. /**
  88751. * Specifies if material alpha testing should be turned on for the mesh
  88752. * @param mesh defines the mesh to check
  88753. */
  88754. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  88755. /**
  88756. * Processes to execute after binding the material to a mesh
  88757. * @param mesh defines the rendered mesh
  88758. */
  88759. protected _afterBind(mesh?: Mesh): void;
  88760. /**
  88761. * Unbinds the material from the mesh
  88762. */
  88763. unbind(): void;
  88764. /**
  88765. * Gets the active textures from the material
  88766. * @returns an array of textures
  88767. */
  88768. getActiveTextures(): BaseTexture[];
  88769. /**
  88770. * Specifies if the material uses a texture
  88771. * @param texture defines the texture to check against the material
  88772. * @returns a boolean specifying if the material uses the texture
  88773. */
  88774. hasTexture(texture: BaseTexture): boolean;
  88775. /**
  88776. * Makes a duplicate of the material, and gives it a new name
  88777. * @param name defines the new name for the duplicated material
  88778. * @returns the cloned material
  88779. */
  88780. clone(name: string): Nullable<Material>;
  88781. /**
  88782. * Gets the meshes bound to the material
  88783. * @returns an array of meshes bound to the material
  88784. */
  88785. getBindedMeshes(): AbstractMesh[];
  88786. /**
  88787. * Force shader compilation
  88788. * @param mesh defines the mesh associated with this material
  88789. * @param onCompiled defines a function to execute once the material is compiled
  88790. * @param options defines the options to configure the compilation
  88791. * @param onError defines a function to execute if the material fails compiling
  88792. */
  88793. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  88794. /**
  88795. * Force shader compilation
  88796. * @param mesh defines the mesh that will use this material
  88797. * @param options defines additional options for compiling the shaders
  88798. * @returns a promise that resolves when the compilation completes
  88799. */
  88800. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  88801. private static readonly _AllDirtyCallBack;
  88802. private static readonly _ImageProcessingDirtyCallBack;
  88803. private static readonly _TextureDirtyCallBack;
  88804. private static readonly _FresnelDirtyCallBack;
  88805. private static readonly _MiscDirtyCallBack;
  88806. private static readonly _LightsDirtyCallBack;
  88807. private static readonly _AttributeDirtyCallBack;
  88808. private static _FresnelAndMiscDirtyCallBack;
  88809. private static _TextureAndMiscDirtyCallBack;
  88810. private static readonly _DirtyCallbackArray;
  88811. private static readonly _RunDirtyCallBacks;
  88812. /**
  88813. * Marks a define in the material to indicate that it needs to be re-computed
  88814. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  88815. */
  88816. markAsDirty(flag: number): void;
  88817. /**
  88818. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  88819. * @param func defines a function which checks material defines against the submeshes
  88820. */
  88821. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  88822. /**
  88823. * Indicates that we need to re-calculated for all submeshes
  88824. */
  88825. protected _markAllSubMeshesAsAllDirty(): void;
  88826. /**
  88827. * Indicates that image processing needs to be re-calculated for all submeshes
  88828. */
  88829. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  88830. /**
  88831. * Indicates that textures need to be re-calculated for all submeshes
  88832. */
  88833. protected _markAllSubMeshesAsTexturesDirty(): void;
  88834. /**
  88835. * Indicates that fresnel needs to be re-calculated for all submeshes
  88836. */
  88837. protected _markAllSubMeshesAsFresnelDirty(): void;
  88838. /**
  88839. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  88840. */
  88841. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  88842. /**
  88843. * Indicates that lights need to be re-calculated for all submeshes
  88844. */
  88845. protected _markAllSubMeshesAsLightsDirty(): void;
  88846. /**
  88847. * Indicates that attributes need to be re-calculated for all submeshes
  88848. */
  88849. protected _markAllSubMeshesAsAttributesDirty(): void;
  88850. /**
  88851. * Indicates that misc needs to be re-calculated for all submeshes
  88852. */
  88853. protected _markAllSubMeshesAsMiscDirty(): void;
  88854. /**
  88855. * Indicates that textures and misc need to be re-calculated for all submeshes
  88856. */
  88857. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  88858. /**
  88859. * Disposes the material
  88860. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  88861. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  88862. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  88863. */
  88864. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  88865. /** @hidden */
  88866. private releaseVertexArrayObject;
  88867. /**
  88868. * Serializes this material
  88869. * @returns the serialized material object
  88870. */
  88871. serialize(): any;
  88872. /**
  88873. * Creates a material from parsed material data
  88874. * @param parsedMaterial defines parsed material data
  88875. * @param scene defines the hosting scene
  88876. * @param rootUrl defines the root URL to use to load textures
  88877. * @returns a new material
  88878. */
  88879. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  88880. }
  88881. }
  88882. declare module BABYLON {
  88883. /**
  88884. * A multi-material is used to apply different materials to different parts of the same object without the need of
  88885. * separate meshes. This can be use to improve performances.
  88886. * @see http://doc.babylonjs.com/how_to/multi_materials
  88887. */
  88888. export class MultiMaterial extends Material {
  88889. private _subMaterials;
  88890. /**
  88891. * Gets or Sets the list of Materials used within the multi material.
  88892. * They need to be ordered according to the submeshes order in the associated mesh
  88893. */
  88894. subMaterials: Nullable<Material>[];
  88895. /**
  88896. * Function used to align with Node.getChildren()
  88897. * @returns the list of Materials used within the multi material
  88898. */
  88899. getChildren(): Nullable<Material>[];
  88900. /**
  88901. * Instantiates a new Multi Material
  88902. * A multi-material is used to apply different materials to different parts of the same object without the need of
  88903. * separate meshes. This can be use to improve performances.
  88904. * @see http://doc.babylonjs.com/how_to/multi_materials
  88905. * @param name Define the name in the scene
  88906. * @param scene Define the scene the material belongs to
  88907. */
  88908. constructor(name: string, scene: Scene);
  88909. private _hookArray;
  88910. /**
  88911. * Get one of the submaterial by its index in the submaterials array
  88912. * @param index The index to look the sub material at
  88913. * @returns The Material if the index has been defined
  88914. */
  88915. getSubMaterial(index: number): Nullable<Material>;
  88916. /**
  88917. * Get the list of active textures for the whole sub materials list.
  88918. * @returns All the textures that will be used during the rendering
  88919. */
  88920. getActiveTextures(): BaseTexture[];
  88921. /**
  88922. * Gets the current class name of the material e.g. "MultiMaterial"
  88923. * Mainly use in serialization.
  88924. * @returns the class name
  88925. */
  88926. getClassName(): string;
  88927. /**
  88928. * Checks if the material is ready to render the requested sub mesh
  88929. * @param mesh Define the mesh the submesh belongs to
  88930. * @param subMesh Define the sub mesh to look readyness for
  88931. * @param useInstances Define whether or not the material is used with instances
  88932. * @returns true if ready, otherwise false
  88933. */
  88934. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  88935. /**
  88936. * Clones the current material and its related sub materials
  88937. * @param name Define the name of the newly cloned material
  88938. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  88939. * @returns the cloned material
  88940. */
  88941. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  88942. /**
  88943. * Serializes the materials into a JSON representation.
  88944. * @returns the JSON representation
  88945. */
  88946. serialize(): any;
  88947. /**
  88948. * Dispose the material and release its associated resources
  88949. * @param forceDisposeEffect Define if we want to force disposing the associated effect (if false the shader is not released and could be reuse later on)
  88950. * @param forceDisposeTextures Define if we want to force disposing the associated textures (if false, they will not be disposed and can still be use elsewhere in the app)
  88951. * @param forceDisposeChildren Define if we want to force disposing the associated submaterials (if false, they will not be disposed and can still be use elsewhere in the app)
  88952. */
  88953. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  88954. /**
  88955. * Creates a MultiMaterial from parsed MultiMaterial data.
  88956. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  88957. * @param scene defines the hosting scene
  88958. * @returns a new MultiMaterial
  88959. */
  88960. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  88961. }
  88962. }
  88963. declare module BABYLON {
  88964. /**
  88965. * Base class for submeshes
  88966. */
  88967. export class BaseSubMesh {
  88968. /** @hidden */
  88969. _materialDefines: Nullable<MaterialDefines>;
  88970. /** @hidden */
  88971. _materialEffect: Nullable<Effect>;
  88972. /**
  88973. * Gets associated effect
  88974. */
  88975. readonly effect: Nullable<Effect>;
  88976. /**
  88977. * Sets associated effect (effect used to render this submesh)
  88978. * @param effect defines the effect to associate with
  88979. * @param defines defines the set of defines used to compile this effect
  88980. */
  88981. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  88982. }
  88983. /**
  88984. * Defines a subdivision inside a mesh
  88985. */
  88986. export class SubMesh extends BaseSubMesh implements ICullable {
  88987. /** the material index to use */
  88988. materialIndex: number;
  88989. /** vertex index start */
  88990. verticesStart: number;
  88991. /** vertices count */
  88992. verticesCount: number;
  88993. /** index start */
  88994. indexStart: number;
  88995. /** indices count */
  88996. indexCount: number;
  88997. /** @hidden */
  88998. _linesIndexCount: number;
  88999. private _mesh;
  89000. private _renderingMesh;
  89001. private _boundingInfo;
  89002. private _linesIndexBuffer;
  89003. /** @hidden */
  89004. _lastColliderWorldVertices: Nullable<Vector3[]>;
  89005. /** @hidden */
  89006. _trianglePlanes: Plane[];
  89007. /** @hidden */
  89008. _lastColliderTransformMatrix: Nullable<Matrix>;
  89009. /** @hidden */
  89010. _renderId: number;
  89011. /** @hidden */
  89012. _alphaIndex: number;
  89013. /** @hidden */
  89014. _distanceToCamera: number;
  89015. /** @hidden */
  89016. _id: number;
  89017. private _currentMaterial;
  89018. /**
  89019. * Add a new submesh to a mesh
  89020. * @param materialIndex defines the material index to use
  89021. * @param verticesStart defines vertex index start
  89022. * @param verticesCount defines vertices count
  89023. * @param indexStart defines index start
  89024. * @param indexCount defines indices count
  89025. * @param mesh defines the parent mesh
  89026. * @param renderingMesh defines an optional rendering mesh
  89027. * @param createBoundingBox defines if bounding box should be created for this submesh
  89028. * @returns the new submesh
  89029. */
  89030. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  89031. /**
  89032. * Creates a new submesh
  89033. * @param materialIndex defines the material index to use
  89034. * @param verticesStart defines vertex index start
  89035. * @param verticesCount defines vertices count
  89036. * @param indexStart defines index start
  89037. * @param indexCount defines indices count
  89038. * @param mesh defines the parent mesh
  89039. * @param renderingMesh defines an optional rendering mesh
  89040. * @param createBoundingBox defines if bounding box should be created for this submesh
  89041. */
  89042. constructor(
  89043. /** the material index to use */
  89044. materialIndex: number,
  89045. /** vertex index start */
  89046. verticesStart: number,
  89047. /** vertices count */
  89048. verticesCount: number,
  89049. /** index start */
  89050. indexStart: number,
  89051. /** indices count */
  89052. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  89053. /**
  89054. * Returns true if this submesh covers the entire parent mesh
  89055. * @ignorenaming
  89056. */
  89057. readonly IsGlobal: boolean;
  89058. /**
  89059. * Returns the submesh BoudingInfo object
  89060. * @returns current bounding info (or mesh's one if the submesh is global)
  89061. */
  89062. getBoundingInfo(): BoundingInfo;
  89063. /**
  89064. * Sets the submesh BoundingInfo
  89065. * @param boundingInfo defines the new bounding info to use
  89066. * @returns the SubMesh
  89067. */
  89068. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  89069. /**
  89070. * Returns the mesh of the current submesh
  89071. * @return the parent mesh
  89072. */
  89073. getMesh(): AbstractMesh;
  89074. /**
  89075. * Returns the rendering mesh of the submesh
  89076. * @returns the rendering mesh (could be different from parent mesh)
  89077. */
  89078. getRenderingMesh(): Mesh;
  89079. /**
  89080. * Returns the submesh material
  89081. * @returns null or the current material
  89082. */
  89083. getMaterial(): Nullable<Material>;
  89084. /**
  89085. * Sets a new updated BoundingInfo object to the submesh
  89086. * @param data defines an optional position array to use to determine the bounding info
  89087. * @returns the SubMesh
  89088. */
  89089. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  89090. /** @hidden */
  89091. _checkCollision(collider: Collider): boolean;
  89092. /**
  89093. * Updates the submesh BoundingInfo
  89094. * @param world defines the world matrix to use to update the bounding info
  89095. * @returns the submesh
  89096. */
  89097. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  89098. /**
  89099. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  89100. * @param frustumPlanes defines the frustum planes
  89101. * @returns true if the submesh is intersecting with the frustum
  89102. */
  89103. isInFrustum(frustumPlanes: Plane[]): boolean;
  89104. /**
  89105. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  89106. * @param frustumPlanes defines the frustum planes
  89107. * @returns true if the submesh is inside the frustum
  89108. */
  89109. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  89110. /**
  89111. * Renders the submesh
  89112. * @param enableAlphaMode defines if alpha needs to be used
  89113. * @returns the submesh
  89114. */
  89115. render(enableAlphaMode: boolean): SubMesh;
  89116. /**
  89117. * @hidden
  89118. */
  89119. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  89120. /**
  89121. * Checks if the submesh intersects with a ray
  89122. * @param ray defines the ray to test
  89123. * @returns true is the passed ray intersects the submesh bounding box
  89124. */
  89125. canIntersects(ray: Ray): boolean;
  89126. /**
  89127. * Intersects current submesh with a ray
  89128. * @param ray defines the ray to test
  89129. * @param positions defines mesh's positions array
  89130. * @param indices defines mesh's indices array
  89131. * @param fastCheck defines if only bounding info should be used
  89132. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  89133. * @returns intersection info or null if no intersection
  89134. */
  89135. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  89136. /** @hidden */
  89137. private _intersectLines;
  89138. /** @hidden */
  89139. private _intersectUnIndexedLines;
  89140. /** @hidden */
  89141. private _intersectTriangles;
  89142. /** @hidden */
  89143. private _intersectUnIndexedTriangles;
  89144. /** @hidden */
  89145. _rebuild(): void;
  89146. /**
  89147. * Creates a new submesh from the passed mesh
  89148. * @param newMesh defines the new hosting mesh
  89149. * @param newRenderingMesh defines an optional rendering mesh
  89150. * @returns the new submesh
  89151. */
  89152. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  89153. /**
  89154. * Release associated resources
  89155. */
  89156. dispose(): void;
  89157. /**
  89158. * Gets the class name
  89159. * @returns the string "SubMesh".
  89160. */
  89161. getClassName(): string;
  89162. /**
  89163. * Creates a new submesh from indices data
  89164. * @param materialIndex the index of the main mesh material
  89165. * @param startIndex the index where to start the copy in the mesh indices array
  89166. * @param indexCount the number of indices to copy then from the startIndex
  89167. * @param mesh the main mesh to create the submesh from
  89168. * @param renderingMesh the optional rendering mesh
  89169. * @returns a new submesh
  89170. */
  89171. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  89172. }
  89173. }
  89174. declare module BABYLON {
  89175. /**
  89176. * Class used to represent data loading progression
  89177. */
  89178. export class SceneLoaderFlags {
  89179. private static _ForceFullSceneLoadingForIncremental;
  89180. private static _ShowLoadingScreen;
  89181. private static _CleanBoneMatrixWeights;
  89182. private static _loggingLevel;
  89183. /**
  89184. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  89185. */
  89186. static ForceFullSceneLoadingForIncremental: boolean;
  89187. /**
  89188. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  89189. */
  89190. static ShowLoadingScreen: boolean;
  89191. /**
  89192. * Defines the current logging level (while loading the scene)
  89193. * @ignorenaming
  89194. */
  89195. static loggingLevel: number;
  89196. /**
  89197. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  89198. */
  89199. static CleanBoneMatrixWeights: boolean;
  89200. }
  89201. }
  89202. declare module BABYLON {
  89203. /**
  89204. * Class used to store geometry data (vertex buffers + index buffer)
  89205. */
  89206. export class Geometry implements IGetSetVerticesData {
  89207. /**
  89208. * Gets or sets the ID of the geometry
  89209. */
  89210. id: string;
  89211. /**
  89212. * Gets or sets the unique ID of the geometry
  89213. */
  89214. uniqueId: number;
  89215. /**
  89216. * Gets the delay loading state of the geometry (none by default which means not delayed)
  89217. */
  89218. delayLoadState: number;
  89219. /**
  89220. * Gets the file containing the data to load when running in delay load state
  89221. */
  89222. delayLoadingFile: Nullable<string>;
  89223. /**
  89224. * Callback called when the geometry is updated
  89225. */
  89226. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  89227. private _scene;
  89228. private _engine;
  89229. private _meshes;
  89230. private _totalVertices;
  89231. /** @hidden */
  89232. _indices: IndicesArray;
  89233. /** @hidden */
  89234. _vertexBuffers: {
  89235. [key: string]: VertexBuffer;
  89236. };
  89237. private _isDisposed;
  89238. private _extend;
  89239. private _boundingBias;
  89240. /** @hidden */
  89241. _delayInfo: Array<string>;
  89242. private _indexBuffer;
  89243. private _indexBufferIsUpdatable;
  89244. /** @hidden */
  89245. _boundingInfo: Nullable<BoundingInfo>;
  89246. /** @hidden */
  89247. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  89248. /** @hidden */
  89249. _softwareSkinningFrameId: number;
  89250. private _vertexArrayObjects;
  89251. private _updatable;
  89252. /** @hidden */
  89253. _positions: Nullable<Vector3[]>;
  89254. /**
  89255. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  89256. */
  89257. /**
  89258. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  89259. */
  89260. boundingBias: Vector2;
  89261. /**
  89262. * Static function used to attach a new empty geometry to a mesh
  89263. * @param mesh defines the mesh to attach the geometry to
  89264. * @returns the new Geometry
  89265. */
  89266. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  89267. /**
  89268. * Creates a new geometry
  89269. * @param id defines the unique ID
  89270. * @param scene defines the hosting scene
  89271. * @param vertexData defines the VertexData used to get geometry data
  89272. * @param updatable defines if geometry must be updatable (false by default)
  89273. * @param mesh defines the mesh that will be associated with the geometry
  89274. */
  89275. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  89276. /**
  89277. * Gets the current extend of the geometry
  89278. */
  89279. readonly extend: {
  89280. minimum: Vector3;
  89281. maximum: Vector3;
  89282. };
  89283. /**
  89284. * Gets the hosting scene
  89285. * @returns the hosting Scene
  89286. */
  89287. getScene(): Scene;
  89288. /**
  89289. * Gets the hosting engine
  89290. * @returns the hosting Engine
  89291. */
  89292. getEngine(): Engine;
  89293. /**
  89294. * Defines if the geometry is ready to use
  89295. * @returns true if the geometry is ready to be used
  89296. */
  89297. isReady(): boolean;
  89298. /**
  89299. * Gets a value indicating that the geometry should not be serialized
  89300. */
  89301. readonly doNotSerialize: boolean;
  89302. /** @hidden */
  89303. _rebuild(): void;
  89304. /**
  89305. * Affects all geometry data in one call
  89306. * @param vertexData defines the geometry data
  89307. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  89308. */
  89309. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  89310. /**
  89311. * Set specific vertex data
  89312. * @param kind defines the data kind (Position, normal, etc...)
  89313. * @param data defines the vertex data to use
  89314. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  89315. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  89316. */
  89317. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  89318. /**
  89319. * Removes a specific vertex data
  89320. * @param kind defines the data kind (Position, normal, etc...)
  89321. */
  89322. removeVerticesData(kind: string): void;
  89323. /**
  89324. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  89325. * @param buffer defines the vertex buffer to use
  89326. * @param totalVertices defines the total number of vertices for position kind (could be null)
  89327. */
  89328. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  89329. /**
  89330. * Update a specific vertex buffer
  89331. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  89332. * It will do nothing if the buffer is not updatable
  89333. * @param kind defines the data kind (Position, normal, etc...)
  89334. * @param data defines the data to use
  89335. * @param offset defines the offset in the target buffer where to store the data
  89336. * @param useBytes set to true if the offset is in bytes
  89337. */
  89338. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  89339. /**
  89340. * Update a specific vertex buffer
  89341. * This function will create a new buffer if the current one is not updatable
  89342. * @param kind defines the data kind (Position, normal, etc...)
  89343. * @param data defines the data to use
  89344. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  89345. */
  89346. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  89347. private _updateBoundingInfo;
  89348. /** @hidden */
  89349. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  89350. /**
  89351. * Gets total number of vertices
  89352. * @returns the total number of vertices
  89353. */
  89354. getTotalVertices(): number;
  89355. /**
  89356. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  89357. * @param kind defines the data kind (Position, normal, etc...)
  89358. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89359. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89360. * @returns a float array containing vertex data
  89361. */
  89362. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  89363. /**
  89364. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  89365. * @param kind defines the data kind (Position, normal, etc...)
  89366. * @returns true if the vertex buffer with the specified kind is updatable
  89367. */
  89368. isVertexBufferUpdatable(kind: string): boolean;
  89369. /**
  89370. * Gets a specific vertex buffer
  89371. * @param kind defines the data kind (Position, normal, etc...)
  89372. * @returns a VertexBuffer
  89373. */
  89374. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  89375. /**
  89376. * Returns all vertex buffers
  89377. * @return an object holding all vertex buffers indexed by kind
  89378. */
  89379. getVertexBuffers(): Nullable<{
  89380. [key: string]: VertexBuffer;
  89381. }>;
  89382. /**
  89383. * Gets a boolean indicating if specific vertex buffer is present
  89384. * @param kind defines the data kind (Position, normal, etc...)
  89385. * @returns true if data is present
  89386. */
  89387. isVerticesDataPresent(kind: string): boolean;
  89388. /**
  89389. * Gets a list of all attached data kinds (Position, normal, etc...)
  89390. * @returns a list of string containing all kinds
  89391. */
  89392. getVerticesDataKinds(): string[];
  89393. /**
  89394. * Update index buffer
  89395. * @param indices defines the indices to store in the index buffer
  89396. * @param offset defines the offset in the target buffer where to store the data
  89397. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  89398. */
  89399. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  89400. /**
  89401. * Creates a new index buffer
  89402. * @param indices defines the indices to store in the index buffer
  89403. * @param totalVertices defines the total number of vertices (could be null)
  89404. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  89405. */
  89406. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  89407. /**
  89408. * Return the total number of indices
  89409. * @returns the total number of indices
  89410. */
  89411. getTotalIndices(): number;
  89412. /**
  89413. * Gets the index buffer array
  89414. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89415. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89416. * @returns the index buffer array
  89417. */
  89418. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89419. /**
  89420. * Gets the index buffer
  89421. * @return the index buffer
  89422. */
  89423. getIndexBuffer(): Nullable<DataBuffer>;
  89424. /** @hidden */
  89425. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  89426. /**
  89427. * Release the associated resources for a specific mesh
  89428. * @param mesh defines the source mesh
  89429. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  89430. */
  89431. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  89432. /**
  89433. * Apply current geometry to a given mesh
  89434. * @param mesh defines the mesh to apply geometry to
  89435. */
  89436. applyToMesh(mesh: Mesh): void;
  89437. private _updateExtend;
  89438. private _applyToMesh;
  89439. private notifyUpdate;
  89440. /**
  89441. * Load the geometry if it was flagged as delay loaded
  89442. * @param scene defines the hosting scene
  89443. * @param onLoaded defines a callback called when the geometry is loaded
  89444. */
  89445. load(scene: Scene, onLoaded?: () => void): void;
  89446. private _queueLoad;
  89447. /**
  89448. * Invert the geometry to move from a right handed system to a left handed one.
  89449. */
  89450. toLeftHanded(): void;
  89451. /** @hidden */
  89452. _resetPointsArrayCache(): void;
  89453. /** @hidden */
  89454. _generatePointsArray(): boolean;
  89455. /**
  89456. * Gets a value indicating if the geometry is disposed
  89457. * @returns true if the geometry was disposed
  89458. */
  89459. isDisposed(): boolean;
  89460. private _disposeVertexArrayObjects;
  89461. /**
  89462. * Free all associated resources
  89463. */
  89464. dispose(): void;
  89465. /**
  89466. * Clone the current geometry into a new geometry
  89467. * @param id defines the unique ID of the new geometry
  89468. * @returns a new geometry object
  89469. */
  89470. copy(id: string): Geometry;
  89471. /**
  89472. * Serialize the current geometry info (and not the vertices data) into a JSON object
  89473. * @return a JSON representation of the current geometry data (without the vertices data)
  89474. */
  89475. serialize(): any;
  89476. private toNumberArray;
  89477. /**
  89478. * Serialize all vertices data into a JSON oject
  89479. * @returns a JSON representation of the current geometry data
  89480. */
  89481. serializeVerticeData(): any;
  89482. /**
  89483. * Extracts a clone of a mesh geometry
  89484. * @param mesh defines the source mesh
  89485. * @param id defines the unique ID of the new geometry object
  89486. * @returns the new geometry object
  89487. */
  89488. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  89489. /**
  89490. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  89491. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  89492. * Be aware Math.random() could cause collisions, but:
  89493. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  89494. * @returns a string containing a new GUID
  89495. */
  89496. static RandomId(): string;
  89497. /** @hidden */
  89498. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  89499. private static _CleanMatricesWeights;
  89500. /**
  89501. * Create a new geometry from persisted data (Using .babylon file format)
  89502. * @param parsedVertexData defines the persisted data
  89503. * @param scene defines the hosting scene
  89504. * @param rootUrl defines the root url to use to load assets (like delayed data)
  89505. * @returns the new geometry object
  89506. */
  89507. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  89508. }
  89509. }
  89510. declare module BABYLON {
  89511. /**
  89512. * Define an interface for all classes that will get and set the data on vertices
  89513. */
  89514. export interface IGetSetVerticesData {
  89515. /**
  89516. * Gets a boolean indicating if specific vertex data is present
  89517. * @param kind defines the vertex data kind to use
  89518. * @returns true is data kind is present
  89519. */
  89520. isVerticesDataPresent(kind: string): boolean;
  89521. /**
  89522. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  89523. * @param kind defines the data kind (Position, normal, etc...)
  89524. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89525. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89526. * @returns a float array containing vertex data
  89527. */
  89528. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  89529. /**
  89530. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  89531. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  89532. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89533. * @returns the indices array or an empty array if the mesh has no geometry
  89534. */
  89535. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89536. /**
  89537. * Set specific vertex data
  89538. * @param kind defines the data kind (Position, normal, etc...)
  89539. * @param data defines the vertex data to use
  89540. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  89541. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  89542. */
  89543. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  89544. /**
  89545. * Update a specific associated vertex buffer
  89546. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  89547. * - VertexBuffer.PositionKind
  89548. * - VertexBuffer.UVKind
  89549. * - VertexBuffer.UV2Kind
  89550. * - VertexBuffer.UV3Kind
  89551. * - VertexBuffer.UV4Kind
  89552. * - VertexBuffer.UV5Kind
  89553. * - VertexBuffer.UV6Kind
  89554. * - VertexBuffer.ColorKind
  89555. * - VertexBuffer.MatricesIndicesKind
  89556. * - VertexBuffer.MatricesIndicesExtraKind
  89557. * - VertexBuffer.MatricesWeightsKind
  89558. * - VertexBuffer.MatricesWeightsExtraKind
  89559. * @param data defines the data source
  89560. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  89561. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  89562. */
  89563. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  89564. /**
  89565. * Creates a new index buffer
  89566. * @param indices defines the indices to store in the index buffer
  89567. * @param totalVertices defines the total number of vertices (could be null)
  89568. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  89569. */
  89570. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  89571. }
  89572. /**
  89573. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  89574. */
  89575. export class VertexData {
  89576. /**
  89577. * Mesh side orientation : usually the external or front surface
  89578. */
  89579. static readonly FRONTSIDE: number;
  89580. /**
  89581. * Mesh side orientation : usually the internal or back surface
  89582. */
  89583. static readonly BACKSIDE: number;
  89584. /**
  89585. * Mesh side orientation : both internal and external or front and back surfaces
  89586. */
  89587. static readonly DOUBLESIDE: number;
  89588. /**
  89589. * Mesh side orientation : by default, `FRONTSIDE`
  89590. */
  89591. static readonly DEFAULTSIDE: number;
  89592. /**
  89593. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  89594. */
  89595. positions: Nullable<FloatArray>;
  89596. /**
  89597. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  89598. */
  89599. normals: Nullable<FloatArray>;
  89600. /**
  89601. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  89602. */
  89603. tangents: Nullable<FloatArray>;
  89604. /**
  89605. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89606. */
  89607. uvs: Nullable<FloatArray>;
  89608. /**
  89609. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89610. */
  89611. uvs2: Nullable<FloatArray>;
  89612. /**
  89613. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89614. */
  89615. uvs3: Nullable<FloatArray>;
  89616. /**
  89617. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89618. */
  89619. uvs4: Nullable<FloatArray>;
  89620. /**
  89621. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89622. */
  89623. uvs5: Nullable<FloatArray>;
  89624. /**
  89625. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89626. */
  89627. uvs6: Nullable<FloatArray>;
  89628. /**
  89629. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  89630. */
  89631. colors: Nullable<FloatArray>;
  89632. /**
  89633. * An array containing the list of indices to the array of matrices produced by bones, each vertex have up to 4 indices (8 if the matricesIndicesExtra is set).
  89634. */
  89635. matricesIndices: Nullable<FloatArray>;
  89636. /**
  89637. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  89638. */
  89639. matricesWeights: Nullable<FloatArray>;
  89640. /**
  89641. * An array extending the number of possible indices
  89642. */
  89643. matricesIndicesExtra: Nullable<FloatArray>;
  89644. /**
  89645. * An array extending the number of possible weights when the number of indices is extended
  89646. */
  89647. matricesWeightsExtra: Nullable<FloatArray>;
  89648. /**
  89649. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  89650. */
  89651. indices: Nullable<IndicesArray>;
  89652. /**
  89653. * Uses the passed data array to set the set the values for the specified kind of data
  89654. * @param data a linear array of floating numbers
  89655. * @param kind the type of data that is being set, eg positions, colors etc
  89656. */
  89657. set(data: FloatArray, kind: string): void;
  89658. /**
  89659. * Associates the vertexData to the passed Mesh.
  89660. * Sets it as updatable or not (default `false`)
  89661. * @param mesh the mesh the vertexData is applied to
  89662. * @param updatable when used and having the value true allows new data to update the vertexData
  89663. * @returns the VertexData
  89664. */
  89665. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  89666. /**
  89667. * Associates the vertexData to the passed Geometry.
  89668. * Sets it as updatable or not (default `false`)
  89669. * @param geometry the geometry the vertexData is applied to
  89670. * @param updatable when used and having the value true allows new data to update the vertexData
  89671. * @returns VertexData
  89672. */
  89673. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  89674. /**
  89675. * Updates the associated mesh
  89676. * @param mesh the mesh to be updated
  89677. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  89678. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  89679. * @returns VertexData
  89680. */
  89681. updateMesh(mesh: Mesh): VertexData;
  89682. /**
  89683. * Updates the associated geometry
  89684. * @param geometry the geometry to be updated
  89685. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  89686. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  89687. * @returns VertexData.
  89688. */
  89689. updateGeometry(geometry: Geometry): VertexData;
  89690. private _applyTo;
  89691. private _update;
  89692. /**
  89693. * Transforms each position and each normal of the vertexData according to the passed Matrix
  89694. * @param matrix the transforming matrix
  89695. * @returns the VertexData
  89696. */
  89697. transform(matrix: Matrix): VertexData;
  89698. /**
  89699. * Merges the passed VertexData into the current one
  89700. * @param other the VertexData to be merged into the current one
  89701. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  89702. * @returns the modified VertexData
  89703. */
  89704. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  89705. private _mergeElement;
  89706. private _validate;
  89707. /**
  89708. * Serializes the VertexData
  89709. * @returns a serialized object
  89710. */
  89711. serialize(): any;
  89712. /**
  89713. * Extracts the vertexData from a mesh
  89714. * @param mesh the mesh from which to extract the VertexData
  89715. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  89716. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  89717. * @returns the object VertexData associated to the passed mesh
  89718. */
  89719. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  89720. /**
  89721. * Extracts the vertexData from the geometry
  89722. * @param geometry the geometry from which to extract the VertexData
  89723. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  89724. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  89725. * @returns the object VertexData associated to the passed mesh
  89726. */
  89727. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  89728. private static _ExtractFrom;
  89729. /**
  89730. * Creates the VertexData for a Ribbon
  89731. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  89732. * * pathArray array of paths, each of which an array of successive Vector3
  89733. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  89734. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  89735. * * offset a positive integer, only used when pathArray contains a single path (offset = 10 means the point 1 is joined to the point 11), default rounded half size of the pathArray length
  89736. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89737. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  89738. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  89739. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  89740. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  89741. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  89742. * @returns the VertexData of the ribbon
  89743. */
  89744. static CreateRibbon(options: {
  89745. pathArray: Vector3[][];
  89746. closeArray?: boolean;
  89747. closePath?: boolean;
  89748. offset?: number;
  89749. sideOrientation?: number;
  89750. frontUVs?: Vector4;
  89751. backUVs?: Vector4;
  89752. invertUV?: boolean;
  89753. uvs?: Vector2[];
  89754. colors?: Color4[];
  89755. }): VertexData;
  89756. /**
  89757. * Creates the VertexData for a box
  89758. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89759. * * size sets the width, height and depth of the box to the value of size, optional default 1
  89760. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  89761. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  89762. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  89763. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  89764. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  89765. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89766. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  89767. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  89768. * @returns the VertexData of the box
  89769. */
  89770. static CreateBox(options: {
  89771. size?: number;
  89772. width?: number;
  89773. height?: number;
  89774. depth?: number;
  89775. faceUV?: Vector4[];
  89776. faceColors?: Color4[];
  89777. sideOrientation?: number;
  89778. frontUVs?: Vector4;
  89779. backUVs?: Vector4;
  89780. }): VertexData;
  89781. /**
  89782. * Creates the VertexData for a tiled box
  89783. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89784. * * faceTiles sets the pattern, tile size and number of tiles for a face
  89785. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  89786. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  89787. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89788. * @returns the VertexData of the box
  89789. */
  89790. static CreateTiledBox(options: {
  89791. pattern?: number;
  89792. width?: number;
  89793. height?: number;
  89794. depth?: number;
  89795. tileSize?: number;
  89796. tileWidth?: number;
  89797. tileHeight?: number;
  89798. alignHorizontal?: number;
  89799. alignVertical?: number;
  89800. faceUV?: Vector4[];
  89801. faceColors?: Color4[];
  89802. sideOrientation?: number;
  89803. }): VertexData;
  89804. /**
  89805. * Creates the VertexData for a tiled plane
  89806. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89807. * * pattern a limited pattern arrangement depending on the number
  89808. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  89809. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  89810. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  89811. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89812. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  89813. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  89814. * @returns the VertexData of the tiled plane
  89815. */
  89816. static CreateTiledPlane(options: {
  89817. pattern?: number;
  89818. tileSize?: number;
  89819. tileWidth?: number;
  89820. tileHeight?: number;
  89821. size?: number;
  89822. width?: number;
  89823. height?: number;
  89824. alignHorizontal?: number;
  89825. alignVertical?: number;
  89826. sideOrientation?: number;
  89827. frontUVs?: Vector4;
  89828. backUVs?: Vector4;
  89829. }): VertexData;
  89830. /**
  89831. * Creates the VertexData for an ellipsoid, defaults to a sphere
  89832. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89833. * * segments sets the number of horizontal strips optional, default 32
  89834. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  89835. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  89836. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  89837. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  89838. * * arc a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the circumference (latitude) given by the arc value, optional, default 1
  89839. * * slice a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the height (latitude) given by the arc value, optional, default 1
  89840. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89841. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  89842. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  89843. * @returns the VertexData of the ellipsoid
  89844. */
  89845. static CreateSphere(options: {
  89846. segments?: number;
  89847. diameter?: number;
  89848. diameterX?: number;
  89849. diameterY?: number;
  89850. diameterZ?: number;
  89851. arc?: number;
  89852. slice?: number;
  89853. sideOrientation?: number;
  89854. frontUVs?: Vector4;
  89855. backUVs?: Vector4;
  89856. }): VertexData;
  89857. /**
  89858. * Creates the VertexData for a cylinder, cone or prism
  89859. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89860. * * height sets the height (y direction) of the cylinder, optional, default 2
  89861. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  89862. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  89863. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  89864. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  89865. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  89866. * * arc a number from 0 to 1, to create an unclosed cylinder based on the fraction of the circumference given by the arc value, optional, default 1
  89867. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  89868. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  89869. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  89870. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  89871. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89872. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  89873. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  89874. * @returns the VertexData of the cylinder, cone or prism
  89875. */
  89876. static CreateCylinder(options: {
  89877. height?: number;
  89878. diameterTop?: number;
  89879. diameterBottom?: number;
  89880. diameter?: number;
  89881. tessellation?: number;
  89882. subdivisions?: number;
  89883. arc?: number;
  89884. faceColors?: Color4[];
  89885. faceUV?: Vector4[];
  89886. hasRings?: boolean;
  89887. enclose?: boolean;
  89888. sideOrientation?: number;
  89889. frontUVs?: Vector4;
  89890. backUVs?: Vector4;
  89891. }): VertexData;
  89892. /**
  89893. * Creates the VertexData for a torus
  89894. * @param options an object used to set the following optional parameters for the box, required but can be empty
  89895. * * diameter the diameter of the torus, optional default 1
  89896. * * thickness the diameter of the tube forming the torus, optional default 0.5
  89897. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  89898. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  89899. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  89900. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  89901. * @returns the VertexData of the torus
  89902. */
  89903. static CreateTorus(options: {
  89904. diameter?: number;
  89905. thickness?: number;
  89906. tessellation?: number;
  89907. sideOrientation?: number;
  89908. frontUVs?: Vector4;
  89909. backUVs?: Vector4;
  89910. }): VertexData;
  89911. /**
  89912. * Creates the VertexData of the LineSystem
  89913. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  89914. * - lines an array of lines, each line being an array of successive Vector3
  89915. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  89916. * @returns the VertexData of the LineSystem
  89917. */
  89918. static CreateLineSystem(options: {
  89919. lines: Vector3[][];
  89920. colors?: Nullable<Color4[][]>;
  89921. }): VertexData;
  89922. /**
  89923. * Create the VertexData for a DashedLines
  89924. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  89925. * - points an array successive Vector3
  89926. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  89927. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  89928. * - dashNb the intended total number of dashes, optional, default 200
  89929. * @returns the VertexData for the DashedLines
  89930. */
  89931. static CreateDashedLines(options: {
  89932. points: Vector3[];
  89933. dashSize?: number;
  89934. gapSize?: number;
  89935. dashNb?: number;
  89936. }): VertexData;
  89937. /**
  89938. * Creates the VertexData for a Ground
  89939. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  89940. * - width the width (x direction) of the ground, optional, default 1
  89941. * - height the height (z direction) of the ground, optional, default 1
  89942. * - subdivisions the number of subdivisions per side, optional, default 1
  89943. * @returns the VertexData of the Ground
  89944. */
  89945. static CreateGround(options: {
  89946. width?: number;
  89947. height?: number;
  89948. subdivisions?: number;
  89949. subdivisionsX?: number;
  89950. subdivisionsY?: number;
  89951. }): VertexData;
  89952. /**
  89953. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  89954. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  89955. * * xmin the ground minimum X coordinate, optional, default -1
  89956. * * zmin the ground minimum Z coordinate, optional, default -1
  89957. * * xmax the ground maximum X coordinate, optional, default 1
  89958. * * zmax the ground maximum Z coordinate, optional, default 1
  89959. * * subdivisions a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the ground width and height creating 'tiles', default {w: 6, h: 6}
  89960. * * precision a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the tile width and height, default {w: 2, h: 2}
  89961. * @returns the VertexData of the TiledGround
  89962. */
  89963. static CreateTiledGround(options: {
  89964. xmin: number;
  89965. zmin: number;
  89966. xmax: number;
  89967. zmax: number;
  89968. subdivisions?: {
  89969. w: number;
  89970. h: number;
  89971. };
  89972. precision?: {
  89973. w: number;
  89974. h: number;
  89975. };
  89976. }): VertexData;
  89977. /**
  89978. * Creates the VertexData of the Ground designed from a heightmap
  89979. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  89980. * * width the width (x direction) of the ground
  89981. * * height the height (z direction) of the ground
  89982. * * subdivisions the number of subdivisions per side
  89983. * * minHeight the minimum altitude on the ground, optional, default 0
  89984. * * maxHeight the maximum altitude on the ground, optional default 1
  89985. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  89986. * * buffer the array holding the image color data
  89987. * * bufferWidth the width of image
  89988. * * bufferHeight the height of image
  89989. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  89990. * @returns the VertexData of the Ground designed from a heightmap
  89991. */
  89992. static CreateGroundFromHeightMap(options: {
  89993. width: number;
  89994. height: number;
  89995. subdivisions: number;
  89996. minHeight: number;
  89997. maxHeight: number;
  89998. colorFilter: Color3;
  89999. buffer: Uint8Array;
  90000. bufferWidth: number;
  90001. bufferHeight: number;
  90002. alphaFilter: number;
  90003. }): VertexData;
  90004. /**
  90005. * Creates the VertexData for a Plane
  90006. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  90007. * * size sets the width and height of the plane to the value of size, optional default 1
  90008. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  90009. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  90010. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90011. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  90012. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  90013. * @returns the VertexData of the box
  90014. */
  90015. static CreatePlane(options: {
  90016. size?: number;
  90017. width?: number;
  90018. height?: number;
  90019. sideOrientation?: number;
  90020. frontUVs?: Vector4;
  90021. backUVs?: Vector4;
  90022. }): VertexData;
  90023. /**
  90024. * Creates the VertexData of the Disc or regular Polygon
  90025. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  90026. * * radius the radius of the disc, optional default 0.5
  90027. * * tessellation the number of polygon sides, optional, default 64
  90028. * * arc a number from 0 to 1, to create an unclosed polygon based on the fraction of the circumference given by the arc value, optional, default 1
  90029. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90030. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  90031. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  90032. * @returns the VertexData of the box
  90033. */
  90034. static CreateDisc(options: {
  90035. radius?: number;
  90036. tessellation?: number;
  90037. arc?: number;
  90038. sideOrientation?: number;
  90039. frontUVs?: Vector4;
  90040. backUVs?: Vector4;
  90041. }): VertexData;
  90042. /**
  90043. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  90044. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  90045. * @param polygon a mesh built from polygonTriangulation.build()
  90046. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90047. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  90048. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  90049. * @param frontUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  90050. * @param backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  90051. * @returns the VertexData of the Polygon
  90052. */
  90053. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  90054. /**
  90055. * Creates the VertexData of the IcoSphere
  90056. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  90057. * * radius the radius of the IcoSphere, optional default 1
  90058. * * radiusX allows stretching in the x direction, optional, default radius
  90059. * * radiusY allows stretching in the y direction, optional, default radius
  90060. * * radiusZ allows stretching in the z direction, optional, default radius
  90061. * * flat when true creates a flat shaded mesh, optional, default true
  90062. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  90063. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90064. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  90065. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  90066. * @returns the VertexData of the IcoSphere
  90067. */
  90068. static CreateIcoSphere(options: {
  90069. radius?: number;
  90070. radiusX?: number;
  90071. radiusY?: number;
  90072. radiusZ?: number;
  90073. flat?: boolean;
  90074. subdivisions?: number;
  90075. sideOrientation?: number;
  90076. frontUVs?: Vector4;
  90077. backUVs?: Vector4;
  90078. }): VertexData;
  90079. /**
  90080. * Creates the VertexData for a Polyhedron
  90081. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  90082. * * type provided types are:
  90083. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  90084. * * 9 : Pentagonal Pyramid (J2), 10 : Triangular Dipyramid (J12), 11 : Pentagonal Dipyramid (J13), 12 : Elongated Square Dipyramid (J15), 13 : Elongated Pentagonal Dipyramid (J16), 14 : Elongated Pentagonal Cupola (J20)
  90085. * * size the size of the IcoSphere, optional default 1
  90086. * * sizeX allows stretching in the x direction, optional, default size
  90087. * * sizeY allows stretching in the y direction, optional, default size
  90088. * * sizeZ allows stretching in the z direction, optional, default size
  90089. * * custom a number that overwrites the type to create from an extended set of polyhedron from https://www.babylonjs-playground.com/#21QRSK#15 with minimised editor
  90090. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  90091. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  90092. * * flat when true creates a flat shaded mesh, optional, default true
  90093. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  90094. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90095. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  90096. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  90097. * @returns the VertexData of the Polyhedron
  90098. */
  90099. static CreatePolyhedron(options: {
  90100. type?: number;
  90101. size?: number;
  90102. sizeX?: number;
  90103. sizeY?: number;
  90104. sizeZ?: number;
  90105. custom?: any;
  90106. faceUV?: Vector4[];
  90107. faceColors?: Color4[];
  90108. flat?: boolean;
  90109. sideOrientation?: number;
  90110. frontUVs?: Vector4;
  90111. backUVs?: Vector4;
  90112. }): VertexData;
  90113. /**
  90114. * Creates the VertexData for a TorusKnot
  90115. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  90116. * * radius the radius of the torus knot, optional, default 2
  90117. * * tube the thickness of the tube, optional, default 0.5
  90118. * * radialSegments the number of sides on each tube segments, optional, default 32
  90119. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  90120. * * p the number of windings around the z axis, optional, default 2
  90121. * * q the number of windings around the x axis, optional, default 3
  90122. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90123. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  90124. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  90125. * @returns the VertexData of the Torus Knot
  90126. */
  90127. static CreateTorusKnot(options: {
  90128. radius?: number;
  90129. tube?: number;
  90130. radialSegments?: number;
  90131. tubularSegments?: number;
  90132. p?: number;
  90133. q?: number;
  90134. sideOrientation?: number;
  90135. frontUVs?: Vector4;
  90136. backUVs?: Vector4;
  90137. }): VertexData;
  90138. /**
  90139. * Compute normals for given positions and indices
  90140. * @param positions an array of vertex positions, [...., x, y, z, ......]
  90141. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  90142. * @param normals an array of vertex normals, [...., x, y, z, ......]
  90143. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  90144. * * facetNormals : optional array of facet normals (vector3)
  90145. * * facetPositions : optional array of facet positions (vector3)
  90146. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  90147. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  90148. * * bInfo : optional bounding info, required for facetPartitioning computation
  90149. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  90150. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  90151. * * useRightHandedSystem: optional boolean to for right handed system computation
  90152. * * depthSort : optional boolean to enable the facet depth sort computation
  90153. * * distanceTo : optional Vector3 to compute the facet depth from this location
  90154. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  90155. */
  90156. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  90157. facetNormals?: any;
  90158. facetPositions?: any;
  90159. facetPartitioning?: any;
  90160. ratio?: number;
  90161. bInfo?: any;
  90162. bbSize?: Vector3;
  90163. subDiv?: any;
  90164. useRightHandedSystem?: boolean;
  90165. depthSort?: boolean;
  90166. distanceTo?: Vector3;
  90167. depthSortedFacets?: any;
  90168. }): void;
  90169. /** @hidden */
  90170. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  90171. /**
  90172. * Applies VertexData created from the imported parameters to the geometry
  90173. * @param parsedVertexData the parsed data from an imported file
  90174. * @param geometry the geometry to apply the VertexData to
  90175. */
  90176. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  90177. }
  90178. }
  90179. declare module BABYLON {
  90180. /**
  90181. * Defines a target to use with MorphTargetManager
  90182. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  90183. */
  90184. export class MorphTarget implements IAnimatable {
  90185. /** defines the name of the target */
  90186. name: string;
  90187. /**
  90188. * Gets or sets the list of animations
  90189. */
  90190. animations: Animation[];
  90191. private _scene;
  90192. private _positions;
  90193. private _normals;
  90194. private _tangents;
  90195. private _uvs;
  90196. private _influence;
  90197. private _uniqueId;
  90198. /**
  90199. * Observable raised when the influence changes
  90200. */
  90201. onInfluenceChanged: Observable<boolean>;
  90202. /** @hidden */
  90203. _onDataLayoutChanged: Observable<void>;
  90204. /**
  90205. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  90206. */
  90207. influence: number;
  90208. /**
  90209. * Gets or sets the id of the morph Target
  90210. */
  90211. id: string;
  90212. private _animationPropertiesOverride;
  90213. /**
  90214. * Gets or sets the animation properties override
  90215. */
  90216. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  90217. /**
  90218. * Creates a new MorphTarget
  90219. * @param name defines the name of the target
  90220. * @param influence defines the influence to use
  90221. * @param scene defines the scene the morphtarget belongs to
  90222. */
  90223. constructor(
  90224. /** defines the name of the target */
  90225. name: string, influence?: number, scene?: Nullable<Scene>);
  90226. /**
  90227. * Gets the unique ID of this manager
  90228. */
  90229. readonly uniqueId: number;
  90230. /**
  90231. * Gets a boolean defining if the target contains position data
  90232. */
  90233. readonly hasPositions: boolean;
  90234. /**
  90235. * Gets a boolean defining if the target contains normal data
  90236. */
  90237. readonly hasNormals: boolean;
  90238. /**
  90239. * Gets a boolean defining if the target contains tangent data
  90240. */
  90241. readonly hasTangents: boolean;
  90242. /**
  90243. * Gets a boolean defining if the target contains texture coordinates data
  90244. */
  90245. readonly hasUVs: boolean;
  90246. /**
  90247. * Affects position data to this target
  90248. * @param data defines the position data to use
  90249. */
  90250. setPositions(data: Nullable<FloatArray>): void;
  90251. /**
  90252. * Gets the position data stored in this target
  90253. * @returns a FloatArray containing the position data (or null if not present)
  90254. */
  90255. getPositions(): Nullable<FloatArray>;
  90256. /**
  90257. * Affects normal data to this target
  90258. * @param data defines the normal data to use
  90259. */
  90260. setNormals(data: Nullable<FloatArray>): void;
  90261. /**
  90262. * Gets the normal data stored in this target
  90263. * @returns a FloatArray containing the normal data (or null if not present)
  90264. */
  90265. getNormals(): Nullable<FloatArray>;
  90266. /**
  90267. * Affects tangent data to this target
  90268. * @param data defines the tangent data to use
  90269. */
  90270. setTangents(data: Nullable<FloatArray>): void;
  90271. /**
  90272. * Gets the tangent data stored in this target
  90273. * @returns a FloatArray containing the tangent data (or null if not present)
  90274. */
  90275. getTangents(): Nullable<FloatArray>;
  90276. /**
  90277. * Affects texture coordinates data to this target
  90278. * @param data defines the texture coordinates data to use
  90279. */
  90280. setUVs(data: Nullable<FloatArray>): void;
  90281. /**
  90282. * Gets the texture coordinates data stored in this target
  90283. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  90284. */
  90285. getUVs(): Nullable<FloatArray>;
  90286. /**
  90287. * Clone the current target
  90288. * @returns a new MorphTarget
  90289. */
  90290. clone(): MorphTarget;
  90291. /**
  90292. * Serializes the current target into a Serialization object
  90293. * @returns the serialized object
  90294. */
  90295. serialize(): any;
  90296. /**
  90297. * Returns the string "MorphTarget"
  90298. * @returns "MorphTarget"
  90299. */
  90300. getClassName(): string;
  90301. /**
  90302. * Creates a new target from serialized data
  90303. * @param serializationObject defines the serialized data to use
  90304. * @returns a new MorphTarget
  90305. */
  90306. static Parse(serializationObject: any): MorphTarget;
  90307. /**
  90308. * Creates a MorphTarget from mesh data
  90309. * @param mesh defines the source mesh
  90310. * @param name defines the name to use for the new target
  90311. * @param influence defines the influence to attach to the target
  90312. * @returns a new MorphTarget
  90313. */
  90314. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  90315. }
  90316. }
  90317. declare module BABYLON {
  90318. /**
  90319. * This class is used to deform meshes using morphing between different targets
  90320. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  90321. */
  90322. export class MorphTargetManager {
  90323. private _targets;
  90324. private _targetInfluenceChangedObservers;
  90325. private _targetDataLayoutChangedObservers;
  90326. private _activeTargets;
  90327. private _scene;
  90328. private _influences;
  90329. private _supportsNormals;
  90330. private _supportsTangents;
  90331. private _supportsUVs;
  90332. private _vertexCount;
  90333. private _uniqueId;
  90334. private _tempInfluences;
  90335. /**
  90336. * Gets or sets a boolean indicating if normals must be morphed
  90337. */
  90338. enableNormalMorphing: boolean;
  90339. /**
  90340. * Gets or sets a boolean indicating if tangents must be morphed
  90341. */
  90342. enableTangentMorphing: boolean;
  90343. /**
  90344. * Gets or sets a boolean indicating if UV must be morphed
  90345. */
  90346. enableUVMorphing: boolean;
  90347. /**
  90348. * Creates a new MorphTargetManager
  90349. * @param scene defines the current scene
  90350. */
  90351. constructor(scene?: Nullable<Scene>);
  90352. /**
  90353. * Gets the unique ID of this manager
  90354. */
  90355. readonly uniqueId: number;
  90356. /**
  90357. * Gets the number of vertices handled by this manager
  90358. */
  90359. readonly vertexCount: number;
  90360. /**
  90361. * Gets a boolean indicating if this manager supports morphing of normals
  90362. */
  90363. readonly supportsNormals: boolean;
  90364. /**
  90365. * Gets a boolean indicating if this manager supports morphing of tangents
  90366. */
  90367. readonly supportsTangents: boolean;
  90368. /**
  90369. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  90370. */
  90371. readonly supportsUVs: boolean;
  90372. /**
  90373. * Gets the number of targets stored in this manager
  90374. */
  90375. readonly numTargets: number;
  90376. /**
  90377. * Gets the number of influencers (ie. the number of targets with influences > 0)
  90378. */
  90379. readonly numInfluencers: number;
  90380. /**
  90381. * Gets the list of influences (one per target)
  90382. */
  90383. readonly influences: Float32Array;
  90384. /**
  90385. * Gets the active target at specified index. An active target is a target with an influence > 0
  90386. * @param index defines the index to check
  90387. * @returns the requested target
  90388. */
  90389. getActiveTarget(index: number): MorphTarget;
  90390. /**
  90391. * Gets the target at specified index
  90392. * @param index defines the index to check
  90393. * @returns the requested target
  90394. */
  90395. getTarget(index: number): MorphTarget;
  90396. /**
  90397. * Add a new target to this manager
  90398. * @param target defines the target to add
  90399. */
  90400. addTarget(target: MorphTarget): void;
  90401. /**
  90402. * Removes a target from the manager
  90403. * @param target defines the target to remove
  90404. */
  90405. removeTarget(target: MorphTarget): void;
  90406. /**
  90407. * Clone the current manager
  90408. * @returns a new MorphTargetManager
  90409. */
  90410. clone(): MorphTargetManager;
  90411. /**
  90412. * Serializes the current manager into a Serialization object
  90413. * @returns the serialized object
  90414. */
  90415. serialize(): any;
  90416. private _syncActiveTargets;
  90417. /**
  90418. * Syncrhonize the targets with all the meshes using this morph target manager
  90419. */
  90420. synchronize(): void;
  90421. /**
  90422. * Creates a new MorphTargetManager from serialized data
  90423. * @param serializationObject defines the serialized data
  90424. * @param scene defines the hosting scene
  90425. * @returns the new MorphTargetManager
  90426. */
  90427. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  90428. }
  90429. }
  90430. declare module BABYLON {
  90431. /**
  90432. * Class used to represent a specific level of detail of a mesh
  90433. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  90434. */
  90435. export class MeshLODLevel {
  90436. /** Defines the distance where this level should start being displayed */
  90437. distance: number;
  90438. /** Defines the mesh to use to render this level */
  90439. mesh: Nullable<Mesh>;
  90440. /**
  90441. * Creates a new LOD level
  90442. * @param distance defines the distance where this level should star being displayed
  90443. * @param mesh defines the mesh to use to render this level
  90444. */
  90445. constructor(
  90446. /** Defines the distance where this level should start being displayed */
  90447. distance: number,
  90448. /** Defines the mesh to use to render this level */
  90449. mesh: Nullable<Mesh>);
  90450. }
  90451. }
  90452. declare module BABYLON {
  90453. /**
  90454. * Mesh representing the gorund
  90455. */
  90456. export class GroundMesh extends Mesh {
  90457. /** If octree should be generated */
  90458. generateOctree: boolean;
  90459. private _heightQuads;
  90460. /** @hidden */
  90461. _subdivisionsX: number;
  90462. /** @hidden */
  90463. _subdivisionsY: number;
  90464. /** @hidden */
  90465. _width: number;
  90466. /** @hidden */
  90467. _height: number;
  90468. /** @hidden */
  90469. _minX: number;
  90470. /** @hidden */
  90471. _maxX: number;
  90472. /** @hidden */
  90473. _minZ: number;
  90474. /** @hidden */
  90475. _maxZ: number;
  90476. constructor(name: string, scene: Scene);
  90477. /**
  90478. * "GroundMesh"
  90479. * @returns "GroundMesh"
  90480. */
  90481. getClassName(): string;
  90482. /**
  90483. * The minimum of x and y subdivisions
  90484. */
  90485. readonly subdivisions: number;
  90486. /**
  90487. * X subdivisions
  90488. */
  90489. readonly subdivisionsX: number;
  90490. /**
  90491. * Y subdivisions
  90492. */
  90493. readonly subdivisionsY: number;
  90494. /**
  90495. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  90496. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  90497. * @param chunksCount the number of subdivisions for x and y
  90498. * @param octreeBlocksSize (Default: 32)
  90499. */
  90500. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  90501. /**
  90502. * Returns a height (y) value in the Worl system :
  90503. * the ground altitude at the coordinates (x, z) expressed in the World system.
  90504. * @param x x coordinate
  90505. * @param z z coordinate
  90506. * @returns the ground y position if (x, z) are outside the ground surface.
  90507. */
  90508. getHeightAtCoordinates(x: number, z: number): number;
  90509. /**
  90510. * Returns a normalized vector (Vector3) orthogonal to the ground
  90511. * at the ground coordinates (x, z) expressed in the World system.
  90512. * @param x x coordinate
  90513. * @param z z coordinate
  90514. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  90515. */
  90516. getNormalAtCoordinates(x: number, z: number): Vector3;
  90517. /**
  90518. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  90519. * at the ground coordinates (x, z) expressed in the World system.
  90520. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  90521. * @param x x coordinate
  90522. * @param z z coordinate
  90523. * @param ref vector to store the result
  90524. * @returns the GroundMesh.
  90525. */
  90526. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  90527. /**
  90528. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  90529. * if the ground has been updated.
  90530. * This can be used in the render loop.
  90531. * @returns the GroundMesh.
  90532. */
  90533. updateCoordinateHeights(): GroundMesh;
  90534. private _getFacetAt;
  90535. private _initHeightQuads;
  90536. private _computeHeightQuads;
  90537. /**
  90538. * Serializes this ground mesh
  90539. * @param serializationObject object to write serialization to
  90540. */
  90541. serialize(serializationObject: any): void;
  90542. /**
  90543. * Parses a serialized ground mesh
  90544. * @param parsedMesh the serialized mesh
  90545. * @param scene the scene to create the ground mesh in
  90546. * @returns the created ground mesh
  90547. */
  90548. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  90549. }
  90550. }
  90551. declare module BABYLON {
  90552. /**
  90553. * Interface for Physics-Joint data
  90554. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90555. */
  90556. export interface PhysicsJointData {
  90557. /**
  90558. * The main pivot of the joint
  90559. */
  90560. mainPivot?: Vector3;
  90561. /**
  90562. * The connected pivot of the joint
  90563. */
  90564. connectedPivot?: Vector3;
  90565. /**
  90566. * The main axis of the joint
  90567. */
  90568. mainAxis?: Vector3;
  90569. /**
  90570. * The connected axis of the joint
  90571. */
  90572. connectedAxis?: Vector3;
  90573. /**
  90574. * The collision of the joint
  90575. */
  90576. collision?: boolean;
  90577. /**
  90578. * Native Oimo/Cannon/Energy data
  90579. */
  90580. nativeParams?: any;
  90581. }
  90582. /**
  90583. * This is a holder class for the physics joint created by the physics plugin
  90584. * It holds a set of functions to control the underlying joint
  90585. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90586. */
  90587. export class PhysicsJoint {
  90588. /**
  90589. * The type of the physics joint
  90590. */
  90591. type: number;
  90592. /**
  90593. * The data for the physics joint
  90594. */
  90595. jointData: PhysicsJointData;
  90596. private _physicsJoint;
  90597. protected _physicsPlugin: IPhysicsEnginePlugin;
  90598. /**
  90599. * Initializes the physics joint
  90600. * @param type The type of the physics joint
  90601. * @param jointData The data for the physics joint
  90602. */
  90603. constructor(
  90604. /**
  90605. * The type of the physics joint
  90606. */
  90607. type: number,
  90608. /**
  90609. * The data for the physics joint
  90610. */
  90611. jointData: PhysicsJointData);
  90612. /**
  90613. * Gets the physics joint
  90614. */
  90615. /**
  90616. * Sets the physics joint
  90617. */
  90618. physicsJoint: any;
  90619. /**
  90620. * Sets the physics plugin
  90621. */
  90622. physicsPlugin: IPhysicsEnginePlugin;
  90623. /**
  90624. * Execute a function that is physics-plugin specific.
  90625. * @param {Function} func the function that will be executed.
  90626. * It accepts two parameters: the physics world and the physics joint
  90627. */
  90628. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  90629. /**
  90630. * Distance-Joint type
  90631. */
  90632. static DistanceJoint: number;
  90633. /**
  90634. * Hinge-Joint type
  90635. */
  90636. static HingeJoint: number;
  90637. /**
  90638. * Ball-and-Socket joint type
  90639. */
  90640. static BallAndSocketJoint: number;
  90641. /**
  90642. * Wheel-Joint type
  90643. */
  90644. static WheelJoint: number;
  90645. /**
  90646. * Slider-Joint type
  90647. */
  90648. static SliderJoint: number;
  90649. /**
  90650. * Prismatic-Joint type
  90651. */
  90652. static PrismaticJoint: number;
  90653. /**
  90654. * Universal-Joint type
  90655. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  90656. */
  90657. static UniversalJoint: number;
  90658. /**
  90659. * Hinge-Joint 2 type
  90660. */
  90661. static Hinge2Joint: number;
  90662. /**
  90663. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  90664. */
  90665. static PointToPointJoint: number;
  90666. /**
  90667. * Spring-Joint type
  90668. */
  90669. static SpringJoint: number;
  90670. /**
  90671. * Lock-Joint type
  90672. */
  90673. static LockJoint: number;
  90674. }
  90675. /**
  90676. * A class representing a physics distance joint
  90677. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90678. */
  90679. export class DistanceJoint extends PhysicsJoint {
  90680. /**
  90681. *
  90682. * @param jointData The data for the Distance-Joint
  90683. */
  90684. constructor(jointData: DistanceJointData);
  90685. /**
  90686. * Update the predefined distance.
  90687. * @param maxDistance The maximum preferred distance
  90688. * @param minDistance The minimum preferred distance
  90689. */
  90690. updateDistance(maxDistance: number, minDistance?: number): void;
  90691. }
  90692. /**
  90693. * Represents a Motor-Enabled Joint
  90694. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90695. */
  90696. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  90697. /**
  90698. * Initializes the Motor-Enabled Joint
  90699. * @param type The type of the joint
  90700. * @param jointData The physica joint data for the joint
  90701. */
  90702. constructor(type: number, jointData: PhysicsJointData);
  90703. /**
  90704. * Set the motor values.
  90705. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90706. * @param force the force to apply
  90707. * @param maxForce max force for this motor.
  90708. */
  90709. setMotor(force?: number, maxForce?: number): void;
  90710. /**
  90711. * Set the motor's limits.
  90712. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90713. * @param upperLimit The upper limit of the motor
  90714. * @param lowerLimit The lower limit of the motor
  90715. */
  90716. setLimit(upperLimit: number, lowerLimit?: number): void;
  90717. }
  90718. /**
  90719. * This class represents a single physics Hinge-Joint
  90720. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90721. */
  90722. export class HingeJoint extends MotorEnabledJoint {
  90723. /**
  90724. * Initializes the Hinge-Joint
  90725. * @param jointData The joint data for the Hinge-Joint
  90726. */
  90727. constructor(jointData: PhysicsJointData);
  90728. /**
  90729. * Set the motor values.
  90730. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90731. * @param {number} force the force to apply
  90732. * @param {number} maxForce max force for this motor.
  90733. */
  90734. setMotor(force?: number, maxForce?: number): void;
  90735. /**
  90736. * Set the motor's limits.
  90737. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90738. * @param upperLimit The upper limit of the motor
  90739. * @param lowerLimit The lower limit of the motor
  90740. */
  90741. setLimit(upperLimit: number, lowerLimit?: number): void;
  90742. }
  90743. /**
  90744. * This class represents a dual hinge physics joint (same as wheel joint)
  90745. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90746. */
  90747. export class Hinge2Joint extends MotorEnabledJoint {
  90748. /**
  90749. * Initializes the Hinge2-Joint
  90750. * @param jointData The joint data for the Hinge2-Joint
  90751. */
  90752. constructor(jointData: PhysicsJointData);
  90753. /**
  90754. * Set the motor values.
  90755. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90756. * @param {number} targetSpeed the speed the motor is to reach
  90757. * @param {number} maxForce max force for this motor.
  90758. * @param {motorIndex} the motor's index, 0 or 1.
  90759. */
  90760. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  90761. /**
  90762. * Set the motor limits.
  90763. * Attention, this function is plugin specific. Engines won't react 100% the same.
  90764. * @param {number} upperLimit the upper limit
  90765. * @param {number} lowerLimit lower limit
  90766. * @param {motorIndex} the motor's index, 0 or 1.
  90767. */
  90768. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  90769. }
  90770. /**
  90771. * Interface for a motor enabled joint
  90772. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90773. */
  90774. export interface IMotorEnabledJoint {
  90775. /**
  90776. * Physics joint
  90777. */
  90778. physicsJoint: any;
  90779. /**
  90780. * Sets the motor of the motor-enabled joint
  90781. * @param force The force of the motor
  90782. * @param maxForce The maximum force of the motor
  90783. * @param motorIndex The index of the motor
  90784. */
  90785. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  90786. /**
  90787. * Sets the limit of the motor
  90788. * @param upperLimit The upper limit of the motor
  90789. * @param lowerLimit The lower limit of the motor
  90790. * @param motorIndex The index of the motor
  90791. */
  90792. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  90793. }
  90794. /**
  90795. * Joint data for a Distance-Joint
  90796. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90797. */
  90798. export interface DistanceJointData extends PhysicsJointData {
  90799. /**
  90800. * Max distance the 2 joint objects can be apart
  90801. */
  90802. maxDistance: number;
  90803. }
  90804. /**
  90805. * Joint data from a spring joint
  90806. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90807. */
  90808. export interface SpringJointData extends PhysicsJointData {
  90809. /**
  90810. * Length of the spring
  90811. */
  90812. length: number;
  90813. /**
  90814. * Stiffness of the spring
  90815. */
  90816. stiffness: number;
  90817. /**
  90818. * Damping of the spring
  90819. */
  90820. damping: number;
  90821. /** this callback will be called when applying the force to the impostors. */
  90822. forceApplicationCallback: () => void;
  90823. }
  90824. }
  90825. declare module BABYLON {
  90826. /**
  90827. * Holds the data for the raycast result
  90828. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90829. */
  90830. export class PhysicsRaycastResult {
  90831. private _hasHit;
  90832. private _hitDistance;
  90833. private _hitNormalWorld;
  90834. private _hitPointWorld;
  90835. private _rayFromWorld;
  90836. private _rayToWorld;
  90837. /**
  90838. * Gets if there was a hit
  90839. */
  90840. readonly hasHit: boolean;
  90841. /**
  90842. * Gets the distance from the hit
  90843. */
  90844. readonly hitDistance: number;
  90845. /**
  90846. * Gets the hit normal/direction in the world
  90847. */
  90848. readonly hitNormalWorld: Vector3;
  90849. /**
  90850. * Gets the hit point in the world
  90851. */
  90852. readonly hitPointWorld: Vector3;
  90853. /**
  90854. * Gets the ray "start point" of the ray in the world
  90855. */
  90856. readonly rayFromWorld: Vector3;
  90857. /**
  90858. * Gets the ray "end point" of the ray in the world
  90859. */
  90860. readonly rayToWorld: Vector3;
  90861. /**
  90862. * Sets the hit data (normal & point in world space)
  90863. * @param hitNormalWorld defines the normal in world space
  90864. * @param hitPointWorld defines the point in world space
  90865. */
  90866. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  90867. /**
  90868. * Sets the distance from the start point to the hit point
  90869. * @param distance
  90870. */
  90871. setHitDistance(distance: number): void;
  90872. /**
  90873. * Calculates the distance manually
  90874. */
  90875. calculateHitDistance(): void;
  90876. /**
  90877. * Resets all the values to default
  90878. * @param from The from point on world space
  90879. * @param to The to point on world space
  90880. */
  90881. reset(from?: Vector3, to?: Vector3): void;
  90882. }
  90883. /**
  90884. * Interface for the size containing width and height
  90885. */
  90886. interface IXYZ {
  90887. /**
  90888. * X
  90889. */
  90890. x: number;
  90891. /**
  90892. * Y
  90893. */
  90894. y: number;
  90895. /**
  90896. * Z
  90897. */
  90898. z: number;
  90899. }
  90900. }
  90901. declare module BABYLON {
  90902. /**
  90903. * Interface used to describe a physics joint
  90904. */
  90905. export interface PhysicsImpostorJoint {
  90906. /** Defines the main impostor to which the joint is linked */
  90907. mainImpostor: PhysicsImpostor;
  90908. /** Defines the impostor that is connected to the main impostor using this joint */
  90909. connectedImpostor: PhysicsImpostor;
  90910. /** Defines the joint itself */
  90911. joint: PhysicsJoint;
  90912. }
  90913. /** @hidden */
  90914. export interface IPhysicsEnginePlugin {
  90915. world: any;
  90916. name: string;
  90917. setGravity(gravity: Vector3): void;
  90918. setTimeStep(timeStep: number): void;
  90919. getTimeStep(): number;
  90920. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  90921. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  90922. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  90923. generatePhysicsBody(impostor: PhysicsImpostor): void;
  90924. removePhysicsBody(impostor: PhysicsImpostor): void;
  90925. generateJoint(joint: PhysicsImpostorJoint): void;
  90926. removeJoint(joint: PhysicsImpostorJoint): void;
  90927. isSupported(): boolean;
  90928. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  90929. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  90930. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  90931. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  90932. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  90933. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  90934. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  90935. getBodyMass(impostor: PhysicsImpostor): number;
  90936. getBodyFriction(impostor: PhysicsImpostor): number;
  90937. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  90938. getBodyRestitution(impostor: PhysicsImpostor): number;
  90939. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  90940. getBodyPressure?(impostor: PhysicsImpostor): number;
  90941. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  90942. getBodyStiffness?(impostor: PhysicsImpostor): number;
  90943. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  90944. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  90945. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  90946. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  90947. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  90948. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  90949. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  90950. sleepBody(impostor: PhysicsImpostor): void;
  90951. wakeUpBody(impostor: PhysicsImpostor): void;
  90952. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  90953. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  90954. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  90955. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  90956. getRadius(impostor: PhysicsImpostor): number;
  90957. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  90958. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  90959. dispose(): void;
  90960. }
  90961. /**
  90962. * Interface used to define a physics engine
  90963. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  90964. */
  90965. export interface IPhysicsEngine {
  90966. /**
  90967. * Gets the gravity vector used by the simulation
  90968. */
  90969. gravity: Vector3;
  90970. /**
  90971. * Sets the gravity vector used by the simulation
  90972. * @param gravity defines the gravity vector to use
  90973. */
  90974. setGravity(gravity: Vector3): void;
  90975. /**
  90976. * Set the time step of the physics engine.
  90977. * Default is 1/60.
  90978. * To slow it down, enter 1/600 for example.
  90979. * To speed it up, 1/30
  90980. * @param newTimeStep the new timestep to apply to this world.
  90981. */
  90982. setTimeStep(newTimeStep: number): void;
  90983. /**
  90984. * Get the time step of the physics engine.
  90985. * @returns the current time step
  90986. */
  90987. getTimeStep(): number;
  90988. /**
  90989. * Release all resources
  90990. */
  90991. dispose(): void;
  90992. /**
  90993. * Gets the name of the current physics plugin
  90994. * @returns the name of the plugin
  90995. */
  90996. getPhysicsPluginName(): string;
  90997. /**
  90998. * Adding a new impostor for the impostor tracking.
  90999. * This will be done by the impostor itself.
  91000. * @param impostor the impostor to add
  91001. */
  91002. addImpostor(impostor: PhysicsImpostor): void;
  91003. /**
  91004. * Remove an impostor from the engine.
  91005. * This impostor and its mesh will not longer be updated by the physics engine.
  91006. * @param impostor the impostor to remove
  91007. */
  91008. removeImpostor(impostor: PhysicsImpostor): void;
  91009. /**
  91010. * Add a joint to the physics engine
  91011. * @param mainImpostor defines the main impostor to which the joint is added.
  91012. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  91013. * @param joint defines the joint that will connect both impostors.
  91014. */
  91015. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  91016. /**
  91017. * Removes a joint from the simulation
  91018. * @param mainImpostor defines the impostor used with the joint
  91019. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  91020. * @param joint defines the joint to remove
  91021. */
  91022. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  91023. /**
  91024. * Gets the current plugin used to run the simulation
  91025. * @returns current plugin
  91026. */
  91027. getPhysicsPlugin(): IPhysicsEnginePlugin;
  91028. /**
  91029. * Gets the list of physic impostors
  91030. * @returns an array of PhysicsImpostor
  91031. */
  91032. getImpostors(): Array<PhysicsImpostor>;
  91033. /**
  91034. * Gets the impostor for a physics enabled object
  91035. * @param object defines the object impersonated by the impostor
  91036. * @returns the PhysicsImpostor or null if not found
  91037. */
  91038. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  91039. /**
  91040. * Gets the impostor for a physics body object
  91041. * @param body defines physics body used by the impostor
  91042. * @returns the PhysicsImpostor or null if not found
  91043. */
  91044. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  91045. /**
  91046. * Does a raycast in the physics world
  91047. * @param from when should the ray start?
  91048. * @param to when should the ray end?
  91049. * @returns PhysicsRaycastResult
  91050. */
  91051. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  91052. /**
  91053. * Called by the scene. No need to call it.
  91054. * @param delta defines the timespam between frames
  91055. */
  91056. _step(delta: number): void;
  91057. }
  91058. }
  91059. declare module BABYLON {
  91060. /**
  91061. * The interface for the physics imposter parameters
  91062. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91063. */
  91064. export interface PhysicsImpostorParameters {
  91065. /**
  91066. * The mass of the physics imposter
  91067. */
  91068. mass: number;
  91069. /**
  91070. * The friction of the physics imposter
  91071. */
  91072. friction?: number;
  91073. /**
  91074. * The coefficient of restitution of the physics imposter
  91075. */
  91076. restitution?: number;
  91077. /**
  91078. * The native options of the physics imposter
  91079. */
  91080. nativeOptions?: any;
  91081. /**
  91082. * Specifies if the parent should be ignored
  91083. */
  91084. ignoreParent?: boolean;
  91085. /**
  91086. * Specifies if bi-directional transformations should be disabled
  91087. */
  91088. disableBidirectionalTransformation?: boolean;
  91089. /**
  91090. * The pressure inside the physics imposter, soft object only
  91091. */
  91092. pressure?: number;
  91093. /**
  91094. * The stiffness the physics imposter, soft object only
  91095. */
  91096. stiffness?: number;
  91097. /**
  91098. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  91099. */
  91100. velocityIterations?: number;
  91101. /**
  91102. * The number of iterations used in maintaining consistent vertex positions, soft object only
  91103. */
  91104. positionIterations?: number;
  91105. /**
  91106. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  91107. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  91108. * Add to fix multiple points
  91109. */
  91110. fixedPoints?: number;
  91111. /**
  91112. * The collision margin around a soft object
  91113. */
  91114. margin?: number;
  91115. /**
  91116. * The collision margin around a soft object
  91117. */
  91118. damping?: number;
  91119. /**
  91120. * The path for a rope based on an extrusion
  91121. */
  91122. path?: any;
  91123. /**
  91124. * The shape of an extrusion used for a rope based on an extrusion
  91125. */
  91126. shape?: any;
  91127. }
  91128. /**
  91129. * Interface for a physics-enabled object
  91130. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91131. */
  91132. export interface IPhysicsEnabledObject {
  91133. /**
  91134. * The position of the physics-enabled object
  91135. */
  91136. position: Vector3;
  91137. /**
  91138. * The rotation of the physics-enabled object
  91139. */
  91140. rotationQuaternion: Nullable<Quaternion>;
  91141. /**
  91142. * The scale of the physics-enabled object
  91143. */
  91144. scaling: Vector3;
  91145. /**
  91146. * The rotation of the physics-enabled object
  91147. */
  91148. rotation?: Vector3;
  91149. /**
  91150. * The parent of the physics-enabled object
  91151. */
  91152. parent?: any;
  91153. /**
  91154. * The bounding info of the physics-enabled object
  91155. * @returns The bounding info of the physics-enabled object
  91156. */
  91157. getBoundingInfo(): BoundingInfo;
  91158. /**
  91159. * Computes the world matrix
  91160. * @param force Specifies if the world matrix should be computed by force
  91161. * @returns A world matrix
  91162. */
  91163. computeWorldMatrix(force: boolean): Matrix;
  91164. /**
  91165. * Gets the world matrix
  91166. * @returns A world matrix
  91167. */
  91168. getWorldMatrix?(): Matrix;
  91169. /**
  91170. * Gets the child meshes
  91171. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  91172. * @returns An array of abstract meshes
  91173. */
  91174. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  91175. /**
  91176. * Gets the vertex data
  91177. * @param kind The type of vertex data
  91178. * @returns A nullable array of numbers, or a float32 array
  91179. */
  91180. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  91181. /**
  91182. * Gets the indices from the mesh
  91183. * @returns A nullable array of index arrays
  91184. */
  91185. getIndices?(): Nullable<IndicesArray>;
  91186. /**
  91187. * Gets the scene from the mesh
  91188. * @returns the indices array or null
  91189. */
  91190. getScene?(): Scene;
  91191. /**
  91192. * Gets the absolute position from the mesh
  91193. * @returns the absolute position
  91194. */
  91195. getAbsolutePosition(): Vector3;
  91196. /**
  91197. * Gets the absolute pivot point from the mesh
  91198. * @returns the absolute pivot point
  91199. */
  91200. getAbsolutePivotPoint(): Vector3;
  91201. /**
  91202. * Rotates the mesh
  91203. * @param axis The axis of rotation
  91204. * @param amount The amount of rotation
  91205. * @param space The space of the rotation
  91206. * @returns The rotation transform node
  91207. */
  91208. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  91209. /**
  91210. * Translates the mesh
  91211. * @param axis The axis of translation
  91212. * @param distance The distance of translation
  91213. * @param space The space of the translation
  91214. * @returns The transform node
  91215. */
  91216. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  91217. /**
  91218. * Sets the absolute position of the mesh
  91219. * @param absolutePosition The absolute position of the mesh
  91220. * @returns The transform node
  91221. */
  91222. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  91223. /**
  91224. * Gets the class name of the mesh
  91225. * @returns The class name
  91226. */
  91227. getClassName(): string;
  91228. }
  91229. /**
  91230. * Represents a physics imposter
  91231. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91232. */
  91233. export class PhysicsImpostor {
  91234. /**
  91235. * The physics-enabled object used as the physics imposter
  91236. */
  91237. object: IPhysicsEnabledObject;
  91238. /**
  91239. * The type of the physics imposter
  91240. */
  91241. type: number;
  91242. private _options;
  91243. private _scene?;
  91244. /**
  91245. * The default object size of the imposter
  91246. */
  91247. static DEFAULT_OBJECT_SIZE: Vector3;
  91248. /**
  91249. * The identity quaternion of the imposter
  91250. */
  91251. static IDENTITY_QUATERNION: Quaternion;
  91252. /** @hidden */
  91253. _pluginData: any;
  91254. private _physicsEngine;
  91255. private _physicsBody;
  91256. private _bodyUpdateRequired;
  91257. private _onBeforePhysicsStepCallbacks;
  91258. private _onAfterPhysicsStepCallbacks;
  91259. /** @hidden */
  91260. _onPhysicsCollideCallbacks: Array<{
  91261. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  91262. otherImpostors: Array<PhysicsImpostor>;
  91263. }>;
  91264. private _deltaPosition;
  91265. private _deltaRotation;
  91266. private _deltaRotationConjugated;
  91267. /** @hidden */
  91268. _isFromLine: boolean;
  91269. private _parent;
  91270. private _isDisposed;
  91271. private static _tmpVecs;
  91272. private static _tmpQuat;
  91273. /**
  91274. * Specifies if the physics imposter is disposed
  91275. */
  91276. readonly isDisposed: boolean;
  91277. /**
  91278. * Gets the mass of the physics imposter
  91279. */
  91280. mass: number;
  91281. /**
  91282. * Gets the coefficient of friction
  91283. */
  91284. /**
  91285. * Sets the coefficient of friction
  91286. */
  91287. friction: number;
  91288. /**
  91289. * Gets the coefficient of restitution
  91290. */
  91291. /**
  91292. * Sets the coefficient of restitution
  91293. */
  91294. restitution: number;
  91295. /**
  91296. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  91297. */
  91298. /**
  91299. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  91300. */
  91301. pressure: number;
  91302. /**
  91303. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  91304. */
  91305. /**
  91306. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  91307. */
  91308. stiffness: number;
  91309. /**
  91310. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  91311. */
  91312. /**
  91313. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  91314. */
  91315. velocityIterations: number;
  91316. /**
  91317. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  91318. */
  91319. /**
  91320. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  91321. */
  91322. positionIterations: number;
  91323. /**
  91324. * The unique id of the physics imposter
  91325. * set by the physics engine when adding this impostor to the array
  91326. */
  91327. uniqueId: number;
  91328. /**
  91329. * @hidden
  91330. */
  91331. soft: boolean;
  91332. /**
  91333. * @hidden
  91334. */
  91335. segments: number;
  91336. private _joints;
  91337. /**
  91338. * Initializes the physics imposter
  91339. * @param object The physics-enabled object used as the physics imposter
  91340. * @param type The type of the physics imposter
  91341. * @param _options The options for the physics imposter
  91342. * @param _scene The Babylon scene
  91343. */
  91344. constructor(
  91345. /**
  91346. * The physics-enabled object used as the physics imposter
  91347. */
  91348. object: IPhysicsEnabledObject,
  91349. /**
  91350. * The type of the physics imposter
  91351. */
  91352. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  91353. /**
  91354. * This function will completly initialize this impostor.
  91355. * It will create a new body - but only if this mesh has no parent.
  91356. * If it has, this impostor will not be used other than to define the impostor
  91357. * of the child mesh.
  91358. * @hidden
  91359. */
  91360. _init(): void;
  91361. private _getPhysicsParent;
  91362. /**
  91363. * Should a new body be generated.
  91364. * @returns boolean specifying if body initialization is required
  91365. */
  91366. isBodyInitRequired(): boolean;
  91367. /**
  91368. * Sets the updated scaling
  91369. * @param updated Specifies if the scaling is updated
  91370. */
  91371. setScalingUpdated(): void;
  91372. /**
  91373. * Force a regeneration of this or the parent's impostor's body.
  91374. * Use under cautious - This will remove all joints already implemented.
  91375. */
  91376. forceUpdate(): void;
  91377. /**
  91378. * Gets the body that holds this impostor. Either its own, or its parent.
  91379. */
  91380. /**
  91381. * Set the physics body. Used mainly by the physics engine/plugin
  91382. */
  91383. physicsBody: any;
  91384. /**
  91385. * Get the parent of the physics imposter
  91386. * @returns Physics imposter or null
  91387. */
  91388. /**
  91389. * Sets the parent of the physics imposter
  91390. */
  91391. parent: Nullable<PhysicsImpostor>;
  91392. /**
  91393. * Resets the update flags
  91394. */
  91395. resetUpdateFlags(): void;
  91396. /**
  91397. * Gets the object extend size
  91398. * @returns the object extend size
  91399. */
  91400. getObjectExtendSize(): Vector3;
  91401. /**
  91402. * Gets the object center
  91403. * @returns The object center
  91404. */
  91405. getObjectCenter(): Vector3;
  91406. /**
  91407. * Get a specific parametes from the options parameter
  91408. * @param paramName The object parameter name
  91409. * @returns The object parameter
  91410. */
  91411. getParam(paramName: string): any;
  91412. /**
  91413. * Sets a specific parameter in the options given to the physics plugin
  91414. * @param paramName The parameter name
  91415. * @param value The value of the parameter
  91416. */
  91417. setParam(paramName: string, value: number): void;
  91418. /**
  91419. * Specifically change the body's mass option. Won't recreate the physics body object
  91420. * @param mass The mass of the physics imposter
  91421. */
  91422. setMass(mass: number): void;
  91423. /**
  91424. * Gets the linear velocity
  91425. * @returns linear velocity or null
  91426. */
  91427. getLinearVelocity(): Nullable<Vector3>;
  91428. /**
  91429. * Sets the linear velocity
  91430. * @param velocity linear velocity or null
  91431. */
  91432. setLinearVelocity(velocity: Nullable<Vector3>): void;
  91433. /**
  91434. * Gets the angular velocity
  91435. * @returns angular velocity or null
  91436. */
  91437. getAngularVelocity(): Nullable<Vector3>;
  91438. /**
  91439. * Sets the angular velocity
  91440. * @param velocity The velocity or null
  91441. */
  91442. setAngularVelocity(velocity: Nullable<Vector3>): void;
  91443. /**
  91444. * Execute a function with the physics plugin native code
  91445. * Provide a function the will have two variables - the world object and the physics body object
  91446. * @param func The function to execute with the physics plugin native code
  91447. */
  91448. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  91449. /**
  91450. * Register a function that will be executed before the physics world is stepping forward
  91451. * @param func The function to execute before the physics world is stepped forward
  91452. */
  91453. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91454. /**
  91455. * Unregister a function that will be executed before the physics world is stepping forward
  91456. * @param func The function to execute before the physics world is stepped forward
  91457. */
  91458. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91459. /**
  91460. * Register a function that will be executed after the physics step
  91461. * @param func The function to execute after physics step
  91462. */
  91463. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91464. /**
  91465. * Unregisters a function that will be executed after the physics step
  91466. * @param func The function to execute after physics step
  91467. */
  91468. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91469. /**
  91470. * register a function that will be executed when this impostor collides against a different body
  91471. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  91472. * @param func Callback that is executed on collision
  91473. */
  91474. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  91475. /**
  91476. * Unregisters the physics imposter on contact
  91477. * @param collideAgainst The physics object to collide against
  91478. * @param func Callback to execute on collision
  91479. */
  91480. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  91481. private _tmpQuat;
  91482. private _tmpQuat2;
  91483. /**
  91484. * Get the parent rotation
  91485. * @returns The parent rotation
  91486. */
  91487. getParentsRotation(): Quaternion;
  91488. /**
  91489. * this function is executed by the physics engine.
  91490. */
  91491. beforeStep: () => void;
  91492. /**
  91493. * this function is executed by the physics engine
  91494. */
  91495. afterStep: () => void;
  91496. /**
  91497. * Legacy collision detection event support
  91498. */
  91499. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  91500. /**
  91501. * event and body object due to cannon's event-based architecture.
  91502. */
  91503. onCollide: (e: {
  91504. body: any;
  91505. }) => void;
  91506. /**
  91507. * Apply a force
  91508. * @param force The force to apply
  91509. * @param contactPoint The contact point for the force
  91510. * @returns The physics imposter
  91511. */
  91512. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  91513. /**
  91514. * Apply an impulse
  91515. * @param force The impulse force
  91516. * @param contactPoint The contact point for the impulse force
  91517. * @returns The physics imposter
  91518. */
  91519. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  91520. /**
  91521. * A help function to create a joint
  91522. * @param otherImpostor A physics imposter used to create a joint
  91523. * @param jointType The type of joint
  91524. * @param jointData The data for the joint
  91525. * @returns The physics imposter
  91526. */
  91527. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  91528. /**
  91529. * Add a joint to this impostor with a different impostor
  91530. * @param otherImpostor A physics imposter used to add a joint
  91531. * @param joint The joint to add
  91532. * @returns The physics imposter
  91533. */
  91534. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  91535. /**
  91536. * Add an anchor to a cloth impostor
  91537. * @param otherImpostor rigid impostor to anchor to
  91538. * @param width ratio across width from 0 to 1
  91539. * @param height ratio up height from 0 to 1
  91540. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  91541. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  91542. * @returns impostor the soft imposter
  91543. */
  91544. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  91545. /**
  91546. * Add a hook to a rope impostor
  91547. * @param otherImpostor rigid impostor to anchor to
  91548. * @param length ratio across rope from 0 to 1
  91549. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  91550. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  91551. * @returns impostor the rope imposter
  91552. */
  91553. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  91554. /**
  91555. * Will keep this body still, in a sleep mode.
  91556. * @returns the physics imposter
  91557. */
  91558. sleep(): PhysicsImpostor;
  91559. /**
  91560. * Wake the body up.
  91561. * @returns The physics imposter
  91562. */
  91563. wakeUp(): PhysicsImpostor;
  91564. /**
  91565. * Clones the physics imposter
  91566. * @param newObject The physics imposter clones to this physics-enabled object
  91567. * @returns A nullable physics imposter
  91568. */
  91569. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  91570. /**
  91571. * Disposes the physics imposter
  91572. */
  91573. dispose(): void;
  91574. /**
  91575. * Sets the delta position
  91576. * @param position The delta position amount
  91577. */
  91578. setDeltaPosition(position: Vector3): void;
  91579. /**
  91580. * Sets the delta rotation
  91581. * @param rotation The delta rotation amount
  91582. */
  91583. setDeltaRotation(rotation: Quaternion): void;
  91584. /**
  91585. * Gets the box size of the physics imposter and stores the result in the input parameter
  91586. * @param result Stores the box size
  91587. * @returns The physics imposter
  91588. */
  91589. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  91590. /**
  91591. * Gets the radius of the physics imposter
  91592. * @returns Radius of the physics imposter
  91593. */
  91594. getRadius(): number;
  91595. /**
  91596. * Sync a bone with this impostor
  91597. * @param bone The bone to sync to the impostor.
  91598. * @param boneMesh The mesh that the bone is influencing.
  91599. * @param jointPivot The pivot of the joint / bone in local space.
  91600. * @param distToJoint Optional distance from the impostor to the joint.
  91601. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  91602. */
  91603. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  91604. /**
  91605. * Sync impostor to a bone
  91606. * @param bone The bone that the impostor will be synced to.
  91607. * @param boneMesh The mesh that the bone is influencing.
  91608. * @param jointPivot The pivot of the joint / bone in local space.
  91609. * @param distToJoint Optional distance from the impostor to the joint.
  91610. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  91611. * @param boneAxis Optional vector3 axis the bone is aligned with
  91612. */
  91613. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  91614. /**
  91615. * No-Imposter type
  91616. */
  91617. static NoImpostor: number;
  91618. /**
  91619. * Sphere-Imposter type
  91620. */
  91621. static SphereImpostor: number;
  91622. /**
  91623. * Box-Imposter type
  91624. */
  91625. static BoxImpostor: number;
  91626. /**
  91627. * Plane-Imposter type
  91628. */
  91629. static PlaneImpostor: number;
  91630. /**
  91631. * Mesh-imposter type
  91632. */
  91633. static MeshImpostor: number;
  91634. /**
  91635. * Capsule-Impostor type (Ammo.js plugin only)
  91636. */
  91637. static CapsuleImpostor: number;
  91638. /**
  91639. * Cylinder-Imposter type
  91640. */
  91641. static CylinderImpostor: number;
  91642. /**
  91643. * Particle-Imposter type
  91644. */
  91645. static ParticleImpostor: number;
  91646. /**
  91647. * Heightmap-Imposter type
  91648. */
  91649. static HeightmapImpostor: number;
  91650. /**
  91651. * ConvexHull-Impostor type (Ammo.js plugin only)
  91652. */
  91653. static ConvexHullImpostor: number;
  91654. /**
  91655. * Rope-Imposter type
  91656. */
  91657. static RopeImpostor: number;
  91658. /**
  91659. * Cloth-Imposter type
  91660. */
  91661. static ClothImpostor: number;
  91662. /**
  91663. * Softbody-Imposter type
  91664. */
  91665. static SoftbodyImpostor: number;
  91666. }
  91667. }
  91668. declare module BABYLON {
  91669. /**
  91670. * @hidden
  91671. **/
  91672. export class _CreationDataStorage {
  91673. closePath?: boolean;
  91674. closeArray?: boolean;
  91675. idx: number[];
  91676. dashSize: number;
  91677. gapSize: number;
  91678. path3D: Path3D;
  91679. pathArray: Vector3[][];
  91680. arc: number;
  91681. radius: number;
  91682. cap: number;
  91683. tessellation: number;
  91684. }
  91685. /**
  91686. * @hidden
  91687. **/
  91688. class _InstanceDataStorage {
  91689. visibleInstances: any;
  91690. batchCache: _InstancesBatch;
  91691. instancesBufferSize: number;
  91692. instancesBuffer: Nullable<Buffer>;
  91693. instancesData: Float32Array;
  91694. overridenInstanceCount: number;
  91695. isFrozen: boolean;
  91696. previousBatch: Nullable<_InstancesBatch>;
  91697. hardwareInstancedRendering: boolean;
  91698. sideOrientation: number;
  91699. }
  91700. /**
  91701. * @hidden
  91702. **/
  91703. export class _InstancesBatch {
  91704. mustReturn: boolean;
  91705. visibleInstances: Nullable<InstancedMesh[]>[];
  91706. renderSelf: boolean[];
  91707. hardwareInstancedRendering: boolean[];
  91708. }
  91709. /**
  91710. * Class used to represent renderable models
  91711. */
  91712. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  91713. /**
  91714. * Mesh side orientation : usually the external or front surface
  91715. */
  91716. static readonly FRONTSIDE: number;
  91717. /**
  91718. * Mesh side orientation : usually the internal or back surface
  91719. */
  91720. static readonly BACKSIDE: number;
  91721. /**
  91722. * Mesh side orientation : both internal and external or front and back surfaces
  91723. */
  91724. static readonly DOUBLESIDE: number;
  91725. /**
  91726. * Mesh side orientation : by default, `FRONTSIDE`
  91727. */
  91728. static readonly DEFAULTSIDE: number;
  91729. /**
  91730. * Mesh cap setting : no cap
  91731. */
  91732. static readonly NO_CAP: number;
  91733. /**
  91734. * Mesh cap setting : one cap at the beginning of the mesh
  91735. */
  91736. static readonly CAP_START: number;
  91737. /**
  91738. * Mesh cap setting : one cap at the end of the mesh
  91739. */
  91740. static readonly CAP_END: number;
  91741. /**
  91742. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  91743. */
  91744. static readonly CAP_ALL: number;
  91745. /**
  91746. * Mesh pattern setting : no flip or rotate
  91747. */
  91748. static readonly NO_FLIP: number;
  91749. /**
  91750. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  91751. */
  91752. static readonly FLIP_TILE: number;
  91753. /**
  91754. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  91755. */
  91756. static readonly ROTATE_TILE: number;
  91757. /**
  91758. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  91759. */
  91760. static readonly FLIP_ROW: number;
  91761. /**
  91762. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  91763. */
  91764. static readonly ROTATE_ROW: number;
  91765. /**
  91766. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  91767. */
  91768. static readonly FLIP_N_ROTATE_TILE: number;
  91769. /**
  91770. * Mesh pattern setting : rotate pattern and rotate
  91771. */
  91772. static readonly FLIP_N_ROTATE_ROW: number;
  91773. /**
  91774. * Mesh tile positioning : part tiles same on left/right or top/bottom
  91775. */
  91776. static readonly CENTER: number;
  91777. /**
  91778. * Mesh tile positioning : part tiles on left
  91779. */
  91780. static readonly LEFT: number;
  91781. /**
  91782. * Mesh tile positioning : part tiles on right
  91783. */
  91784. static readonly RIGHT: number;
  91785. /**
  91786. * Mesh tile positioning : part tiles on top
  91787. */
  91788. static readonly TOP: number;
  91789. /**
  91790. * Mesh tile positioning : part tiles on bottom
  91791. */
  91792. static readonly BOTTOM: number;
  91793. /**
  91794. * Gets the default side orientation.
  91795. * @param orientation the orientation to value to attempt to get
  91796. * @returns the default orientation
  91797. * @hidden
  91798. */
  91799. static _GetDefaultSideOrientation(orientation?: number): number;
  91800. private _internalMeshDataInfo;
  91801. /**
  91802. * An event triggered before rendering the mesh
  91803. */
  91804. readonly onBeforeRenderObservable: Observable<Mesh>;
  91805. /**
  91806. * An event triggered before binding the mesh
  91807. */
  91808. readonly onBeforeBindObservable: Observable<Mesh>;
  91809. /**
  91810. * An event triggered after rendering the mesh
  91811. */
  91812. readonly onAfterRenderObservable: Observable<Mesh>;
  91813. /**
  91814. * An event triggered before drawing the mesh
  91815. */
  91816. readonly onBeforeDrawObservable: Observable<Mesh>;
  91817. private _onBeforeDrawObserver;
  91818. /**
  91819. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  91820. */
  91821. onBeforeDraw: () => void;
  91822. readonly hasInstances: boolean;
  91823. /**
  91824. * Gets the delay loading state of the mesh (when delay loading is turned on)
  91825. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  91826. */
  91827. delayLoadState: number;
  91828. /**
  91829. * Gets the list of instances created from this mesh
  91830. * it is not supposed to be modified manually.
  91831. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  91832. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  91833. */
  91834. instances: InstancedMesh[];
  91835. /**
  91836. * Gets the file containing delay loading data for this mesh
  91837. */
  91838. delayLoadingFile: string;
  91839. /** @hidden */
  91840. _binaryInfo: any;
  91841. /**
  91842. * User defined function used to change how LOD level selection is done
  91843. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  91844. */
  91845. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  91846. /**
  91847. * Gets or sets the morph target manager
  91848. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  91849. */
  91850. morphTargetManager: Nullable<MorphTargetManager>;
  91851. /** @hidden */
  91852. _creationDataStorage: Nullable<_CreationDataStorage>;
  91853. /** @hidden */
  91854. _geometry: Nullable<Geometry>;
  91855. /** @hidden */
  91856. _delayInfo: Array<string>;
  91857. /** @hidden */
  91858. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  91859. /** @hidden */
  91860. _instanceDataStorage: _InstanceDataStorage;
  91861. private _effectiveMaterial;
  91862. /** @hidden */
  91863. _shouldGenerateFlatShading: boolean;
  91864. /** @hidden */
  91865. _originalBuilderSideOrientation: number;
  91866. /**
  91867. * Use this property to change the original side orientation defined at construction time
  91868. */
  91869. overrideMaterialSideOrientation: Nullable<number>;
  91870. /**
  91871. * Gets the source mesh (the one used to clone this one from)
  91872. */
  91873. readonly source: Nullable<Mesh>;
  91874. /**
  91875. * Gets or sets a boolean indicating that this mesh does not use index buffer
  91876. */
  91877. isUnIndexed: boolean;
  91878. /**
  91879. * @constructor
  91880. * @param name The value used by scene.getMeshByName() to do a lookup.
  91881. * @param scene The scene to add this mesh to.
  91882. * @param parent The parent of this mesh, if it has one
  91883. * @param source An optional Mesh from which geometry is shared, cloned.
  91884. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  91885. * When false, achieved by calling a clone(), also passing False.
  91886. * This will make creation of children, recursive.
  91887. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  91888. */
  91889. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  91890. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  91891. doNotInstantiate: boolean;
  91892. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  91893. /**
  91894. * Gets the class name
  91895. * @returns the string "Mesh".
  91896. */
  91897. getClassName(): string;
  91898. /** @hidden */
  91899. readonly _isMesh: boolean;
  91900. /**
  91901. * Returns a description of this mesh
  91902. * @param fullDetails define if full details about this mesh must be used
  91903. * @returns a descriptive string representing this mesh
  91904. */
  91905. toString(fullDetails?: boolean): string;
  91906. /** @hidden */
  91907. _unBindEffect(): void;
  91908. /**
  91909. * Gets a boolean indicating if this mesh has LOD
  91910. */
  91911. readonly hasLODLevels: boolean;
  91912. /**
  91913. * Gets the list of MeshLODLevel associated with the current mesh
  91914. * @returns an array of MeshLODLevel
  91915. */
  91916. getLODLevels(): MeshLODLevel[];
  91917. private _sortLODLevels;
  91918. /**
  91919. * Add a mesh as LOD level triggered at the given distance.
  91920. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91921. * @param distance The distance from the center of the object to show this level
  91922. * @param mesh The mesh to be added as LOD level (can be null)
  91923. * @return This mesh (for chaining)
  91924. */
  91925. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  91926. /**
  91927. * Returns the LOD level mesh at the passed distance or null if not found.
  91928. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91929. * @param distance The distance from the center of the object to show this level
  91930. * @returns a Mesh or `null`
  91931. */
  91932. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  91933. /**
  91934. * Remove a mesh from the LOD array
  91935. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91936. * @param mesh defines the mesh to be removed
  91937. * @return This mesh (for chaining)
  91938. */
  91939. removeLODLevel(mesh: Mesh): Mesh;
  91940. /**
  91941. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  91942. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  91943. * @param camera defines the camera to use to compute distance
  91944. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  91945. * @return This mesh (for chaining)
  91946. */
  91947. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  91948. /**
  91949. * Gets the mesh internal Geometry object
  91950. */
  91951. readonly geometry: Nullable<Geometry>;
  91952. /**
  91953. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  91954. * @returns the total number of vertices
  91955. */
  91956. getTotalVertices(): number;
  91957. /**
  91958. * Returns the content of an associated vertex buffer
  91959. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  91960. * - VertexBuffer.PositionKind
  91961. * - VertexBuffer.UVKind
  91962. * - VertexBuffer.UV2Kind
  91963. * - VertexBuffer.UV3Kind
  91964. * - VertexBuffer.UV4Kind
  91965. * - VertexBuffer.UV5Kind
  91966. * - VertexBuffer.UV6Kind
  91967. * - VertexBuffer.ColorKind
  91968. * - VertexBuffer.MatricesIndicesKind
  91969. * - VertexBuffer.MatricesIndicesExtraKind
  91970. * - VertexBuffer.MatricesWeightsKind
  91971. * - VertexBuffer.MatricesWeightsExtraKind
  91972. * @param copyWhenShared defines a boolean indicating that if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one
  91973. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  91974. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  91975. */
  91976. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  91977. /**
  91978. * Returns the mesh VertexBuffer object from the requested `kind`
  91979. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  91980. * - VertexBuffer.PositionKind
  91981. * - VertexBuffer.NormalKind
  91982. * - VertexBuffer.UVKind
  91983. * - VertexBuffer.UV2Kind
  91984. * - VertexBuffer.UV3Kind
  91985. * - VertexBuffer.UV4Kind
  91986. * - VertexBuffer.UV5Kind
  91987. * - VertexBuffer.UV6Kind
  91988. * - VertexBuffer.ColorKind
  91989. * - VertexBuffer.MatricesIndicesKind
  91990. * - VertexBuffer.MatricesIndicesExtraKind
  91991. * - VertexBuffer.MatricesWeightsKind
  91992. * - VertexBuffer.MatricesWeightsExtraKind
  91993. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  91994. */
  91995. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  91996. /**
  91997. * Tests if a specific vertex buffer is associated with this mesh
  91998. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  91999. * - VertexBuffer.PositionKind
  92000. * - VertexBuffer.NormalKind
  92001. * - VertexBuffer.UVKind
  92002. * - VertexBuffer.UV2Kind
  92003. * - VertexBuffer.UV3Kind
  92004. * - VertexBuffer.UV4Kind
  92005. * - VertexBuffer.UV5Kind
  92006. * - VertexBuffer.UV6Kind
  92007. * - VertexBuffer.ColorKind
  92008. * - VertexBuffer.MatricesIndicesKind
  92009. * - VertexBuffer.MatricesIndicesExtraKind
  92010. * - VertexBuffer.MatricesWeightsKind
  92011. * - VertexBuffer.MatricesWeightsExtraKind
  92012. * @returns a boolean
  92013. */
  92014. isVerticesDataPresent(kind: string): boolean;
  92015. /**
  92016. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  92017. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  92018. * - VertexBuffer.PositionKind
  92019. * - VertexBuffer.UVKind
  92020. * - VertexBuffer.UV2Kind
  92021. * - VertexBuffer.UV3Kind
  92022. * - VertexBuffer.UV4Kind
  92023. * - VertexBuffer.UV5Kind
  92024. * - VertexBuffer.UV6Kind
  92025. * - VertexBuffer.ColorKind
  92026. * - VertexBuffer.MatricesIndicesKind
  92027. * - VertexBuffer.MatricesIndicesExtraKind
  92028. * - VertexBuffer.MatricesWeightsKind
  92029. * - VertexBuffer.MatricesWeightsExtraKind
  92030. * @returns a boolean
  92031. */
  92032. isVertexBufferUpdatable(kind: string): boolean;
  92033. /**
  92034. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  92035. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  92036. * - VertexBuffer.PositionKind
  92037. * - VertexBuffer.NormalKind
  92038. * - VertexBuffer.UVKind
  92039. * - VertexBuffer.UV2Kind
  92040. * - VertexBuffer.UV3Kind
  92041. * - VertexBuffer.UV4Kind
  92042. * - VertexBuffer.UV5Kind
  92043. * - VertexBuffer.UV6Kind
  92044. * - VertexBuffer.ColorKind
  92045. * - VertexBuffer.MatricesIndicesKind
  92046. * - VertexBuffer.MatricesIndicesExtraKind
  92047. * - VertexBuffer.MatricesWeightsKind
  92048. * - VertexBuffer.MatricesWeightsExtraKind
  92049. * @returns an array of strings
  92050. */
  92051. getVerticesDataKinds(): string[];
  92052. /**
  92053. * Returns a positive integer : the total number of indices in this mesh geometry.
  92054. * @returns the numner of indices or zero if the mesh has no geometry.
  92055. */
  92056. getTotalIndices(): number;
  92057. /**
  92058. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  92059. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  92060. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  92061. * @returns the indices array or an empty array if the mesh has no geometry
  92062. */
  92063. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  92064. readonly isBlocked: boolean;
  92065. /**
  92066. * Determine if the current mesh is ready to be rendered
  92067. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  92068. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  92069. * @returns true if all associated assets are ready (material, textures, shaders)
  92070. */
  92071. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  92072. /**
  92073. * Gets a boolean indicating if the normals aren't to be recomputed on next mesh `positions` array update. This property is pertinent only for updatable parametric shapes.
  92074. */
  92075. readonly areNormalsFrozen: boolean;
  92076. /**
  92077. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It prevents the mesh normals from being recomputed on next `positions` array update.
  92078. * @returns the current mesh
  92079. */
  92080. freezeNormals(): Mesh;
  92081. /**
  92082. * This function affects parametric shapes on vertex position update only : ribbons, tubes, etc. It has no effect at all on other shapes. It reactivates the mesh normals computation if it was previously frozen
  92083. * @returns the current mesh
  92084. */
  92085. unfreezeNormals(): Mesh;
  92086. /**
  92087. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  92088. */
  92089. overridenInstanceCount: number;
  92090. /** @hidden */
  92091. _preActivate(): Mesh;
  92092. /** @hidden */
  92093. _preActivateForIntermediateRendering(renderId: number): Mesh;
  92094. /** @hidden */
  92095. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  92096. /**
  92097. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  92098. * This means the mesh underlying bounding box and sphere are recomputed.
  92099. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  92100. * @returns the current mesh
  92101. */
  92102. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  92103. /** @hidden */
  92104. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  92105. /**
  92106. * This function will subdivide the mesh into multiple submeshes
  92107. * @param count defines the expected number of submeshes
  92108. */
  92109. subdivide(count: number): void;
  92110. /**
  92111. * Copy a FloatArray into a specific associated vertex buffer
  92112. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  92113. * - VertexBuffer.PositionKind
  92114. * - VertexBuffer.UVKind
  92115. * - VertexBuffer.UV2Kind
  92116. * - VertexBuffer.UV3Kind
  92117. * - VertexBuffer.UV4Kind
  92118. * - VertexBuffer.UV5Kind
  92119. * - VertexBuffer.UV6Kind
  92120. * - VertexBuffer.ColorKind
  92121. * - VertexBuffer.MatricesIndicesKind
  92122. * - VertexBuffer.MatricesIndicesExtraKind
  92123. * - VertexBuffer.MatricesWeightsKind
  92124. * - VertexBuffer.MatricesWeightsExtraKind
  92125. * @param data defines the data source
  92126. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  92127. * @param stride defines the data stride size (can be null)
  92128. * @returns the current mesh
  92129. */
  92130. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  92131. /**
  92132. * Delete a vertex buffer associated with this mesh
  92133. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  92134. * - VertexBuffer.PositionKind
  92135. * - VertexBuffer.UVKind
  92136. * - VertexBuffer.UV2Kind
  92137. * - VertexBuffer.UV3Kind
  92138. * - VertexBuffer.UV4Kind
  92139. * - VertexBuffer.UV5Kind
  92140. * - VertexBuffer.UV6Kind
  92141. * - VertexBuffer.ColorKind
  92142. * - VertexBuffer.MatricesIndicesKind
  92143. * - VertexBuffer.MatricesIndicesExtraKind
  92144. * - VertexBuffer.MatricesWeightsKind
  92145. * - VertexBuffer.MatricesWeightsExtraKind
  92146. */
  92147. removeVerticesData(kind: string): void;
  92148. /**
  92149. * Flags an associated vertex buffer as updatable
  92150. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  92151. * - VertexBuffer.PositionKind
  92152. * - VertexBuffer.UVKind
  92153. * - VertexBuffer.UV2Kind
  92154. * - VertexBuffer.UV3Kind
  92155. * - VertexBuffer.UV4Kind
  92156. * - VertexBuffer.UV5Kind
  92157. * - VertexBuffer.UV6Kind
  92158. * - VertexBuffer.ColorKind
  92159. * - VertexBuffer.MatricesIndicesKind
  92160. * - VertexBuffer.MatricesIndicesExtraKind
  92161. * - VertexBuffer.MatricesWeightsKind
  92162. * - VertexBuffer.MatricesWeightsExtraKind
  92163. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  92164. */
  92165. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  92166. /**
  92167. * Sets the mesh global Vertex Buffer
  92168. * @param buffer defines the buffer to use
  92169. * @returns the current mesh
  92170. */
  92171. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  92172. /**
  92173. * Update a specific associated vertex buffer
  92174. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  92175. * - VertexBuffer.PositionKind
  92176. * - VertexBuffer.UVKind
  92177. * - VertexBuffer.UV2Kind
  92178. * - VertexBuffer.UV3Kind
  92179. * - VertexBuffer.UV4Kind
  92180. * - VertexBuffer.UV5Kind
  92181. * - VertexBuffer.UV6Kind
  92182. * - VertexBuffer.ColorKind
  92183. * - VertexBuffer.MatricesIndicesKind
  92184. * - VertexBuffer.MatricesIndicesExtraKind
  92185. * - VertexBuffer.MatricesWeightsKind
  92186. * - VertexBuffer.MatricesWeightsExtraKind
  92187. * @param data defines the data source
  92188. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  92189. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  92190. * @returns the current mesh
  92191. */
  92192. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  92193. /**
  92194. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  92195. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  92196. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  92197. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  92198. * @returns the current mesh
  92199. */
  92200. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  92201. /**
  92202. * Creates a un-shared specific occurence of the geometry for the mesh.
  92203. * @returns the current mesh
  92204. */
  92205. makeGeometryUnique(): Mesh;
  92206. /**
  92207. * Set the index buffer of this mesh
  92208. * @param indices defines the source data
  92209. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  92210. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  92211. * @returns the current mesh
  92212. */
  92213. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  92214. /**
  92215. * Update the current index buffer
  92216. * @param indices defines the source data
  92217. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  92218. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  92219. * @returns the current mesh
  92220. */
  92221. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  92222. /**
  92223. * Invert the geometry to move from a right handed system to a left handed one.
  92224. * @returns the current mesh
  92225. */
  92226. toLeftHanded(): Mesh;
  92227. /** @hidden */
  92228. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  92229. /** @hidden */
  92230. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  92231. /**
  92232. * Registers for this mesh a javascript function called just before the rendering process
  92233. * @param func defines the function to call before rendering this mesh
  92234. * @returns the current mesh
  92235. */
  92236. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  92237. /**
  92238. * Disposes a previously registered javascript function called before the rendering
  92239. * @param func defines the function to remove
  92240. * @returns the current mesh
  92241. */
  92242. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  92243. /**
  92244. * Registers for this mesh a javascript function called just after the rendering is complete
  92245. * @param func defines the function to call after rendering this mesh
  92246. * @returns the current mesh
  92247. */
  92248. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  92249. /**
  92250. * Disposes a previously registered javascript function called after the rendering.
  92251. * @param func defines the function to remove
  92252. * @returns the current mesh
  92253. */
  92254. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  92255. /** @hidden */
  92256. _getInstancesRenderList(subMeshId: number): _InstancesBatch;
  92257. /** @hidden */
  92258. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  92259. /** @hidden */
  92260. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  92261. /** @hidden */
  92262. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  92263. /** @hidden */
  92264. _rebuild(): void;
  92265. /** @hidden */
  92266. _freeze(): void;
  92267. /** @hidden */
  92268. _unFreeze(): void;
  92269. /**
  92270. * Triggers the draw call for the mesh. Usually, you don't need to call this method by your own because the mesh rendering is handled by the scene rendering manager
  92271. * @param subMesh defines the subMesh to render
  92272. * @param enableAlphaMode defines if alpha mode can be changed
  92273. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  92274. * @returns the current mesh
  92275. */
  92276. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  92277. private _onBeforeDraw;
  92278. /**
  92279. * Renormalize the mesh and patch it up if there are no weights
  92280. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  92281. * However in the case of zero weights then we set just a single influence to 1.
  92282. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  92283. */
  92284. cleanMatrixWeights(): void;
  92285. private normalizeSkinFourWeights;
  92286. private normalizeSkinWeightsAndExtra;
  92287. /**
  92288. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  92289. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  92290. * the user know there was an issue with importing the mesh
  92291. * @returns a validation object with skinned, valid and report string
  92292. */
  92293. validateSkinning(): {
  92294. skinned: boolean;
  92295. valid: boolean;
  92296. report: string;
  92297. };
  92298. /** @hidden */
  92299. _checkDelayState(): Mesh;
  92300. private _queueLoad;
  92301. /**
  92302. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  92303. * A mesh is in the frustum if its bounding box intersects the frustum
  92304. * @param frustumPlanes defines the frustum to test
  92305. * @returns true if the mesh is in the frustum planes
  92306. */
  92307. isInFrustum(frustumPlanes: Plane[]): boolean;
  92308. /**
  92309. * Sets the mesh material by the material or multiMaterial `id` property
  92310. * @param id is a string identifying the material or the multiMaterial
  92311. * @returns the current mesh
  92312. */
  92313. setMaterialByID(id: string): Mesh;
  92314. /**
  92315. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  92316. * @returns an array of IAnimatable
  92317. */
  92318. getAnimatables(): IAnimatable[];
  92319. /**
  92320. * Modifies the mesh geometry according to the passed transformation matrix.
  92321. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  92322. * The mesh normals are modified using the same transformation.
  92323. * Note that, under the hood, this method sets a new VertexBuffer each call.
  92324. * @param transform defines the transform matrix to use
  92325. * @see http://doc.babylonjs.com/resources/baking_transformations
  92326. * @returns the current mesh
  92327. */
  92328. bakeTransformIntoVertices(transform: Matrix): Mesh;
  92329. /**
  92330. * Modifies the mesh geometry according to its own current World Matrix.
  92331. * The mesh World Matrix is then reset.
  92332. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  92333. * Note that, under the hood, this method sets a new VertexBuffer each call.
  92334. * @see http://doc.babylonjs.com/resources/baking_transformations
  92335. * @returns the current mesh
  92336. */
  92337. bakeCurrentTransformIntoVertices(): Mesh;
  92338. /** @hidden */
  92339. readonly _positions: Nullable<Vector3[]>;
  92340. /** @hidden */
  92341. _resetPointsArrayCache(): Mesh;
  92342. /** @hidden */
  92343. _generatePointsArray(): boolean;
  92344. /**
  92345. * Returns a new Mesh object generated from the current mesh properties.
  92346. * This method must not get confused with createInstance()
  92347. * @param name is a string, the name given to the new mesh
  92348. * @param newParent can be any Node object (default `null`)
  92349. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  92350. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  92351. * @returns a new mesh
  92352. */
  92353. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  92354. /**
  92355. * Releases resources associated with this mesh.
  92356. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  92357. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  92358. */
  92359. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  92360. /** @hidden */
  92361. _disposeInstanceSpecificData(): void;
  92362. /**
  92363. * Modifies the mesh geometry according to a displacement map.
  92364. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  92365. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  92366. * @param url is a string, the URL from the image file is to be downloaded.
  92367. * @param minHeight is the lower limit of the displacement.
  92368. * @param maxHeight is the upper limit of the displacement.
  92369. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  92370. * @param uvOffset is an optional vector2 used to offset UV.
  92371. * @param uvScale is an optional vector2 used to scale UV.
  92372. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  92373. * @returns the Mesh.
  92374. */
  92375. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  92376. /**
  92377. * Modifies the mesh geometry according to a displacementMap buffer.
  92378. * A displacement map is a colored image. Each pixel color value (actually a gradient computed from red, green, blue values) will give the displacement to apply to each mesh vertex.
  92379. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  92380. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  92381. * @param heightMapWidth is the width of the buffer image.
  92382. * @param heightMapHeight is the height of the buffer image.
  92383. * @param minHeight is the lower limit of the displacement.
  92384. * @param maxHeight is the upper limit of the displacement.
  92385. * @param onSuccess is an optional Javascript function to be called just after the mesh is modified. It is passed the modified mesh and must return nothing.
  92386. * @param uvOffset is an optional vector2 used to offset UV.
  92387. * @param uvScale is an optional vector2 used to scale UV.
  92388. * @param forceUpdate defines whether or not to force an update of the generated buffers. This is useful to apply on a deserialized model for instance.
  92389. * @returns the Mesh.
  92390. */
  92391. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  92392. /**
  92393. * Modify the mesh to get a flat shading rendering.
  92394. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  92395. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  92396. * @returns current mesh
  92397. */
  92398. convertToFlatShadedMesh(): Mesh;
  92399. /**
  92400. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  92401. * In other words, more vertices, no more indices and a single bigger VBO.
  92402. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  92403. * @returns current mesh
  92404. */
  92405. convertToUnIndexedMesh(): Mesh;
  92406. /**
  92407. * Inverses facet orientations.
  92408. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92409. * @param flipNormals will also inverts the normals
  92410. * @returns current mesh
  92411. */
  92412. flipFaces(flipNormals?: boolean): Mesh;
  92413. /**
  92414. * Increase the number of facets and hence vertices in a mesh
  92415. * Vertex normals are interpolated from existing vertex normals
  92416. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92417. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  92418. */
  92419. increaseVertices(numberPerEdge: number): void;
  92420. /**
  92421. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  92422. * This will undo any application of covertToFlatShadedMesh
  92423. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92424. */
  92425. forceSharedVertices(): void;
  92426. /** @hidden */
  92427. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  92428. /** @hidden */
  92429. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  92430. /**
  92431. * Creates a new InstancedMesh object from the mesh model.
  92432. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  92433. * @param name defines the name of the new instance
  92434. * @returns a new InstancedMesh
  92435. */
  92436. createInstance(name: string): InstancedMesh;
  92437. /**
  92438. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  92439. * After this call, all the mesh instances have the same submeshes than the current mesh.
  92440. * @returns the current mesh
  92441. */
  92442. synchronizeInstances(): Mesh;
  92443. /**
  92444. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  92445. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  92446. * This should be used together with the simplification to avoid disappearing triangles.
  92447. * @param successCallback an optional success callback to be called after the optimization finished.
  92448. * @returns the current mesh
  92449. */
  92450. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  92451. /**
  92452. * Serialize current mesh
  92453. * @param serializationObject defines the object which will receive the serialization data
  92454. */
  92455. serialize(serializationObject: any): void;
  92456. /** @hidden */
  92457. _syncGeometryWithMorphTargetManager(): void;
  92458. /** @hidden */
  92459. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  92460. /**
  92461. * Returns a new Mesh object parsed from the source provided.
  92462. * @param parsedMesh is the source
  92463. * @param scene defines the hosting scene
  92464. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  92465. * @returns a new Mesh
  92466. */
  92467. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  92468. /**
  92469. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  92470. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92471. * @param name defines the name of the mesh to create
  92472. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  92473. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  92474. * @param closePath creates a seam between the first and the last points of each path of the path array
  92475. * @param offset is taken in account only if the `pathArray` is containing a single path
  92476. * @param scene defines the hosting scene
  92477. * @param updatable defines if the mesh must be flagged as updatable
  92478. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92479. * @param instance defines an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#ribbon)
  92480. * @returns a new Mesh
  92481. */
  92482. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92483. /**
  92484. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  92485. * @param name defines the name of the mesh to create
  92486. * @param radius sets the radius size (float) of the polygon (default 0.5)
  92487. * @param tessellation sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  92488. * @param scene defines the hosting scene
  92489. * @param updatable defines if the mesh must be flagged as updatable
  92490. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92491. * @returns a new Mesh
  92492. */
  92493. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  92494. /**
  92495. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  92496. * @param name defines the name of the mesh to create
  92497. * @param size sets the size (float) of each box side (default 1)
  92498. * @param scene defines the hosting scene
  92499. * @param updatable defines if the mesh must be flagged as updatable
  92500. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92501. * @returns a new Mesh
  92502. */
  92503. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  92504. /**
  92505. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  92506. * @param name defines the name of the mesh to create
  92507. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  92508. * @param diameter sets the diameter size (float) of the sphere (default 1)
  92509. * @param scene defines the hosting scene
  92510. * @param updatable defines if the mesh must be flagged as updatable
  92511. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92512. * @returns a new Mesh
  92513. */
  92514. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92515. /**
  92516. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  92517. * @param name defines the name of the mesh to create
  92518. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  92519. * @param diameter sets the diameter size (float) of the sphere (default 1)
  92520. * @param scene defines the hosting scene
  92521. * @returns a new Mesh
  92522. */
  92523. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  92524. /**
  92525. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  92526. * @param name defines the name of the mesh to create
  92527. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  92528. * @param diameterTop set the top cap diameter (floats, default 1)
  92529. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  92530. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  92531. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  92532. * @param scene defines the hosting scene
  92533. * @param updatable defines if the mesh must be flagged as updatable
  92534. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92535. * @returns a new Mesh
  92536. */
  92537. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  92538. /**
  92539. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  92540. * @param name defines the name of the mesh to create
  92541. * @param diameter sets the diameter size (float) of the torus (default 1)
  92542. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  92543. * @param tessellation sets the number of torus sides (postive integer, default 16)
  92544. * @param scene defines the hosting scene
  92545. * @param updatable defines if the mesh must be flagged as updatable
  92546. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92547. * @returns a new Mesh
  92548. */
  92549. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92550. /**
  92551. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  92552. * @param name defines the name of the mesh to create
  92553. * @param radius sets the global radius size (float) of the torus knot (default 2)
  92554. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  92555. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  92556. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  92557. * @param p the number of windings on X axis (positive integers, default 2)
  92558. * @param q the number of windings on Y axis (positive integers, default 3)
  92559. * @param scene defines the hosting scene
  92560. * @param updatable defines if the mesh must be flagged as updatable
  92561. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92562. * @returns a new Mesh
  92563. */
  92564. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92565. /**
  92566. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  92567. * @param name defines the name of the mesh to create
  92568. * @param points is an array successive Vector3
  92569. * @param scene defines the hosting scene
  92570. * @param updatable defines if the mesh must be flagged as updatable
  92571. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines).
  92572. * @returns a new Mesh
  92573. */
  92574. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  92575. /**
  92576. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  92577. * @param name defines the name of the mesh to create
  92578. * @param points is an array successive Vector3
  92579. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  92580. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  92581. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  92582. * @param scene defines the hosting scene
  92583. * @param updatable defines if the mesh must be flagged as updatable
  92584. * @param instance is an instance of an existing LineMesh object to be updated with the passed `points` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#lines-and-dashedlines)
  92585. * @returns a new Mesh
  92586. */
  92587. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  92588. /**
  92589. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  92590. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  92591. * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors.
  92592. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  92593. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  92594. * Remember you can only change the shape positions, not their number when updating a polygon.
  92595. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  92596. * @param name defines the name of the mesh to create
  92597. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  92598. * @param scene defines the hosting scene
  92599. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  92600. * @param updatable defines if the mesh must be flagged as updatable
  92601. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92602. * @param earcutInjection can be used to inject your own earcut reference
  92603. * @returns a new Mesh
  92604. */
  92605. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  92606. /**
  92607. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  92608. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  92609. * @param name defines the name of the mesh to create
  92610. * @param shape is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  92611. * @param depth defines the height of extrusion
  92612. * @param scene defines the hosting scene
  92613. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  92614. * @param updatable defines if the mesh must be flagged as updatable
  92615. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92616. * @param earcutInjection can be used to inject your own earcut reference
  92617. * @returns a new Mesh
  92618. */
  92619. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  92620. /**
  92621. * Creates an extruded shape mesh.
  92622. * The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters. Please consider using the same method from the MeshBuilder class instead
  92623. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92624. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  92625. * @param name defines the name of the mesh to create
  92626. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  92627. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  92628. * @param scale is the value to scale the shape
  92629. * @param rotation is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve
  92630. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  92631. * @param scene defines the hosting scene
  92632. * @param updatable defines if the mesh must be flagged as updatable
  92633. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92634. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#extruded-shape)
  92635. * @returns a new Mesh
  92636. */
  92637. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92638. /**
  92639. * Creates an custom extruded shape mesh.
  92640. * The custom extrusion is a parametric shape.
  92641. * It has no predefined shape. Its final shape will depend on the input parameters.
  92642. * Please consider using the same method from the MeshBuilder class instead
  92643. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  92644. * @param name defines the name of the mesh to create
  92645. * @param shape is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis
  92646. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  92647. * @param scaleFunction is a custom Javascript function called on each path point
  92648. * @param rotationFunction is a custom Javascript function called on each path point
  92649. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  92650. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  92651. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  92652. * @param scene defines the hosting scene
  92653. * @param updatable defines if the mesh must be flagged as updatable
  92654. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92655. * @param instance is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters (http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape)
  92656. * @returns a new Mesh
  92657. */
  92658. static ExtrudeShapeCustom(name: string, shape: Vector3[], path: Vector3[], scaleFunction: Function, rotationFunction: Function, ribbonCloseArray: boolean, ribbonClosePath: boolean, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92659. /**
  92660. * Creates lathe mesh.
  92661. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  92662. * Please consider using the same method from the MeshBuilder class instead
  92663. * @param name defines the name of the mesh to create
  92664. * @param shape is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  92665. * @param radius is the radius value of the lathe
  92666. * @param tessellation is the side number of the lathe.
  92667. * @param scene defines the hosting scene
  92668. * @param updatable defines if the mesh must be flagged as updatable
  92669. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92670. * @returns a new Mesh
  92671. */
  92672. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92673. /**
  92674. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  92675. * @param name defines the name of the mesh to create
  92676. * @param size sets the size (float) of both sides of the plane at once (default 1)
  92677. * @param scene defines the hosting scene
  92678. * @param updatable defines if the mesh must be flagged as updatable
  92679. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92680. * @returns a new Mesh
  92681. */
  92682. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92683. /**
  92684. * Creates a ground mesh.
  92685. * Please consider using the same method from the MeshBuilder class instead
  92686. * @param name defines the name of the mesh to create
  92687. * @param width set the width of the ground
  92688. * @param height set the height of the ground
  92689. * @param subdivisions sets the number of subdivisions per side
  92690. * @param scene defines the hosting scene
  92691. * @param updatable defines if the mesh must be flagged as updatable
  92692. * @returns a new Mesh
  92693. */
  92694. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  92695. /**
  92696. * Creates a tiled ground mesh.
  92697. * Please consider using the same method from the MeshBuilder class instead
  92698. * @param name defines the name of the mesh to create
  92699. * @param xmin set the ground minimum X coordinate
  92700. * @param zmin set the ground minimum Y coordinate
  92701. * @param xmax set the ground maximum X coordinate
  92702. * @param zmax set the ground maximum Z coordinate
  92703. * @param subdivisions is an object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  92704. * @param precision is an object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  92705. * @param scene defines the hosting scene
  92706. * @param updatable defines if the mesh must be flagged as updatable
  92707. * @returns a new Mesh
  92708. */
  92709. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  92710. w: number;
  92711. h: number;
  92712. }, precision: {
  92713. w: number;
  92714. h: number;
  92715. }, scene: Scene, updatable?: boolean): Mesh;
  92716. /**
  92717. * Creates a ground mesh from a height map.
  92718. * Please consider using the same method from the MeshBuilder class instead
  92719. * @see http://doc.babylonjs.com/babylon101/height_map
  92720. * @param name defines the name of the mesh to create
  92721. * @param url sets the URL of the height map image resource
  92722. * @param width set the ground width size
  92723. * @param height set the ground height size
  92724. * @param subdivisions sets the number of subdivision per side
  92725. * @param minHeight is the minimum altitude on the ground
  92726. * @param maxHeight is the maximum altitude on the ground
  92727. * @param scene defines the hosting scene
  92728. * @param updatable defines if the mesh must be flagged as updatable
  92729. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  92730. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  92731. * @returns a new Mesh
  92732. */
  92733. static CreateGroundFromHeightMap(name: string, url: string, width: number, height: number, subdivisions: number, minHeight: number, maxHeight: number, scene: Scene, updatable?: boolean, onReady?: (mesh: GroundMesh) => void, alphaFilter?: number): GroundMesh;
  92734. /**
  92735. * Creates a tube mesh.
  92736. * The tube is a parametric shape.
  92737. * It has no predefined shape. Its final shape will depend on the input parameters.
  92738. * Please consider using the same method from the MeshBuilder class instead
  92739. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92740. * @param name defines the name of the mesh to create
  92741. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  92742. * @param radius sets the tube radius size
  92743. * @param tessellation is the number of sides on the tubular surface
  92744. * @param radiusFunction is a custom function. If it is not null, it overwrittes the parameter `radius`. This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path
  92745. * @param cap sets the way the extruded shape is capped. Possible values : Mesh.NO_CAP (default), Mesh.CAP_START, Mesh.CAP_END, Mesh.CAP_ALL
  92746. * @param scene defines the hosting scene
  92747. * @param updatable defines if the mesh must be flagged as updatable
  92748. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92749. * @param instance is an instance of an existing Tube object to be updated with the passed `pathArray` parameter (http://doc.babylonjs.com/how_to/How_to_dynamically_morph_a_mesh#tube)
  92750. * @returns a new Mesh
  92751. */
  92752. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  92753. (i: number, distance: number): number;
  92754. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92755. /**
  92756. * Creates a polyhedron mesh.
  92757. * Please consider using the same method from the MeshBuilder class instead.
  92758. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  92759. * * The parameter `size` (positive float, default 1) sets the polygon size
  92760. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  92761. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  92762. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  92763. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  92764. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  92765. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  92766. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  92767. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  92768. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  92769. * @param name defines the name of the mesh to create
  92770. * @param options defines the options used to create the mesh
  92771. * @param scene defines the hosting scene
  92772. * @returns a new Mesh
  92773. */
  92774. static CreatePolyhedron(name: string, options: {
  92775. type?: number;
  92776. size?: number;
  92777. sizeX?: number;
  92778. sizeY?: number;
  92779. sizeZ?: number;
  92780. custom?: any;
  92781. faceUV?: Vector4[];
  92782. faceColors?: Color4[];
  92783. updatable?: boolean;
  92784. sideOrientation?: number;
  92785. }, scene: Scene): Mesh;
  92786. /**
  92787. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  92788. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  92789. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value than `radius`)
  92790. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  92791. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  92792. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  92793. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  92794. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  92795. * @param name defines the name of the mesh
  92796. * @param options defines the options used to create the mesh
  92797. * @param scene defines the hosting scene
  92798. * @returns a new Mesh
  92799. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  92800. */
  92801. static CreateIcoSphere(name: string, options: {
  92802. radius?: number;
  92803. flat?: boolean;
  92804. subdivisions?: number;
  92805. sideOrientation?: number;
  92806. updatable?: boolean;
  92807. }, scene: Scene): Mesh;
  92808. /**
  92809. * Creates a decal mesh.
  92810. * Please consider using the same method from the MeshBuilder class instead.
  92811. * A decal is a mesh usually applied as a model onto the surface of another mesh
  92812. * @param name defines the name of the mesh
  92813. * @param sourceMesh defines the mesh receiving the decal
  92814. * @param position sets the position of the decal in world coordinates
  92815. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  92816. * @param size sets the decal scaling
  92817. * @param angle sets the angle to rotate the decal
  92818. * @returns a new Mesh
  92819. */
  92820. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  92821. /**
  92822. * Prepare internal position array for software CPU skinning
  92823. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  92824. */
  92825. setPositionsForCPUSkinning(): Float32Array;
  92826. /**
  92827. * Prepare internal normal array for software CPU skinning
  92828. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  92829. */
  92830. setNormalsForCPUSkinning(): Float32Array;
  92831. /**
  92832. * Updates the vertex buffer by applying transformation from the bones
  92833. * @param skeleton defines the skeleton to apply to current mesh
  92834. * @returns the current mesh
  92835. */
  92836. applySkeleton(skeleton: Skeleton): Mesh;
  92837. /**
  92838. * Returns an object containing a min and max Vector3 which are the minimum and maximum vectors of each mesh bounding box from the passed array, in the world coordinates
  92839. * @param meshes defines the list of meshes to scan
  92840. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  92841. */
  92842. static MinMax(meshes: AbstractMesh[]): {
  92843. min: Vector3;
  92844. max: Vector3;
  92845. };
  92846. /**
  92847. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  92848. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  92849. * @returns a vector3
  92850. */
  92851. static Center(meshesOrMinMaxVector: {
  92852. min: Vector3;
  92853. max: Vector3;
  92854. } | AbstractMesh[]): Vector3;
  92855. /**
  92856. * Merge the array of meshes into a single mesh for performance reasons.
  92857. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  92858. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  92859. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  92860. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  92861. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  92862. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  92863. * @returns a new mesh
  92864. */
  92865. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  92866. /** @hidden */
  92867. addInstance(instance: InstancedMesh): void;
  92868. /** @hidden */
  92869. removeInstance(instance: InstancedMesh): void;
  92870. }
  92871. }
  92872. declare module BABYLON {
  92873. /**
  92874. * This is the base class of all the camera used in the application.
  92875. * @see http://doc.babylonjs.com/features/cameras
  92876. */
  92877. export class Camera extends Node {
  92878. /** @hidden */
  92879. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  92880. /**
  92881. * This is the default projection mode used by the cameras.
  92882. * It helps recreating a feeling of perspective and better appreciate depth.
  92883. * This is the best way to simulate real life cameras.
  92884. */
  92885. static readonly PERSPECTIVE_CAMERA: number;
  92886. /**
  92887. * This helps creating camera with an orthographic mode.
  92888. * Orthographic is commonly used in engineering as a means to produce object specifications that communicate dimensions unambiguously, each line of 1 unit length (cm, meter..whatever) will appear to have the same length everywhere on the drawing. This allows the drafter to dimension only a subset of lines and let the reader know that other lines of that length on the drawing are also that length in reality. Every parallel line in the drawing is also parallel in the object.
  92889. */
  92890. static readonly ORTHOGRAPHIC_CAMERA: number;
  92891. /**
  92892. * This is the default FOV mode for perspective cameras.
  92893. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  92894. */
  92895. static readonly FOVMODE_VERTICAL_FIXED: number;
  92896. /**
  92897. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  92898. */
  92899. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  92900. /**
  92901. * This specifies ther is no need for a camera rig.
  92902. * Basically only one eye is rendered corresponding to the camera.
  92903. */
  92904. static readonly RIG_MODE_NONE: number;
  92905. /**
  92906. * Simulates a camera Rig with one blue eye and one red eye.
  92907. * This can be use with 3d blue and red glasses.
  92908. */
  92909. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  92910. /**
  92911. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  92912. */
  92913. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  92914. /**
  92915. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  92916. */
  92917. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  92918. /**
  92919. * Defines that both eyes of the camera will be rendered over under each other.
  92920. */
  92921. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  92922. /**
  92923. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  92924. */
  92925. static readonly RIG_MODE_VR: number;
  92926. /**
  92927. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  92928. */
  92929. static readonly RIG_MODE_WEBVR: number;
  92930. /**
  92931. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  92932. */
  92933. static readonly RIG_MODE_CUSTOM: number;
  92934. /**
  92935. * Defines if by default attaching controls should prevent the default javascript event to continue.
  92936. */
  92937. static ForceAttachControlToAlwaysPreventDefault: boolean;
  92938. /**
  92939. * Define the input manager associated with the camera.
  92940. */
  92941. inputs: CameraInputsManager<Camera>;
  92942. /** @hidden */
  92943. _position: Vector3;
  92944. /**
  92945. * Define the current local position of the camera in the scene
  92946. */
  92947. position: Vector3;
  92948. /**
  92949. * The vector the camera should consider as up.
  92950. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  92951. */
  92952. upVector: Vector3;
  92953. /**
  92954. * Define the current limit on the left side for an orthographic camera
  92955. * In scene unit
  92956. */
  92957. orthoLeft: Nullable<number>;
  92958. /**
  92959. * Define the current limit on the right side for an orthographic camera
  92960. * In scene unit
  92961. */
  92962. orthoRight: Nullable<number>;
  92963. /**
  92964. * Define the current limit on the bottom side for an orthographic camera
  92965. * In scene unit
  92966. */
  92967. orthoBottom: Nullable<number>;
  92968. /**
  92969. * Define the current limit on the top side for an orthographic camera
  92970. * In scene unit
  92971. */
  92972. orthoTop: Nullable<number>;
  92973. /**
  92974. * Field Of View is set in Radians. (default is 0.8)
  92975. */
  92976. fov: number;
  92977. /**
  92978. * Define the minimum distance the camera can see from.
  92979. * This is important to note that the depth buffer are not infinite and the closer it starts
  92980. * the more your scene might encounter depth fighting issue.
  92981. */
  92982. minZ: number;
  92983. /**
  92984. * Define the maximum distance the camera can see to.
  92985. * This is important to note that the depth buffer are not infinite and the further it end
  92986. * the more your scene might encounter depth fighting issue.
  92987. */
  92988. maxZ: number;
  92989. /**
  92990. * Define the default inertia of the camera.
  92991. * This helps giving a smooth feeling to the camera movement.
  92992. */
  92993. inertia: number;
  92994. /**
  92995. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  92996. */
  92997. mode: number;
  92998. /**
  92999. * Define wether the camera is intermediate.
  93000. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  93001. */
  93002. isIntermediate: boolean;
  93003. /**
  93004. * Define the viewport of the camera.
  93005. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  93006. */
  93007. viewport: Viewport;
  93008. /**
  93009. * Restricts the camera to viewing objects with the same layerMask.
  93010. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  93011. */
  93012. layerMask: number;
  93013. /**
  93014. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  93015. */
  93016. fovMode: number;
  93017. /**
  93018. * Rig mode of the camera.
  93019. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  93020. * This is normally controlled byt the camera themselves as internal use.
  93021. */
  93022. cameraRigMode: number;
  93023. /**
  93024. * Defines the distance between both "eyes" in case of a RIG
  93025. */
  93026. interaxialDistance: number;
  93027. /**
  93028. * Defines if stereoscopic rendering is done side by side or over under.
  93029. */
  93030. isStereoscopicSideBySide: boolean;
  93031. /**
  93032. * Defines the list of custom render target which are rendered to and then used as the input to this camera's render. Eg. display another camera view on a TV in the main scene
  93033. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  93034. * else in the scene. (Eg. security camera)
  93035. *
  93036. * To change the final output target of the camera, camera.outputRenderTarget should be used instead (eg. webXR renders to a render target corrisponding to an HMD)
  93037. */
  93038. customRenderTargets: RenderTargetTexture[];
  93039. /**
  93040. * When set, the camera will render to this render target instead of the default canvas
  93041. *
  93042. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  93043. */
  93044. outputRenderTarget: Nullable<RenderTargetTexture>;
  93045. /**
  93046. * Observable triggered when the camera view matrix has changed.
  93047. */
  93048. onViewMatrixChangedObservable: Observable<Camera>;
  93049. /**
  93050. * Observable triggered when the camera Projection matrix has changed.
  93051. */
  93052. onProjectionMatrixChangedObservable: Observable<Camera>;
  93053. /**
  93054. * Observable triggered when the inputs have been processed.
  93055. */
  93056. onAfterCheckInputsObservable: Observable<Camera>;
  93057. /**
  93058. * Observable triggered when reset has been called and applied to the camera.
  93059. */
  93060. onRestoreStateObservable: Observable<Camera>;
  93061. /** @hidden */
  93062. _cameraRigParams: any;
  93063. /** @hidden */
  93064. _rigCameras: Camera[];
  93065. /** @hidden */
  93066. _rigPostProcess: Nullable<PostProcess>;
  93067. protected _webvrViewMatrix: Matrix;
  93068. /** @hidden */
  93069. _skipRendering: boolean;
  93070. /** @hidden */
  93071. _projectionMatrix: Matrix;
  93072. /** @hidden */
  93073. _postProcesses: Nullable<PostProcess>[];
  93074. /** @hidden */
  93075. _activeMeshes: SmartArray<AbstractMesh>;
  93076. protected _globalPosition: Vector3;
  93077. /** @hidden */
  93078. _computedViewMatrix: Matrix;
  93079. private _doNotComputeProjectionMatrix;
  93080. private _transformMatrix;
  93081. private _frustumPlanes;
  93082. private _refreshFrustumPlanes;
  93083. private _storedFov;
  93084. private _stateStored;
  93085. /**
  93086. * Instantiates a new camera object.
  93087. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  93088. * @see http://doc.babylonjs.com/features/cameras
  93089. * @param name Defines the name of the camera in the scene
  93090. * @param position Defines the position of the camera
  93091. * @param scene Defines the scene the camera belongs too
  93092. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  93093. */
  93094. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  93095. /**
  93096. * Store current camera state (fov, position, etc..)
  93097. * @returns the camera
  93098. */
  93099. storeState(): Camera;
  93100. /**
  93101. * Restores the camera state values if it has been stored. You must call storeState() first
  93102. */
  93103. protected _restoreStateValues(): boolean;
  93104. /**
  93105. * Restored camera state. You must call storeState() first.
  93106. * @returns true if restored and false otherwise
  93107. */
  93108. restoreState(): boolean;
  93109. /**
  93110. * Gets the class name of the camera.
  93111. * @returns the class name
  93112. */
  93113. getClassName(): string;
  93114. /** @hidden */
  93115. readonly _isCamera: boolean;
  93116. /**
  93117. * Gets a string representation of the camera useful for debug purpose.
  93118. * @param fullDetails Defines that a more verboe level of logging is required
  93119. * @returns the string representation
  93120. */
  93121. toString(fullDetails?: boolean): string;
  93122. /**
  93123. * Gets the current world space position of the camera.
  93124. */
  93125. readonly globalPosition: Vector3;
  93126. /**
  93127. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  93128. * @returns the active meshe list
  93129. */
  93130. getActiveMeshes(): SmartArray<AbstractMesh>;
  93131. /**
  93132. * Check wether a mesh is part of the current active mesh list of the camera
  93133. * @param mesh Defines the mesh to check
  93134. * @returns true if active, false otherwise
  93135. */
  93136. isActiveMesh(mesh: Mesh): boolean;
  93137. /**
  93138. * Is this camera ready to be used/rendered
  93139. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  93140. * @return true if the camera is ready
  93141. */
  93142. isReady(completeCheck?: boolean): boolean;
  93143. /** @hidden */
  93144. _initCache(): void;
  93145. /** @hidden */
  93146. _updateCache(ignoreParentClass?: boolean): void;
  93147. /** @hidden */
  93148. _isSynchronized(): boolean;
  93149. /** @hidden */
  93150. _isSynchronizedViewMatrix(): boolean;
  93151. /** @hidden */
  93152. _isSynchronizedProjectionMatrix(): boolean;
  93153. /**
  93154. * Attach the input controls to a specific dom element to get the input from.
  93155. * @param element Defines the element the controls should be listened from
  93156. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  93157. */
  93158. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  93159. /**
  93160. * Detach the current controls from the specified dom element.
  93161. * @param element Defines the element to stop listening the inputs from
  93162. */
  93163. detachControl(element: HTMLElement): void;
  93164. /**
  93165. * Update the camera state according to the different inputs gathered during the frame.
  93166. */
  93167. update(): void;
  93168. /** @hidden */
  93169. _checkInputs(): void;
  93170. /** @hidden */
  93171. readonly rigCameras: Camera[];
  93172. /**
  93173. * Gets the post process used by the rig cameras
  93174. */
  93175. readonly rigPostProcess: Nullable<PostProcess>;
  93176. /**
  93177. * Internal, gets the first post proces.
  93178. * @returns the first post process to be run on this camera.
  93179. */
  93180. _getFirstPostProcess(): Nullable<PostProcess>;
  93181. private _cascadePostProcessesToRigCams;
  93182. /**
  93183. * Attach a post process to the camera.
  93184. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  93185. * @param postProcess The post process to attach to the camera
  93186. * @param insertAt The position of the post process in case several of them are in use in the scene
  93187. * @returns the position the post process has been inserted at
  93188. */
  93189. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  93190. /**
  93191. * Detach a post process to the camera.
  93192. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  93193. * @param postProcess The post process to detach from the camera
  93194. */
  93195. detachPostProcess(postProcess: PostProcess): void;
  93196. /**
  93197. * Gets the current world matrix of the camera
  93198. */
  93199. getWorldMatrix(): Matrix;
  93200. /** @hidden */
  93201. _getViewMatrix(): Matrix;
  93202. /**
  93203. * Gets the current view matrix of the camera.
  93204. * @param force forces the camera to recompute the matrix without looking at the cached state
  93205. * @returns the view matrix
  93206. */
  93207. getViewMatrix(force?: boolean): Matrix;
  93208. /**
  93209. * Freeze the projection matrix.
  93210. * It will prevent the cache check of the camera projection compute and can speed up perf
  93211. * if no parameter of the camera are meant to change
  93212. * @param projection Defines manually a projection if necessary
  93213. */
  93214. freezeProjectionMatrix(projection?: Matrix): void;
  93215. /**
  93216. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  93217. */
  93218. unfreezeProjectionMatrix(): void;
  93219. /**
  93220. * Gets the current projection matrix of the camera.
  93221. * @param force forces the camera to recompute the matrix without looking at the cached state
  93222. * @returns the projection matrix
  93223. */
  93224. getProjectionMatrix(force?: boolean): Matrix;
  93225. /**
  93226. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  93227. * @returns a Matrix
  93228. */
  93229. getTransformationMatrix(): Matrix;
  93230. private _updateFrustumPlanes;
  93231. /**
  93232. * Checks if a cullable object (mesh...) is in the camera frustum
  93233. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  93234. * @param target The object to check
  93235. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  93236. * @returns true if the object is in frustum otherwise false
  93237. */
  93238. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  93239. /**
  93240. * Checks if a cullable object (mesh...) is in the camera frustum
  93241. * Unlike isInFrustum this cheks the full bounding box
  93242. * @param target The object to check
  93243. * @returns true if the object is in frustum otherwise false
  93244. */
  93245. isCompletelyInFrustum(target: ICullable): boolean;
  93246. /**
  93247. * Gets a ray in the forward direction from the camera.
  93248. * @param length Defines the length of the ray to create
  93249. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  93250. * @param origin Defines the start point of the ray which defaults to the camera position
  93251. * @returns the forward ray
  93252. */
  93253. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  93254. /**
  93255. * Releases resources associated with this node.
  93256. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  93257. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  93258. */
  93259. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  93260. /** @hidden */
  93261. _isLeftCamera: boolean;
  93262. /**
  93263. * Gets the left camera of a rig setup in case of Rigged Camera
  93264. */
  93265. readonly isLeftCamera: boolean;
  93266. /** @hidden */
  93267. _isRightCamera: boolean;
  93268. /**
  93269. * Gets the right camera of a rig setup in case of Rigged Camera
  93270. */
  93271. readonly isRightCamera: boolean;
  93272. /**
  93273. * Gets the left camera of a rig setup in case of Rigged Camera
  93274. */
  93275. readonly leftCamera: Nullable<FreeCamera>;
  93276. /**
  93277. * Gets the right camera of a rig setup in case of Rigged Camera
  93278. */
  93279. readonly rightCamera: Nullable<FreeCamera>;
  93280. /**
  93281. * Gets the left camera target of a rig setup in case of Rigged Camera
  93282. * @returns the target position
  93283. */
  93284. getLeftTarget(): Nullable<Vector3>;
  93285. /**
  93286. * Gets the right camera target of a rig setup in case of Rigged Camera
  93287. * @returns the target position
  93288. */
  93289. getRightTarget(): Nullable<Vector3>;
  93290. /**
  93291. * @hidden
  93292. */
  93293. setCameraRigMode(mode: number, rigParams: any): void;
  93294. /** @hidden */
  93295. static _setStereoscopicRigMode(camera: Camera): void;
  93296. /** @hidden */
  93297. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  93298. /** @hidden */
  93299. static _setVRRigMode(camera: Camera, rigParams: any): void;
  93300. /** @hidden */
  93301. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  93302. /** @hidden */
  93303. _getVRProjectionMatrix(): Matrix;
  93304. protected _updateCameraRotationMatrix(): void;
  93305. protected _updateWebVRCameraRotationMatrix(): void;
  93306. /**
  93307. * This function MUST be overwritten by the different WebVR cameras available.
  93308. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  93309. * @hidden
  93310. */
  93311. _getWebVRProjectionMatrix(): Matrix;
  93312. /**
  93313. * This function MUST be overwritten by the different WebVR cameras available.
  93314. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  93315. * @hidden
  93316. */
  93317. _getWebVRViewMatrix(): Matrix;
  93318. /** @hidden */
  93319. setCameraRigParameter(name: string, value: any): void;
  93320. /**
  93321. * needs to be overridden by children so sub has required properties to be copied
  93322. * @hidden
  93323. */
  93324. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  93325. /**
  93326. * May need to be overridden by children
  93327. * @hidden
  93328. */
  93329. _updateRigCameras(): void;
  93330. /** @hidden */
  93331. _setupInputs(): void;
  93332. /**
  93333. * Serialiaze the camera setup to a json represention
  93334. * @returns the JSON representation
  93335. */
  93336. serialize(): any;
  93337. /**
  93338. * Clones the current camera.
  93339. * @param name The cloned camera name
  93340. * @returns the cloned camera
  93341. */
  93342. clone(name: string): Camera;
  93343. /**
  93344. * Gets the direction of the camera relative to a given local axis.
  93345. * @param localAxis Defines the reference axis to provide a relative direction.
  93346. * @return the direction
  93347. */
  93348. getDirection(localAxis: Vector3): Vector3;
  93349. /**
  93350. * Returns the current camera absolute rotation
  93351. */
  93352. readonly absoluteRotation: Quaternion;
  93353. /**
  93354. * Gets the direction of the camera relative to a given local axis into a passed vector.
  93355. * @param localAxis Defines the reference axis to provide a relative direction.
  93356. * @param result Defines the vector to store the result in
  93357. */
  93358. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  93359. /**
  93360. * Gets a camera constructor for a given camera type
  93361. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  93362. * @param name The name of the camera the result will be able to instantiate
  93363. * @param scene The scene the result will construct the camera in
  93364. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  93365. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  93366. * @returns a factory method to construc the camera
  93367. */
  93368. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  93369. /**
  93370. * Compute the world matrix of the camera.
  93371. * @returns the camera world matrix
  93372. */
  93373. computeWorldMatrix(): Matrix;
  93374. /**
  93375. * Parse a JSON and creates the camera from the parsed information
  93376. * @param parsedCamera The JSON to parse
  93377. * @param scene The scene to instantiate the camera in
  93378. * @returns the newly constructed camera
  93379. */
  93380. static Parse(parsedCamera: any, scene: Scene): Camera;
  93381. }
  93382. }
  93383. declare module BABYLON {
  93384. /**
  93385. * Class containing static functions to help procedurally build meshes
  93386. */
  93387. export class DiscBuilder {
  93388. /**
  93389. * Creates a plane polygonal mesh. By default, this is a disc
  93390. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  93391. * * The parameter `tessellation` sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  93392. * * You can create an unclosed polygon with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference : 2 x PI x ratio
  93393. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  93394. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  93395. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  93396. * @param name defines the name of the mesh
  93397. * @param options defines the options used to create the mesh
  93398. * @param scene defines the hosting scene
  93399. * @returns the plane polygonal mesh
  93400. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  93401. */
  93402. static CreateDisc(name: string, options: {
  93403. radius?: number;
  93404. tessellation?: number;
  93405. arc?: number;
  93406. updatable?: boolean;
  93407. sideOrientation?: number;
  93408. frontUVs?: Vector4;
  93409. backUVs?: Vector4;
  93410. }, scene?: Nullable<Scene>): Mesh;
  93411. }
  93412. }
  93413. declare module BABYLON {
  93414. /**
  93415. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  93416. *As it is just a mesh, the SPS has all the same properties than any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  93417. * The SPS is also a particle system. It provides some methods to manage the particles.
  93418. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  93419. *
  93420. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  93421. */
  93422. export class SolidParticleSystem implements IDisposable {
  93423. /**
  93424. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  93425. * Example : var p = SPS.particles[i];
  93426. */
  93427. particles: SolidParticle[];
  93428. /**
  93429. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  93430. */
  93431. nbParticles: number;
  93432. /**
  93433. * If the particles must ever face the camera (default false). Useful for planar particles.
  93434. */
  93435. billboard: boolean;
  93436. /**
  93437. * Recompute normals when adding a shape
  93438. */
  93439. recomputeNormals: boolean;
  93440. /**
  93441. * This a counter ofr your own usage. It's not set by any SPS functions.
  93442. */
  93443. counter: number;
  93444. /**
  93445. * The SPS name. This name is also given to the underlying mesh.
  93446. */
  93447. name: string;
  93448. /**
  93449. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  93450. */
  93451. mesh: Mesh;
  93452. /**
  93453. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  93454. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  93455. */
  93456. vars: any;
  93457. /**
  93458. * This array is populated when the SPS is set as 'pickable'.
  93459. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  93460. * Each element of this array is an object `{idx: int, faceId: int}`.
  93461. * `idx` is the picked particle index in the `SPS.particles` array
  93462. * `faceId` is the picked face index counted within this particle.
  93463. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  93464. */
  93465. pickedParticles: {
  93466. idx: number;
  93467. faceId: number;
  93468. }[];
  93469. /**
  93470. * This array is populated when `enableDepthSort` is set to true.
  93471. * Each element of this array is an instance of the class DepthSortedParticle.
  93472. */
  93473. depthSortedParticles: DepthSortedParticle[];
  93474. /**
  93475. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  93476. * @hidden
  93477. */
  93478. _bSphereOnly: boolean;
  93479. /**
  93480. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  93481. * @hidden
  93482. */
  93483. _bSphereRadiusFactor: number;
  93484. private _scene;
  93485. private _positions;
  93486. private _indices;
  93487. private _normals;
  93488. private _colors;
  93489. private _uvs;
  93490. private _indices32;
  93491. private _positions32;
  93492. private _normals32;
  93493. private _fixedNormal32;
  93494. private _colors32;
  93495. private _uvs32;
  93496. private _index;
  93497. private _updatable;
  93498. private _pickable;
  93499. private _isVisibilityBoxLocked;
  93500. private _alwaysVisible;
  93501. private _depthSort;
  93502. private _expandable;
  93503. private _shapeCounter;
  93504. private _copy;
  93505. private _mustResetCopy;
  93506. private _color;
  93507. private _computeParticleColor;
  93508. private _computeParticleTexture;
  93509. private _computeParticleRotation;
  93510. private _computeParticleVertex;
  93511. private _computeBoundingBox;
  93512. private _depthSortParticles;
  93513. private _camera;
  93514. private _mustUnrotateFixedNormals;
  93515. private _particlesIntersect;
  93516. private _needs32Bits;
  93517. private _isNotBuilt;
  93518. private _lastParticleId;
  93519. private _idxOfId;
  93520. /**
  93521. * Creates a SPS (Solid Particle System) object.
  93522. * @param name (String) is the SPS name, this will be the underlying mesh name.
  93523. * @param scene (Scene) is the scene in which the SPS is added.
  93524. * @param options defines the options of the sps e.g.
  93525. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  93526. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  93527. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  93528. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  93529. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  93530. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  93531. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  93532. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  93533. */
  93534. constructor(name: string, scene: Scene, options?: {
  93535. updatable?: boolean;
  93536. isPickable?: boolean;
  93537. enableDepthSort?: boolean;
  93538. particleIntersection?: boolean;
  93539. boundingSphereOnly?: boolean;
  93540. bSphereRadiusFactor?: number;
  93541. expandable?: boolean;
  93542. });
  93543. /**
  93544. * Builds the SPS underlying mesh. Returns a standard Mesh.
  93545. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  93546. * @returns the created mesh
  93547. */
  93548. buildMesh(): Mesh;
  93549. /**
  93550. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  93551. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  93552. * Thus the particles generated from `digest()` have their property `position` set yet.
  93553. * @param mesh ( Mesh ) is the mesh to be digested
  93554. * @param options {facetNb} (optional integer, default 1) is the number of mesh facets per particle, this parameter is overriden by the parameter `number` if any
  93555. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  93556. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  93557. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  93558. * @returns the current SPS
  93559. */
  93560. digest(mesh: Mesh, options?: {
  93561. facetNb?: number;
  93562. number?: number;
  93563. delta?: number;
  93564. storage?: [];
  93565. }): SolidParticleSystem;
  93566. /**
  93567. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  93568. * @hidden
  93569. */
  93570. private _unrotateFixedNormals;
  93571. /**
  93572. * Resets the temporary working copy particle
  93573. * @hidden
  93574. */
  93575. private _resetCopy;
  93576. /**
  93577. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  93578. * @param p the current index in the positions array to be updated
  93579. * @param shape a Vector3 array, the shape geometry
  93580. * @param positions the positions array to be updated
  93581. * @param meshInd the shape indices array
  93582. * @param indices the indices array to be updated
  93583. * @param meshUV the shape uv array
  93584. * @param uvs the uv array to be updated
  93585. * @param meshCol the shape color array
  93586. * @param colors the color array to be updated
  93587. * @param meshNor the shape normals array
  93588. * @param normals the normals array to be updated
  93589. * @param idx the particle index
  93590. * @param idxInShape the particle index in its shape
  93591. * @param options the addShape() method passed options
  93592. * @hidden
  93593. */
  93594. private _meshBuilder;
  93595. /**
  93596. * Returns a shape Vector3 array from positions float array
  93597. * @param positions float array
  93598. * @returns a vector3 array
  93599. * @hidden
  93600. */
  93601. private _posToShape;
  93602. /**
  93603. * Returns a shapeUV array from a float uvs (array deep copy)
  93604. * @param uvs as a float array
  93605. * @returns a shapeUV array
  93606. * @hidden
  93607. */
  93608. private _uvsToShapeUV;
  93609. /**
  93610. * Adds a new particle object in the particles array
  93611. * @param idx particle index in particles array
  93612. * @param id particle id
  93613. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  93614. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  93615. * @param model particle ModelShape object
  93616. * @param shapeId model shape identifier
  93617. * @param idxInShape index of the particle in the current model
  93618. * @param bInfo model bounding info object
  93619. * @param storage target storage array, if any
  93620. * @hidden
  93621. */
  93622. private _addParticle;
  93623. /**
  93624. * Adds some particles to the SPS from the model shape. Returns the shape id.
  93625. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  93626. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  93627. * @param nb (positive integer) the number of particles to be created from this model
  93628. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  93629. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  93630. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  93631. * @returns the number of shapes in the system
  93632. */
  93633. addShape(mesh: Mesh, nb: number, options?: {
  93634. positionFunction?: any;
  93635. vertexFunction?: any;
  93636. storage?: [];
  93637. }): number;
  93638. /**
  93639. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  93640. * @hidden
  93641. */
  93642. private _rebuildParticle;
  93643. /**
  93644. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  93645. * @param reset boolean, default false : if the particles must be reset at position and rotation zero, scaling 1, color white, initial UVs and not parented.
  93646. * @returns the SPS.
  93647. */
  93648. rebuildMesh(reset?: boolean): SolidParticleSystem;
  93649. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  93650. * Returns an array with the removed particles.
  93651. * If the number of particles to remove is lower than zero or greater than the global remaining particle number, then an empty array is returned.
  93652. * The SPS can't be empty so at least one particle needs to remain in place.
  93653. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  93654. * @param start index of the first particle to remove
  93655. * @param end index of the last particle to remove (included)
  93656. * @returns an array populated with the removed particles
  93657. */
  93658. removeParticles(start: number, end: number): SolidParticle[];
  93659. /**
  93660. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  93661. * @param solidParticleArray an array populated with Solid Particles objects
  93662. * @returns the SPS
  93663. */
  93664. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  93665. /**
  93666. * Creates a new particle and modifies the SPS mesh geometry :
  93667. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  93668. * - calls _addParticle() to populate the particle array
  93669. * factorized code from addShape() and insertParticlesFromArray()
  93670. * @param idx particle index in the particles array
  93671. * @param i particle index in its shape
  93672. * @param modelShape particle ModelShape object
  93673. * @param shape shape vertex array
  93674. * @param meshInd shape indices array
  93675. * @param meshUV shape uv array
  93676. * @param meshCol shape color array
  93677. * @param meshNor shape normals array
  93678. * @param bbInfo shape bounding info
  93679. * @param storage target particle storage
  93680. * @options addShape() passed options
  93681. * @hidden
  93682. */
  93683. private _insertNewParticle;
  93684. /**
  93685. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  93686. * This method calls `updateParticle()` for each particle of the SPS.
  93687. * For an animated SPS, it is usually called within the render loop.
  93688. * This methods does nothing if called on a non updatable or not yet built SPS. Example : buildMesh() not called after having added or removed particles from an expandable SPS.
  93689. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  93690. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  93691. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  93692. * @returns the SPS.
  93693. */
  93694. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  93695. /**
  93696. * Disposes the SPS.
  93697. */
  93698. dispose(): void;
  93699. /**
  93700. * Returns a SolidParticle object from its identifier : particle.id
  93701. * @param id (integer) the particle Id
  93702. * @returns the searched particle or null if not found in the SPS.
  93703. */
  93704. getParticleById(id: number): Nullable<SolidParticle>;
  93705. /**
  93706. * Returns a new array populated with the particles having the passed shapeId.
  93707. * @param shapeId (integer) the shape identifier
  93708. * @returns a new solid particle array
  93709. */
  93710. getParticlesByShapeId(shapeId: number): SolidParticle[];
  93711. /**
  93712. * Populates the passed array "ref" with the particles having the passed shapeId.
  93713. * @param shapeId the shape identifier
  93714. * @returns the SPS
  93715. * @param ref
  93716. */
  93717. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  93718. /**
  93719. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  93720. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93721. * @returns the SPS.
  93722. */
  93723. refreshVisibleSize(): SolidParticleSystem;
  93724. /**
  93725. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  93726. * @param size the size (float) of the visibility box
  93727. * note : this doesn't lock the SPS mesh bounding box.
  93728. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93729. */
  93730. setVisibilityBox(size: number): void;
  93731. /**
  93732. * Gets whether the SPS as always visible or not
  93733. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93734. */
  93735. /**
  93736. * Sets the SPS as always visible or not
  93737. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93738. */
  93739. isAlwaysVisible: boolean;
  93740. /**
  93741. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  93742. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93743. */
  93744. /**
  93745. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  93746. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  93747. */
  93748. isVisibilityBoxLocked: boolean;
  93749. /**
  93750. * Tells to `setParticles()` to compute the particle rotations or not.
  93751. * Default value : true. The SPS is faster when it's set to false.
  93752. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  93753. */
  93754. /**
  93755. * Gets if `setParticles()` computes the particle rotations or not.
  93756. * Default value : true. The SPS is faster when it's set to false.
  93757. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  93758. */
  93759. computeParticleRotation: boolean;
  93760. /**
  93761. * Tells to `setParticles()` to compute the particle colors or not.
  93762. * Default value : true. The SPS is faster when it's set to false.
  93763. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  93764. */
  93765. /**
  93766. * Gets if `setParticles()` computes the particle colors or not.
  93767. * Default value : true. The SPS is faster when it's set to false.
  93768. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  93769. */
  93770. computeParticleColor: boolean;
  93771. /**
  93772. * Gets if `setParticles()` computes the particle textures or not.
  93773. * Default value : true. The SPS is faster when it's set to false.
  93774. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  93775. */
  93776. computeParticleTexture: boolean;
  93777. /**
  93778. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  93779. * Default value : false. The SPS is faster when it's set to false.
  93780. * Note : the particle custom vertex positions aren't stored values.
  93781. */
  93782. /**
  93783. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  93784. * Default value : false. The SPS is faster when it's set to false.
  93785. * Note : the particle custom vertex positions aren't stored values.
  93786. */
  93787. computeParticleVertex: boolean;
  93788. /**
  93789. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  93790. */
  93791. /**
  93792. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  93793. */
  93794. computeBoundingBox: boolean;
  93795. /**
  93796. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  93797. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  93798. * Default : `true`
  93799. */
  93800. /**
  93801. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  93802. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  93803. * Default : `true`
  93804. */
  93805. depthSortParticles: boolean;
  93806. /**
  93807. * Gets if the SPS is created as expandable at construction time.
  93808. * Default : `false`
  93809. */
  93810. readonly expandable: boolean;
  93811. /**
  93812. * This function does nothing. It may be overwritten to set all the particle first values.
  93813. * The SPS doesn't call this function, you may have to call it by your own.
  93814. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  93815. */
  93816. initParticles(): void;
  93817. /**
  93818. * This function does nothing. It may be overwritten to recycle a particle.
  93819. * The SPS doesn't call this function, you may have to call it by your own.
  93820. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  93821. * @param particle The particle to recycle
  93822. * @returns the recycled particle
  93823. */
  93824. recycleParticle(particle: SolidParticle): SolidParticle;
  93825. /**
  93826. * Updates a particle : this function should be overwritten by the user.
  93827. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  93828. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  93829. * @example : just set a particle position or velocity and recycle conditions
  93830. * @param particle The particle to update
  93831. * @returns the updated particle
  93832. */
  93833. updateParticle(particle: SolidParticle): SolidParticle;
  93834. /**
  93835. * Updates a vertex of a particle : it can be overwritten by the user.
  93836. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  93837. * @param particle the current particle
  93838. * @param vertex the current index of the current particle
  93839. * @param pt the index of the current vertex in the particle shape
  93840. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  93841. * @example : just set a vertex particle position
  93842. * @returns the updated vertex
  93843. */
  93844. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  93845. /**
  93846. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  93847. * This does nothing and may be overwritten by the user.
  93848. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93849. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93850. * @param update the boolean update value actually passed to setParticles()
  93851. */
  93852. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  93853. /**
  93854. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  93855. * This will be passed three parameters.
  93856. * This does nothing and may be overwritten by the user.
  93857. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93858. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  93859. * @param update the boolean update value actually passed to setParticles()
  93860. */
  93861. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  93862. }
  93863. }
  93864. declare module BABYLON {
  93865. /**
  93866. * Represents one particle of a solid particle system.
  93867. */
  93868. export class SolidParticle {
  93869. /**
  93870. * particle global index
  93871. */
  93872. idx: number;
  93873. /**
  93874. * particle identifier
  93875. */
  93876. id: number;
  93877. /**
  93878. * The color of the particle
  93879. */
  93880. color: Nullable<Color4>;
  93881. /**
  93882. * The world space position of the particle.
  93883. */
  93884. position: Vector3;
  93885. /**
  93886. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  93887. */
  93888. rotation: Vector3;
  93889. /**
  93890. * The world space rotation quaternion of the particle.
  93891. */
  93892. rotationQuaternion: Nullable<Quaternion>;
  93893. /**
  93894. * The scaling of the particle.
  93895. */
  93896. scaling: Vector3;
  93897. /**
  93898. * The uvs of the particle.
  93899. */
  93900. uvs: Vector4;
  93901. /**
  93902. * The current speed of the particle.
  93903. */
  93904. velocity: Vector3;
  93905. /**
  93906. * The pivot point in the particle local space.
  93907. */
  93908. pivot: Vector3;
  93909. /**
  93910. * Must the particle be translated from its pivot point in its local space ?
  93911. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  93912. * Default : false
  93913. */
  93914. translateFromPivot: boolean;
  93915. /**
  93916. * Is the particle active or not ?
  93917. */
  93918. alive: boolean;
  93919. /**
  93920. * Is the particle visible or not ?
  93921. */
  93922. isVisible: boolean;
  93923. /**
  93924. * Index of this particle in the global "positions" array (Internal use)
  93925. * @hidden
  93926. */
  93927. _pos: number;
  93928. /**
  93929. * @hidden Index of this particle in the global "indices" array (Internal use)
  93930. */
  93931. _ind: number;
  93932. /**
  93933. * @hidden ModelShape of this particle (Internal use)
  93934. */
  93935. _model: ModelShape;
  93936. /**
  93937. * ModelShape id of this particle
  93938. */
  93939. shapeId: number;
  93940. /**
  93941. * Index of the particle in its shape id
  93942. */
  93943. idxInShape: number;
  93944. /**
  93945. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  93946. */
  93947. _modelBoundingInfo: BoundingInfo;
  93948. /**
  93949. * @hidden Particle BoundingInfo object (Internal use)
  93950. */
  93951. _boundingInfo: BoundingInfo;
  93952. /**
  93953. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  93954. */
  93955. _sps: SolidParticleSystem;
  93956. /**
  93957. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  93958. */
  93959. _stillInvisible: boolean;
  93960. /**
  93961. * @hidden Last computed particle rotation matrix
  93962. */
  93963. _rotationMatrix: number[];
  93964. /**
  93965. * Parent particle Id, if any.
  93966. * Default null.
  93967. */
  93968. parentId: Nullable<number>;
  93969. /**
  93970. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  93971. * The possible values are :
  93972. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  93973. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  93974. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  93975. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  93976. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  93977. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  93978. * */
  93979. cullingStrategy: number;
  93980. /**
  93981. * @hidden Internal global position in the SPS.
  93982. */
  93983. _globalPosition: Vector3;
  93984. /**
  93985. * Creates a Solid Particle object.
  93986. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  93987. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  93988. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  93989. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  93990. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  93991. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  93992. * @param shapeId (integer) is the model shape identifier in the SPS.
  93993. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  93994. * @param sps defines the sps it is associated to
  93995. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  93996. */
  93997. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  93998. /**
  93999. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  94000. * @param target the particle target
  94001. * @returns the current particle
  94002. */
  94003. copyToRef(target: SolidParticle): SolidParticle;
  94004. /**
  94005. * Legacy support, changed scale to scaling
  94006. */
  94007. /**
  94008. * Legacy support, changed scale to scaling
  94009. */
  94010. scale: Vector3;
  94011. /**
  94012. * Legacy support, changed quaternion to rotationQuaternion
  94013. */
  94014. /**
  94015. * Legacy support, changed quaternion to rotationQuaternion
  94016. */
  94017. quaternion: Nullable<Quaternion>;
  94018. /**
  94019. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  94020. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  94021. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  94022. * @returns true if it intersects
  94023. */
  94024. intersectsMesh(target: Mesh | SolidParticle): boolean;
  94025. /**
  94026. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  94027. * A particle is in the frustum if its bounding box intersects the frustum
  94028. * @param frustumPlanes defines the frustum to test
  94029. * @returns true if the particle is in the frustum planes
  94030. */
  94031. isInFrustum(frustumPlanes: Plane[]): boolean;
  94032. /**
  94033. * get the rotation matrix of the particle
  94034. * @hidden
  94035. */
  94036. getRotationMatrix(m: Matrix): void;
  94037. }
  94038. /**
  94039. * Represents the shape of the model used by one particle of a solid particle system.
  94040. * SPS internal tool, don't use it manually.
  94041. */
  94042. export class ModelShape {
  94043. /**
  94044. * The shape id
  94045. * @hidden
  94046. */
  94047. shapeID: number;
  94048. /**
  94049. * flat array of model positions (internal use)
  94050. * @hidden
  94051. */
  94052. _shape: Vector3[];
  94053. /**
  94054. * flat array of model UVs (internal use)
  94055. * @hidden
  94056. */
  94057. _shapeUV: number[];
  94058. /**
  94059. * color array of the model
  94060. * @hidden
  94061. */
  94062. _shapeColors: number[];
  94063. /**
  94064. * indices array of the model
  94065. * @hidden
  94066. */
  94067. _indices: number[];
  94068. /**
  94069. * normals array of the model
  94070. * @hidden
  94071. */
  94072. _normals: number[];
  94073. /**
  94074. * length of the shape in the model indices array (internal use)
  94075. * @hidden
  94076. */
  94077. _indicesLength: number;
  94078. /**
  94079. * Custom position function (internal use)
  94080. * @hidden
  94081. */
  94082. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  94083. /**
  94084. * Custom vertex function (internal use)
  94085. * @hidden
  94086. */
  94087. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  94088. /**
  94089. * Creates a ModelShape object. This is an internal simplified reference to a mesh used as for a model to replicate particles from by the SPS.
  94090. * SPS internal tool, don't use it manually.
  94091. * @hidden
  94092. */
  94093. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>);
  94094. }
  94095. /**
  94096. * Represents a Depth Sorted Particle in the solid particle system.
  94097. */
  94098. export class DepthSortedParticle {
  94099. /**
  94100. * Index of the particle in the "indices" array
  94101. */
  94102. ind: number;
  94103. /**
  94104. * Length of the particle shape in the "indices" array
  94105. */
  94106. indicesLength: number;
  94107. /**
  94108. * Squared distance from the particle to the camera
  94109. */
  94110. sqDistance: number;
  94111. }
  94112. }
  94113. declare module BABYLON {
  94114. /**
  94115. * @hidden
  94116. */
  94117. export class _MeshCollisionData {
  94118. _checkCollisions: boolean;
  94119. _collisionMask: number;
  94120. _collisionGroup: number;
  94121. _collider: Nullable<Collider>;
  94122. _oldPositionForCollisions: Vector3;
  94123. _diffPositionForCollisions: Vector3;
  94124. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  94125. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  94126. }
  94127. }
  94128. declare module BABYLON {
  94129. /** @hidden */
  94130. class _FacetDataStorage {
  94131. facetPositions: Vector3[];
  94132. facetNormals: Vector3[];
  94133. facetPartitioning: number[][];
  94134. facetNb: number;
  94135. partitioningSubdivisions: number;
  94136. partitioningBBoxRatio: number;
  94137. facetDataEnabled: boolean;
  94138. facetParameters: any;
  94139. bbSize: Vector3;
  94140. subDiv: {
  94141. max: number;
  94142. X: number;
  94143. Y: number;
  94144. Z: number;
  94145. };
  94146. facetDepthSort: boolean;
  94147. facetDepthSortEnabled: boolean;
  94148. depthSortedIndices: IndicesArray;
  94149. depthSortedFacets: {
  94150. ind: number;
  94151. sqDistance: number;
  94152. }[];
  94153. facetDepthSortFunction: (f1: {
  94154. ind: number;
  94155. sqDistance: number;
  94156. }, f2: {
  94157. ind: number;
  94158. sqDistance: number;
  94159. }) => number;
  94160. facetDepthSortFrom: Vector3;
  94161. facetDepthSortOrigin: Vector3;
  94162. invertedMatrix: Matrix;
  94163. }
  94164. /**
  94165. * @hidden
  94166. **/
  94167. class _InternalAbstractMeshDataInfo {
  94168. _hasVertexAlpha: boolean;
  94169. _useVertexColors: boolean;
  94170. _numBoneInfluencers: number;
  94171. _applyFog: boolean;
  94172. _receiveShadows: boolean;
  94173. _facetData: _FacetDataStorage;
  94174. _visibility: number;
  94175. _skeleton: Nullable<Skeleton>;
  94176. _layerMask: number;
  94177. _computeBonesUsingShaders: boolean;
  94178. _isActive: boolean;
  94179. _onlyForInstances: boolean;
  94180. _isActiveIntermediate: boolean;
  94181. _onlyForInstancesIntermediate: boolean;
  94182. _actAsRegularMesh: boolean;
  94183. }
  94184. /**
  94185. * Class used to store all common mesh properties
  94186. */
  94187. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  94188. /** No occlusion */
  94189. static OCCLUSION_TYPE_NONE: number;
  94190. /** Occlusion set to optimisitic */
  94191. static OCCLUSION_TYPE_OPTIMISTIC: number;
  94192. /** Occlusion set to strict */
  94193. static OCCLUSION_TYPE_STRICT: number;
  94194. /** Use an accurante occlusion algorithm */
  94195. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  94196. /** Use a conservative occlusion algorithm */
  94197. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  94198. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  94199. * Test order :
  94200. * Is the bounding sphere outside the frustum ?
  94201. * If not, are the bounding box vertices outside the frustum ?
  94202. * It not, then the cullable object is in the frustum.
  94203. */
  94204. static readonly CULLINGSTRATEGY_STANDARD: number;
  94205. /** Culling strategy : Bounding Sphere Only.
  94206. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  94207. * It's also less accurate than the standard because some not visible objects can still be selected.
  94208. * Test : is the bounding sphere outside the frustum ?
  94209. * If not, then the cullable object is in the frustum.
  94210. */
  94211. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  94212. /** Culling strategy : Optimistic Inclusion.
  94213. * This in an inclusion test first, then the standard exclusion test.
  94214. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  94215. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  94216. * Anyway, it's as accurate as the standard strategy.
  94217. * Test :
  94218. * Is the cullable object bounding sphere center in the frustum ?
  94219. * If not, apply the default culling strategy.
  94220. */
  94221. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  94222. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  94223. * This in an inclusion test first, then the bounding sphere only exclusion test.
  94224. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  94225. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  94226. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  94227. * Test :
  94228. * Is the cullable object bounding sphere center in the frustum ?
  94229. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  94230. */
  94231. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  94232. /**
  94233. * No billboard
  94234. */
  94235. static readonly BILLBOARDMODE_NONE: number;
  94236. /** Billboard on X axis */
  94237. static readonly BILLBOARDMODE_X: number;
  94238. /** Billboard on Y axis */
  94239. static readonly BILLBOARDMODE_Y: number;
  94240. /** Billboard on Z axis */
  94241. static readonly BILLBOARDMODE_Z: number;
  94242. /** Billboard on all axes */
  94243. static readonly BILLBOARDMODE_ALL: number;
  94244. /** Billboard on using position instead of orientation */
  94245. static readonly BILLBOARDMODE_USE_POSITION: number;
  94246. /** @hidden */
  94247. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  94248. /**
  94249. * The culling strategy to use to check whether the mesh must be rendered or not.
  94250. * This value can be changed at any time and will be used on the next render mesh selection.
  94251. * The possible values are :
  94252. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  94253. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  94254. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  94255. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  94256. * Please read each static variable documentation to get details about the culling process.
  94257. * */
  94258. cullingStrategy: number;
  94259. /**
  94260. * Gets the number of facets in the mesh
  94261. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  94262. */
  94263. readonly facetNb: number;
  94264. /**
  94265. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  94266. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  94267. */
  94268. partitioningSubdivisions: number;
  94269. /**
  94270. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  94271. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  94272. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  94273. */
  94274. partitioningBBoxRatio: number;
  94275. /**
  94276. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  94277. * Works only for updatable meshes.
  94278. * Doesn't work with multi-materials
  94279. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  94280. */
  94281. mustDepthSortFacets: boolean;
  94282. /**
  94283. * The location (Vector3) where the facet depth sort must be computed from.
  94284. * By default, the active camera position.
  94285. * Used only when facet depth sort is enabled
  94286. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  94287. */
  94288. facetDepthSortFrom: Vector3;
  94289. /**
  94290. * gets a boolean indicating if facetData is enabled
  94291. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  94292. */
  94293. readonly isFacetDataEnabled: boolean;
  94294. /** @hidden */
  94295. _updateNonUniformScalingState(value: boolean): boolean;
  94296. /**
  94297. * An event triggered when this mesh collides with another one
  94298. */
  94299. onCollideObservable: Observable<AbstractMesh>;
  94300. /** Set a function to call when this mesh collides with another one */
  94301. onCollide: () => void;
  94302. /**
  94303. * An event triggered when the collision's position changes
  94304. */
  94305. onCollisionPositionChangeObservable: Observable<Vector3>;
  94306. /** Set a function to call when the collision's position changes */
  94307. onCollisionPositionChange: () => void;
  94308. /**
  94309. * An event triggered when material is changed
  94310. */
  94311. onMaterialChangedObservable: Observable<AbstractMesh>;
  94312. /**
  94313. * Gets or sets the orientation for POV movement & rotation
  94314. */
  94315. definedFacingForward: boolean;
  94316. /** @hidden */
  94317. _occlusionQuery: Nullable<WebGLQuery>;
  94318. /** @hidden */
  94319. _renderingGroup: Nullable<RenderingGroup>;
  94320. /**
  94321. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  94322. */
  94323. /**
  94324. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  94325. */
  94326. visibility: number;
  94327. /** Gets or sets the alpha index used to sort transparent meshes
  94328. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  94329. */
  94330. alphaIndex: number;
  94331. /**
  94332. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  94333. */
  94334. isVisible: boolean;
  94335. /**
  94336. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  94337. */
  94338. isPickable: boolean;
  94339. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  94340. showSubMeshesBoundingBox: boolean;
  94341. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  94342. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  94343. */
  94344. isBlocker: boolean;
  94345. /**
  94346. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  94347. */
  94348. enablePointerMoveEvents: boolean;
  94349. /**
  94350. * Specifies the rendering group id for this mesh (0 by default)
  94351. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  94352. */
  94353. renderingGroupId: number;
  94354. private _material;
  94355. /** Gets or sets current material */
  94356. material: Nullable<Material>;
  94357. /**
  94358. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  94359. * @see http://doc.babylonjs.com/babylon101/shadows
  94360. */
  94361. receiveShadows: boolean;
  94362. /** Defines color to use when rendering outline */
  94363. outlineColor: Color3;
  94364. /** Define width to use when rendering outline */
  94365. outlineWidth: number;
  94366. /** Defines color to use when rendering overlay */
  94367. overlayColor: Color3;
  94368. /** Defines alpha to use when rendering overlay */
  94369. overlayAlpha: number;
  94370. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  94371. hasVertexAlpha: boolean;
  94372. /** Gets or sets a boolean indicating that this mesh needs to use vertex color data to render (if this kind of vertex data is available in the geometry) */
  94373. useVertexColors: boolean;
  94374. /**
  94375. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  94376. */
  94377. computeBonesUsingShaders: boolean;
  94378. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  94379. numBoneInfluencers: number;
  94380. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  94381. applyFog: boolean;
  94382. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  94383. useOctreeForRenderingSelection: boolean;
  94384. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  94385. useOctreeForPicking: boolean;
  94386. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  94387. useOctreeForCollisions: boolean;
  94388. /**
  94389. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  94390. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  94391. */
  94392. layerMask: number;
  94393. /**
  94394. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  94395. */
  94396. alwaysSelectAsActiveMesh: boolean;
  94397. /**
  94398. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  94399. */
  94400. doNotSyncBoundingInfo: boolean;
  94401. /**
  94402. * Gets or sets the current action manager
  94403. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  94404. */
  94405. actionManager: Nullable<AbstractActionManager>;
  94406. private _meshCollisionData;
  94407. /**
  94408. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  94409. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94410. */
  94411. ellipsoid: Vector3;
  94412. /**
  94413. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  94414. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94415. */
  94416. ellipsoidOffset: Vector3;
  94417. /**
  94418. * Gets or sets a collision mask used to mask collisions (default is -1).
  94419. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  94420. */
  94421. collisionMask: number;
  94422. /**
  94423. * Gets or sets the current collision group mask (-1 by default).
  94424. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  94425. */
  94426. collisionGroup: number;
  94427. /**
  94428. * Defines edge width used when edgesRenderer is enabled
  94429. * @see https://www.babylonjs-playground.com/#10OJSG#13
  94430. */
  94431. edgesWidth: number;
  94432. /**
  94433. * Defines edge color used when edgesRenderer is enabled
  94434. * @see https://www.babylonjs-playground.com/#10OJSG#13
  94435. */
  94436. edgesColor: Color4;
  94437. /** @hidden */
  94438. _edgesRenderer: Nullable<IEdgesRenderer>;
  94439. /** @hidden */
  94440. _masterMesh: Nullable<AbstractMesh>;
  94441. /** @hidden */
  94442. _boundingInfo: Nullable<BoundingInfo>;
  94443. /** @hidden */
  94444. _renderId: number;
  94445. /**
  94446. * Gets or sets the list of subMeshes
  94447. * @see http://doc.babylonjs.com/how_to/multi_materials
  94448. */
  94449. subMeshes: SubMesh[];
  94450. /** @hidden */
  94451. _intersectionsInProgress: AbstractMesh[];
  94452. /** @hidden */
  94453. _unIndexed: boolean;
  94454. /** @hidden */
  94455. _lightSources: Light[];
  94456. /** Gets the list of lights affecting that mesh */
  94457. readonly lightSources: Light[];
  94458. /** @hidden */
  94459. readonly _positions: Nullable<Vector3[]>;
  94460. /** @hidden */
  94461. _waitingData: {
  94462. lods: Nullable<any>;
  94463. actions: Nullable<any>;
  94464. freezeWorldMatrix: Nullable<boolean>;
  94465. };
  94466. /** @hidden */
  94467. _bonesTransformMatrices: Nullable<Float32Array>;
  94468. /** @hidden */
  94469. _transformMatrixTexture: Nullable<RawTexture>;
  94470. /**
  94471. * Gets or sets a skeleton to apply skining transformations
  94472. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94473. */
  94474. skeleton: Nullable<Skeleton>;
  94475. /**
  94476. * An event triggered when the mesh is rebuilt.
  94477. */
  94478. onRebuildObservable: Observable<AbstractMesh>;
  94479. /**
  94480. * Creates a new AbstractMesh
  94481. * @param name defines the name of the mesh
  94482. * @param scene defines the hosting scene
  94483. */
  94484. constructor(name: string, scene?: Nullable<Scene>);
  94485. /**
  94486. * Returns the string "AbstractMesh"
  94487. * @returns "AbstractMesh"
  94488. */
  94489. getClassName(): string;
  94490. /**
  94491. * Gets a string representation of the current mesh
  94492. * @param fullDetails defines a boolean indicating if full details must be included
  94493. * @returns a string representation of the current mesh
  94494. */
  94495. toString(fullDetails?: boolean): string;
  94496. /**
  94497. * @hidden
  94498. */
  94499. protected _getEffectiveParent(): Nullable<Node>;
  94500. /** @hidden */
  94501. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  94502. /** @hidden */
  94503. _rebuild(): void;
  94504. /** @hidden */
  94505. _resyncLightSources(): void;
  94506. /** @hidden */
  94507. _resyncLighSource(light: Light): void;
  94508. /** @hidden */
  94509. _unBindEffect(): void;
  94510. /** @hidden */
  94511. _removeLightSource(light: Light, dispose: boolean): void;
  94512. private _markSubMeshesAsDirty;
  94513. /** @hidden */
  94514. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  94515. /** @hidden */
  94516. _markSubMeshesAsAttributesDirty(): void;
  94517. /** @hidden */
  94518. _markSubMeshesAsMiscDirty(): void;
  94519. /**
  94520. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  94521. */
  94522. scaling: Vector3;
  94523. /**
  94524. * Returns true if the mesh is blocked. Implemented by child classes
  94525. */
  94526. readonly isBlocked: boolean;
  94527. /**
  94528. * Returns the mesh itself by default. Implemented by child classes
  94529. * @param camera defines the camera to use to pick the right LOD level
  94530. * @returns the currentAbstractMesh
  94531. */
  94532. getLOD(camera: Camera): Nullable<AbstractMesh>;
  94533. /**
  94534. * Returns 0 by default. Implemented by child classes
  94535. * @returns an integer
  94536. */
  94537. getTotalVertices(): number;
  94538. /**
  94539. * Returns a positive integer : the total number of indices in this mesh geometry.
  94540. * @returns the numner of indices or zero if the mesh has no geometry.
  94541. */
  94542. getTotalIndices(): number;
  94543. /**
  94544. * Returns null by default. Implemented by child classes
  94545. * @returns null
  94546. */
  94547. getIndices(): Nullable<IndicesArray>;
  94548. /**
  94549. * Returns the array of the requested vertex data kind. Implemented by child classes
  94550. * @param kind defines the vertex data kind to use
  94551. * @returns null
  94552. */
  94553. getVerticesData(kind: string): Nullable<FloatArray>;
  94554. /**
  94555. * Sets the vertex data of the mesh geometry for the requested `kind`.
  94556. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  94557. * Note that a new underlying VertexBuffer object is created each call.
  94558. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  94559. * @param kind defines vertex data kind:
  94560. * * VertexBuffer.PositionKind
  94561. * * VertexBuffer.UVKind
  94562. * * VertexBuffer.UV2Kind
  94563. * * VertexBuffer.UV3Kind
  94564. * * VertexBuffer.UV4Kind
  94565. * * VertexBuffer.UV5Kind
  94566. * * VertexBuffer.UV6Kind
  94567. * * VertexBuffer.ColorKind
  94568. * * VertexBuffer.MatricesIndicesKind
  94569. * * VertexBuffer.MatricesIndicesExtraKind
  94570. * * VertexBuffer.MatricesWeightsKind
  94571. * * VertexBuffer.MatricesWeightsExtraKind
  94572. * @param data defines the data source
  94573. * @param updatable defines if the data must be flagged as updatable (or static)
  94574. * @param stride defines the vertex stride (size of an entire vertex). Can be null and in this case will be deduced from vertex data kind
  94575. * @returns the current mesh
  94576. */
  94577. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  94578. /**
  94579. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  94580. * If the mesh has no geometry, it is simply returned as it is.
  94581. * @param kind defines vertex data kind:
  94582. * * VertexBuffer.PositionKind
  94583. * * VertexBuffer.UVKind
  94584. * * VertexBuffer.UV2Kind
  94585. * * VertexBuffer.UV3Kind
  94586. * * VertexBuffer.UV4Kind
  94587. * * VertexBuffer.UV5Kind
  94588. * * VertexBuffer.UV6Kind
  94589. * * VertexBuffer.ColorKind
  94590. * * VertexBuffer.MatricesIndicesKind
  94591. * * VertexBuffer.MatricesIndicesExtraKind
  94592. * * VertexBuffer.MatricesWeightsKind
  94593. * * VertexBuffer.MatricesWeightsExtraKind
  94594. * @param data defines the data source
  94595. * @param updateExtends If `kind` is `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed
  94596. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  94597. * @returns the current mesh
  94598. */
  94599. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  94600. /**
  94601. * Sets the mesh indices,
  94602. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  94603. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  94604. * @param totalVertices Defines the total number of vertices
  94605. * @returns the current mesh
  94606. */
  94607. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  94608. /**
  94609. * Gets a boolean indicating if specific vertex data is present
  94610. * @param kind defines the vertex data kind to use
  94611. * @returns true is data kind is present
  94612. */
  94613. isVerticesDataPresent(kind: string): boolean;
  94614. /**
  94615. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  94616. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  94617. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  94618. * @returns a BoundingInfo
  94619. */
  94620. getBoundingInfo(): BoundingInfo;
  94621. /**
  94622. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94623. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94624. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94625. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94626. * @returns the current mesh
  94627. */
  94628. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  94629. /**
  94630. * Overwrite the current bounding info
  94631. * @param boundingInfo defines the new bounding info
  94632. * @returns the current mesh
  94633. */
  94634. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  94635. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  94636. readonly useBones: boolean;
  94637. /** @hidden */
  94638. _preActivate(): void;
  94639. /** @hidden */
  94640. _preActivateForIntermediateRendering(renderId: number): void;
  94641. /** @hidden */
  94642. _activate(renderId: number, intermediateRendering: boolean): boolean;
  94643. /** @hidden */
  94644. _postActivate(): void;
  94645. /** @hidden */
  94646. _freeze(): void;
  94647. /** @hidden */
  94648. _unFreeze(): void;
  94649. /**
  94650. * Gets the current world matrix
  94651. * @returns a Matrix
  94652. */
  94653. getWorldMatrix(): Matrix;
  94654. /** @hidden */
  94655. _getWorldMatrixDeterminant(): number;
  94656. /**
  94657. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  94658. */
  94659. readonly isAnInstance: boolean;
  94660. /**
  94661. * Gets a boolean indicating if this mesh has instances
  94662. */
  94663. readonly hasInstances: boolean;
  94664. /**
  94665. * Perform relative position change from the point of view of behind the front of the mesh.
  94666. * This is performed taking into account the meshes current rotation, so you do not have to care.
  94667. * Supports definition of mesh facing forward or backward
  94668. * @param amountRight defines the distance on the right axis
  94669. * @param amountUp defines the distance on the up axis
  94670. * @param amountForward defines the distance on the forward axis
  94671. * @returns the current mesh
  94672. */
  94673. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  94674. /**
  94675. * Calculate relative position change from the point of view of behind the front of the mesh.
  94676. * This is performed taking into account the meshes current rotation, so you do not have to care.
  94677. * Supports definition of mesh facing forward or backward
  94678. * @param amountRight defines the distance on the right axis
  94679. * @param amountUp defines the distance on the up axis
  94680. * @param amountForward defines the distance on the forward axis
  94681. * @returns the new displacement vector
  94682. */
  94683. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  94684. /**
  94685. * Perform relative rotation change from the point of view of behind the front of the mesh.
  94686. * Supports definition of mesh facing forward or backward
  94687. * @param flipBack defines the flip
  94688. * @param twirlClockwise defines the twirl
  94689. * @param tiltRight defines the tilt
  94690. * @returns the current mesh
  94691. */
  94692. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  94693. /**
  94694. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  94695. * Supports definition of mesh facing forward or backward.
  94696. * @param flipBack defines the flip
  94697. * @param twirlClockwise defines the twirl
  94698. * @param tiltRight defines the tilt
  94699. * @returns the new rotation vector
  94700. */
  94701. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  94702. /**
  94703. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  94704. * This means the mesh underlying bounding box and sphere are recomputed.
  94705. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  94706. * @returns the current mesh
  94707. */
  94708. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  94709. /** @hidden */
  94710. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  94711. /** @hidden */
  94712. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  94713. /** @hidden */
  94714. _updateBoundingInfo(): AbstractMesh;
  94715. /** @hidden */
  94716. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  94717. /** @hidden */
  94718. protected _afterComputeWorldMatrix(): void;
  94719. /** @hidden */
  94720. readonly _effectiveMesh: AbstractMesh;
  94721. /**
  94722. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  94723. * A mesh is in the frustum if its bounding box intersects the frustum
  94724. * @param frustumPlanes defines the frustum to test
  94725. * @returns true if the mesh is in the frustum planes
  94726. */
  94727. isInFrustum(frustumPlanes: Plane[]): boolean;
  94728. /**
  94729. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  94730. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  94731. * @param frustumPlanes defines the frustum to test
  94732. * @returns true if the mesh is completely in the frustum planes
  94733. */
  94734. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  94735. /**
  94736. * True if the mesh intersects another mesh or a SolidParticle object
  94737. * @param mesh defines a target mesh or SolidParticle to test
  94738. * @param precise Unless the parameter `precise` is set to `true` the intersection is computed according to Axis Aligned Bounding Boxes (AABB), else according to OBB (Oriented BBoxes)
  94739. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  94740. * @returns true if there is an intersection
  94741. */
  94742. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  94743. /**
  94744. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  94745. * @param point defines the point to test
  94746. * @returns true if there is an intersection
  94747. */
  94748. intersectsPoint(point: Vector3): boolean;
  94749. /**
  94750. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  94751. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94752. */
  94753. checkCollisions: boolean;
  94754. /**
  94755. * Gets Collider object used to compute collisions (not physics)
  94756. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94757. */
  94758. readonly collider: Nullable<Collider>;
  94759. /**
  94760. * Move the mesh using collision engine
  94761. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94762. * @param displacement defines the requested displacement vector
  94763. * @returns the current mesh
  94764. */
  94765. moveWithCollisions(displacement: Vector3): AbstractMesh;
  94766. private _onCollisionPositionChange;
  94767. /** @hidden */
  94768. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  94769. /** @hidden */
  94770. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  94771. /** @hidden */
  94772. _checkCollision(collider: Collider): AbstractMesh;
  94773. /** @hidden */
  94774. _generatePointsArray(): boolean;
  94775. /**
  94776. * Checks if the passed Ray intersects with the mesh
  94777. * @param ray defines the ray to use
  94778. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  94779. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  94780. * @returns the picking info
  94781. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  94782. */
  94783. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  94784. /**
  94785. * Clones the current mesh
  94786. * @param name defines the mesh name
  94787. * @param newParent defines the new mesh parent
  94788. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  94789. * @returns the new mesh
  94790. */
  94791. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  94792. /**
  94793. * Disposes all the submeshes of the current meshnp
  94794. * @returns the current mesh
  94795. */
  94796. releaseSubMeshes(): AbstractMesh;
  94797. /**
  94798. * Releases resources associated with this abstract mesh.
  94799. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94800. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94801. */
  94802. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94803. /**
  94804. * Adds the passed mesh as a child to the current mesh
  94805. * @param mesh defines the child mesh
  94806. * @returns the current mesh
  94807. */
  94808. addChild(mesh: AbstractMesh): AbstractMesh;
  94809. /**
  94810. * Removes the passed mesh from the current mesh children list
  94811. * @param mesh defines the child mesh
  94812. * @returns the current mesh
  94813. */
  94814. removeChild(mesh: AbstractMesh): AbstractMesh;
  94815. /** @hidden */
  94816. private _initFacetData;
  94817. /**
  94818. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  94819. * This method can be called within the render loop.
  94820. * You don't need to call this method by yourself in the render loop when you update/morph a mesh with the methods CreateXXX() as they automatically manage this computation
  94821. * @returns the current mesh
  94822. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94823. */
  94824. updateFacetData(): AbstractMesh;
  94825. /**
  94826. * Returns the facetLocalNormals array.
  94827. * The normals are expressed in the mesh local spac
  94828. * @returns an array of Vector3
  94829. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94830. */
  94831. getFacetLocalNormals(): Vector3[];
  94832. /**
  94833. * Returns the facetLocalPositions array.
  94834. * The facet positions are expressed in the mesh local space
  94835. * @returns an array of Vector3
  94836. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94837. */
  94838. getFacetLocalPositions(): Vector3[];
  94839. /**
  94840. * Returns the facetLocalPartioning array
  94841. * @returns an array of array of numbers
  94842. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94843. */
  94844. getFacetLocalPartitioning(): number[][];
  94845. /**
  94846. * Returns the i-th facet position in the world system.
  94847. * This method allocates a new Vector3 per call
  94848. * @param i defines the facet index
  94849. * @returns a new Vector3
  94850. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94851. */
  94852. getFacetPosition(i: number): Vector3;
  94853. /**
  94854. * Sets the reference Vector3 with the i-th facet position in the world system
  94855. * @param i defines the facet index
  94856. * @param ref defines the target vector
  94857. * @returns the current mesh
  94858. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94859. */
  94860. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  94861. /**
  94862. * Returns the i-th facet normal in the world system.
  94863. * This method allocates a new Vector3 per call
  94864. * @param i defines the facet index
  94865. * @returns a new Vector3
  94866. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94867. */
  94868. getFacetNormal(i: number): Vector3;
  94869. /**
  94870. * Sets the reference Vector3 with the i-th facet normal in the world system
  94871. * @param i defines the facet index
  94872. * @param ref defines the target vector
  94873. * @returns the current mesh
  94874. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94875. */
  94876. getFacetNormalToRef(i: number, ref: Vector3): this;
  94877. /**
  94878. * Returns the facets (in an array) in the same partitioning block than the one the passed coordinates are located (expressed in the mesh local system)
  94879. * @param x defines x coordinate
  94880. * @param y defines y coordinate
  94881. * @param z defines z coordinate
  94882. * @returns the array of facet indexes
  94883. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94884. */
  94885. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  94886. /**
  94887. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  94888. * @param projected sets as the (x,y,z) world projection on the facet
  94889. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  94890. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  94891. * @param x defines x coordinate
  94892. * @param y defines y coordinate
  94893. * @param z defines z coordinate
  94894. * @returns the face index if found (or null instead)
  94895. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94896. */
  94897. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  94898. /**
  94899. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  94900. * @param projected sets as the (x,y,z) local projection on the facet
  94901. * @param checkFace if true (default false), only the facet "facing" to (x,y,z) or only the ones "turning their backs", according to the parameter "facing" are returned
  94902. * @param facing if facing and checkFace are true, only the facet "facing" to (x, y, z) are returned : positive dot (x, y, z) * facet position. If facing si false and checkFace is true, only the facet "turning their backs" to (x, y, z) are returned : negative dot (x, y, z) * facet position
  94903. * @param x defines x coordinate
  94904. * @param y defines y coordinate
  94905. * @param z defines z coordinate
  94906. * @returns the face index if found (or null instead)
  94907. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94908. */
  94909. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  94910. /**
  94911. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  94912. * @returns the parameters
  94913. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94914. */
  94915. getFacetDataParameters(): any;
  94916. /**
  94917. * Disables the feature FacetData and frees the related memory
  94918. * @returns the current mesh
  94919. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  94920. */
  94921. disableFacetData(): AbstractMesh;
  94922. /**
  94923. * Updates the AbstractMesh indices array
  94924. * @param indices defines the data source
  94925. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  94926. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  94927. * @returns the current mesh
  94928. */
  94929. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  94930. /**
  94931. * Creates new normals data for the mesh
  94932. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  94933. * @returns the current mesh
  94934. */
  94935. createNormals(updatable: boolean): AbstractMesh;
  94936. /**
  94937. * Align the mesh with a normal
  94938. * @param normal defines the normal to use
  94939. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  94940. * @returns the current mesh
  94941. */
  94942. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  94943. /** @hidden */
  94944. _checkOcclusionQuery(): boolean;
  94945. /**
  94946. * Disables the mesh edge rendering mode
  94947. * @returns the currentAbstractMesh
  94948. */
  94949. disableEdgesRendering(): AbstractMesh;
  94950. /**
  94951. * Enables the edge rendering mode on the mesh.
  94952. * This mode makes the mesh edges visible
  94953. * @param epsilon defines the maximal distance between two angles to detect a face
  94954. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  94955. * @returns the currentAbstractMesh
  94956. * @see https://www.babylonjs-playground.com/#19O9TU#0
  94957. */
  94958. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  94959. }
  94960. }
  94961. declare module BABYLON {
  94962. /**
  94963. * Interface used to define ActionEvent
  94964. */
  94965. export interface IActionEvent {
  94966. /** The mesh or sprite that triggered the action */
  94967. source: any;
  94968. /** The X mouse cursor position at the time of the event */
  94969. pointerX: number;
  94970. /** The Y mouse cursor position at the time of the event */
  94971. pointerY: number;
  94972. /** The mesh that is currently pointed at (can be null) */
  94973. meshUnderPointer: Nullable<AbstractMesh>;
  94974. /** the original (browser) event that triggered the ActionEvent */
  94975. sourceEvent?: any;
  94976. /** additional data for the event */
  94977. additionalData?: any;
  94978. }
  94979. /**
  94980. * ActionEvent is the event being sent when an action is triggered.
  94981. */
  94982. export class ActionEvent implements IActionEvent {
  94983. /** The mesh or sprite that triggered the action */
  94984. source: any;
  94985. /** The X mouse cursor position at the time of the event */
  94986. pointerX: number;
  94987. /** The Y mouse cursor position at the time of the event */
  94988. pointerY: number;
  94989. /** The mesh that is currently pointed at (can be null) */
  94990. meshUnderPointer: Nullable<AbstractMesh>;
  94991. /** the original (browser) event that triggered the ActionEvent */
  94992. sourceEvent?: any;
  94993. /** additional data for the event */
  94994. additionalData?: any;
  94995. /**
  94996. * Creates a new ActionEvent
  94997. * @param source The mesh or sprite that triggered the action
  94998. * @param pointerX The X mouse cursor position at the time of the event
  94999. * @param pointerY The Y mouse cursor position at the time of the event
  95000. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  95001. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  95002. * @param additionalData additional data for the event
  95003. */
  95004. constructor(
  95005. /** The mesh or sprite that triggered the action */
  95006. source: any,
  95007. /** The X mouse cursor position at the time of the event */
  95008. pointerX: number,
  95009. /** The Y mouse cursor position at the time of the event */
  95010. pointerY: number,
  95011. /** The mesh that is currently pointed at (can be null) */
  95012. meshUnderPointer: Nullable<AbstractMesh>,
  95013. /** the original (browser) event that triggered the ActionEvent */
  95014. sourceEvent?: any,
  95015. /** additional data for the event */
  95016. additionalData?: any);
  95017. /**
  95018. * Helper function to auto-create an ActionEvent from a source mesh.
  95019. * @param source The source mesh that triggered the event
  95020. * @param evt The original (browser) event
  95021. * @param additionalData additional data for the event
  95022. * @returns the new ActionEvent
  95023. */
  95024. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  95025. /**
  95026. * Helper function to auto-create an ActionEvent from a source sprite
  95027. * @param source The source sprite that triggered the event
  95028. * @param scene Scene associated with the sprite
  95029. * @param evt The original (browser) event
  95030. * @param additionalData additional data for the event
  95031. * @returns the new ActionEvent
  95032. */
  95033. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  95034. /**
  95035. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  95036. * @param scene the scene where the event occurred
  95037. * @param evt The original (browser) event
  95038. * @returns the new ActionEvent
  95039. */
  95040. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  95041. /**
  95042. * Helper function to auto-create an ActionEvent from a primitive
  95043. * @param prim defines the target primitive
  95044. * @param pointerPos defines the pointer position
  95045. * @param evt The original (browser) event
  95046. * @param additionalData additional data for the event
  95047. * @returns the new ActionEvent
  95048. */
  95049. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  95050. }
  95051. }
  95052. declare module BABYLON {
  95053. /**
  95054. * Abstract class used to decouple action Manager from scene and meshes.
  95055. * Do not instantiate.
  95056. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  95057. */
  95058. export abstract class AbstractActionManager implements IDisposable {
  95059. /** Gets the list of active triggers */
  95060. static Triggers: {
  95061. [key: string]: number;
  95062. };
  95063. /** Gets the cursor to use when hovering items */
  95064. hoverCursor: string;
  95065. /** Gets the list of actions */
  95066. actions: IAction[];
  95067. /**
  95068. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  95069. */
  95070. isRecursive: boolean;
  95071. /**
  95072. * Releases all associated resources
  95073. */
  95074. abstract dispose(): void;
  95075. /**
  95076. * Does this action manager has pointer triggers
  95077. */
  95078. abstract readonly hasPointerTriggers: boolean;
  95079. /**
  95080. * Does this action manager has pick triggers
  95081. */
  95082. abstract readonly hasPickTriggers: boolean;
  95083. /**
  95084. * Process a specific trigger
  95085. * @param trigger defines the trigger to process
  95086. * @param evt defines the event details to be processed
  95087. */
  95088. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  95089. /**
  95090. * Does this action manager handles actions of any of the given triggers
  95091. * @param triggers defines the triggers to be tested
  95092. * @return a boolean indicating whether one (or more) of the triggers is handled
  95093. */
  95094. abstract hasSpecificTriggers(triggers: number[]): boolean;
  95095. /**
  95096. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  95097. * speed.
  95098. * @param triggerA defines the trigger to be tested
  95099. * @param triggerB defines the trigger to be tested
  95100. * @return a boolean indicating whether one (or more) of the triggers is handled
  95101. */
  95102. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  95103. /**
  95104. * Does this action manager handles actions of a given trigger
  95105. * @param trigger defines the trigger to be tested
  95106. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  95107. * @return whether the trigger is handled
  95108. */
  95109. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  95110. /**
  95111. * Serialize this manager to a JSON object
  95112. * @param name defines the property name to store this manager
  95113. * @returns a JSON representation of this manager
  95114. */
  95115. abstract serialize(name: string): any;
  95116. /**
  95117. * Registers an action to this action manager
  95118. * @param action defines the action to be registered
  95119. * @return the action amended (prepared) after registration
  95120. */
  95121. abstract registerAction(action: IAction): Nullable<IAction>;
  95122. /**
  95123. * Unregisters an action to this action manager
  95124. * @param action defines the action to be unregistered
  95125. * @return a boolean indicating whether the action has been unregistered
  95126. */
  95127. abstract unregisterAction(action: IAction): Boolean;
  95128. /**
  95129. * Does exist one action manager with at least one trigger
  95130. **/
  95131. static readonly HasTriggers: boolean;
  95132. /**
  95133. * Does exist one action manager with at least one pick trigger
  95134. **/
  95135. static readonly HasPickTriggers: boolean;
  95136. /**
  95137. * Does exist one action manager that handles actions of a given trigger
  95138. * @param trigger defines the trigger to be tested
  95139. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  95140. **/
  95141. static HasSpecificTrigger(trigger: number): boolean;
  95142. }
  95143. }
  95144. declare module BABYLON {
  95145. /**
  95146. * Defines how a node can be built from a string name.
  95147. */
  95148. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  95149. /**
  95150. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  95151. */
  95152. export class Node implements IBehaviorAware<Node> {
  95153. /** @hidden */
  95154. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  95155. private static _NodeConstructors;
  95156. /**
  95157. * Add a new node constructor
  95158. * @param type defines the type name of the node to construct
  95159. * @param constructorFunc defines the constructor function
  95160. */
  95161. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  95162. /**
  95163. * Returns a node constructor based on type name
  95164. * @param type defines the type name
  95165. * @param name defines the new node name
  95166. * @param scene defines the hosting scene
  95167. * @param options defines optional options to transmit to constructors
  95168. * @returns the new constructor or null
  95169. */
  95170. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  95171. /**
  95172. * Gets or sets the name of the node
  95173. */
  95174. name: string;
  95175. /**
  95176. * Gets or sets the id of the node
  95177. */
  95178. id: string;
  95179. /**
  95180. * Gets or sets the unique id of the node
  95181. */
  95182. uniqueId: number;
  95183. /**
  95184. * Gets or sets a string used to store user defined state for the node
  95185. */
  95186. state: string;
  95187. /**
  95188. * Gets or sets an object used to store user defined information for the node
  95189. */
  95190. metadata: any;
  95191. /**
  95192. * For internal use only. Please do not use.
  95193. */
  95194. reservedDataStore: any;
  95195. /**
  95196. * List of inspectable custom properties (used by the Inspector)
  95197. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95198. */
  95199. inspectableCustomProperties: IInspectable[];
  95200. private _doNotSerialize;
  95201. /**
  95202. * Gets or sets a boolean used to define if the node must be serialized
  95203. */
  95204. doNotSerialize: boolean;
  95205. /** @hidden */
  95206. _isDisposed: boolean;
  95207. /**
  95208. * Gets a list of Animations associated with the node
  95209. */
  95210. animations: Animation[];
  95211. protected _ranges: {
  95212. [name: string]: Nullable<AnimationRange>;
  95213. };
  95214. /**
  95215. * Callback raised when the node is ready to be used
  95216. */
  95217. onReady: Nullable<(node: Node) => void>;
  95218. private _isEnabled;
  95219. private _isParentEnabled;
  95220. private _isReady;
  95221. /** @hidden */
  95222. _currentRenderId: number;
  95223. private _parentUpdateId;
  95224. /** @hidden */
  95225. _childUpdateId: number;
  95226. /** @hidden */
  95227. _waitingParentId: Nullable<string>;
  95228. /** @hidden */
  95229. _scene: Scene;
  95230. /** @hidden */
  95231. _cache: any;
  95232. private _parentNode;
  95233. private _children;
  95234. /** @hidden */
  95235. _worldMatrix: Matrix;
  95236. /** @hidden */
  95237. _worldMatrixDeterminant: number;
  95238. /** @hidden */
  95239. _worldMatrixDeterminantIsDirty: boolean;
  95240. /** @hidden */
  95241. private _sceneRootNodesIndex;
  95242. /**
  95243. * Gets a boolean indicating if the node has been disposed
  95244. * @returns true if the node was disposed
  95245. */
  95246. isDisposed(): boolean;
  95247. /**
  95248. * Gets or sets the parent of the node (without keeping the current position in the scene)
  95249. * @see https://doc.babylonjs.com/how_to/parenting
  95250. */
  95251. parent: Nullable<Node>;
  95252. /** @hidden */
  95253. _addToSceneRootNodes(): void;
  95254. /** @hidden */
  95255. _removeFromSceneRootNodes(): void;
  95256. private _animationPropertiesOverride;
  95257. /**
  95258. * Gets or sets the animation properties override
  95259. */
  95260. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  95261. /**
  95262. * Gets a string idenfifying the name of the class
  95263. * @returns "Node" string
  95264. */
  95265. getClassName(): string;
  95266. /** @hidden */
  95267. readonly _isNode: boolean;
  95268. /**
  95269. * An event triggered when the mesh is disposed
  95270. */
  95271. onDisposeObservable: Observable<Node>;
  95272. private _onDisposeObserver;
  95273. /**
  95274. * Sets a callback that will be raised when the node will be disposed
  95275. */
  95276. onDispose: () => void;
  95277. /**
  95278. * Creates a new Node
  95279. * @param name the name and id to be given to this node
  95280. * @param scene the scene this node will be added to
  95281. */
  95282. constructor(name: string, scene?: Nullable<Scene>);
  95283. /**
  95284. * Gets the scene of the node
  95285. * @returns a scene
  95286. */
  95287. getScene(): Scene;
  95288. /**
  95289. * Gets the engine of the node
  95290. * @returns a Engine
  95291. */
  95292. getEngine(): Engine;
  95293. private _behaviors;
  95294. /**
  95295. * Attach a behavior to the node
  95296. * @see http://doc.babylonjs.com/features/behaviour
  95297. * @param behavior defines the behavior to attach
  95298. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  95299. * @returns the current Node
  95300. */
  95301. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  95302. /**
  95303. * Remove an attached behavior
  95304. * @see http://doc.babylonjs.com/features/behaviour
  95305. * @param behavior defines the behavior to attach
  95306. * @returns the current Node
  95307. */
  95308. removeBehavior(behavior: Behavior<Node>): Node;
  95309. /**
  95310. * Gets the list of attached behaviors
  95311. * @see http://doc.babylonjs.com/features/behaviour
  95312. */
  95313. readonly behaviors: Behavior<Node>[];
  95314. /**
  95315. * Gets an attached behavior by name
  95316. * @param name defines the name of the behavior to look for
  95317. * @see http://doc.babylonjs.com/features/behaviour
  95318. * @returns null if behavior was not found else the requested behavior
  95319. */
  95320. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  95321. /**
  95322. * Returns the latest update of the World matrix
  95323. * @returns a Matrix
  95324. */
  95325. getWorldMatrix(): Matrix;
  95326. /** @hidden */
  95327. _getWorldMatrixDeterminant(): number;
  95328. /**
  95329. * Returns directly the latest state of the mesh World matrix.
  95330. * A Matrix is returned.
  95331. */
  95332. readonly worldMatrixFromCache: Matrix;
  95333. /** @hidden */
  95334. _initCache(): void;
  95335. /** @hidden */
  95336. updateCache(force?: boolean): void;
  95337. /** @hidden */
  95338. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  95339. /** @hidden */
  95340. _updateCache(ignoreParentClass?: boolean): void;
  95341. /** @hidden */
  95342. _isSynchronized(): boolean;
  95343. /** @hidden */
  95344. _markSyncedWithParent(): void;
  95345. /** @hidden */
  95346. isSynchronizedWithParent(): boolean;
  95347. /** @hidden */
  95348. isSynchronized(): boolean;
  95349. /**
  95350. * Is this node ready to be used/rendered
  95351. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95352. * @return true if the node is ready
  95353. */
  95354. isReady(completeCheck?: boolean): boolean;
  95355. /**
  95356. * Is this node enabled?
  95357. * If the node has a parent, all ancestors will be checked and false will be returned if any are false (not enabled), otherwise will return true
  95358. * @param checkAncestors indicates if this method should check the ancestors. The default is to check the ancestors. If set to false, the method will return the value of this node without checking ancestors
  95359. * @return whether this node (and its parent) is enabled
  95360. */
  95361. isEnabled(checkAncestors?: boolean): boolean;
  95362. /** @hidden */
  95363. protected _syncParentEnabledState(): void;
  95364. /**
  95365. * Set the enabled state of this node
  95366. * @param value defines the new enabled state
  95367. */
  95368. setEnabled(value: boolean): void;
  95369. /**
  95370. * Is this node a descendant of the given node?
  95371. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  95372. * @param ancestor defines the parent node to inspect
  95373. * @returns a boolean indicating if this node is a descendant of the given node
  95374. */
  95375. isDescendantOf(ancestor: Node): boolean;
  95376. /** @hidden */
  95377. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  95378. /**
  95379. * Will return all nodes that have this node as ascendant
  95380. * @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
  95381. * @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
  95382. * @return all children nodes of all types
  95383. */
  95384. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  95385. /**
  95386. * Get all child-meshes of this node
  95387. * @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 (Default: false)
  95388. * @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
  95389. * @returns an array of AbstractMesh
  95390. */
  95391. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  95392. /**
  95393. * Get all direct children of this node
  95394. * @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
  95395. * @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 (Default: true)
  95396. * @returns an array of Node
  95397. */
  95398. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  95399. /** @hidden */
  95400. _setReady(state: boolean): void;
  95401. /**
  95402. * Get an animation by name
  95403. * @param name defines the name of the animation to look for
  95404. * @returns null if not found else the requested animation
  95405. */
  95406. getAnimationByName(name: string): Nullable<Animation>;
  95407. /**
  95408. * Creates an animation range for this node
  95409. * @param name defines the name of the range
  95410. * @param from defines the starting key
  95411. * @param to defines the end key
  95412. */
  95413. createAnimationRange(name: string, from: number, to: number): void;
  95414. /**
  95415. * Delete a specific animation range
  95416. * @param name defines the name of the range to delete
  95417. * @param deleteFrames defines if animation frames from the range must be deleted as well
  95418. */
  95419. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95420. /**
  95421. * Get an animation range by name
  95422. * @param name defines the name of the animation range to look for
  95423. * @returns null if not found else the requested animation range
  95424. */
  95425. getAnimationRange(name: string): Nullable<AnimationRange>;
  95426. /**
  95427. * Gets the list of all animation ranges defined on this node
  95428. * @returns an array
  95429. */
  95430. getAnimationRanges(): Nullable<AnimationRange>[];
  95431. /**
  95432. * Will start the animation sequence
  95433. * @param name defines the range frames for animation sequence
  95434. * @param loop defines if the animation should loop (false by default)
  95435. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  95436. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  95437. * @returns the object created for this animation. If range does not exist, it will return null
  95438. */
  95439. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95440. /**
  95441. * Serialize animation ranges into a JSON compatible object
  95442. * @returns serialization object
  95443. */
  95444. serializeAnimationRanges(): any;
  95445. /**
  95446. * Computes the world matrix of the node
  95447. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  95448. * @returns the world matrix
  95449. */
  95450. computeWorldMatrix(force?: boolean): Matrix;
  95451. /**
  95452. * Releases resources associated with this node.
  95453. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  95454. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  95455. */
  95456. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95457. /**
  95458. * Parse animation range data from a serialization object and store them into a given node
  95459. * @param node defines where to store the animation ranges
  95460. * @param parsedNode defines the serialization object to read data from
  95461. * @param scene defines the hosting scene
  95462. */
  95463. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  95464. /**
  95465. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  95466. * @param includeDescendants Include bounding info from descendants as well (true by default)
  95467. * @param predicate defines a callback function that can be customize to filter what meshes should be included in the list used to compute the bounding vectors
  95468. * @returns the new bounding vectors
  95469. */
  95470. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  95471. min: Vector3;
  95472. max: Vector3;
  95473. };
  95474. }
  95475. }
  95476. declare module BABYLON {
  95477. /**
  95478. * @hidden
  95479. */
  95480. export class _IAnimationState {
  95481. key: number;
  95482. repeatCount: number;
  95483. workValue?: any;
  95484. loopMode?: number;
  95485. offsetValue?: any;
  95486. highLimitValue?: any;
  95487. }
  95488. /**
  95489. * Class used to store any kind of animation
  95490. */
  95491. export class Animation {
  95492. /**Name of the animation */
  95493. name: string;
  95494. /**Property to animate */
  95495. targetProperty: string;
  95496. /**The frames per second of the animation */
  95497. framePerSecond: number;
  95498. /**The data type of the animation */
  95499. dataType: number;
  95500. /**The loop mode of the animation */
  95501. loopMode?: number | undefined;
  95502. /**Specifies if blending should be enabled */
  95503. enableBlending?: boolean | undefined;
  95504. /**
  95505. * Use matrix interpolation instead of using direct key value when animating matrices
  95506. */
  95507. static AllowMatricesInterpolation: boolean;
  95508. /**
  95509. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  95510. */
  95511. static AllowMatrixDecomposeForInterpolation: boolean;
  95512. /**
  95513. * Stores the key frames of the animation
  95514. */
  95515. private _keys;
  95516. /**
  95517. * Stores the easing function of the animation
  95518. */
  95519. private _easingFunction;
  95520. /**
  95521. * @hidden Internal use only
  95522. */
  95523. _runtimeAnimations: RuntimeAnimation[];
  95524. /**
  95525. * The set of event that will be linked to this animation
  95526. */
  95527. private _events;
  95528. /**
  95529. * Stores an array of target property paths
  95530. */
  95531. targetPropertyPath: string[];
  95532. /**
  95533. * Stores the blending speed of the animation
  95534. */
  95535. blendingSpeed: number;
  95536. /**
  95537. * Stores the animation ranges for the animation
  95538. */
  95539. private _ranges;
  95540. /**
  95541. * @hidden Internal use
  95542. */
  95543. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  95544. /**
  95545. * Sets up an animation
  95546. * @param property The property to animate
  95547. * @param animationType The animation type to apply
  95548. * @param framePerSecond The frames per second of the animation
  95549. * @param easingFunction The easing function used in the animation
  95550. * @returns The created animation
  95551. */
  95552. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  95553. /**
  95554. * Create and start an animation on a node
  95555. * @param name defines the name of the global animation that will be run on all nodes
  95556. * @param node defines the root node where the animation will take place
  95557. * @param targetProperty defines property to animate
  95558. * @param framePerSecond defines the number of frame per second yo use
  95559. * @param totalFrame defines the number of frames in total
  95560. * @param from defines the initial value
  95561. * @param to defines the final value
  95562. * @param loopMode defines which loop mode you want to use (off by default)
  95563. * @param easingFunction defines the easing function to use (linear by default)
  95564. * @param onAnimationEnd defines the callback to call when animation end
  95565. * @returns the animatable created for this animation
  95566. */
  95567. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  95568. /**
  95569. * Create and start an animation on a node and its descendants
  95570. * @param name defines the name of the global animation that will be run on all nodes
  95571. * @param node defines the root node where the animation will take place
  95572. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used
  95573. * @param targetProperty defines property to animate
  95574. * @param framePerSecond defines the number of frame per second to use
  95575. * @param totalFrame defines the number of frames in total
  95576. * @param from defines the initial value
  95577. * @param to defines the final value
  95578. * @param loopMode defines which loop mode you want to use (off by default)
  95579. * @param easingFunction defines the easing function to use (linear by default)
  95580. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95581. * @returns the list of animatables created for all nodes
  95582. * @example https://www.babylonjs-playground.com/#MH0VLI
  95583. */
  95584. static CreateAndStartHierarchyAnimation(name: string, node: Node, directDescendantsOnly: boolean, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable[]>;
  95585. /**
  95586. * Creates a new animation, merges it with the existing animations and starts it
  95587. * @param name Name of the animation
  95588. * @param node Node which contains the scene that begins the animations
  95589. * @param targetProperty Specifies which property to animate
  95590. * @param framePerSecond The frames per second of the animation
  95591. * @param totalFrame The total number of frames
  95592. * @param from The frame at the beginning of the animation
  95593. * @param to The frame at the end of the animation
  95594. * @param loopMode Specifies the loop mode of the animation
  95595. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  95596. * @param onAnimationEnd Callback to run once the animation is complete
  95597. * @returns Nullable animation
  95598. */
  95599. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  95600. /**
  95601. * Transition property of an host to the target Value
  95602. * @param property The property to transition
  95603. * @param targetValue The target Value of the property
  95604. * @param host The object where the property to animate belongs
  95605. * @param scene Scene used to run the animation
  95606. * @param frameRate Framerate (in frame/s) to use
  95607. * @param transition The transition type we want to use
  95608. * @param duration The duration of the animation, in milliseconds
  95609. * @param onAnimationEnd Callback trigger at the end of the animation
  95610. * @returns Nullable animation
  95611. */
  95612. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  95613. /**
  95614. * Return the array of runtime animations currently using this animation
  95615. */
  95616. readonly runtimeAnimations: RuntimeAnimation[];
  95617. /**
  95618. * Specifies if any of the runtime animations are currently running
  95619. */
  95620. readonly hasRunningRuntimeAnimations: boolean;
  95621. /**
  95622. * Initializes the animation
  95623. * @param name Name of the animation
  95624. * @param targetProperty Property to animate
  95625. * @param framePerSecond The frames per second of the animation
  95626. * @param dataType The data type of the animation
  95627. * @param loopMode The loop mode of the animation
  95628. * @param enableBlending Specifies if blending should be enabled
  95629. */
  95630. constructor(
  95631. /**Name of the animation */
  95632. name: string,
  95633. /**Property to animate */
  95634. targetProperty: string,
  95635. /**The frames per second of the animation */
  95636. framePerSecond: number,
  95637. /**The data type of the animation */
  95638. dataType: number,
  95639. /**The loop mode of the animation */
  95640. loopMode?: number | undefined,
  95641. /**Specifies if blending should be enabled */
  95642. enableBlending?: boolean | undefined);
  95643. /**
  95644. * Converts the animation to a string
  95645. * @param fullDetails support for multiple levels of logging within scene loading
  95646. * @returns String form of the animation
  95647. */
  95648. toString(fullDetails?: boolean): string;
  95649. /**
  95650. * Add an event to this animation
  95651. * @param event Event to add
  95652. */
  95653. addEvent(event: AnimationEvent): void;
  95654. /**
  95655. * Remove all events found at the given frame
  95656. * @param frame The frame to remove events from
  95657. */
  95658. removeEvents(frame: number): void;
  95659. /**
  95660. * Retrieves all the events from the animation
  95661. * @returns Events from the animation
  95662. */
  95663. getEvents(): AnimationEvent[];
  95664. /**
  95665. * Creates an animation range
  95666. * @param name Name of the animation range
  95667. * @param from Starting frame of the animation range
  95668. * @param to Ending frame of the animation
  95669. */
  95670. createRange(name: string, from: number, to: number): void;
  95671. /**
  95672. * Deletes an animation range by name
  95673. * @param name Name of the animation range to delete
  95674. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  95675. */
  95676. deleteRange(name: string, deleteFrames?: boolean): void;
  95677. /**
  95678. * Gets the animation range by name, or null if not defined
  95679. * @param name Name of the animation range
  95680. * @returns Nullable animation range
  95681. */
  95682. getRange(name: string): Nullable<AnimationRange>;
  95683. /**
  95684. * Gets the key frames from the animation
  95685. * @returns The key frames of the animation
  95686. */
  95687. getKeys(): Array<IAnimationKey>;
  95688. /**
  95689. * Gets the highest frame rate of the animation
  95690. * @returns Highest frame rate of the animation
  95691. */
  95692. getHighestFrame(): number;
  95693. /**
  95694. * Gets the easing function of the animation
  95695. * @returns Easing function of the animation
  95696. */
  95697. getEasingFunction(): IEasingFunction;
  95698. /**
  95699. * Sets the easing function of the animation
  95700. * @param easingFunction A custom mathematical formula for animation
  95701. */
  95702. setEasingFunction(easingFunction: EasingFunction): void;
  95703. /**
  95704. * Interpolates a scalar linearly
  95705. * @param startValue Start value of the animation curve
  95706. * @param endValue End value of the animation curve
  95707. * @param gradient Scalar amount to interpolate
  95708. * @returns Interpolated scalar value
  95709. */
  95710. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  95711. /**
  95712. * Interpolates a scalar cubically
  95713. * @param startValue Start value of the animation curve
  95714. * @param outTangent End tangent of the animation
  95715. * @param endValue End value of the animation curve
  95716. * @param inTangent Start tangent of the animation curve
  95717. * @param gradient Scalar amount to interpolate
  95718. * @returns Interpolated scalar value
  95719. */
  95720. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  95721. /**
  95722. * Interpolates a quaternion using a spherical linear interpolation
  95723. * @param startValue Start value of the animation curve
  95724. * @param endValue End value of the animation curve
  95725. * @param gradient Scalar amount to interpolate
  95726. * @returns Interpolated quaternion value
  95727. */
  95728. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  95729. /**
  95730. * Interpolates a quaternion cubically
  95731. * @param startValue Start value of the animation curve
  95732. * @param outTangent End tangent of the animation curve
  95733. * @param endValue End value of the animation curve
  95734. * @param inTangent Start tangent of the animation curve
  95735. * @param gradient Scalar amount to interpolate
  95736. * @returns Interpolated quaternion value
  95737. */
  95738. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  95739. /**
  95740. * Interpolates a Vector3 linearl
  95741. * @param startValue Start value of the animation curve
  95742. * @param endValue End value of the animation curve
  95743. * @param gradient Scalar amount to interpolate
  95744. * @returns Interpolated scalar value
  95745. */
  95746. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  95747. /**
  95748. * Interpolates a Vector3 cubically
  95749. * @param startValue Start value of the animation curve
  95750. * @param outTangent End tangent of the animation
  95751. * @param endValue End value of the animation curve
  95752. * @param inTangent Start tangent of the animation curve
  95753. * @param gradient Scalar amount to interpolate
  95754. * @returns InterpolatedVector3 value
  95755. */
  95756. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  95757. /**
  95758. * Interpolates a Vector2 linearly
  95759. * @param startValue Start value of the animation curve
  95760. * @param endValue End value of the animation curve
  95761. * @param gradient Scalar amount to interpolate
  95762. * @returns Interpolated Vector2 value
  95763. */
  95764. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  95765. /**
  95766. * Interpolates a Vector2 cubically
  95767. * @param startValue Start value of the animation curve
  95768. * @param outTangent End tangent of the animation
  95769. * @param endValue End value of the animation curve
  95770. * @param inTangent Start tangent of the animation curve
  95771. * @param gradient Scalar amount to interpolate
  95772. * @returns Interpolated Vector2 value
  95773. */
  95774. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  95775. /**
  95776. * Interpolates a size linearly
  95777. * @param startValue Start value of the animation curve
  95778. * @param endValue End value of the animation curve
  95779. * @param gradient Scalar amount to interpolate
  95780. * @returns Interpolated Size value
  95781. */
  95782. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  95783. /**
  95784. * Interpolates a Color3 linearly
  95785. * @param startValue Start value of the animation curve
  95786. * @param endValue End value of the animation curve
  95787. * @param gradient Scalar amount to interpolate
  95788. * @returns Interpolated Color3 value
  95789. */
  95790. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  95791. /**
  95792. * Interpolates a Color4 linearly
  95793. * @param startValue Start value of the animation curve
  95794. * @param endValue End value of the animation curve
  95795. * @param gradient Scalar amount to interpolate
  95796. * @returns Interpolated Color3 value
  95797. */
  95798. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  95799. /**
  95800. * @hidden Internal use only
  95801. */
  95802. _getKeyValue(value: any): any;
  95803. /**
  95804. * @hidden Internal use only
  95805. */
  95806. _interpolate(currentFrame: number, state: _IAnimationState): any;
  95807. /**
  95808. * Defines the function to use to interpolate matrices
  95809. * @param startValue defines the start matrix
  95810. * @param endValue defines the end matrix
  95811. * @param gradient defines the gradient between both matrices
  95812. * @param result defines an optional target matrix where to store the interpolation
  95813. * @returns the interpolated matrix
  95814. */
  95815. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  95816. /**
  95817. * Makes a copy of the animation
  95818. * @returns Cloned animation
  95819. */
  95820. clone(): Animation;
  95821. /**
  95822. * Sets the key frames of the animation
  95823. * @param values The animation key frames to set
  95824. */
  95825. setKeys(values: Array<IAnimationKey>): void;
  95826. /**
  95827. * Serializes the animation to an object
  95828. * @returns Serialized object
  95829. */
  95830. serialize(): any;
  95831. /**
  95832. * Float animation type
  95833. */
  95834. static readonly ANIMATIONTYPE_FLOAT: number;
  95835. /**
  95836. * Vector3 animation type
  95837. */
  95838. static readonly ANIMATIONTYPE_VECTOR3: number;
  95839. /**
  95840. * Quaternion animation type
  95841. */
  95842. static readonly ANIMATIONTYPE_QUATERNION: number;
  95843. /**
  95844. * Matrix animation type
  95845. */
  95846. static readonly ANIMATIONTYPE_MATRIX: number;
  95847. /**
  95848. * Color3 animation type
  95849. */
  95850. static readonly ANIMATIONTYPE_COLOR3: number;
  95851. /**
  95852. * Color3 animation type
  95853. */
  95854. static readonly ANIMATIONTYPE_COLOR4: number;
  95855. /**
  95856. * Vector2 animation type
  95857. */
  95858. static readonly ANIMATIONTYPE_VECTOR2: number;
  95859. /**
  95860. * Size animation type
  95861. */
  95862. static readonly ANIMATIONTYPE_SIZE: number;
  95863. /**
  95864. * Relative Loop Mode
  95865. */
  95866. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  95867. /**
  95868. * Cycle Loop Mode
  95869. */
  95870. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  95871. /**
  95872. * Constant Loop Mode
  95873. */
  95874. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  95875. /** @hidden */
  95876. static _UniversalLerp(left: any, right: any, amount: number): any;
  95877. /**
  95878. * Parses an animation object and creates an animation
  95879. * @param parsedAnimation Parsed animation object
  95880. * @returns Animation object
  95881. */
  95882. static Parse(parsedAnimation: any): Animation;
  95883. /**
  95884. * Appends the serialized animations from the source animations
  95885. * @param source Source containing the animations
  95886. * @param destination Target to store the animations
  95887. */
  95888. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  95889. }
  95890. }
  95891. declare module BABYLON {
  95892. /**
  95893. * Interface containing an array of animations
  95894. */
  95895. export interface IAnimatable {
  95896. /**
  95897. * Array of animations
  95898. */
  95899. animations: Nullable<Array<Animation>>;
  95900. }
  95901. }
  95902. declare module BABYLON {
  95903. /**
  95904. * This represents all the required information to add a fresnel effect on a material:
  95905. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  95906. */
  95907. export class FresnelParameters {
  95908. private _isEnabled;
  95909. /**
  95910. * Define if the fresnel effect is enable or not.
  95911. */
  95912. isEnabled: boolean;
  95913. /**
  95914. * Define the color used on edges (grazing angle)
  95915. */
  95916. leftColor: Color3;
  95917. /**
  95918. * Define the color used on center
  95919. */
  95920. rightColor: Color3;
  95921. /**
  95922. * Define bias applied to computed fresnel term
  95923. */
  95924. bias: number;
  95925. /**
  95926. * Defined the power exponent applied to fresnel term
  95927. */
  95928. power: number;
  95929. /**
  95930. * Clones the current fresnel and its valuues
  95931. * @returns a clone fresnel configuration
  95932. */
  95933. clone(): FresnelParameters;
  95934. /**
  95935. * Serializes the current fresnel parameters to a JSON representation.
  95936. * @return the JSON serialization
  95937. */
  95938. serialize(): any;
  95939. /**
  95940. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  95941. * @param parsedFresnelParameters Define the JSON representation
  95942. * @returns the parsed parameters
  95943. */
  95944. static Parse(parsedFresnelParameters: any): FresnelParameters;
  95945. }
  95946. }
  95947. declare module BABYLON {
  95948. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  95949. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95950. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95951. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95952. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95953. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95954. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95955. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95956. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95957. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95958. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95959. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95960. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95961. /**
  95962. * Decorator used to define property that can be serialized as reference to a camera
  95963. * @param sourceName defines the name of the property to decorate
  95964. */
  95965. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  95966. /**
  95967. * Class used to help serialization objects
  95968. */
  95969. export class SerializationHelper {
  95970. /** @hidden */
  95971. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  95972. /** @hidden */
  95973. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  95974. /** @hidden */
  95975. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  95976. /** @hidden */
  95977. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  95978. /**
  95979. * Appends the serialized animations from the source animations
  95980. * @param source Source containing the animations
  95981. * @param destination Target to store the animations
  95982. */
  95983. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  95984. /**
  95985. * Static function used to serialized a specific entity
  95986. * @param entity defines the entity to serialize
  95987. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  95988. * @returns a JSON compatible object representing the serialization of the entity
  95989. */
  95990. static Serialize<T>(entity: T, serializationObject?: any): any;
  95991. /**
  95992. * Creates a new entity from a serialization data object
  95993. * @param creationFunction defines a function used to instanciated the new entity
  95994. * @param source defines the source serialization data
  95995. * @param scene defines the hosting scene
  95996. * @param rootUrl defines the root url for resources
  95997. * @returns a new entity
  95998. */
  95999. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  96000. /**
  96001. * Clones an object
  96002. * @param creationFunction defines the function used to instanciate the new object
  96003. * @param source defines the source object
  96004. * @returns the cloned object
  96005. */
  96006. static Clone<T>(creationFunction: () => T, source: T): T;
  96007. /**
  96008. * Instanciates a new object based on a source one (some data will be shared between both object)
  96009. * @param creationFunction defines the function used to instanciate the new object
  96010. * @param source defines the source object
  96011. * @returns the new object
  96012. */
  96013. static Instanciate<T>(creationFunction: () => T, source: T): T;
  96014. }
  96015. }
  96016. declare module BABYLON {
  96017. /**
  96018. * Class used to manipulate GUIDs
  96019. */
  96020. export class GUID {
  96021. /**
  96022. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  96023. * Be aware Math.random() could cause collisions, but:
  96024. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  96025. * @returns a pseudo random id
  96026. */
  96027. static RandomId(): string;
  96028. }
  96029. }
  96030. declare module BABYLON {
  96031. /**
  96032. * Base class of all the textures in babylon.
  96033. * It groups all the common properties the materials, post process, lights... might need
  96034. * in order to make a correct use of the texture.
  96035. */
  96036. export class BaseTexture implements IAnimatable {
  96037. /**
  96038. * Default anisotropic filtering level for the application.
  96039. * It is set to 4 as a good tradeoff between perf and quality.
  96040. */
  96041. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  96042. /**
  96043. * Gets or sets the unique id of the texture
  96044. */
  96045. uniqueId: number;
  96046. /**
  96047. * Define the name of the texture.
  96048. */
  96049. name: string;
  96050. /**
  96051. * Gets or sets an object used to store user defined information.
  96052. */
  96053. metadata: any;
  96054. /**
  96055. * For internal use only. Please do not use.
  96056. */
  96057. reservedDataStore: any;
  96058. private _hasAlpha;
  96059. /**
  96060. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  96061. */
  96062. hasAlpha: boolean;
  96063. /**
  96064. * Defines if the alpha value should be determined via the rgb values.
  96065. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  96066. */
  96067. getAlphaFromRGB: boolean;
  96068. /**
  96069. * Intensity or strength of the texture.
  96070. * It is commonly used by materials to fine tune the intensity of the texture
  96071. */
  96072. level: number;
  96073. /**
  96074. * Define the UV chanel to use starting from 0 and defaulting to 0.
  96075. * This is part of the texture as textures usually maps to one uv set.
  96076. */
  96077. coordinatesIndex: number;
  96078. private _coordinatesMode;
  96079. /**
  96080. * How a texture is mapped.
  96081. *
  96082. * | Value | Type | Description |
  96083. * | ----- | ----------------------------------- | ----------- |
  96084. * | 0 | EXPLICIT_MODE | |
  96085. * | 1 | SPHERICAL_MODE | |
  96086. * | 2 | PLANAR_MODE | |
  96087. * | 3 | CUBIC_MODE | |
  96088. * | 4 | PROJECTION_MODE | |
  96089. * | 5 | SKYBOX_MODE | |
  96090. * | 6 | INVCUBIC_MODE | |
  96091. * | 7 | EQUIRECTANGULAR_MODE | |
  96092. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  96093. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  96094. */
  96095. coordinatesMode: number;
  96096. /**
  96097. * | Value | Type | Description |
  96098. * | ----- | ------------------ | ----------- |
  96099. * | 0 | CLAMP_ADDRESSMODE | |
  96100. * | 1 | WRAP_ADDRESSMODE | |
  96101. * | 2 | MIRROR_ADDRESSMODE | |
  96102. */
  96103. wrapU: number;
  96104. /**
  96105. * | Value | Type | Description |
  96106. * | ----- | ------------------ | ----------- |
  96107. * | 0 | CLAMP_ADDRESSMODE | |
  96108. * | 1 | WRAP_ADDRESSMODE | |
  96109. * | 2 | MIRROR_ADDRESSMODE | |
  96110. */
  96111. wrapV: number;
  96112. /**
  96113. * | Value | Type | Description |
  96114. * | ----- | ------------------ | ----------- |
  96115. * | 0 | CLAMP_ADDRESSMODE | |
  96116. * | 1 | WRAP_ADDRESSMODE | |
  96117. * | 2 | MIRROR_ADDRESSMODE | |
  96118. */
  96119. wrapR: number;
  96120. /**
  96121. * With compliant hardware and browser (supporting anisotropic filtering)
  96122. * this defines the level of anisotropic filtering in the texture.
  96123. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  96124. */
  96125. anisotropicFilteringLevel: number;
  96126. /**
  96127. * Define if the texture is a cube texture or if false a 2d texture.
  96128. */
  96129. isCube: boolean;
  96130. /**
  96131. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  96132. */
  96133. is3D: boolean;
  96134. /**
  96135. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  96136. */
  96137. is2DArray: boolean;
  96138. /**
  96139. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  96140. * HDR texture are usually stored in linear space.
  96141. * This only impacts the PBR and Background materials
  96142. */
  96143. gammaSpace: boolean;
  96144. /**
  96145. * Gets or sets whether or not the texture contains RGBD data.
  96146. */
  96147. isRGBD: boolean;
  96148. /**
  96149. * Is Z inverted in the texture (useful in a cube texture).
  96150. */
  96151. invertZ: boolean;
  96152. /**
  96153. * Are mip maps generated for this texture or not.
  96154. */
  96155. readonly noMipmap: boolean;
  96156. /**
  96157. * @hidden
  96158. */
  96159. lodLevelInAlpha: boolean;
  96160. /**
  96161. * With prefiltered texture, defined the offset used during the prefiltering steps.
  96162. */
  96163. lodGenerationOffset: number;
  96164. /**
  96165. * With prefiltered texture, defined the scale used during the prefiltering steps.
  96166. */
  96167. lodGenerationScale: number;
  96168. /**
  96169. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  96170. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  96171. * average roughness values.
  96172. */
  96173. linearSpecularLOD: boolean;
  96174. /**
  96175. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  96176. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  96177. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  96178. */
  96179. irradianceTexture: Nullable<BaseTexture>;
  96180. /**
  96181. * Define if the texture is a render target.
  96182. */
  96183. isRenderTarget: boolean;
  96184. /**
  96185. * Define the unique id of the texture in the scene.
  96186. */
  96187. readonly uid: string;
  96188. /**
  96189. * Return a string representation of the texture.
  96190. * @returns the texture as a string
  96191. */
  96192. toString(): string;
  96193. /**
  96194. * Get the class name of the texture.
  96195. * @returns "BaseTexture"
  96196. */
  96197. getClassName(): string;
  96198. /**
  96199. * Define the list of animation attached to the texture.
  96200. */
  96201. animations: Animation[];
  96202. /**
  96203. * An event triggered when the texture is disposed.
  96204. */
  96205. onDisposeObservable: Observable<BaseTexture>;
  96206. private _onDisposeObserver;
  96207. /**
  96208. * Callback triggered when the texture has been disposed.
  96209. * Kept for back compatibility, you can use the onDisposeObservable instead.
  96210. */
  96211. onDispose: () => void;
  96212. /**
  96213. * Define the current state of the loading sequence when in delayed load mode.
  96214. */
  96215. delayLoadState: number;
  96216. private _scene;
  96217. /** @hidden */
  96218. _texture: Nullable<InternalTexture>;
  96219. private _uid;
  96220. /**
  96221. * Define if the texture is preventinga material to render or not.
  96222. * If not and the texture is not ready, the engine will use a default black texture instead.
  96223. */
  96224. readonly isBlocking: boolean;
  96225. /**
  96226. * Instantiates a new BaseTexture.
  96227. * Base class of all the textures in babylon.
  96228. * It groups all the common properties the materials, post process, lights... might need
  96229. * in order to make a correct use of the texture.
  96230. * @param scene Define the scene the texture blongs to
  96231. */
  96232. constructor(scene: Nullable<Scene>);
  96233. /**
  96234. * Get the scene the texture belongs to.
  96235. * @returns the scene or null if undefined
  96236. */
  96237. getScene(): Nullable<Scene>;
  96238. /**
  96239. * Get the texture transform matrix used to offset tile the texture for istance.
  96240. * @returns the transformation matrix
  96241. */
  96242. getTextureMatrix(): Matrix;
  96243. /**
  96244. * Get the texture reflection matrix used to rotate/transform the reflection.
  96245. * @returns the reflection matrix
  96246. */
  96247. getReflectionTextureMatrix(): Matrix;
  96248. /**
  96249. * Get the underlying lower level texture from Babylon.
  96250. * @returns the insternal texture
  96251. */
  96252. getInternalTexture(): Nullable<InternalTexture>;
  96253. /**
  96254. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  96255. * @returns true if ready or not blocking
  96256. */
  96257. isReadyOrNotBlocking(): boolean;
  96258. /**
  96259. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  96260. * @returns true if fully ready
  96261. */
  96262. isReady(): boolean;
  96263. private _cachedSize;
  96264. /**
  96265. * Get the size of the texture.
  96266. * @returns the texture size.
  96267. */
  96268. getSize(): ISize;
  96269. /**
  96270. * Get the base size of the texture.
  96271. * It can be different from the size if the texture has been resized for POT for instance
  96272. * @returns the base size
  96273. */
  96274. getBaseSize(): ISize;
  96275. /**
  96276. * Update the sampling mode of the texture.
  96277. * Default is Trilinear mode.
  96278. *
  96279. * | Value | Type | Description |
  96280. * | ----- | ------------------ | ----------- |
  96281. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  96282. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  96283. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  96284. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  96285. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  96286. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  96287. * | 7 | NEAREST_LINEAR | |
  96288. * | 8 | NEAREST_NEAREST | |
  96289. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  96290. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  96291. * | 11 | LINEAR_LINEAR | |
  96292. * | 12 | LINEAR_NEAREST | |
  96293. *
  96294. * > _mag_: magnification filter (close to the viewer)
  96295. * > _min_: minification filter (far from the viewer)
  96296. * > _mip_: filter used between mip map levels
  96297. *@param samplingMode Define the new sampling mode of the texture
  96298. */
  96299. updateSamplingMode(samplingMode: number): void;
  96300. /**
  96301. * Scales the texture if is `canRescale()`
  96302. * @param ratio the resize factor we want to use to rescale
  96303. */
  96304. scale(ratio: number): void;
  96305. /**
  96306. * Get if the texture can rescale.
  96307. */
  96308. readonly canRescale: boolean;
  96309. /** @hidden */
  96310. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  96311. /** @hidden */
  96312. _rebuild(): void;
  96313. /**
  96314. * Triggers the load sequence in delayed load mode.
  96315. */
  96316. delayLoad(): void;
  96317. /**
  96318. * Clones the texture.
  96319. * @returns the cloned texture
  96320. */
  96321. clone(): Nullable<BaseTexture>;
  96322. /**
  96323. * Get the texture underlying type (INT, FLOAT...)
  96324. */
  96325. readonly textureType: number;
  96326. /**
  96327. * Get the texture underlying format (RGB, RGBA...)
  96328. */
  96329. readonly textureFormat: number;
  96330. /**
  96331. * Indicates that textures need to be re-calculated for all materials
  96332. */
  96333. protected _markAllSubMeshesAsTexturesDirty(): void;
  96334. /**
  96335. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  96336. * This will returns an RGBA array buffer containing either in values (0-255) or
  96337. * float values (0-1) depending of the underlying buffer type.
  96338. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  96339. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  96340. * @param buffer defines a user defined buffer to fill with data (can be null)
  96341. * @returns The Array buffer containing the pixels data.
  96342. */
  96343. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  96344. /**
  96345. * Release and destroy the underlying lower level texture aka internalTexture.
  96346. */
  96347. releaseInternalTexture(): void;
  96348. /** @hidden */
  96349. readonly _lodTextureHigh: Nullable<BaseTexture>;
  96350. /** @hidden */
  96351. readonly _lodTextureMid: Nullable<BaseTexture>;
  96352. /** @hidden */
  96353. readonly _lodTextureLow: Nullable<BaseTexture>;
  96354. /**
  96355. * Dispose the texture and release its associated resources.
  96356. */
  96357. dispose(): void;
  96358. /**
  96359. * Serialize the texture into a JSON representation that can be parsed later on.
  96360. * @returns the JSON representation of the texture
  96361. */
  96362. serialize(): any;
  96363. /**
  96364. * Helper function to be called back once a list of texture contains only ready textures.
  96365. * @param textures Define the list of textures to wait for
  96366. * @param callback Define the callback triggered once the entire list will be ready
  96367. */
  96368. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  96369. }
  96370. }
  96371. declare module BABYLON {
  96372. /**
  96373. * Options to be used when creating an effect.
  96374. */
  96375. export interface IEffectCreationOptions {
  96376. /**
  96377. * Atrributes that will be used in the shader.
  96378. */
  96379. attributes: string[];
  96380. /**
  96381. * Uniform varible names that will be set in the shader.
  96382. */
  96383. uniformsNames: string[];
  96384. /**
  96385. * Uniform buffer varible names that will be set in the shader.
  96386. */
  96387. uniformBuffersNames: string[];
  96388. /**
  96389. * Sampler texture variable names that will be set in the shader.
  96390. */
  96391. samplers: string[];
  96392. /**
  96393. * Define statements that will be set in the shader.
  96394. */
  96395. defines: any;
  96396. /**
  96397. * Possible fallbacks for this effect to improve performance when needed.
  96398. */
  96399. fallbacks: Nullable<IEffectFallbacks>;
  96400. /**
  96401. * Callback that will be called when the shader is compiled.
  96402. */
  96403. onCompiled: Nullable<(effect: Effect) => void>;
  96404. /**
  96405. * Callback that will be called if an error occurs during shader compilation.
  96406. */
  96407. onError: Nullable<(effect: Effect, errors: string) => void>;
  96408. /**
  96409. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  96410. */
  96411. indexParameters?: any;
  96412. /**
  96413. * Max number of lights that can be used in the shader.
  96414. */
  96415. maxSimultaneousLights?: number;
  96416. /**
  96417. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  96418. */
  96419. transformFeedbackVaryings?: Nullable<string[]>;
  96420. }
  96421. /**
  96422. * Effect containing vertex and fragment shader that can be executed on an object.
  96423. */
  96424. export class Effect implements IDisposable {
  96425. /**
  96426. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  96427. */
  96428. static ShadersRepository: string;
  96429. /**
  96430. * Name of the effect.
  96431. */
  96432. name: any;
  96433. /**
  96434. * String container all the define statements that should be set on the shader.
  96435. */
  96436. defines: string;
  96437. /**
  96438. * Callback that will be called when the shader is compiled.
  96439. */
  96440. onCompiled: Nullable<(effect: Effect) => void>;
  96441. /**
  96442. * Callback that will be called if an error occurs during shader compilation.
  96443. */
  96444. onError: Nullable<(effect: Effect, errors: string) => void>;
  96445. /**
  96446. * Callback that will be called when effect is bound.
  96447. */
  96448. onBind: Nullable<(effect: Effect) => void>;
  96449. /**
  96450. * Unique ID of the effect.
  96451. */
  96452. uniqueId: number;
  96453. /**
  96454. * Observable that will be called when the shader is compiled.
  96455. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  96456. */
  96457. onCompileObservable: Observable<Effect>;
  96458. /**
  96459. * Observable that will be called if an error occurs during shader compilation.
  96460. */
  96461. onErrorObservable: Observable<Effect>;
  96462. /** @hidden */
  96463. _onBindObservable: Nullable<Observable<Effect>>;
  96464. /**
  96465. * Observable that will be called when effect is bound.
  96466. */
  96467. readonly onBindObservable: Observable<Effect>;
  96468. /** @hidden */
  96469. _bonesComputationForcedToCPU: boolean;
  96470. private static _uniqueIdSeed;
  96471. private _engine;
  96472. private _uniformBuffersNames;
  96473. private _uniformsNames;
  96474. private _samplerList;
  96475. private _samplers;
  96476. private _isReady;
  96477. private _compilationError;
  96478. private _allFallbacksProcessed;
  96479. private _attributesNames;
  96480. private _attributes;
  96481. private _uniforms;
  96482. /**
  96483. * Key for the effect.
  96484. * @hidden
  96485. */
  96486. _key: string;
  96487. private _indexParameters;
  96488. private _fallbacks;
  96489. private _vertexSourceCode;
  96490. private _fragmentSourceCode;
  96491. private _vertexSourceCodeOverride;
  96492. private _fragmentSourceCodeOverride;
  96493. private _transformFeedbackVaryings;
  96494. /**
  96495. * Compiled shader to webGL program.
  96496. * @hidden
  96497. */
  96498. _pipelineContext: Nullable<IPipelineContext>;
  96499. private _valueCache;
  96500. private static _baseCache;
  96501. /**
  96502. * Instantiates an effect.
  96503. * An effect can be used to create/manage/execute vertex and fragment shaders.
  96504. * @param baseName Name of the effect.
  96505. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  96506. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  96507. * @param samplers List of sampler variables that will be passed to the shader.
  96508. * @param engine Engine to be used to render the effect
  96509. * @param defines Define statements to be added to the shader.
  96510. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  96511. * @param onCompiled Callback that will be called when the shader is compiled.
  96512. * @param onError Callback that will be called if an error occurs during shader compilation.
  96513. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  96514. */
  96515. constructor(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: Nullable<string[]>, engine?: ThinEngine, defines?: Nullable<string>, fallbacks?: Nullable<IEffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  96516. private _useFinalCode;
  96517. /**
  96518. * Unique key for this effect
  96519. */
  96520. readonly key: string;
  96521. /**
  96522. * If the effect has been compiled and prepared.
  96523. * @returns if the effect is compiled and prepared.
  96524. */
  96525. isReady(): boolean;
  96526. private _isReadyInternal;
  96527. /**
  96528. * The engine the effect was initialized with.
  96529. * @returns the engine.
  96530. */
  96531. getEngine(): Engine;
  96532. /**
  96533. * The pipeline context for this effect
  96534. * @returns the associated pipeline context
  96535. */
  96536. getPipelineContext(): Nullable<IPipelineContext>;
  96537. /**
  96538. * The set of names of attribute variables for the shader.
  96539. * @returns An array of attribute names.
  96540. */
  96541. getAttributesNames(): string[];
  96542. /**
  96543. * Returns the attribute at the given index.
  96544. * @param index The index of the attribute.
  96545. * @returns The location of the attribute.
  96546. */
  96547. getAttributeLocation(index: number): number;
  96548. /**
  96549. * Returns the attribute based on the name of the variable.
  96550. * @param name of the attribute to look up.
  96551. * @returns the attribute location.
  96552. */
  96553. getAttributeLocationByName(name: string): number;
  96554. /**
  96555. * The number of attributes.
  96556. * @returns the numnber of attributes.
  96557. */
  96558. getAttributesCount(): number;
  96559. /**
  96560. * Gets the index of a uniform variable.
  96561. * @param uniformName of the uniform to look up.
  96562. * @returns the index.
  96563. */
  96564. getUniformIndex(uniformName: string): number;
  96565. /**
  96566. * Returns the attribute based on the name of the variable.
  96567. * @param uniformName of the uniform to look up.
  96568. * @returns the location of the uniform.
  96569. */
  96570. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  96571. /**
  96572. * Returns an array of sampler variable names
  96573. * @returns The array of sampler variable neames.
  96574. */
  96575. getSamplers(): string[];
  96576. /**
  96577. * The error from the last compilation.
  96578. * @returns the error string.
  96579. */
  96580. getCompilationError(): string;
  96581. /**
  96582. * Gets a boolean indicating that all fallbacks were used during compilation
  96583. * @returns true if all fallbacks were used
  96584. */
  96585. allFallbacksProcessed(): boolean;
  96586. /**
  96587. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  96588. * @param func The callback to be used.
  96589. */
  96590. executeWhenCompiled(func: (effect: Effect) => void): void;
  96591. private _checkIsReady;
  96592. private _loadShader;
  96593. /**
  96594. * Recompiles the webGL program
  96595. * @param vertexSourceCode The source code for the vertex shader.
  96596. * @param fragmentSourceCode The source code for the fragment shader.
  96597. * @param onCompiled Callback called when completed.
  96598. * @param onError Callback called on error.
  96599. * @hidden
  96600. */
  96601. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  96602. /**
  96603. * Prepares the effect
  96604. * @hidden
  96605. */
  96606. _prepareEffect(): void;
  96607. private _processCompilationErrors;
  96608. /**
  96609. * Checks if the effect is supported. (Must be called after compilation)
  96610. */
  96611. readonly isSupported: boolean;
  96612. /**
  96613. * Binds a texture to the engine to be used as output of the shader.
  96614. * @param channel Name of the output variable.
  96615. * @param texture Texture to bind.
  96616. * @hidden
  96617. */
  96618. _bindTexture(channel: string, texture: InternalTexture): void;
  96619. /**
  96620. * Sets a texture on the engine to be used in the shader.
  96621. * @param channel Name of the sampler variable.
  96622. * @param texture Texture to set.
  96623. */
  96624. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  96625. /**
  96626. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  96627. * @param channel Name of the sampler variable.
  96628. * @param texture Texture to set.
  96629. */
  96630. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  96631. /**
  96632. * Sets an array of textures on the engine to be used in the shader.
  96633. * @param channel Name of the variable.
  96634. * @param textures Textures to set.
  96635. */
  96636. setTextureArray(channel: string, textures: BaseTexture[]): void;
  96637. /**
  96638. * Sets a texture to be the input of the specified post process. (To use the output, pass in the next post process in the pipeline)
  96639. * @param channel Name of the sampler variable.
  96640. * @param postProcess Post process to get the input texture from.
  96641. */
  96642. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  96643. /**
  96644. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  96645. * Sets the input texture of the passed in post process to be input of this effect. (To use the output of the passed in post process use setTextureFromPostProcessOutput)
  96646. * @param channel Name of the sampler variable.
  96647. * @param postProcess Post process to get the output texture from.
  96648. */
  96649. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  96650. /** @hidden */
  96651. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  96652. /** @hidden */
  96653. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  96654. /** @hidden */
  96655. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  96656. /** @hidden */
  96657. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  96658. /**
  96659. * Binds a buffer to a uniform.
  96660. * @param buffer Buffer to bind.
  96661. * @param name Name of the uniform variable to bind to.
  96662. */
  96663. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  96664. /**
  96665. * Binds block to a uniform.
  96666. * @param blockName Name of the block to bind.
  96667. * @param index Index to bind.
  96668. */
  96669. bindUniformBlock(blockName: string, index: number): void;
  96670. /**
  96671. * Sets an interger value on a uniform variable.
  96672. * @param uniformName Name of the variable.
  96673. * @param value Value to be set.
  96674. * @returns this effect.
  96675. */
  96676. setInt(uniformName: string, value: number): Effect;
  96677. /**
  96678. * Sets an int array on a uniform variable.
  96679. * @param uniformName Name of the variable.
  96680. * @param array array to be set.
  96681. * @returns this effect.
  96682. */
  96683. setIntArray(uniformName: string, array: Int32Array): Effect;
  96684. /**
  96685. * Sets an int array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  96686. * @param uniformName Name of the variable.
  96687. * @param array array to be set.
  96688. * @returns this effect.
  96689. */
  96690. setIntArray2(uniformName: string, array: Int32Array): Effect;
  96691. /**
  96692. * Sets an int array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  96693. * @param uniformName Name of the variable.
  96694. * @param array array to be set.
  96695. * @returns this effect.
  96696. */
  96697. setIntArray3(uniformName: string, array: Int32Array): Effect;
  96698. /**
  96699. * Sets an int array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  96700. * @param uniformName Name of the variable.
  96701. * @param array array to be set.
  96702. * @returns this effect.
  96703. */
  96704. setIntArray4(uniformName: string, array: Int32Array): Effect;
  96705. /**
  96706. * Sets an float array on a uniform variable.
  96707. * @param uniformName Name of the variable.
  96708. * @param array array to be set.
  96709. * @returns this effect.
  96710. */
  96711. setFloatArray(uniformName: string, array: Float32Array): Effect;
  96712. /**
  96713. * Sets an float array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  96714. * @param uniformName Name of the variable.
  96715. * @param array array to be set.
  96716. * @returns this effect.
  96717. */
  96718. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  96719. /**
  96720. * Sets an float array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  96721. * @param uniformName Name of the variable.
  96722. * @param array array to be set.
  96723. * @returns this effect.
  96724. */
  96725. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  96726. /**
  96727. * Sets an float array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  96728. * @param uniformName Name of the variable.
  96729. * @param array array to be set.
  96730. * @returns this effect.
  96731. */
  96732. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  96733. /**
  96734. * Sets an array on a uniform variable.
  96735. * @param uniformName Name of the variable.
  96736. * @param array array to be set.
  96737. * @returns this effect.
  96738. */
  96739. setArray(uniformName: string, array: number[]): Effect;
  96740. /**
  96741. * Sets an array 2 on a uniform variable. (Array is specified as single array eg. [1,2,3,4] will result in [[1,2],[3,4]] in the shader)
  96742. * @param uniformName Name of the variable.
  96743. * @param array array to be set.
  96744. * @returns this effect.
  96745. */
  96746. setArray2(uniformName: string, array: number[]): Effect;
  96747. /**
  96748. * Sets an array 3 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6] will result in [[1,2,3],[4,5,6]] in the shader)
  96749. * @param uniformName Name of the variable.
  96750. * @param array array to be set.
  96751. * @returns this effect.
  96752. */
  96753. setArray3(uniformName: string, array: number[]): Effect;
  96754. /**
  96755. * Sets an array 4 on a uniform variable. (Array is specified as single array eg. [1,2,3,4,5,6,7,8] will result in [[1,2,3,4],[5,6,7,8]] in the shader)
  96756. * @param uniformName Name of the variable.
  96757. * @param array array to be set.
  96758. * @returns this effect.
  96759. */
  96760. setArray4(uniformName: string, array: number[]): Effect;
  96761. /**
  96762. * Sets matrices on a uniform variable.
  96763. * @param uniformName Name of the variable.
  96764. * @param matrices matrices to be set.
  96765. * @returns this effect.
  96766. */
  96767. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  96768. /**
  96769. * Sets matrix on a uniform variable.
  96770. * @param uniformName Name of the variable.
  96771. * @param matrix matrix to be set.
  96772. * @returns this effect.
  96773. */
  96774. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  96775. /**
  96776. * Sets a 3x3 matrix on a uniform variable. (Speicified as [1,2,3,4,5,6,7,8,9] will result in [1,2,3][4,5,6][7,8,9] matrix)
  96777. * @param uniformName Name of the variable.
  96778. * @param matrix matrix to be set.
  96779. * @returns this effect.
  96780. */
  96781. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  96782. /**
  96783. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  96784. * @param uniformName Name of the variable.
  96785. * @param matrix matrix to be set.
  96786. * @returns this effect.
  96787. */
  96788. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  96789. /**
  96790. * Sets a float on a uniform variable.
  96791. * @param uniformName Name of the variable.
  96792. * @param value value to be set.
  96793. * @returns this effect.
  96794. */
  96795. setFloat(uniformName: string, value: number): Effect;
  96796. /**
  96797. * Sets a boolean on a uniform variable.
  96798. * @param uniformName Name of the variable.
  96799. * @param bool value to be set.
  96800. * @returns this effect.
  96801. */
  96802. setBool(uniformName: string, bool: boolean): Effect;
  96803. /**
  96804. * Sets a Vector2 on a uniform variable.
  96805. * @param uniformName Name of the variable.
  96806. * @param vector2 vector2 to be set.
  96807. * @returns this effect.
  96808. */
  96809. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  96810. /**
  96811. * Sets a float2 on a uniform variable.
  96812. * @param uniformName Name of the variable.
  96813. * @param x First float in float2.
  96814. * @param y Second float in float2.
  96815. * @returns this effect.
  96816. */
  96817. setFloat2(uniformName: string, x: number, y: number): Effect;
  96818. /**
  96819. * Sets a Vector3 on a uniform variable.
  96820. * @param uniformName Name of the variable.
  96821. * @param vector3 Value to be set.
  96822. * @returns this effect.
  96823. */
  96824. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  96825. /**
  96826. * Sets a float3 on a uniform variable.
  96827. * @param uniformName Name of the variable.
  96828. * @param x First float in float3.
  96829. * @param y Second float in float3.
  96830. * @param z Third float in float3.
  96831. * @returns this effect.
  96832. */
  96833. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  96834. /**
  96835. * Sets a Vector4 on a uniform variable.
  96836. * @param uniformName Name of the variable.
  96837. * @param vector4 Value to be set.
  96838. * @returns this effect.
  96839. */
  96840. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  96841. /**
  96842. * Sets a float4 on a uniform variable.
  96843. * @param uniformName Name of the variable.
  96844. * @param x First float in float4.
  96845. * @param y Second float in float4.
  96846. * @param z Third float in float4.
  96847. * @param w Fourth float in float4.
  96848. * @returns this effect.
  96849. */
  96850. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  96851. /**
  96852. * Sets a Color3 on a uniform variable.
  96853. * @param uniformName Name of the variable.
  96854. * @param color3 Value to be set.
  96855. * @returns this effect.
  96856. */
  96857. setColor3(uniformName: string, color3: IColor3Like): Effect;
  96858. /**
  96859. * Sets a Color4 on a uniform variable.
  96860. * @param uniformName Name of the variable.
  96861. * @param color3 Value to be set.
  96862. * @param alpha Alpha value to be set.
  96863. * @returns this effect.
  96864. */
  96865. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  96866. /**
  96867. * Sets a Color4 on a uniform variable
  96868. * @param uniformName defines the name of the variable
  96869. * @param color4 defines the value to be set
  96870. * @returns this effect.
  96871. */
  96872. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  96873. /** Release all associated resources */
  96874. dispose(): void;
  96875. /**
  96876. * This function will add a new shader to the shader store
  96877. * @param name the name of the shader
  96878. * @param pixelShader optional pixel shader content
  96879. * @param vertexShader optional vertex shader content
  96880. */
  96881. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  96882. /**
  96883. * Store of each shader (The can be looked up using effect.key)
  96884. */
  96885. static ShadersStore: {
  96886. [key: string]: string;
  96887. };
  96888. /**
  96889. * Store of each included file for a shader (The can be looked up using effect.key)
  96890. */
  96891. static IncludesShadersStore: {
  96892. [key: string]: string;
  96893. };
  96894. /**
  96895. * Resets the cache of effects.
  96896. */
  96897. static ResetCache(): void;
  96898. }
  96899. }
  96900. declare module BABYLON {
  96901. /**
  96902. * Interface used to describe the capabilities of the engine relatively to the current browser
  96903. */
  96904. export interface EngineCapabilities {
  96905. /** Maximum textures units per fragment shader */
  96906. maxTexturesImageUnits: number;
  96907. /** Maximum texture units per vertex shader */
  96908. maxVertexTextureImageUnits: number;
  96909. /** Maximum textures units in the entire pipeline */
  96910. maxCombinedTexturesImageUnits: number;
  96911. /** Maximum texture size */
  96912. maxTextureSize: number;
  96913. /** Maximum cube texture size */
  96914. maxCubemapTextureSize: number;
  96915. /** Maximum render texture size */
  96916. maxRenderTextureSize: number;
  96917. /** Maximum number of vertex attributes */
  96918. maxVertexAttribs: number;
  96919. /** Maximum number of varyings */
  96920. maxVaryingVectors: number;
  96921. /** Maximum number of uniforms per vertex shader */
  96922. maxVertexUniformVectors: number;
  96923. /** Maximum number of uniforms per fragment shader */
  96924. maxFragmentUniformVectors: number;
  96925. /** Defines if standard derivates (dx/dy) are supported */
  96926. standardDerivatives: boolean;
  96927. /** Defines if s3tc texture compression is supported */
  96928. s3tc?: WEBGL_compressed_texture_s3tc;
  96929. /** Defines if pvrtc texture compression is supported */
  96930. pvrtc: any;
  96931. /** Defines if etc1 texture compression is supported */
  96932. etc1: any;
  96933. /** Defines if etc2 texture compression is supported */
  96934. etc2: any;
  96935. /** Defines if astc texture compression is supported */
  96936. astc: any;
  96937. /** Defines if float textures are supported */
  96938. textureFloat: boolean;
  96939. /** Defines if vertex array objects are supported */
  96940. vertexArrayObject: boolean;
  96941. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  96942. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  96943. /** Gets the maximum level of anisotropy supported */
  96944. maxAnisotropy: number;
  96945. /** Defines if instancing is supported */
  96946. instancedArrays: boolean;
  96947. /** Defines if 32 bits indices are supported */
  96948. uintIndices: boolean;
  96949. /** Defines if high precision shaders are supported */
  96950. highPrecisionShaderSupported: boolean;
  96951. /** Defines if depth reading in the fragment shader is supported */
  96952. fragmentDepthSupported: boolean;
  96953. /** Defines if float texture linear filtering is supported*/
  96954. textureFloatLinearFiltering: boolean;
  96955. /** Defines if rendering to float textures is supported */
  96956. textureFloatRender: boolean;
  96957. /** Defines if half float textures are supported*/
  96958. textureHalfFloat: boolean;
  96959. /** Defines if half float texture linear filtering is supported*/
  96960. textureHalfFloatLinearFiltering: boolean;
  96961. /** Defines if rendering to half float textures is supported */
  96962. textureHalfFloatRender: boolean;
  96963. /** Defines if textureLOD shader command is supported */
  96964. textureLOD: boolean;
  96965. /** Defines if draw buffers extension is supported */
  96966. drawBuffersExtension: boolean;
  96967. /** Defines if depth textures are supported */
  96968. depthTextureExtension: boolean;
  96969. /** Defines if float color buffer are supported */
  96970. colorBufferFloat: boolean;
  96971. /** Gets disjoint timer query extension (null if not supported) */
  96972. timerQuery?: EXT_disjoint_timer_query;
  96973. /** Defines if timestamp can be used with timer query */
  96974. canUseTimestampForTimerQuery: boolean;
  96975. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  96976. multiview?: any;
  96977. /** Function used to let the system compiles shaders in background */
  96978. parallelShaderCompile?: {
  96979. COMPLETION_STATUS_KHR: number;
  96980. };
  96981. /** Max number of texture samples for MSAA */
  96982. maxMSAASamples: number;
  96983. /** Defines if the blend min max extension is supported */
  96984. blendMinMax: boolean;
  96985. }
  96986. }
  96987. declare module BABYLON {
  96988. /**
  96989. * @hidden
  96990. **/
  96991. export class DepthCullingState {
  96992. private _isDepthTestDirty;
  96993. private _isDepthMaskDirty;
  96994. private _isDepthFuncDirty;
  96995. private _isCullFaceDirty;
  96996. private _isCullDirty;
  96997. private _isZOffsetDirty;
  96998. private _isFrontFaceDirty;
  96999. private _depthTest;
  97000. private _depthMask;
  97001. private _depthFunc;
  97002. private _cull;
  97003. private _cullFace;
  97004. private _zOffset;
  97005. private _frontFace;
  97006. /**
  97007. * Initializes the state.
  97008. */
  97009. constructor();
  97010. readonly isDirty: boolean;
  97011. zOffset: number;
  97012. cullFace: Nullable<number>;
  97013. cull: Nullable<boolean>;
  97014. depthFunc: Nullable<number>;
  97015. depthMask: boolean;
  97016. depthTest: boolean;
  97017. frontFace: Nullable<number>;
  97018. reset(): void;
  97019. apply(gl: WebGLRenderingContext): void;
  97020. }
  97021. }
  97022. declare module BABYLON {
  97023. /**
  97024. * @hidden
  97025. **/
  97026. export class StencilState {
  97027. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  97028. static readonly ALWAYS: number;
  97029. /** Passed to stencilOperation to specify that stencil value must be kept */
  97030. static readonly KEEP: number;
  97031. /** Passed to stencilOperation to specify that stencil value must be replaced */
  97032. static readonly REPLACE: number;
  97033. private _isStencilTestDirty;
  97034. private _isStencilMaskDirty;
  97035. private _isStencilFuncDirty;
  97036. private _isStencilOpDirty;
  97037. private _stencilTest;
  97038. private _stencilMask;
  97039. private _stencilFunc;
  97040. private _stencilFuncRef;
  97041. private _stencilFuncMask;
  97042. private _stencilOpStencilFail;
  97043. private _stencilOpDepthFail;
  97044. private _stencilOpStencilDepthPass;
  97045. readonly isDirty: boolean;
  97046. stencilFunc: number;
  97047. stencilFuncRef: number;
  97048. stencilFuncMask: number;
  97049. stencilOpStencilFail: number;
  97050. stencilOpDepthFail: number;
  97051. stencilOpStencilDepthPass: number;
  97052. stencilMask: number;
  97053. stencilTest: boolean;
  97054. constructor();
  97055. reset(): void;
  97056. apply(gl: WebGLRenderingContext): void;
  97057. }
  97058. }
  97059. declare module BABYLON {
  97060. /**
  97061. * @hidden
  97062. **/
  97063. export class AlphaState {
  97064. private _isAlphaBlendDirty;
  97065. private _isBlendFunctionParametersDirty;
  97066. private _isBlendEquationParametersDirty;
  97067. private _isBlendConstantsDirty;
  97068. private _alphaBlend;
  97069. private _blendFunctionParameters;
  97070. private _blendEquationParameters;
  97071. private _blendConstants;
  97072. /**
  97073. * Initializes the state.
  97074. */
  97075. constructor();
  97076. readonly isDirty: boolean;
  97077. alphaBlend: boolean;
  97078. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  97079. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  97080. setAlphaEquationParameters(rgb: number, alpha: number): void;
  97081. reset(): void;
  97082. apply(gl: WebGLRenderingContext): void;
  97083. }
  97084. }
  97085. declare module BABYLON {
  97086. /** @hidden */
  97087. export class WebGL2ShaderProcessor implements IShaderProcessor {
  97088. attributeProcessor(attribute: string): string;
  97089. varyingProcessor(varying: string, isFragment: boolean): string;
  97090. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  97091. }
  97092. }
  97093. declare module BABYLON {
  97094. /**
  97095. * Interface for attribute information associated with buffer instanciation
  97096. */
  97097. export interface InstancingAttributeInfo {
  97098. /**
  97099. * Index/offset of the attribute in the vertex shader
  97100. */
  97101. index: number;
  97102. /**
  97103. * size of the attribute, 1, 2, 3 or 4
  97104. */
  97105. attributeSize: number;
  97106. /**
  97107. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  97108. * default is FLOAT
  97109. */
  97110. attributeType: number;
  97111. /**
  97112. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  97113. */
  97114. normalized: boolean;
  97115. /**
  97116. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  97117. */
  97118. offset: number;
  97119. /**
  97120. * Name of the GLSL attribute, for debugging purpose only
  97121. */
  97122. attributeName: string;
  97123. }
  97124. }
  97125. declare module BABYLON {
  97126. interface ThinEngine {
  97127. /**
  97128. * Update a video texture
  97129. * @param texture defines the texture to update
  97130. * @param video defines the video element to use
  97131. * @param invertY defines if data must be stored with Y axis inverted
  97132. */
  97133. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  97134. }
  97135. }
  97136. declare module BABYLON {
  97137. /**
  97138. * Settings for finer control over video usage
  97139. */
  97140. export interface VideoTextureSettings {
  97141. /**
  97142. * Applies `autoplay` to video, if specified
  97143. */
  97144. autoPlay?: boolean;
  97145. /**
  97146. * Applies `loop` to video, if specified
  97147. */
  97148. loop?: boolean;
  97149. /**
  97150. * Automatically updates internal texture from video at every frame in the render loop
  97151. */
  97152. autoUpdateTexture: boolean;
  97153. /**
  97154. * Image src displayed during the video loading or until the user interacts with the video.
  97155. */
  97156. poster?: string;
  97157. }
  97158. /**
  97159. * If you want to display a video in your scene, this is the special texture for that.
  97160. * This special texture works similar to other textures, with the exception of a few parameters.
  97161. * @see https://doc.babylonjs.com/how_to/video_texture
  97162. */
  97163. export class VideoTexture extends Texture {
  97164. /**
  97165. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  97166. */
  97167. readonly autoUpdateTexture: boolean;
  97168. /**
  97169. * The video instance used by the texture internally
  97170. */
  97171. readonly video: HTMLVideoElement;
  97172. private _onUserActionRequestedObservable;
  97173. /**
  97174. * Event triggerd when a dom action is required by the user to play the video.
  97175. * This happens due to recent changes in browser policies preventing video to auto start.
  97176. */
  97177. readonly onUserActionRequestedObservable: Observable<Texture>;
  97178. private _generateMipMaps;
  97179. private _engine;
  97180. private _stillImageCaptured;
  97181. private _displayingPosterTexture;
  97182. private _settings;
  97183. private _createInternalTextureOnEvent;
  97184. private _frameId;
  97185. /**
  97186. * Creates a video texture.
  97187. * If you want to display a video in your scene, this is the special texture for that.
  97188. * This special texture works similar to other textures, with the exception of a few parameters.
  97189. * @see https://doc.babylonjs.com/how_to/video_texture
  97190. * @param name optional name, will detect from video source, if not defined
  97191. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  97192. * @param scene is obviously the current scene.
  97193. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  97194. * @param invertY is false by default but can be used to invert video on Y axis
  97195. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  97196. * @param settings allows finer control over video usage
  97197. */
  97198. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  97199. private _getName;
  97200. private _getVideo;
  97201. private _createInternalTexture;
  97202. private reset;
  97203. /**
  97204. * @hidden Internal method to initiate `update`.
  97205. */
  97206. _rebuild(): void;
  97207. /**
  97208. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  97209. */
  97210. update(): void;
  97211. /**
  97212. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  97213. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  97214. */
  97215. updateTexture(isVisible: boolean): void;
  97216. protected _updateInternalTexture: () => void;
  97217. /**
  97218. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  97219. * @param url New url.
  97220. */
  97221. updateURL(url: string): void;
  97222. /**
  97223. * Dispose the texture and release its associated resources.
  97224. */
  97225. dispose(): void;
  97226. /**
  97227. * Creates a video texture straight from a stream.
  97228. * @param scene Define the scene the texture should be created in
  97229. * @param stream Define the stream the texture should be created from
  97230. * @returns The created video texture as a promise
  97231. */
  97232. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  97233. /**
  97234. * Creates a video texture straight from your WebCam video feed.
  97235. * @param scene Define the scene the texture should be created in
  97236. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  97237. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  97238. * @returns The created video texture as a promise
  97239. */
  97240. static CreateFromWebCamAsync(scene: Scene, constraints: {
  97241. minWidth: number;
  97242. maxWidth: number;
  97243. minHeight: number;
  97244. maxHeight: number;
  97245. deviceId: string;
  97246. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  97247. /**
  97248. * Creates a video texture straight from your WebCam video feed.
  97249. * @param scene Define the scene the texture should be created in
  97250. * @param onReady Define a callback to triggered once the texture will be ready
  97251. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  97252. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  97253. */
  97254. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  97255. minWidth: number;
  97256. maxWidth: number;
  97257. minHeight: number;
  97258. maxHeight: number;
  97259. deviceId: string;
  97260. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  97261. }
  97262. }
  97263. declare module BABYLON {
  97264. /**
  97265. * Defines the interface used by objects working like Scene
  97266. * @hidden
  97267. */
  97268. interface ISceneLike {
  97269. _addPendingData(data: any): void;
  97270. _removePendingData(data: any): void;
  97271. offlineProvider: IOfflineProvider;
  97272. }
  97273. /** Interface defining initialization parameters for Engine class */
  97274. export interface EngineOptions extends WebGLContextAttributes {
  97275. /**
  97276. * Defines if the engine should no exceed a specified device ratio
  97277. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  97278. */
  97279. limitDeviceRatio?: number;
  97280. /**
  97281. * Defines if webvr should be enabled automatically
  97282. * @see http://doc.babylonjs.com/how_to/webvr_camera
  97283. */
  97284. autoEnableWebVR?: boolean;
  97285. /**
  97286. * Defines if webgl2 should be turned off even if supported
  97287. * @see http://doc.babylonjs.com/features/webgl2
  97288. */
  97289. disableWebGL2Support?: boolean;
  97290. /**
  97291. * Defines if webaudio should be initialized as well
  97292. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  97293. */
  97294. audioEngine?: boolean;
  97295. /**
  97296. * Defines if animations should run using a deterministic lock step
  97297. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  97298. */
  97299. deterministicLockstep?: boolean;
  97300. /** Defines the maximum steps to use with deterministic lock step mode */
  97301. lockstepMaxSteps?: number;
  97302. /**
  97303. * Defines that engine should ignore context lost events
  97304. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  97305. */
  97306. doNotHandleContextLost?: boolean;
  97307. /**
  97308. * Defines that engine should ignore modifying touch action attribute and style
  97309. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  97310. */
  97311. doNotHandleTouchAction?: boolean;
  97312. /**
  97313. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  97314. */
  97315. useHighPrecisionFloats?: boolean;
  97316. }
  97317. /**
  97318. * The base engine class (root of all engines)
  97319. */
  97320. export class ThinEngine {
  97321. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  97322. static ExceptionList: ({
  97323. key: string;
  97324. capture: string;
  97325. captureConstraint: number;
  97326. targets: string[];
  97327. } | {
  97328. key: string;
  97329. capture: null;
  97330. captureConstraint: null;
  97331. targets: string[];
  97332. })[];
  97333. /** @hidden */
  97334. static _TextureLoaders: IInternalTextureLoader[];
  97335. /**
  97336. * Returns the current npm package of the sdk
  97337. */
  97338. static readonly NpmPackage: string;
  97339. /**
  97340. * Returns the current version of the framework
  97341. */
  97342. static readonly Version: string;
  97343. /**
  97344. * Returns a string describing the current engine
  97345. */
  97346. readonly description: string;
  97347. /**
  97348. * Gets or sets the epsilon value used by collision engine
  97349. */
  97350. static CollisionsEpsilon: number;
  97351. /**
  97352. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  97353. */
  97354. static ShadersRepository: string;
  97355. /** @hidden */
  97356. _shaderProcessor: IShaderProcessor;
  97357. /**
  97358. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  97359. */
  97360. forcePOTTextures: boolean;
  97361. /**
  97362. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  97363. */
  97364. isFullscreen: boolean;
  97365. /**
  97366. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  97367. */
  97368. cullBackFaces: boolean;
  97369. /**
  97370. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  97371. */
  97372. renderEvenInBackground: boolean;
  97373. /**
  97374. * Gets or sets a boolean indicating that cache can be kept between frames
  97375. */
  97376. preventCacheWipeBetweenFrames: boolean;
  97377. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  97378. validateShaderPrograms: boolean;
  97379. /**
  97380. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  97381. */
  97382. disableUniformBuffers: boolean;
  97383. /** @hidden */
  97384. _uniformBuffers: UniformBuffer[];
  97385. /**
  97386. * Gets a boolean indicating that the engine supports uniform buffers
  97387. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  97388. */
  97389. readonly supportsUniformBuffers: boolean;
  97390. /** @hidden */
  97391. _gl: WebGLRenderingContext;
  97392. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  97393. protected _windowIsBackground: boolean;
  97394. protected _webGLVersion: number;
  97395. protected _creationOptions: EngineOptions;
  97396. protected _highPrecisionShadersAllowed: boolean;
  97397. /** @hidden */
  97398. readonly _shouldUseHighPrecisionShader: boolean;
  97399. /**
  97400. * Gets a boolean indicating that only power of 2 textures are supported
  97401. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  97402. */
  97403. readonly needPOTTextures: boolean;
  97404. /** @hidden */
  97405. _badOS: boolean;
  97406. /** @hidden */
  97407. _badDesktopOS: boolean;
  97408. private _hardwareScalingLevel;
  97409. /** @hidden */
  97410. _caps: EngineCapabilities;
  97411. private _isStencilEnable;
  97412. protected _colorWrite: boolean;
  97413. private _glVersion;
  97414. private _glRenderer;
  97415. private _glVendor;
  97416. /** @hidden */
  97417. _videoTextureSupported: boolean;
  97418. protected _renderingQueueLaunched: boolean;
  97419. protected _activeRenderLoops: (() => void)[];
  97420. /**
  97421. * Observable signaled when a context lost event is raised
  97422. */
  97423. onContextLostObservable: Observable<ThinEngine>;
  97424. /**
  97425. * Observable signaled when a context restored event is raised
  97426. */
  97427. onContextRestoredObservable: Observable<ThinEngine>;
  97428. private _onContextLost;
  97429. private _onContextRestored;
  97430. protected _contextWasLost: boolean;
  97431. /** @hidden */
  97432. _doNotHandleContextLost: boolean;
  97433. /**
  97434. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  97435. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  97436. */
  97437. doNotHandleContextLost: boolean;
  97438. /**
  97439. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  97440. */
  97441. disableVertexArrayObjects: boolean;
  97442. /** @hidden */
  97443. protected _depthCullingState: DepthCullingState;
  97444. /** @hidden */
  97445. protected _stencilState: StencilState;
  97446. /** @hidden */
  97447. protected _alphaState: AlphaState;
  97448. /** @hidden */
  97449. _internalTexturesCache: InternalTexture[];
  97450. /** @hidden */
  97451. protected _activeChannel: number;
  97452. private _currentTextureChannel;
  97453. /** @hidden */
  97454. protected _boundTexturesCache: {
  97455. [key: string]: Nullable<InternalTexture>;
  97456. };
  97457. /** @hidden */
  97458. protected _currentEffect: Nullable<Effect>;
  97459. /** @hidden */
  97460. protected _currentProgram: Nullable<WebGLProgram>;
  97461. private _compiledEffects;
  97462. private _vertexAttribArraysEnabled;
  97463. /** @hidden */
  97464. protected _cachedViewport: Nullable<IViewportLike>;
  97465. private _cachedVertexArrayObject;
  97466. /** @hidden */
  97467. protected _cachedVertexBuffers: any;
  97468. /** @hidden */
  97469. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  97470. /** @hidden */
  97471. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  97472. /** @hidden */
  97473. _currentRenderTarget: Nullable<InternalTexture>;
  97474. private _uintIndicesCurrentlySet;
  97475. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  97476. /** @hidden */
  97477. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  97478. private _currentBufferPointers;
  97479. private _currentInstanceLocations;
  97480. private _currentInstanceBuffers;
  97481. private _textureUnits;
  97482. /** @hidden */
  97483. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  97484. /** @hidden */
  97485. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  97486. /** @hidden */
  97487. _boundRenderFunction: any;
  97488. private _vaoRecordInProgress;
  97489. private _mustWipeVertexAttributes;
  97490. private _emptyTexture;
  97491. private _emptyCubeTexture;
  97492. private _emptyTexture3D;
  97493. private _emptyTexture2DArray;
  97494. /** @hidden */
  97495. _frameHandler: number;
  97496. private _nextFreeTextureSlots;
  97497. private _maxSimultaneousTextures;
  97498. private _activeRequests;
  97499. protected _texturesSupported: string[];
  97500. /** @hidden */
  97501. _textureFormatInUse: Nullable<string>;
  97502. protected readonly _supportsHardwareTextureRescaling: boolean;
  97503. /**
  97504. * Gets the list of texture formats supported
  97505. */
  97506. readonly texturesSupported: Array<string>;
  97507. /**
  97508. * Gets the list of texture formats in use
  97509. */
  97510. readonly textureFormatInUse: Nullable<string>;
  97511. /**
  97512. * Gets the current viewport
  97513. */
  97514. readonly currentViewport: Nullable<IViewportLike>;
  97515. /**
  97516. * Gets the default empty texture
  97517. */
  97518. readonly emptyTexture: InternalTexture;
  97519. /**
  97520. * Gets the default empty 3D texture
  97521. */
  97522. readonly emptyTexture3D: InternalTexture;
  97523. /**
  97524. * Gets the default empty 2D array texture
  97525. */
  97526. readonly emptyTexture2DArray: InternalTexture;
  97527. /**
  97528. * Gets the default empty cube texture
  97529. */
  97530. readonly emptyCubeTexture: InternalTexture;
  97531. /**
  97532. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  97533. */
  97534. readonly premultipliedAlpha: boolean;
  97535. /**
  97536. * Observable event triggered before each texture is initialized
  97537. */
  97538. onBeforeTextureInitObservable: Observable<Texture>;
  97539. /**
  97540. * Creates a new engine
  97541. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  97542. * @param antialias defines enable antialiasing (default: false)
  97543. * @param options defines further options to be sent to the getContext() function
  97544. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  97545. */
  97546. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  97547. private _rebuildInternalTextures;
  97548. private _rebuildEffects;
  97549. /**
  97550. * Gets a boolean indicating if all created effects are ready
  97551. * @returns true if all effects are ready
  97552. */
  97553. areAllEffectsReady(): boolean;
  97554. protected _rebuildBuffers(): void;
  97555. private _initGLContext;
  97556. /**
  97557. * Gets version of the current webGL context
  97558. */
  97559. readonly webGLVersion: number;
  97560. /**
  97561. * Gets a string idenfifying the name of the class
  97562. * @returns "Engine" string
  97563. */
  97564. getClassName(): string;
  97565. /**
  97566. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  97567. */
  97568. readonly isStencilEnable: boolean;
  97569. /** @hidden */
  97570. _prepareWorkingCanvas(): void;
  97571. /**
  97572. * Reset the texture cache to empty state
  97573. */
  97574. resetTextureCache(): void;
  97575. /**
  97576. * Gets an object containing information about the current webGL context
  97577. * @returns an object containing the vender, the renderer and the version of the current webGL context
  97578. */
  97579. getGlInfo(): {
  97580. vendor: string;
  97581. renderer: string;
  97582. version: string;
  97583. };
  97584. /**
  97585. * Defines the hardware scaling level.
  97586. * By default the hardware scaling level is computed from the window device ratio.
  97587. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  97588. * @param level defines the level to use
  97589. */
  97590. setHardwareScalingLevel(level: number): void;
  97591. /**
  97592. * Gets the current hardware scaling level.
  97593. * By default the hardware scaling level is computed from the window device ratio.
  97594. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  97595. * @returns a number indicating the current hardware scaling level
  97596. */
  97597. getHardwareScalingLevel(): number;
  97598. /**
  97599. * Gets the list of loaded textures
  97600. * @returns an array containing all loaded textures
  97601. */
  97602. getLoadedTexturesCache(): InternalTexture[];
  97603. /**
  97604. * Gets the object containing all engine capabilities
  97605. * @returns the EngineCapabilities object
  97606. */
  97607. getCaps(): EngineCapabilities;
  97608. /**
  97609. * stop executing a render loop function and remove it from the execution array
  97610. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  97611. */
  97612. stopRenderLoop(renderFunction?: () => void): void;
  97613. /** @hidden */
  97614. _renderLoop(): void;
  97615. /**
  97616. * Gets the HTML canvas attached with the current webGL context
  97617. * @returns a HTML canvas
  97618. */
  97619. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  97620. /**
  97621. * Gets host window
  97622. * @returns the host window object
  97623. */
  97624. getHostWindow(): Nullable<Window>;
  97625. /**
  97626. * Gets the current render width
  97627. * @param useScreen defines if screen size must be used (or the current render target if any)
  97628. * @returns a number defining the current render width
  97629. */
  97630. getRenderWidth(useScreen?: boolean): number;
  97631. /**
  97632. * Gets the current render height
  97633. * @param useScreen defines if screen size must be used (or the current render target if any)
  97634. * @returns a number defining the current render height
  97635. */
  97636. getRenderHeight(useScreen?: boolean): number;
  97637. /**
  97638. * Can be used to override the current requestAnimationFrame requester.
  97639. * @hidden
  97640. */
  97641. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  97642. /**
  97643. * Register and execute a render loop. The engine can have more than one render function
  97644. * @param renderFunction defines the function to continuously execute
  97645. */
  97646. runRenderLoop(renderFunction: () => void): void;
  97647. /**
  97648. * Clear the current render buffer or the current render target (if any is set up)
  97649. * @param color defines the color to use
  97650. * @param backBuffer defines if the back buffer must be cleared
  97651. * @param depth defines if the depth buffer must be cleared
  97652. * @param stencil defines if the stencil buffer must be cleared
  97653. */
  97654. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  97655. private _viewportCached;
  97656. /** @hidden */
  97657. _viewport(x: number, y: number, width: number, height: number): void;
  97658. /**
  97659. * Set the WebGL's viewport
  97660. * @param viewport defines the viewport element to be used
  97661. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  97662. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  97663. */
  97664. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  97665. /**
  97666. * Begin a new frame
  97667. */
  97668. beginFrame(): void;
  97669. /**
  97670. * Enf the current frame
  97671. */
  97672. endFrame(): void;
  97673. /**
  97674. * Resize the view according to the canvas' size
  97675. */
  97676. resize(): void;
  97677. /**
  97678. * Force a specific size of the canvas
  97679. * @param width defines the new canvas' width
  97680. * @param height defines the new canvas' height
  97681. */
  97682. setSize(width: number, height: number): void;
  97683. /**
  97684. * Binds the frame buffer to the specified texture.
  97685. * @param texture The texture to render to or null for the default canvas
  97686. * @param faceIndex The face of the texture to render to in case of cube texture
  97687. * @param requiredWidth The width of the target to render to
  97688. * @param requiredHeight The height of the target to render to
  97689. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  97690. * @param depthStencilTexture The depth stencil texture to use to render
  97691. * @param lodLevel defines le lod level to bind to the frame buffer
  97692. */
  97693. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  97694. /** @hidden */
  97695. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  97696. /**
  97697. * Unbind the current render target texture from the webGL context
  97698. * @param texture defines the render target texture to unbind
  97699. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  97700. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  97701. */
  97702. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  97703. /**
  97704. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  97705. */
  97706. flushFramebuffer(): void;
  97707. /**
  97708. * Unbind the current render target and bind the default framebuffer
  97709. */
  97710. restoreDefaultFramebuffer(): void;
  97711. /** @hidden */
  97712. protected _resetVertexBufferBinding(): void;
  97713. /**
  97714. * Creates a vertex buffer
  97715. * @param data the data for the vertex buffer
  97716. * @returns the new WebGL static buffer
  97717. */
  97718. createVertexBuffer(data: DataArray): DataBuffer;
  97719. private _createVertexBuffer;
  97720. /**
  97721. * Creates a dynamic vertex buffer
  97722. * @param data the data for the dynamic vertex buffer
  97723. * @returns the new WebGL dynamic buffer
  97724. */
  97725. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  97726. protected _resetIndexBufferBinding(): void;
  97727. /**
  97728. * Creates a new index buffer
  97729. * @param indices defines the content of the index buffer
  97730. * @param updatable defines if the index buffer must be updatable
  97731. * @returns a new webGL buffer
  97732. */
  97733. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  97734. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  97735. /**
  97736. * Bind a webGL buffer to the webGL context
  97737. * @param buffer defines the buffer to bind
  97738. */
  97739. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  97740. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  97741. private bindBuffer;
  97742. /**
  97743. * update the bound buffer with the given data
  97744. * @param data defines the data to update
  97745. */
  97746. updateArrayBuffer(data: Float32Array): void;
  97747. private _vertexAttribPointer;
  97748. private _bindIndexBufferWithCache;
  97749. private _bindVertexBuffersAttributes;
  97750. /**
  97751. * Records a vertex array object
  97752. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  97753. * @param vertexBuffers defines the list of vertex buffers to store
  97754. * @param indexBuffer defines the index buffer to store
  97755. * @param effect defines the effect to store
  97756. * @returns the new vertex array object
  97757. */
  97758. recordVertexArrayObject(vertexBuffers: {
  97759. [key: string]: VertexBuffer;
  97760. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  97761. /**
  97762. * Bind a specific vertex array object
  97763. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  97764. * @param vertexArrayObject defines the vertex array object to bind
  97765. * @param indexBuffer defines the index buffer to bind
  97766. */
  97767. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  97768. /**
  97769. * Bind webGl buffers directly to the webGL context
  97770. * @param vertexBuffer defines the vertex buffer to bind
  97771. * @param indexBuffer defines the index buffer to bind
  97772. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  97773. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  97774. * @param effect defines the effect associated with the vertex buffer
  97775. */
  97776. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  97777. private _unbindVertexArrayObject;
  97778. /**
  97779. * Bind a list of vertex buffers to the webGL context
  97780. * @param vertexBuffers defines the list of vertex buffers to bind
  97781. * @param indexBuffer defines the index buffer to bind
  97782. * @param effect defines the effect associated with the vertex buffers
  97783. */
  97784. bindBuffers(vertexBuffers: {
  97785. [key: string]: Nullable<VertexBuffer>;
  97786. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  97787. /**
  97788. * Unbind all instance attributes
  97789. */
  97790. unbindInstanceAttributes(): void;
  97791. /**
  97792. * Release and free the memory of a vertex array object
  97793. * @param vao defines the vertex array object to delete
  97794. */
  97795. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  97796. /** @hidden */
  97797. _releaseBuffer(buffer: DataBuffer): boolean;
  97798. protected _deleteBuffer(buffer: DataBuffer): void;
  97799. /**
  97800. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  97801. * @param instancesBuffer defines the webGL buffer to update and bind
  97802. * @param data defines the data to store in the buffer
  97803. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  97804. */
  97805. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  97806. /**
  97807. * Apply all cached states (depth, culling, stencil and alpha)
  97808. */
  97809. applyStates(): void;
  97810. /**
  97811. * Send a draw order
  97812. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  97813. * @param indexStart defines the starting index
  97814. * @param indexCount defines the number of index to draw
  97815. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97816. */
  97817. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  97818. /**
  97819. * Draw a list of points
  97820. * @param verticesStart defines the index of first vertex to draw
  97821. * @param verticesCount defines the count of vertices to draw
  97822. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97823. */
  97824. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  97825. /**
  97826. * Draw a list of unindexed primitives
  97827. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  97828. * @param verticesStart defines the index of first vertex to draw
  97829. * @param verticesCount defines the count of vertices to draw
  97830. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97831. */
  97832. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  97833. /**
  97834. * Draw a list of indexed primitives
  97835. * @param fillMode defines the primitive to use
  97836. * @param indexStart defines the starting index
  97837. * @param indexCount defines the number of index to draw
  97838. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97839. */
  97840. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  97841. /**
  97842. * Draw a list of unindexed primitives
  97843. * @param fillMode defines the primitive to use
  97844. * @param verticesStart defines the index of first vertex to draw
  97845. * @param verticesCount defines the count of vertices to draw
  97846. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  97847. */
  97848. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  97849. private _drawMode;
  97850. /** @hidden */
  97851. protected _reportDrawCall(): void;
  97852. /** @hidden */
  97853. _releaseEffect(effect: Effect): void;
  97854. /** @hidden */
  97855. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  97856. /**
  97857. * Create a new effect (used to store vertex/fragment shaders)
  97858. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  97859. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  97860. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  97861. * @param samplers defines an array of string used to represent textures
  97862. * @param defines defines the string containing the defines to use to compile the shaders
  97863. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  97864. * @param onCompiled defines a function to call when the effect creation is successful
  97865. * @param onError defines a function to call when the effect creation has failed
  97866. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  97867. * @returns the new Effect
  97868. */
  97869. createEffect(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: string[], defines?: string, fallbacks?: IEffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  97870. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  97871. private _compileShader;
  97872. private _compileRawShader;
  97873. /**
  97874. * Directly creates a webGL program
  97875. * @param pipelineContext defines the pipeline context to attach to
  97876. * @param vertexCode defines the vertex shader code to use
  97877. * @param fragmentCode defines the fragment shader code to use
  97878. * @param context defines the webGL context to use (if not set, the current one will be used)
  97879. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  97880. * @returns the new webGL program
  97881. */
  97882. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  97883. /**
  97884. * Creates a webGL program
  97885. * @param pipelineContext defines the pipeline context to attach to
  97886. * @param vertexCode defines the vertex shader code to use
  97887. * @param fragmentCode defines the fragment shader code to use
  97888. * @param defines defines the string containing the defines to use to compile the shaders
  97889. * @param context defines the webGL context to use (if not set, the current one will be used)
  97890. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  97891. * @returns the new webGL program
  97892. */
  97893. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  97894. /**
  97895. * Creates a new pipeline context
  97896. * @returns the new pipeline
  97897. */
  97898. createPipelineContext(): IPipelineContext;
  97899. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  97900. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  97901. /** @hidden */
  97902. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  97903. /** @hidden */
  97904. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  97905. /** @hidden */
  97906. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  97907. /**
  97908. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  97909. * @param pipelineContext defines the pipeline context to use
  97910. * @param uniformsNames defines the list of uniform names
  97911. * @returns an array of webGL uniform locations
  97912. */
  97913. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  97914. /**
  97915. * Gets the lsit of active attributes for a given webGL program
  97916. * @param pipelineContext defines the pipeline context to use
  97917. * @param attributesNames defines the list of attribute names to get
  97918. * @returns an array of indices indicating the offset of each attribute
  97919. */
  97920. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  97921. /**
  97922. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  97923. * @param effect defines the effect to activate
  97924. */
  97925. enableEffect(effect: Nullable<Effect>): void;
  97926. /**
  97927. * Set the value of an uniform to a number (int)
  97928. * @param uniform defines the webGL uniform location where to store the value
  97929. * @param value defines the int number to store
  97930. */
  97931. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  97932. /**
  97933. * Set the value of an uniform to an array of int32
  97934. * @param uniform defines the webGL uniform location where to store the value
  97935. * @param array defines the array of int32 to store
  97936. */
  97937. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97938. /**
  97939. * Set the value of an uniform to an array of int32 (stored as vec2)
  97940. * @param uniform defines the webGL uniform location where to store the value
  97941. * @param array defines the array of int32 to store
  97942. */
  97943. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97944. /**
  97945. * Set the value of an uniform to an array of int32 (stored as vec3)
  97946. * @param uniform defines the webGL uniform location where to store the value
  97947. * @param array defines the array of int32 to store
  97948. */
  97949. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97950. /**
  97951. * Set the value of an uniform to an array of int32 (stored as vec4)
  97952. * @param uniform defines the webGL uniform location where to store the value
  97953. * @param array defines the array of int32 to store
  97954. */
  97955. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  97956. /**
  97957. * Set the value of an uniform to an array of number
  97958. * @param uniform defines the webGL uniform location where to store the value
  97959. * @param array defines the array of number to store
  97960. */
  97961. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97962. /**
  97963. * Set the value of an uniform to an array of number (stored as vec2)
  97964. * @param uniform defines the webGL uniform location where to store the value
  97965. * @param array defines the array of number to store
  97966. */
  97967. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97968. /**
  97969. * Set the value of an uniform to an array of number (stored as vec3)
  97970. * @param uniform defines the webGL uniform location where to store the value
  97971. * @param array defines the array of number to store
  97972. */
  97973. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97974. /**
  97975. * Set the value of an uniform to an array of number (stored as vec4)
  97976. * @param uniform defines the webGL uniform location where to store the value
  97977. * @param array defines the array of number to store
  97978. */
  97979. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  97980. /**
  97981. * Set the value of an uniform to an array of float32 (stored as matrices)
  97982. * @param uniform defines the webGL uniform location where to store the value
  97983. * @param matrices defines the array of float32 to store
  97984. */
  97985. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  97986. /**
  97987. * Set the value of an uniform to a matrix (3x3)
  97988. * @param uniform defines the webGL uniform location where to store the value
  97989. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  97990. */
  97991. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  97992. /**
  97993. * Set the value of an uniform to a matrix (2x2)
  97994. * @param uniform defines the webGL uniform location where to store the value
  97995. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  97996. */
  97997. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  97998. /**
  97999. * Set the value of an uniform to a number (float)
  98000. * @param uniform defines the webGL uniform location where to store the value
  98001. * @param value defines the float number to store
  98002. */
  98003. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  98004. /**
  98005. * Set the value of an uniform to a vec2
  98006. * @param uniform defines the webGL uniform location where to store the value
  98007. * @param x defines the 1st component of the value
  98008. * @param y defines the 2nd component of the value
  98009. */
  98010. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  98011. /**
  98012. * Set the value of an uniform to a vec3
  98013. * @param uniform defines the webGL uniform location where to store the value
  98014. * @param x defines the 1st component of the value
  98015. * @param y defines the 2nd component of the value
  98016. * @param z defines the 3rd component of the value
  98017. */
  98018. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  98019. /**
  98020. * Set the value of an uniform to a vec4
  98021. * @param uniform defines the webGL uniform location where to store the value
  98022. * @param x defines the 1st component of the value
  98023. * @param y defines the 2nd component of the value
  98024. * @param z defines the 3rd component of the value
  98025. * @param w defines the 4th component of the value
  98026. */
  98027. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  98028. /**
  98029. * Gets the depth culling state manager
  98030. */
  98031. readonly depthCullingState: DepthCullingState;
  98032. /**
  98033. * Gets the alpha state manager
  98034. */
  98035. readonly alphaState: AlphaState;
  98036. /**
  98037. * Gets the stencil state manager
  98038. */
  98039. readonly stencilState: StencilState;
  98040. /**
  98041. * Clears the list of texture accessible through engine.
  98042. * This can help preventing texture load conflict due to name collision.
  98043. */
  98044. clearInternalTexturesCache(): void;
  98045. /**
  98046. * Force the entire cache to be cleared
  98047. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  98048. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  98049. */
  98050. wipeCaches(bruteForce?: boolean): void;
  98051. /** @hidden */
  98052. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  98053. min: number;
  98054. mag: number;
  98055. };
  98056. /** @hidden */
  98057. _createTexture(): WebGLTexture;
  98058. /**
  98059. * Usually called from Texture.ts.
  98060. * Passed information to create a WebGLTexture
  98061. * @param urlArg defines a value which contains one of the following:
  98062. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  98063. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  98064. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  98065. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  98066. * @param invertY when true, image is flipped when loaded. You probably want true. Certain compressed textures may invert this if their default is inverted (eg. ktx)
  98067. * @param scene needed for loading to the correct scene
  98068. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  98069. * @param onLoad optional callback to be called upon successful completion
  98070. * @param onError optional callback to be called upon failure
  98071. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), HTMLImageElement (image format), or a Blob
  98072. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  98073. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  98074. * @param forcedExtension defines the extension to use to pick the right loader
  98075. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  98076. * @param mimeType defines an optional mime type
  98077. * @returns a InternalTexture for assignment back into BABYLON.Texture
  98078. */
  98079. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, excludeLoaders?: Array<IInternalTextureLoader>, mimeType?: string): InternalTexture;
  98080. /**
  98081. * @hidden
  98082. */
  98083. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  98084. /**
  98085. * Creates a raw texture
  98086. * @param data defines the data to store in the texture
  98087. * @param width defines the width of the texture
  98088. * @param height defines the height of the texture
  98089. * @param format defines the format of the data
  98090. * @param generateMipMaps defines if the engine should generate the mip levels
  98091. * @param invertY defines if data must be stored with Y axis inverted
  98092. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  98093. * @param compression defines the compression used (null by default)
  98094. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  98095. * @returns the raw texture inside an InternalTexture
  98096. */
  98097. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, type?: number): InternalTexture;
  98098. /**
  98099. * Creates a new raw cube texture
  98100. * @param data defines the array of data to use to create each face
  98101. * @param size defines the size of the textures
  98102. * @param format defines the format of the data
  98103. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  98104. * @param generateMipMaps defines if the engine should generate the mip levels
  98105. * @param invertY defines if data must be stored with Y axis inverted
  98106. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  98107. * @param compression defines the compression used (null by default)
  98108. * @returns the cube texture as an InternalTexture
  98109. */
  98110. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>): InternalTexture;
  98111. /**
  98112. * Creates a new raw 3D texture
  98113. * @param data defines the data used to create the texture
  98114. * @param width defines the width of the texture
  98115. * @param height defines the height of the texture
  98116. * @param depth defines the depth of the texture
  98117. * @param format defines the format of the texture
  98118. * @param generateMipMaps defines if the engine must generate mip levels
  98119. * @param invertY defines if data must be stored with Y axis inverted
  98120. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  98121. * @param compression defines the compressed used (can be null)
  98122. * @param textureType defines the compressed used (can be null)
  98123. * @returns a new raw 3D texture (stored in an InternalTexture)
  98124. */
  98125. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  98126. /**
  98127. * Creates a new raw 2D array texture
  98128. * @param data defines the data used to create the texture
  98129. * @param width defines the width of the texture
  98130. * @param height defines the height of the texture
  98131. * @param depth defines the number of layers of the texture
  98132. * @param format defines the format of the texture
  98133. * @param generateMipMaps defines if the engine must generate mip levels
  98134. * @param invertY defines if data must be stored with Y axis inverted
  98135. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  98136. * @param compression defines the compressed used (can be null)
  98137. * @param textureType defines the compressed used (can be null)
  98138. * @returns a new raw 2D array texture (stored in an InternalTexture)
  98139. */
  98140. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  98141. private _unpackFlipYCached;
  98142. /**
  98143. * In case you are sharing the context with other applications, it might
  98144. * be interested to not cache the unpack flip y state to ensure a consistent
  98145. * value would be set.
  98146. */
  98147. enableUnpackFlipYCached: boolean;
  98148. /** @hidden */
  98149. _unpackFlipY(value: boolean): void;
  98150. /** @hidden */
  98151. _getUnpackAlignement(): number;
  98152. /**
  98153. * Update the sampling mode of a given texture
  98154. * @param samplingMode defines the required sampling mode
  98155. * @param texture defines the texture to update
  98156. */
  98157. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  98158. /** @hidden */
  98159. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  98160. width: number;
  98161. height: number;
  98162. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  98163. /** @hidden */
  98164. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  98165. /** @hidden */
  98166. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  98167. /** @hidden */
  98168. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  98169. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  98170. private _prepareWebGLTexture;
  98171. /** @hidden */
  98172. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  98173. /** @hidden */
  98174. _releaseFramebufferObjects(texture: InternalTexture): void;
  98175. /** @hidden */
  98176. _releaseTexture(texture: InternalTexture): void;
  98177. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  98178. protected _setProgram(program: WebGLProgram): void;
  98179. protected _boundUniforms: {
  98180. [key: number]: WebGLUniformLocation;
  98181. };
  98182. /**
  98183. * Binds an effect to the webGL context
  98184. * @param effect defines the effect to bind
  98185. */
  98186. bindSamplers(effect: Effect): void;
  98187. private _activateCurrentTexture;
  98188. /** @hidden */
  98189. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  98190. /** @hidden */
  98191. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  98192. /**
  98193. * Unbind all textures from the webGL context
  98194. */
  98195. unbindAllTextures(): void;
  98196. /**
  98197. * Sets a texture to the according uniform.
  98198. * @param channel The texture channel
  98199. * @param uniform The uniform to set
  98200. * @param texture The texture to apply
  98201. */
  98202. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  98203. private _bindSamplerUniformToChannel;
  98204. private _getTextureWrapMode;
  98205. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  98206. /**
  98207. * Sets an array of texture to the webGL context
  98208. * @param channel defines the channel where the texture array must be set
  98209. * @param uniform defines the associated uniform location
  98210. * @param textures defines the array of textures to bind
  98211. */
  98212. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  98213. /** @hidden */
  98214. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  98215. private _setTextureParameterFloat;
  98216. private _setTextureParameterInteger;
  98217. /**
  98218. * Unbind all vertex attributes from the webGL context
  98219. */
  98220. unbindAllAttributes(): void;
  98221. /**
  98222. * Force the engine to release all cached effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled
  98223. */
  98224. releaseEffects(): void;
  98225. /**
  98226. * Dispose and release all associated resources
  98227. */
  98228. dispose(): void;
  98229. /**
  98230. * Attach a new callback raised when context lost event is fired
  98231. * @param callback defines the callback to call
  98232. */
  98233. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  98234. /**
  98235. * Attach a new callback raised when context restored event is fired
  98236. * @param callback defines the callback to call
  98237. */
  98238. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  98239. /**
  98240. * Get the current error code of the webGL context
  98241. * @returns the error code
  98242. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  98243. */
  98244. getError(): number;
  98245. private _canRenderToFloatFramebuffer;
  98246. private _canRenderToHalfFloatFramebuffer;
  98247. private _canRenderToFramebuffer;
  98248. /** @hidden */
  98249. _getWebGLTextureType(type: number): number;
  98250. /** @hidden */
  98251. _getInternalFormat(format: number): number;
  98252. /** @hidden */
  98253. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  98254. /** @hidden */
  98255. _getRGBAMultiSampleBufferFormat(type: number): number;
  98256. /** @hidden */
  98257. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest;
  98258. /**
  98259. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  98260. * @returns true if the engine can be created
  98261. * @ignorenaming
  98262. */
  98263. static isSupported(): boolean;
  98264. /**
  98265. * Find the next highest power of two.
  98266. * @param x Number to start search from.
  98267. * @return Next highest power of two.
  98268. */
  98269. static CeilingPOT(x: number): number;
  98270. /**
  98271. * Find the next lowest power of two.
  98272. * @param x Number to start search from.
  98273. * @return Next lowest power of two.
  98274. */
  98275. static FloorPOT(x: number): number;
  98276. /**
  98277. * Find the nearest power of two.
  98278. * @param x Number to start search from.
  98279. * @return Next nearest power of two.
  98280. */
  98281. static NearestPOT(x: number): number;
  98282. /**
  98283. * Get the closest exponent of two
  98284. * @param value defines the value to approximate
  98285. * @param max defines the maximum value to return
  98286. * @param mode defines how to define the closest value
  98287. * @returns closest exponent of two of the given value
  98288. */
  98289. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  98290. /**
  98291. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  98292. * @param func - the function to be called
  98293. * @param requester - the object that will request the next frame. Falls back to window.
  98294. * @returns frame number
  98295. */
  98296. static QueueNewFrame(func: () => void, requester?: any): number;
  98297. }
  98298. }
  98299. declare module BABYLON {
  98300. /**
  98301. * Class representing spherical harmonics coefficients to the 3rd degree
  98302. */
  98303. export class SphericalHarmonics {
  98304. /**
  98305. * Defines whether or not the harmonics have been prescaled for rendering.
  98306. */
  98307. preScaled: boolean;
  98308. /**
  98309. * The l0,0 coefficients of the spherical harmonics
  98310. */
  98311. l00: Vector3;
  98312. /**
  98313. * The l1,-1 coefficients of the spherical harmonics
  98314. */
  98315. l1_1: Vector3;
  98316. /**
  98317. * The l1,0 coefficients of the spherical harmonics
  98318. */
  98319. l10: Vector3;
  98320. /**
  98321. * The l1,1 coefficients of the spherical harmonics
  98322. */
  98323. l11: Vector3;
  98324. /**
  98325. * The l2,-2 coefficients of the spherical harmonics
  98326. */
  98327. l2_2: Vector3;
  98328. /**
  98329. * The l2,-1 coefficients of the spherical harmonics
  98330. */
  98331. l2_1: Vector3;
  98332. /**
  98333. * The l2,0 coefficients of the spherical harmonics
  98334. */
  98335. l20: Vector3;
  98336. /**
  98337. * The l2,1 coefficients of the spherical harmonics
  98338. */
  98339. l21: Vector3;
  98340. /**
  98341. * The l2,2 coefficients of the spherical harmonics
  98342. */
  98343. l22: Vector3;
  98344. /**
  98345. * Adds a light to the spherical harmonics
  98346. * @param direction the direction of the light
  98347. * @param color the color of the light
  98348. * @param deltaSolidAngle the delta solid angle of the light
  98349. */
  98350. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  98351. /**
  98352. * Scales the spherical harmonics by the given amount
  98353. * @param scale the amount to scale
  98354. */
  98355. scaleInPlace(scale: number): void;
  98356. /**
  98357. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  98358. *
  98359. * ```
  98360. * E_lm = A_l * L_lm
  98361. * ```
  98362. *
  98363. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  98364. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  98365. * the scaling factors are given in equation 9.
  98366. */
  98367. convertIncidentRadianceToIrradiance(): void;
  98368. /**
  98369. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  98370. *
  98371. * ```
  98372. * L = (1/pi) * E * rho
  98373. * ```
  98374. *
  98375. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  98376. */
  98377. convertIrradianceToLambertianRadiance(): void;
  98378. /**
  98379. * Integrates the reconstruction coefficients directly in to the SH preventing further
  98380. * required operations at run time.
  98381. *
  98382. * This is simply done by scaling back the SH with Ylm constants parameter.
  98383. * The trigonometric part being applied by the shader at run time.
  98384. */
  98385. preScaleForRendering(): void;
  98386. /**
  98387. * Constructs a spherical harmonics from an array.
  98388. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  98389. * @returns the spherical harmonics
  98390. */
  98391. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  98392. /**
  98393. * Gets the spherical harmonics from polynomial
  98394. * @param polynomial the spherical polynomial
  98395. * @returns the spherical harmonics
  98396. */
  98397. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  98398. }
  98399. /**
  98400. * Class representing spherical polynomial coefficients to the 3rd degree
  98401. */
  98402. export class SphericalPolynomial {
  98403. private _harmonics;
  98404. /**
  98405. * The spherical harmonics used to create the polynomials.
  98406. */
  98407. readonly preScaledHarmonics: SphericalHarmonics;
  98408. /**
  98409. * The x coefficients of the spherical polynomial
  98410. */
  98411. x: Vector3;
  98412. /**
  98413. * The y coefficients of the spherical polynomial
  98414. */
  98415. y: Vector3;
  98416. /**
  98417. * The z coefficients of the spherical polynomial
  98418. */
  98419. z: Vector3;
  98420. /**
  98421. * The xx coefficients of the spherical polynomial
  98422. */
  98423. xx: Vector3;
  98424. /**
  98425. * The yy coefficients of the spherical polynomial
  98426. */
  98427. yy: Vector3;
  98428. /**
  98429. * The zz coefficients of the spherical polynomial
  98430. */
  98431. zz: Vector3;
  98432. /**
  98433. * The xy coefficients of the spherical polynomial
  98434. */
  98435. xy: Vector3;
  98436. /**
  98437. * The yz coefficients of the spherical polynomial
  98438. */
  98439. yz: Vector3;
  98440. /**
  98441. * The zx coefficients of the spherical polynomial
  98442. */
  98443. zx: Vector3;
  98444. /**
  98445. * Adds an ambient color to the spherical polynomial
  98446. * @param color the color to add
  98447. */
  98448. addAmbient(color: Color3): void;
  98449. /**
  98450. * Scales the spherical polynomial by the given amount
  98451. * @param scale the amount to scale
  98452. */
  98453. scaleInPlace(scale: number): void;
  98454. /**
  98455. * Gets the spherical polynomial from harmonics
  98456. * @param harmonics the spherical harmonics
  98457. * @returns the spherical polynomial
  98458. */
  98459. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  98460. /**
  98461. * Constructs a spherical polynomial from an array.
  98462. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  98463. * @returns the spherical polynomial
  98464. */
  98465. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  98466. }
  98467. }
  98468. declare module BABYLON {
  98469. /**
  98470. * Defines the source of the internal texture
  98471. */
  98472. export enum InternalTextureSource {
  98473. /**
  98474. * The source of the texture data is unknown
  98475. */
  98476. Unknown = 0,
  98477. /**
  98478. * Texture data comes from an URL
  98479. */
  98480. Url = 1,
  98481. /**
  98482. * Texture data is only used for temporary storage
  98483. */
  98484. Temp = 2,
  98485. /**
  98486. * Texture data comes from raw data (ArrayBuffer)
  98487. */
  98488. Raw = 3,
  98489. /**
  98490. * Texture content is dynamic (video or dynamic texture)
  98491. */
  98492. Dynamic = 4,
  98493. /**
  98494. * Texture content is generated by rendering to it
  98495. */
  98496. RenderTarget = 5,
  98497. /**
  98498. * Texture content is part of a multi render target process
  98499. */
  98500. MultiRenderTarget = 6,
  98501. /**
  98502. * Texture data comes from a cube data file
  98503. */
  98504. Cube = 7,
  98505. /**
  98506. * Texture data comes from a raw cube data
  98507. */
  98508. CubeRaw = 8,
  98509. /**
  98510. * Texture data come from a prefiltered cube data file
  98511. */
  98512. CubePrefiltered = 9,
  98513. /**
  98514. * Texture content is raw 3D data
  98515. */
  98516. Raw3D = 10,
  98517. /**
  98518. * Texture content is raw 2D array data
  98519. */
  98520. Raw2DArray = 11,
  98521. /**
  98522. * Texture content is a depth texture
  98523. */
  98524. Depth = 12,
  98525. /**
  98526. * Texture data comes from a raw cube data encoded with RGBD
  98527. */
  98528. CubeRawRGBD = 13
  98529. }
  98530. /**
  98531. * Class used to store data associated with WebGL texture data for the engine
  98532. * This class should not be used directly
  98533. */
  98534. export class InternalTexture {
  98535. /** @hidden */
  98536. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  98537. /**
  98538. * Defines if the texture is ready
  98539. */
  98540. isReady: boolean;
  98541. /**
  98542. * Defines if the texture is a cube texture
  98543. */
  98544. isCube: boolean;
  98545. /**
  98546. * Defines if the texture contains 3D data
  98547. */
  98548. is3D: boolean;
  98549. /**
  98550. * Defines if the texture contains 2D array data
  98551. */
  98552. is2DArray: boolean;
  98553. /**
  98554. * Defines if the texture contains multiview data
  98555. */
  98556. isMultiview: boolean;
  98557. /**
  98558. * Gets the URL used to load this texture
  98559. */
  98560. url: string;
  98561. /**
  98562. * Gets the sampling mode of the texture
  98563. */
  98564. samplingMode: number;
  98565. /**
  98566. * Gets a boolean indicating if the texture needs mipmaps generation
  98567. */
  98568. generateMipMaps: boolean;
  98569. /**
  98570. * Gets the number of samples used by the texture (WebGL2+ only)
  98571. */
  98572. samples: number;
  98573. /**
  98574. * Gets the type of the texture (int, float...)
  98575. */
  98576. type: number;
  98577. /**
  98578. * Gets the format of the texture (RGB, RGBA...)
  98579. */
  98580. format: number;
  98581. /**
  98582. * Observable called when the texture is loaded
  98583. */
  98584. onLoadedObservable: Observable<InternalTexture>;
  98585. /**
  98586. * Gets the width of the texture
  98587. */
  98588. width: number;
  98589. /**
  98590. * Gets the height of the texture
  98591. */
  98592. height: number;
  98593. /**
  98594. * Gets the depth of the texture
  98595. */
  98596. depth: number;
  98597. /**
  98598. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  98599. */
  98600. baseWidth: number;
  98601. /**
  98602. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  98603. */
  98604. baseHeight: number;
  98605. /**
  98606. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  98607. */
  98608. baseDepth: number;
  98609. /**
  98610. * Gets a boolean indicating if the texture is inverted on Y axis
  98611. */
  98612. invertY: boolean;
  98613. /** @hidden */
  98614. _invertVScale: boolean;
  98615. /** @hidden */
  98616. _associatedChannel: number;
  98617. /** @hidden */
  98618. _source: InternalTextureSource;
  98619. /** @hidden */
  98620. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  98621. /** @hidden */
  98622. _bufferView: Nullable<ArrayBufferView>;
  98623. /** @hidden */
  98624. _bufferViewArray: Nullable<ArrayBufferView[]>;
  98625. /** @hidden */
  98626. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  98627. /** @hidden */
  98628. _size: number;
  98629. /** @hidden */
  98630. _extension: string;
  98631. /** @hidden */
  98632. _files: Nullable<string[]>;
  98633. /** @hidden */
  98634. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  98635. /** @hidden */
  98636. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  98637. /** @hidden */
  98638. _framebuffer: Nullable<WebGLFramebuffer>;
  98639. /** @hidden */
  98640. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  98641. /** @hidden */
  98642. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  98643. /** @hidden */
  98644. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  98645. /** @hidden */
  98646. _attachments: Nullable<number[]>;
  98647. /** @hidden */
  98648. _cachedCoordinatesMode: Nullable<number>;
  98649. /** @hidden */
  98650. _cachedWrapU: Nullable<number>;
  98651. /** @hidden */
  98652. _cachedWrapV: Nullable<number>;
  98653. /** @hidden */
  98654. _cachedWrapR: Nullable<number>;
  98655. /** @hidden */
  98656. _cachedAnisotropicFilteringLevel: Nullable<number>;
  98657. /** @hidden */
  98658. _isDisabled: boolean;
  98659. /** @hidden */
  98660. _compression: Nullable<string>;
  98661. /** @hidden */
  98662. _generateStencilBuffer: boolean;
  98663. /** @hidden */
  98664. _generateDepthBuffer: boolean;
  98665. /** @hidden */
  98666. _comparisonFunction: number;
  98667. /** @hidden */
  98668. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  98669. /** @hidden */
  98670. _lodGenerationScale: number;
  98671. /** @hidden */
  98672. _lodGenerationOffset: number;
  98673. /** @hidden */
  98674. _colorTextureArray: Nullable<WebGLTexture>;
  98675. /** @hidden */
  98676. _depthStencilTextureArray: Nullable<WebGLTexture>;
  98677. /** @hidden */
  98678. _lodTextureHigh: Nullable<BaseTexture>;
  98679. /** @hidden */
  98680. _lodTextureMid: Nullable<BaseTexture>;
  98681. /** @hidden */
  98682. _lodTextureLow: Nullable<BaseTexture>;
  98683. /** @hidden */
  98684. _isRGBD: boolean;
  98685. /** @hidden */
  98686. _linearSpecularLOD: boolean;
  98687. /** @hidden */
  98688. _irradianceTexture: Nullable<BaseTexture>;
  98689. /** @hidden */
  98690. _webGLTexture: Nullable<WebGLTexture>;
  98691. /** @hidden */
  98692. _references: number;
  98693. private _engine;
  98694. /**
  98695. * Gets the Engine the texture belongs to.
  98696. * @returns The babylon engine
  98697. */
  98698. getEngine(): ThinEngine;
  98699. /**
  98700. * Gets the data source type of the texture
  98701. */
  98702. readonly source: InternalTextureSource;
  98703. /**
  98704. * Creates a new InternalTexture
  98705. * @param engine defines the engine to use
  98706. * @param source defines the type of data that will be used
  98707. * @param delayAllocation if the texture allocation should be delayed (default: false)
  98708. */
  98709. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  98710. /**
  98711. * Increments the number of references (ie. the number of Texture that point to it)
  98712. */
  98713. incrementReferences(): void;
  98714. /**
  98715. * Change the size of the texture (not the size of the content)
  98716. * @param width defines the new width
  98717. * @param height defines the new height
  98718. * @param depth defines the new depth (1 by default)
  98719. */
  98720. updateSize(width: int, height: int, depth?: int): void;
  98721. /** @hidden */
  98722. _rebuild(): void;
  98723. /** @hidden */
  98724. _swapAndDie(target: InternalTexture): void;
  98725. /**
  98726. * Dispose the current allocated resources
  98727. */
  98728. dispose(): void;
  98729. }
  98730. }
  98731. declare module BABYLON {
  98732. /**
  98733. * Class used to work with sound analyzer using fast fourier transform (FFT)
  98734. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  98735. */
  98736. export class Analyser {
  98737. /**
  98738. * Gets or sets the smoothing
  98739. * @ignorenaming
  98740. */
  98741. SMOOTHING: number;
  98742. /**
  98743. * Gets or sets the FFT table size
  98744. * @ignorenaming
  98745. */
  98746. FFT_SIZE: number;
  98747. /**
  98748. * Gets or sets the bar graph amplitude
  98749. * @ignorenaming
  98750. */
  98751. BARGRAPHAMPLITUDE: number;
  98752. /**
  98753. * Gets or sets the position of the debug canvas
  98754. * @ignorenaming
  98755. */
  98756. DEBUGCANVASPOS: {
  98757. x: number;
  98758. y: number;
  98759. };
  98760. /**
  98761. * Gets or sets the debug canvas size
  98762. * @ignorenaming
  98763. */
  98764. DEBUGCANVASSIZE: {
  98765. width: number;
  98766. height: number;
  98767. };
  98768. private _byteFreqs;
  98769. private _byteTime;
  98770. private _floatFreqs;
  98771. private _webAudioAnalyser;
  98772. private _debugCanvas;
  98773. private _debugCanvasContext;
  98774. private _scene;
  98775. private _registerFunc;
  98776. private _audioEngine;
  98777. /**
  98778. * Creates a new analyser
  98779. * @param scene defines hosting scene
  98780. */
  98781. constructor(scene: Scene);
  98782. /**
  98783. * Get the number of data values you will have to play with for the visualization
  98784. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  98785. * @returns a number
  98786. */
  98787. getFrequencyBinCount(): number;
  98788. /**
  98789. * Gets the current frequency data as a byte array
  98790. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  98791. * @returns a Uint8Array
  98792. */
  98793. getByteFrequencyData(): Uint8Array;
  98794. /**
  98795. * Gets the current waveform as a byte array
  98796. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  98797. * @returns a Uint8Array
  98798. */
  98799. getByteTimeDomainData(): Uint8Array;
  98800. /**
  98801. * Gets the current frequency data as a float array
  98802. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  98803. * @returns a Float32Array
  98804. */
  98805. getFloatFrequencyData(): Float32Array;
  98806. /**
  98807. * Renders the debug canvas
  98808. */
  98809. drawDebugCanvas(): void;
  98810. /**
  98811. * Stops rendering the debug canvas and removes it
  98812. */
  98813. stopDebugCanvas(): void;
  98814. /**
  98815. * Connects two audio nodes
  98816. * @param inputAudioNode defines first node to connect
  98817. * @param outputAudioNode defines second node to connect
  98818. */
  98819. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  98820. /**
  98821. * Releases all associated resources
  98822. */
  98823. dispose(): void;
  98824. }
  98825. }
  98826. declare module BABYLON {
  98827. /**
  98828. * This represents an audio engine and it is responsible
  98829. * to play, synchronize and analyse sounds throughout the application.
  98830. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  98831. */
  98832. export interface IAudioEngine extends IDisposable {
  98833. /**
  98834. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  98835. */
  98836. readonly canUseWebAudio: boolean;
  98837. /**
  98838. * Gets the current AudioContext if available.
  98839. */
  98840. readonly audioContext: Nullable<AudioContext>;
  98841. /**
  98842. * The master gain node defines the global audio volume of your audio engine.
  98843. */
  98844. readonly masterGain: GainNode;
  98845. /**
  98846. * Gets whether or not mp3 are supported by your browser.
  98847. */
  98848. readonly isMP3supported: boolean;
  98849. /**
  98850. * Gets whether or not ogg are supported by your browser.
  98851. */
  98852. readonly isOGGsupported: boolean;
  98853. /**
  98854. * Defines if Babylon should emit a warning if WebAudio is not supported.
  98855. * @ignoreNaming
  98856. */
  98857. WarnedWebAudioUnsupported: boolean;
  98858. /**
  98859. * Defines if the audio engine relies on a custom unlocked button.
  98860. * In this case, the embedded button will not be displayed.
  98861. */
  98862. useCustomUnlockedButton: boolean;
  98863. /**
  98864. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  98865. */
  98866. readonly unlocked: boolean;
  98867. /**
  98868. * Event raised when audio has been unlocked on the browser.
  98869. */
  98870. onAudioUnlockedObservable: Observable<AudioEngine>;
  98871. /**
  98872. * Event raised when audio has been locked on the browser.
  98873. */
  98874. onAudioLockedObservable: Observable<AudioEngine>;
  98875. /**
  98876. * Flags the audio engine in Locked state.
  98877. * This happens due to new browser policies preventing audio to autoplay.
  98878. */
  98879. lock(): void;
  98880. /**
  98881. * Unlocks the audio engine once a user action has been done on the dom.
  98882. * This is helpful to resume play once browser policies have been satisfied.
  98883. */
  98884. unlock(): void;
  98885. }
  98886. /**
  98887. * This represents the default audio engine used in babylon.
  98888. * It is responsible to play, synchronize and analyse sounds throughout the application.
  98889. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  98890. */
  98891. export class AudioEngine implements IAudioEngine {
  98892. private _audioContext;
  98893. private _audioContextInitialized;
  98894. private _muteButton;
  98895. private _hostElement;
  98896. /**
  98897. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  98898. */
  98899. canUseWebAudio: boolean;
  98900. /**
  98901. * The master gain node defines the global audio volume of your audio engine.
  98902. */
  98903. masterGain: GainNode;
  98904. /**
  98905. * Defines if Babylon should emit a warning if WebAudio is not supported.
  98906. * @ignoreNaming
  98907. */
  98908. WarnedWebAudioUnsupported: boolean;
  98909. /**
  98910. * Gets whether or not mp3 are supported by your browser.
  98911. */
  98912. isMP3supported: boolean;
  98913. /**
  98914. * Gets whether or not ogg are supported by your browser.
  98915. */
  98916. isOGGsupported: boolean;
  98917. /**
  98918. * Gets whether audio has been unlocked on the device.
  98919. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  98920. * a user interaction has happened.
  98921. */
  98922. unlocked: boolean;
  98923. /**
  98924. * Defines if the audio engine relies on a custom unlocked button.
  98925. * In this case, the embedded button will not be displayed.
  98926. */
  98927. useCustomUnlockedButton: boolean;
  98928. /**
  98929. * Event raised when audio has been unlocked on the browser.
  98930. */
  98931. onAudioUnlockedObservable: Observable<AudioEngine>;
  98932. /**
  98933. * Event raised when audio has been locked on the browser.
  98934. */
  98935. onAudioLockedObservable: Observable<AudioEngine>;
  98936. /**
  98937. * Gets the current AudioContext if available.
  98938. */
  98939. readonly audioContext: Nullable<AudioContext>;
  98940. private _connectedAnalyser;
  98941. /**
  98942. * Instantiates a new audio engine.
  98943. *
  98944. * There should be only one per page as some browsers restrict the number
  98945. * of audio contexts you can create.
  98946. * @param hostElement defines the host element where to display the mute icon if necessary
  98947. */
  98948. constructor(hostElement?: Nullable<HTMLElement>);
  98949. /**
  98950. * Flags the audio engine in Locked state.
  98951. * This happens due to new browser policies preventing audio to autoplay.
  98952. */
  98953. lock(): void;
  98954. /**
  98955. * Unlocks the audio engine once a user action has been done on the dom.
  98956. * This is helpful to resume play once browser policies have been satisfied.
  98957. */
  98958. unlock(): void;
  98959. private _resumeAudioContext;
  98960. private _initializeAudioContext;
  98961. private _tryToRun;
  98962. private _triggerRunningState;
  98963. private _triggerSuspendedState;
  98964. private _displayMuteButton;
  98965. private _moveButtonToTopLeft;
  98966. private _onResize;
  98967. private _hideMuteButton;
  98968. /**
  98969. * Destroy and release the resources associated with the audio ccontext.
  98970. */
  98971. dispose(): void;
  98972. /**
  98973. * Gets the global volume sets on the master gain.
  98974. * @returns the global volume if set or -1 otherwise
  98975. */
  98976. getGlobalVolume(): number;
  98977. /**
  98978. * Sets the global volume of your experience (sets on the master gain).
  98979. * @param newVolume Defines the new global volume of the application
  98980. */
  98981. setGlobalVolume(newVolume: number): void;
  98982. /**
  98983. * Connect the audio engine to an audio analyser allowing some amazing
  98984. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  98985. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  98986. * @param analyser The analyser to connect to the engine
  98987. */
  98988. connectToAnalyser(analyser: Analyser): void;
  98989. }
  98990. }
  98991. declare module BABYLON {
  98992. /**
  98993. * Interface used to present a loading screen while loading a scene
  98994. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  98995. */
  98996. export interface ILoadingScreen {
  98997. /**
  98998. * Function called to display the loading screen
  98999. */
  99000. displayLoadingUI: () => void;
  99001. /**
  99002. * Function called to hide the loading screen
  99003. */
  99004. hideLoadingUI: () => void;
  99005. /**
  99006. * Gets or sets the color to use for the background
  99007. */
  99008. loadingUIBackgroundColor: string;
  99009. /**
  99010. * Gets or sets the text to display while loading
  99011. */
  99012. loadingUIText: string;
  99013. }
  99014. /**
  99015. * Class used for the default loading screen
  99016. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99017. */
  99018. export class DefaultLoadingScreen implements ILoadingScreen {
  99019. private _renderingCanvas;
  99020. private _loadingText;
  99021. private _loadingDivBackgroundColor;
  99022. private _loadingDiv;
  99023. private _loadingTextDiv;
  99024. /** Gets or sets the logo url to use for the default loading screen */
  99025. static DefaultLogoUrl: string;
  99026. /** Gets or sets the spinner url to use for the default loading screen */
  99027. static DefaultSpinnerUrl: string;
  99028. /**
  99029. * Creates a new default loading screen
  99030. * @param _renderingCanvas defines the canvas used to render the scene
  99031. * @param _loadingText defines the default text to display
  99032. * @param _loadingDivBackgroundColor defines the default background color
  99033. */
  99034. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  99035. /**
  99036. * Function called to display the loading screen
  99037. */
  99038. displayLoadingUI(): void;
  99039. /**
  99040. * Function called to hide the loading screen
  99041. */
  99042. hideLoadingUI(): void;
  99043. /**
  99044. * Gets or sets the text to display while loading
  99045. */
  99046. loadingUIText: string;
  99047. /**
  99048. * Gets or sets the color to use for the background
  99049. */
  99050. loadingUIBackgroundColor: string;
  99051. private _resizeLoadingUI;
  99052. }
  99053. }
  99054. declare module BABYLON {
  99055. /**
  99056. * Interface for any object that can request an animation frame
  99057. */
  99058. export interface ICustomAnimationFrameRequester {
  99059. /**
  99060. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  99061. */
  99062. renderFunction?: Function;
  99063. /**
  99064. * Called to request the next frame to render to
  99065. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  99066. */
  99067. requestAnimationFrame: Function;
  99068. /**
  99069. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  99070. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  99071. */
  99072. requestID?: number;
  99073. }
  99074. }
  99075. declare module BABYLON {
  99076. /**
  99077. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  99078. */
  99079. export class PerformanceMonitor {
  99080. private _enabled;
  99081. private _rollingFrameTime;
  99082. private _lastFrameTimeMs;
  99083. /**
  99084. * constructor
  99085. * @param frameSampleSize The number of samples required to saturate the sliding window
  99086. */
  99087. constructor(frameSampleSize?: number);
  99088. /**
  99089. * Samples current frame
  99090. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  99091. */
  99092. sampleFrame(timeMs?: number): void;
  99093. /**
  99094. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  99095. */
  99096. readonly averageFrameTime: number;
  99097. /**
  99098. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  99099. */
  99100. readonly averageFrameTimeVariance: number;
  99101. /**
  99102. * Returns the frame time of the most recent frame
  99103. */
  99104. readonly instantaneousFrameTime: number;
  99105. /**
  99106. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  99107. */
  99108. readonly averageFPS: number;
  99109. /**
  99110. * Returns the average framerate in frames per second using the most recent frame time
  99111. */
  99112. readonly instantaneousFPS: number;
  99113. /**
  99114. * Returns true if enough samples have been taken to completely fill the sliding window
  99115. */
  99116. readonly isSaturated: boolean;
  99117. /**
  99118. * Enables contributions to the sliding window sample set
  99119. */
  99120. enable(): void;
  99121. /**
  99122. * Disables contributions to the sliding window sample set
  99123. * Samples will not be interpolated over the disabled period
  99124. */
  99125. disable(): void;
  99126. /**
  99127. * Returns true if sampling is enabled
  99128. */
  99129. readonly isEnabled: boolean;
  99130. /**
  99131. * Resets performance monitor
  99132. */
  99133. reset(): void;
  99134. }
  99135. /**
  99136. * RollingAverage
  99137. *
  99138. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  99139. */
  99140. export class RollingAverage {
  99141. /**
  99142. * Current average
  99143. */
  99144. average: number;
  99145. /**
  99146. * Current variance
  99147. */
  99148. variance: number;
  99149. protected _samples: Array<number>;
  99150. protected _sampleCount: number;
  99151. protected _pos: number;
  99152. protected _m2: number;
  99153. /**
  99154. * constructor
  99155. * @param length The number of samples required to saturate the sliding window
  99156. */
  99157. constructor(length: number);
  99158. /**
  99159. * Adds a sample to the sample set
  99160. * @param v The sample value
  99161. */
  99162. add(v: number): void;
  99163. /**
  99164. * Returns previously added values or null if outside of history or outside the sliding window domain
  99165. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  99166. * @return Value previously recorded with add() or null if outside of range
  99167. */
  99168. history(i: number): number;
  99169. /**
  99170. * Returns true if enough samples have been taken to completely fill the sliding window
  99171. * @return true if sample-set saturated
  99172. */
  99173. isSaturated(): boolean;
  99174. /**
  99175. * Resets the rolling average (equivalent to 0 samples taken so far)
  99176. */
  99177. reset(): void;
  99178. /**
  99179. * Wraps a value around the sample range boundaries
  99180. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  99181. * @return Wrapped position in sample range
  99182. */
  99183. protected _wrapPosition(i: number): number;
  99184. }
  99185. }
  99186. declare module BABYLON {
  99187. /**
  99188. * This class is used to track a performance counter which is number based.
  99189. * The user has access to many properties which give statistics of different nature.
  99190. *
  99191. * The implementer can track two kinds of Performance Counter: time and count.
  99192. * For time you can optionally call fetchNewFrame() to notify the start of a new frame to monitor, then call beginMonitoring() to start and endMonitoring() to record the lapsed time. endMonitoring takes a newFrame parameter for you to specify if the monitored time should be set for a new frame or accumulated to the current frame being monitored.
  99193. * For count you first have to call fetchNewFrame() to notify the start of a new frame to monitor, then call addCount() how many time required to increment the count value you monitor.
  99194. */
  99195. export class PerfCounter {
  99196. /**
  99197. * Gets or sets a global boolean to turn on and off all the counters
  99198. */
  99199. static Enabled: boolean;
  99200. /**
  99201. * Returns the smallest value ever
  99202. */
  99203. readonly min: number;
  99204. /**
  99205. * Returns the biggest value ever
  99206. */
  99207. readonly max: number;
  99208. /**
  99209. * Returns the average value since the performance counter is running
  99210. */
  99211. readonly average: number;
  99212. /**
  99213. * Returns the average value of the last second the counter was monitored
  99214. */
  99215. readonly lastSecAverage: number;
  99216. /**
  99217. * Returns the current value
  99218. */
  99219. readonly current: number;
  99220. /**
  99221. * Gets the accumulated total
  99222. */
  99223. readonly total: number;
  99224. /**
  99225. * Gets the total value count
  99226. */
  99227. readonly count: number;
  99228. /**
  99229. * Creates a new counter
  99230. */
  99231. constructor();
  99232. /**
  99233. * Call this method to start monitoring a new frame.
  99234. * This scenario is typically used when you accumulate monitoring time many times for a single frame, you call this method at the start of the frame, then beginMonitoring to start recording and endMonitoring(false) to accumulated the recorded time to the PerfCounter or addCount() to accumulate a monitored count.
  99235. */
  99236. fetchNewFrame(): void;
  99237. /**
  99238. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  99239. * @param newCount the count value to add to the monitored count
  99240. * @param fetchResult true when it's the last time in the frame you add to the counter and you wish to update the statistics properties (min/max/average), false if you only want to update statistics.
  99241. */
  99242. addCount(newCount: number, fetchResult: boolean): void;
  99243. /**
  99244. * Start monitoring this performance counter
  99245. */
  99246. beginMonitoring(): void;
  99247. /**
  99248. * Compute the time lapsed since the previous beginMonitoring() call.
  99249. * @param newFrame true by default to fetch the result and monitor a new frame, if false the time monitored will be added to the current frame counter
  99250. */
  99251. endMonitoring(newFrame?: boolean): void;
  99252. private _fetchResult;
  99253. private _startMonitoringTime;
  99254. private _min;
  99255. private _max;
  99256. private _average;
  99257. private _current;
  99258. private _totalValueCount;
  99259. private _totalAccumulated;
  99260. private _lastSecAverage;
  99261. private _lastSecAccumulated;
  99262. private _lastSecTime;
  99263. private _lastSecValueCount;
  99264. }
  99265. }
  99266. declare module BABYLON {
  99267. /**
  99268. * Defines the interface used by display changed events
  99269. */
  99270. export interface IDisplayChangedEventArgs {
  99271. /** Gets the vrDisplay object (if any) */
  99272. vrDisplay: Nullable<any>;
  99273. /** Gets a boolean indicating if webVR is supported */
  99274. vrSupported: boolean;
  99275. }
  99276. /**
  99277. * Defines the interface used by objects containing a viewport (like a camera)
  99278. */
  99279. interface IViewportOwnerLike {
  99280. /**
  99281. * Gets or sets the viewport
  99282. */
  99283. viewport: IViewportLike;
  99284. }
  99285. /**
  99286. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  99287. */
  99288. export class Engine extends ThinEngine {
  99289. /** Defines that alpha blending is disabled */
  99290. static readonly ALPHA_DISABLE: number;
  99291. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  99292. static readonly ALPHA_ADD: number;
  99293. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  99294. static readonly ALPHA_COMBINE: number;
  99295. /** Defines that alpha blending to DEST - SRC * DEST */
  99296. static readonly ALPHA_SUBTRACT: number;
  99297. /** Defines that alpha blending to SRC * DEST */
  99298. static readonly ALPHA_MULTIPLY: number;
  99299. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  99300. static readonly ALPHA_MAXIMIZED: number;
  99301. /** Defines that alpha blending to SRC + DEST */
  99302. static readonly ALPHA_ONEONE: number;
  99303. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  99304. static readonly ALPHA_PREMULTIPLIED: number;
  99305. /**
  99306. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  99307. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  99308. */
  99309. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  99310. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  99311. static readonly ALPHA_INTERPOLATE: number;
  99312. /**
  99313. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  99314. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  99315. */
  99316. static readonly ALPHA_SCREENMODE: number;
  99317. /** Defines that the ressource is not delayed*/
  99318. static readonly DELAYLOADSTATE_NONE: number;
  99319. /** Defines that the ressource was successfully delay loaded */
  99320. static readonly DELAYLOADSTATE_LOADED: number;
  99321. /** Defines that the ressource is currently delay loading */
  99322. static readonly DELAYLOADSTATE_LOADING: number;
  99323. /** Defines that the ressource is delayed and has not started loading */
  99324. static readonly DELAYLOADSTATE_NOTLOADED: number;
  99325. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  99326. static readonly NEVER: number;
  99327. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  99328. static readonly ALWAYS: number;
  99329. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  99330. static readonly LESS: number;
  99331. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  99332. static readonly EQUAL: number;
  99333. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  99334. static readonly LEQUAL: number;
  99335. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  99336. static readonly GREATER: number;
  99337. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  99338. static readonly GEQUAL: number;
  99339. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  99340. static readonly NOTEQUAL: number;
  99341. /** Passed to stencilOperation to specify that stencil value must be kept */
  99342. static readonly KEEP: number;
  99343. /** Passed to stencilOperation to specify that stencil value must be replaced */
  99344. static readonly REPLACE: number;
  99345. /** Passed to stencilOperation to specify that stencil value must be incremented */
  99346. static readonly INCR: number;
  99347. /** Passed to stencilOperation to specify that stencil value must be decremented */
  99348. static readonly DECR: number;
  99349. /** Passed to stencilOperation to specify that stencil value must be inverted */
  99350. static readonly INVERT: number;
  99351. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  99352. static readonly INCR_WRAP: number;
  99353. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  99354. static readonly DECR_WRAP: number;
  99355. /** Texture is not repeating outside of 0..1 UVs */
  99356. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  99357. /** Texture is repeating outside of 0..1 UVs */
  99358. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  99359. /** Texture is repeating and mirrored */
  99360. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  99361. /** ALPHA */
  99362. static readonly TEXTUREFORMAT_ALPHA: number;
  99363. /** LUMINANCE */
  99364. static readonly TEXTUREFORMAT_LUMINANCE: number;
  99365. /** LUMINANCE_ALPHA */
  99366. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  99367. /** RGB */
  99368. static readonly TEXTUREFORMAT_RGB: number;
  99369. /** RGBA */
  99370. static readonly TEXTUREFORMAT_RGBA: number;
  99371. /** RED */
  99372. static readonly TEXTUREFORMAT_RED: number;
  99373. /** RED (2nd reference) */
  99374. static readonly TEXTUREFORMAT_R: number;
  99375. /** RG */
  99376. static readonly TEXTUREFORMAT_RG: number;
  99377. /** RED_INTEGER */
  99378. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  99379. /** RED_INTEGER (2nd reference) */
  99380. static readonly TEXTUREFORMAT_R_INTEGER: number;
  99381. /** RG_INTEGER */
  99382. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  99383. /** RGB_INTEGER */
  99384. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  99385. /** RGBA_INTEGER */
  99386. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  99387. /** UNSIGNED_BYTE */
  99388. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  99389. /** UNSIGNED_BYTE (2nd reference) */
  99390. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  99391. /** FLOAT */
  99392. static readonly TEXTURETYPE_FLOAT: number;
  99393. /** HALF_FLOAT */
  99394. static readonly TEXTURETYPE_HALF_FLOAT: number;
  99395. /** BYTE */
  99396. static readonly TEXTURETYPE_BYTE: number;
  99397. /** SHORT */
  99398. static readonly TEXTURETYPE_SHORT: number;
  99399. /** UNSIGNED_SHORT */
  99400. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  99401. /** INT */
  99402. static readonly TEXTURETYPE_INT: number;
  99403. /** UNSIGNED_INT */
  99404. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  99405. /** UNSIGNED_SHORT_4_4_4_4 */
  99406. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  99407. /** UNSIGNED_SHORT_5_5_5_1 */
  99408. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  99409. /** UNSIGNED_SHORT_5_6_5 */
  99410. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  99411. /** UNSIGNED_INT_2_10_10_10_REV */
  99412. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  99413. /** UNSIGNED_INT_24_8 */
  99414. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  99415. /** UNSIGNED_INT_10F_11F_11F_REV */
  99416. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  99417. /** UNSIGNED_INT_5_9_9_9_REV */
  99418. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  99419. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  99420. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  99421. /** nearest is mag = nearest and min = nearest and mip = linear */
  99422. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  99423. /** Bilinear is mag = linear and min = linear and mip = nearest */
  99424. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  99425. /** Trilinear is mag = linear and min = linear and mip = linear */
  99426. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  99427. /** nearest is mag = nearest and min = nearest and mip = linear */
  99428. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  99429. /** Bilinear is mag = linear and min = linear and mip = nearest */
  99430. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  99431. /** Trilinear is mag = linear and min = linear and mip = linear */
  99432. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  99433. /** mag = nearest and min = nearest and mip = nearest */
  99434. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  99435. /** mag = nearest and min = linear and mip = nearest */
  99436. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  99437. /** mag = nearest and min = linear and mip = linear */
  99438. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  99439. /** mag = nearest and min = linear and mip = none */
  99440. static readonly TEXTURE_NEAREST_LINEAR: number;
  99441. /** mag = nearest and min = nearest and mip = none */
  99442. static readonly TEXTURE_NEAREST_NEAREST: number;
  99443. /** mag = linear and min = nearest and mip = nearest */
  99444. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  99445. /** mag = linear and min = nearest and mip = linear */
  99446. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  99447. /** mag = linear and min = linear and mip = none */
  99448. static readonly TEXTURE_LINEAR_LINEAR: number;
  99449. /** mag = linear and min = nearest and mip = none */
  99450. static readonly TEXTURE_LINEAR_NEAREST: number;
  99451. /** Explicit coordinates mode */
  99452. static readonly TEXTURE_EXPLICIT_MODE: number;
  99453. /** Spherical coordinates mode */
  99454. static readonly TEXTURE_SPHERICAL_MODE: number;
  99455. /** Planar coordinates mode */
  99456. static readonly TEXTURE_PLANAR_MODE: number;
  99457. /** Cubic coordinates mode */
  99458. static readonly TEXTURE_CUBIC_MODE: number;
  99459. /** Projection coordinates mode */
  99460. static readonly TEXTURE_PROJECTION_MODE: number;
  99461. /** Skybox coordinates mode */
  99462. static readonly TEXTURE_SKYBOX_MODE: number;
  99463. /** Inverse Cubic coordinates mode */
  99464. static readonly TEXTURE_INVCUBIC_MODE: number;
  99465. /** Equirectangular coordinates mode */
  99466. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  99467. /** Equirectangular Fixed coordinates mode */
  99468. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  99469. /** Equirectangular Fixed Mirrored coordinates mode */
  99470. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  99471. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  99472. static readonly SCALEMODE_FLOOR: number;
  99473. /** Defines that texture rescaling will look for the nearest power of 2 size */
  99474. static readonly SCALEMODE_NEAREST: number;
  99475. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  99476. static readonly SCALEMODE_CEILING: number;
  99477. /**
  99478. * Returns the current npm package of the sdk
  99479. */
  99480. static readonly NpmPackage: string;
  99481. /**
  99482. * Returns the current version of the framework
  99483. */
  99484. static readonly Version: string;
  99485. /** Gets the list of created engines */
  99486. static readonly Instances: Engine[];
  99487. /**
  99488. * Gets the latest created engine
  99489. */
  99490. static readonly LastCreatedEngine: Nullable<Engine>;
  99491. /**
  99492. * Gets the latest created scene
  99493. */
  99494. static readonly LastCreatedScene: Nullable<Scene>;
  99495. /**
  99496. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  99497. * @param flag defines which part of the materials must be marked as dirty
  99498. * @param predicate defines a predicate used to filter which materials should be affected
  99499. */
  99500. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  99501. /**
  99502. * Method called to create the default loading screen.
  99503. * This can be overriden in your own app.
  99504. * @param canvas The rendering canvas element
  99505. * @returns The loading screen
  99506. */
  99507. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  99508. /**
  99509. * Method called to create the default rescale post process on each engine.
  99510. */
  99511. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  99512. /**
  99513. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  99514. **/
  99515. enableOfflineSupport: boolean;
  99516. /**
  99517. * Gets or sets a boolean to enable/disable checking manifest if IndexedDB support is enabled (js will always consider the database is up to date)
  99518. **/
  99519. disableManifestCheck: boolean;
  99520. /**
  99521. * Gets the list of created scenes
  99522. */
  99523. scenes: Scene[];
  99524. /**
  99525. * Event raised when a new scene is created
  99526. */
  99527. onNewSceneAddedObservable: Observable<Scene>;
  99528. /**
  99529. * Gets the list of created postprocesses
  99530. */
  99531. postProcesses: PostProcess[];
  99532. /**
  99533. * Gets a boolean indicating if the pointer is currently locked
  99534. */
  99535. isPointerLock: boolean;
  99536. /**
  99537. * Observable event triggered each time the rendering canvas is resized
  99538. */
  99539. onResizeObservable: Observable<Engine>;
  99540. /**
  99541. * Observable event triggered each time the canvas loses focus
  99542. */
  99543. onCanvasBlurObservable: Observable<Engine>;
  99544. /**
  99545. * Observable event triggered each time the canvas gains focus
  99546. */
  99547. onCanvasFocusObservable: Observable<Engine>;
  99548. /**
  99549. * Observable event triggered each time the canvas receives pointerout event
  99550. */
  99551. onCanvasPointerOutObservable: Observable<PointerEvent>;
  99552. /**
  99553. * Observable raised when the engine begins a new frame
  99554. */
  99555. onBeginFrameObservable: Observable<Engine>;
  99556. /**
  99557. * If set, will be used to request the next animation frame for the render loop
  99558. */
  99559. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  99560. /**
  99561. * Observable raised when the engine ends the current frame
  99562. */
  99563. onEndFrameObservable: Observable<Engine>;
  99564. /**
  99565. * Observable raised when the engine is about to compile a shader
  99566. */
  99567. onBeforeShaderCompilationObservable: Observable<Engine>;
  99568. /**
  99569. * Observable raised when the engine has jsut compiled a shader
  99570. */
  99571. onAfterShaderCompilationObservable: Observable<Engine>;
  99572. /**
  99573. * Gets the audio engine
  99574. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99575. * @ignorenaming
  99576. */
  99577. static audioEngine: IAudioEngine;
  99578. /**
  99579. * Default AudioEngine factory responsible of creating the Audio Engine.
  99580. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  99581. */
  99582. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  99583. /**
  99584. * Default offline support factory responsible of creating a tool used to store data locally.
  99585. * By default, this will create a Database object if the workload has been embedded.
  99586. */
  99587. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  99588. private _loadingScreen;
  99589. private _pointerLockRequested;
  99590. private _dummyFramebuffer;
  99591. private _rescalePostProcess;
  99592. /** @hidden */
  99593. protected _alphaMode: number;
  99594. /** @hidden */
  99595. protected _alphaEquation: number;
  99596. private _deterministicLockstep;
  99597. private _lockstepMaxSteps;
  99598. protected readonly _supportsHardwareTextureRescaling: boolean;
  99599. private _fps;
  99600. private _deltaTime;
  99601. /** @hidden */
  99602. _drawCalls: PerfCounter;
  99603. /**
  99604. * Turn this value on if you want to pause FPS computation when in background
  99605. */
  99606. disablePerformanceMonitorInBackground: boolean;
  99607. private _performanceMonitor;
  99608. /**
  99609. * Gets the performance monitor attached to this engine
  99610. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  99611. */
  99612. readonly performanceMonitor: PerformanceMonitor;
  99613. private _onFocus;
  99614. private _onBlur;
  99615. private _onCanvasPointerOut;
  99616. private _onCanvasBlur;
  99617. private _onCanvasFocus;
  99618. private _onFullscreenChange;
  99619. private _onPointerLockChange;
  99620. /**
  99621. * Gets the HTML element used to attach event listeners
  99622. * @returns a HTML element
  99623. */
  99624. getInputElement(): Nullable<HTMLElement>;
  99625. /**
  99626. * Creates a new engine
  99627. * @param canvasOrContext defines the canvas or WebGL context to use for rendering. If you provide a WebGL context, Babylon.js will not hook events on the canvas (like pointers, keyboards, etc...) so no event observables will be available. This is mostly used when Babylon.js is used as a plugin on a system which alreay used the WebGL context
  99628. * @param antialias defines enable antialiasing (default: false)
  99629. * @param options defines further options to be sent to the getContext() function
  99630. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  99631. */
  99632. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  99633. /**
  99634. * Gets current aspect ratio
  99635. * @param viewportOwner defines the camera to use to get the aspect ratio
  99636. * @param useScreen defines if screen size must be used (or the current render target if any)
  99637. * @returns a number defining the aspect ratio
  99638. */
  99639. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  99640. /**
  99641. * Gets current screen aspect ratio
  99642. * @returns a number defining the aspect ratio
  99643. */
  99644. getScreenAspectRatio(): number;
  99645. /**
  99646. * Gets host document
  99647. * @returns the host document object
  99648. */
  99649. getHostDocument(): Document;
  99650. /**
  99651. * Gets the client rect of the HTML canvas attached with the current webGL context
  99652. * @returns a client rectanglee
  99653. */
  99654. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  99655. /**
  99656. * Gets the client rect of the HTML element used for events
  99657. * @returns a client rectanglee
  99658. */
  99659. getInputElementClientRect(): Nullable<ClientRect>;
  99660. /**
  99661. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  99662. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  99663. * @returns true if engine is in deterministic lock step mode
  99664. */
  99665. isDeterministicLockStep(): boolean;
  99666. /**
  99667. * Gets the max steps when engine is running in deterministic lock step
  99668. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  99669. * @returns the max steps
  99670. */
  99671. getLockstepMaxSteps(): number;
  99672. /**
  99673. * Force the mipmap generation for the given render target texture
  99674. * @param texture defines the render target texture to use
  99675. */
  99676. generateMipMapsForCubemap(texture: InternalTexture): void;
  99677. /** States */
  99678. /**
  99679. * Set various states to the webGL context
  99680. * @param culling defines backface culling state
  99681. * @param zOffset defines the value to apply to zOffset (0 by default)
  99682. * @param force defines if states must be applied even if cache is up to date
  99683. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  99684. */
  99685. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  99686. /**
  99687. * Set the z offset to apply to current rendering
  99688. * @param value defines the offset to apply
  99689. */
  99690. setZOffset(value: number): void;
  99691. /**
  99692. * Gets the current value of the zOffset
  99693. * @returns the current zOffset state
  99694. */
  99695. getZOffset(): number;
  99696. /**
  99697. * Enable or disable depth buffering
  99698. * @param enable defines the state to set
  99699. */
  99700. setDepthBuffer(enable: boolean): void;
  99701. /**
  99702. * Gets a boolean indicating if depth writing is enabled
  99703. * @returns the current depth writing state
  99704. */
  99705. getDepthWrite(): boolean;
  99706. /**
  99707. * Enable or disable depth writing
  99708. * @param enable defines the state to set
  99709. */
  99710. setDepthWrite(enable: boolean): void;
  99711. /**
  99712. * Enable or disable color writing
  99713. * @param enable defines the state to set
  99714. */
  99715. setColorWrite(enable: boolean): void;
  99716. /**
  99717. * Gets a boolean indicating if color writing is enabled
  99718. * @returns the current color writing state
  99719. */
  99720. getColorWrite(): boolean;
  99721. /**
  99722. * Sets alpha constants used by some alpha blending modes
  99723. * @param r defines the red component
  99724. * @param g defines the green component
  99725. * @param b defines the blue component
  99726. * @param a defines the alpha component
  99727. */
  99728. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  99729. /**
  99730. * Sets the current alpha mode
  99731. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  99732. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  99733. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  99734. */
  99735. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  99736. /**
  99737. * Gets the current alpha mode
  99738. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  99739. * @returns the current alpha mode
  99740. */
  99741. getAlphaMode(): number;
  99742. /**
  99743. * Sets the current alpha equation
  99744. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  99745. */
  99746. setAlphaEquation(equation: number): void;
  99747. /**
  99748. * Gets the current alpha equation.
  99749. * @returns the current alpha equation
  99750. */
  99751. getAlphaEquation(): number;
  99752. /**
  99753. * Gets a boolean indicating if stencil buffer is enabled
  99754. * @returns the current stencil buffer state
  99755. */
  99756. getStencilBuffer(): boolean;
  99757. /**
  99758. * Enable or disable the stencil buffer
  99759. * @param enable defines if the stencil buffer must be enabled or disabled
  99760. */
  99761. setStencilBuffer(enable: boolean): void;
  99762. /**
  99763. * Gets the current stencil mask
  99764. * @returns a number defining the new stencil mask to use
  99765. */
  99766. getStencilMask(): number;
  99767. /**
  99768. * Sets the current stencil mask
  99769. * @param mask defines the new stencil mask to use
  99770. */
  99771. setStencilMask(mask: number): void;
  99772. /**
  99773. * Gets the current stencil function
  99774. * @returns a number defining the stencil function to use
  99775. */
  99776. getStencilFunction(): number;
  99777. /**
  99778. * Gets the current stencil reference value
  99779. * @returns a number defining the stencil reference value to use
  99780. */
  99781. getStencilFunctionReference(): number;
  99782. /**
  99783. * Gets the current stencil mask
  99784. * @returns a number defining the stencil mask to use
  99785. */
  99786. getStencilFunctionMask(): number;
  99787. /**
  99788. * Sets the current stencil function
  99789. * @param stencilFunc defines the new stencil function to use
  99790. */
  99791. setStencilFunction(stencilFunc: number): void;
  99792. /**
  99793. * Sets the current stencil reference
  99794. * @param reference defines the new stencil reference to use
  99795. */
  99796. setStencilFunctionReference(reference: number): void;
  99797. /**
  99798. * Sets the current stencil mask
  99799. * @param mask defines the new stencil mask to use
  99800. */
  99801. setStencilFunctionMask(mask: number): void;
  99802. /**
  99803. * Gets the current stencil operation when stencil fails
  99804. * @returns a number defining stencil operation to use when stencil fails
  99805. */
  99806. getStencilOperationFail(): number;
  99807. /**
  99808. * Gets the current stencil operation when depth fails
  99809. * @returns a number defining stencil operation to use when depth fails
  99810. */
  99811. getStencilOperationDepthFail(): number;
  99812. /**
  99813. * Gets the current stencil operation when stencil passes
  99814. * @returns a number defining stencil operation to use when stencil passes
  99815. */
  99816. getStencilOperationPass(): number;
  99817. /**
  99818. * Sets the stencil operation to use when stencil fails
  99819. * @param operation defines the stencil operation to use when stencil fails
  99820. */
  99821. setStencilOperationFail(operation: number): void;
  99822. /**
  99823. * Sets the stencil operation to use when depth fails
  99824. * @param operation defines the stencil operation to use when depth fails
  99825. */
  99826. setStencilOperationDepthFail(operation: number): void;
  99827. /**
  99828. * Sets the stencil operation to use when stencil passes
  99829. * @param operation defines the stencil operation to use when stencil passes
  99830. */
  99831. setStencilOperationPass(operation: number): void;
  99832. /**
  99833. * Sets a boolean indicating if the dithering state is enabled or disabled
  99834. * @param value defines the dithering state
  99835. */
  99836. setDitheringState(value: boolean): void;
  99837. /**
  99838. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  99839. * @param value defines the rasterizer state
  99840. */
  99841. setRasterizerState(value: boolean): void;
  99842. /**
  99843. * Gets the current depth function
  99844. * @returns a number defining the depth function
  99845. */
  99846. getDepthFunction(): Nullable<number>;
  99847. /**
  99848. * Sets the current depth function
  99849. * @param depthFunc defines the function to use
  99850. */
  99851. setDepthFunction(depthFunc: number): void;
  99852. /**
  99853. * Sets the current depth function to GREATER
  99854. */
  99855. setDepthFunctionToGreater(): void;
  99856. /**
  99857. * Sets the current depth function to GEQUAL
  99858. */
  99859. setDepthFunctionToGreaterOrEqual(): void;
  99860. /**
  99861. * Sets the current depth function to LESS
  99862. */
  99863. setDepthFunctionToLess(): void;
  99864. /**
  99865. * Sets the current depth function to LEQUAL
  99866. */
  99867. setDepthFunctionToLessOrEqual(): void;
  99868. private _cachedStencilBuffer;
  99869. private _cachedStencilFunction;
  99870. private _cachedStencilMask;
  99871. private _cachedStencilOperationPass;
  99872. private _cachedStencilOperationFail;
  99873. private _cachedStencilOperationDepthFail;
  99874. private _cachedStencilReference;
  99875. /**
  99876. * Caches the the state of the stencil buffer
  99877. */
  99878. cacheStencilState(): void;
  99879. /**
  99880. * Restores the state of the stencil buffer
  99881. */
  99882. restoreStencilState(): void;
  99883. /**
  99884. * Directly set the WebGL Viewport
  99885. * @param x defines the x coordinate of the viewport (in screen space)
  99886. * @param y defines the y coordinate of the viewport (in screen space)
  99887. * @param width defines the width of the viewport (in screen space)
  99888. * @param height defines the height of the viewport (in screen space)
  99889. * @return the current viewport Object (if any) that is being replaced by this call. You can restore this viewport later on to go back to the original state
  99890. */
  99891. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  99892. /**
  99893. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  99894. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  99895. * @param y defines the y-coordinate of the corner of the clear rectangle
  99896. * @param width defines the width of the clear rectangle
  99897. * @param height defines the height of the clear rectangle
  99898. * @param clearColor defines the clear color
  99899. */
  99900. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  99901. /**
  99902. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  99903. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  99904. * @param y defines the y-coordinate of the corner of the clear rectangle
  99905. * @param width defines the width of the clear rectangle
  99906. * @param height defines the height of the clear rectangle
  99907. */
  99908. enableScissor(x: number, y: number, width: number, height: number): void;
  99909. /**
  99910. * Disable previously set scissor test rectangle
  99911. */
  99912. disableScissor(): void;
  99913. protected _reportDrawCall(): void;
  99914. /**
  99915. * Initializes a webVR display and starts listening to display change events
  99916. * The onVRDisplayChangedObservable will be notified upon these changes
  99917. * @returns The onVRDisplayChangedObservable
  99918. */
  99919. initWebVR(): Observable<IDisplayChangedEventArgs>;
  99920. /** @hidden */
  99921. _prepareVRComponent(): void;
  99922. /** @hidden */
  99923. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  99924. /** @hidden */
  99925. _submitVRFrame(): void;
  99926. /**
  99927. * Call this function to leave webVR mode
  99928. * Will do nothing if webVR is not supported or if there is no webVR device
  99929. * @see http://doc.babylonjs.com/how_to/webvr_camera
  99930. */
  99931. disableVR(): void;
  99932. /**
  99933. * Gets a boolean indicating that the system is in VR mode and is presenting
  99934. * @returns true if VR mode is engaged
  99935. */
  99936. isVRPresenting(): boolean;
  99937. /** @hidden */
  99938. _requestVRFrame(): void;
  99939. /** @hidden */
  99940. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  99941. /**
  99942. * Gets the source code of the vertex shader associated with a specific webGL program
  99943. * @param program defines the program to use
  99944. * @returns a string containing the source code of the vertex shader associated with the program
  99945. */
  99946. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  99947. /**
  99948. * Gets the source code of the fragment shader associated with a specific webGL program
  99949. * @param program defines the program to use
  99950. * @returns a string containing the source code of the fragment shader associated with the program
  99951. */
  99952. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  99953. /**
  99954. * Reads pixels from the current frame buffer. Please note that this function can be slow
  99955. * @param x defines the x coordinate of the rectangle where pixels must be read
  99956. * @param y defines the y coordinate of the rectangle where pixels must be read
  99957. * @param width defines the width of the rectangle where pixels must be read
  99958. * @param height defines the height of the rectangle where pixels must be read
  99959. * @returns a Uint8Array containing RGBA colors
  99960. */
  99961. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  99962. /**
  99963. * Sets a depth stencil texture from a render target to the according uniform.
  99964. * @param channel The texture channel
  99965. * @param uniform The uniform to set
  99966. * @param texture The render target texture containing the depth stencil texture to apply
  99967. */
  99968. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  99969. /**
  99970. * Sets a texture to the webGL context from a postprocess
  99971. * @param channel defines the channel to use
  99972. * @param postProcess defines the source postprocess
  99973. */
  99974. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  99975. /**
  99976. * Binds the output of the passed in post process to the texture channel specified
  99977. * @param channel The channel the texture should be bound to
  99978. * @param postProcess The post process which's output should be bound
  99979. */
  99980. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  99981. /** @hidden */
  99982. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  99983. protected _rebuildBuffers(): void;
  99984. /** @hidden */
  99985. _renderFrame(): void;
  99986. _renderLoop(): void;
  99987. /** @hidden */
  99988. _renderViews(): boolean;
  99989. /**
  99990. * Toggle full screen mode
  99991. * @param requestPointerLock defines if a pointer lock should be requested from the user
  99992. */
  99993. switchFullscreen(requestPointerLock: boolean): void;
  99994. /**
  99995. * Enters full screen mode
  99996. * @param requestPointerLock defines if a pointer lock should be requested from the user
  99997. */
  99998. enterFullscreen(requestPointerLock: boolean): void;
  99999. /**
  100000. * Exits full screen mode
  100001. */
  100002. exitFullscreen(): void;
  100003. /**
  100004. * Enters Pointerlock mode
  100005. */
  100006. enterPointerlock(): void;
  100007. /**
  100008. * Exits Pointerlock mode
  100009. */
  100010. exitPointerlock(): void;
  100011. /**
  100012. * Begin a new frame
  100013. */
  100014. beginFrame(): void;
  100015. /**
  100016. * Enf the current frame
  100017. */
  100018. endFrame(): void;
  100019. resize(): void;
  100020. /**
  100021. * Set the compressed texture format to use, based on the formats you have, and the formats
  100022. * supported by the hardware / browser.
  100023. *
  100024. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  100025. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  100026. * to API arguments needed to compressed textures. This puts the burden on the container
  100027. * generator to house the arcane code for determining these for current & future formats.
  100028. *
  100029. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  100030. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  100031. *
  100032. * Note: The result of this call is not taken into account when a texture is base64.
  100033. *
  100034. * @param formatsAvailable defines the list of those format families you have created
  100035. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  100036. *
  100037. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  100038. * @returns The extension selected.
  100039. */
  100040. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  100041. /**
  100042. * Force a specific size of the canvas
  100043. * @param width defines the new canvas' width
  100044. * @param height defines the new canvas' height
  100045. */
  100046. setSize(width: number, height: number): void;
  100047. /**
  100048. * Updates a dynamic vertex buffer.
  100049. * @param vertexBuffer the vertex buffer to update
  100050. * @param data the data used to update the vertex buffer
  100051. * @param byteOffset the byte offset of the data
  100052. * @param byteLength the byte length of the data
  100053. */
  100054. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  100055. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  100056. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  100057. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  100058. _releaseTexture(texture: InternalTexture): void;
  100059. /**
  100060. * @hidden
  100061. * Rescales a texture
  100062. * @param source input texutre
  100063. * @param destination destination texture
  100064. * @param scene scene to use to render the resize
  100065. * @param internalFormat format to use when resizing
  100066. * @param onComplete callback to be called when resize has completed
  100067. */
  100068. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  100069. /**
  100070. * Gets the current framerate
  100071. * @returns a number representing the framerate
  100072. */
  100073. getFps(): number;
  100074. /**
  100075. * Gets the time spent between current and previous frame
  100076. * @returns a number representing the delta time in ms
  100077. */
  100078. getDeltaTime(): number;
  100079. private _measureFps;
  100080. /** @hidden */
  100081. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  100082. /**
  100083. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  100084. * @param renderTarget The render target to set the frame buffer for
  100085. */
  100086. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  100087. /**
  100088. * Update a dynamic index buffer
  100089. * @param indexBuffer defines the target index buffer
  100090. * @param indices defines the data to update
  100091. * @param offset defines the offset in the target index buffer where update should start
  100092. */
  100093. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  100094. /**
  100095. * Updates the sample count of a render target texture
  100096. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  100097. * @param texture defines the texture to update
  100098. * @param samples defines the sample count to set
  100099. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  100100. */
  100101. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  100102. /**
  100103. * Updates a depth texture Comparison Mode and Function.
  100104. * If the comparison Function is equal to 0, the mode will be set to none.
  100105. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  100106. * @param texture The texture to set the comparison function for
  100107. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  100108. */
  100109. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  100110. /**
  100111. * Creates a webGL buffer to use with instanciation
  100112. * @param capacity defines the size of the buffer
  100113. * @returns the webGL buffer
  100114. */
  100115. createInstancesBuffer(capacity: number): DataBuffer;
  100116. /**
  100117. * Delete a webGL buffer used with instanciation
  100118. * @param buffer defines the webGL buffer to delete
  100119. */
  100120. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  100121. /** @hidden */
  100122. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  100123. dispose(): void;
  100124. private _disableTouchAction;
  100125. /**
  100126. * Display the loading screen
  100127. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100128. */
  100129. displayLoadingUI(): void;
  100130. /**
  100131. * Hide the loading screen
  100132. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100133. */
  100134. hideLoadingUI(): void;
  100135. /**
  100136. * Gets the current loading screen object
  100137. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100138. */
  100139. /**
  100140. * Sets the current loading screen object
  100141. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100142. */
  100143. loadingScreen: ILoadingScreen;
  100144. /**
  100145. * Sets the current loading screen text
  100146. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100147. */
  100148. loadingUIText: string;
  100149. /**
  100150. * Sets the current loading screen background color
  100151. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100152. */
  100153. loadingUIBackgroundColor: string;
  100154. /** Pointerlock and fullscreen */
  100155. /**
  100156. * Ask the browser to promote the current element to pointerlock mode
  100157. * @param element defines the DOM element to promote
  100158. */
  100159. static _RequestPointerlock(element: HTMLElement): void;
  100160. /**
  100161. * Asks the browser to exit pointerlock mode
  100162. */
  100163. static _ExitPointerlock(): void;
  100164. /**
  100165. * Ask the browser to promote the current element to fullscreen rendering mode
  100166. * @param element defines the DOM element to promote
  100167. */
  100168. static _RequestFullscreen(element: HTMLElement): void;
  100169. /**
  100170. * Asks the browser to exit fullscreen mode
  100171. */
  100172. static _ExitFullscreen(): void;
  100173. }
  100174. }
  100175. declare module BABYLON {
  100176. /**
  100177. * The engine store class is responsible to hold all the instances of Engine and Scene created
  100178. * during the life time of the application.
  100179. */
  100180. export class EngineStore {
  100181. /** Gets the list of created engines */
  100182. static Instances: Engine[];
  100183. /** @hidden */
  100184. static _LastCreatedScene: Nullable<Scene>;
  100185. /**
  100186. * Gets the latest created engine
  100187. */
  100188. static readonly LastCreatedEngine: Nullable<Engine>;
  100189. /**
  100190. * Gets the latest created scene
  100191. */
  100192. static readonly LastCreatedScene: Nullable<Scene>;
  100193. /**
  100194. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  100195. * @ignorenaming
  100196. */
  100197. static UseFallbackTexture: boolean;
  100198. /**
  100199. * Texture content used if a texture cannot loaded
  100200. * @ignorenaming
  100201. */
  100202. static FallbackTexture: string;
  100203. }
  100204. }
  100205. declare module BABYLON {
  100206. /**
  100207. * Helper class that provides a small promise polyfill
  100208. */
  100209. export class PromisePolyfill {
  100210. /**
  100211. * Static function used to check if the polyfill is required
  100212. * If this is the case then the function will inject the polyfill to window.Promise
  100213. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  100214. */
  100215. static Apply(force?: boolean): void;
  100216. }
  100217. }
  100218. declare module BABYLON {
  100219. /**
  100220. * Interface for screenshot methods with describe argument called `size` as object with options
  100221. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  100222. */
  100223. export interface IScreenshotSize {
  100224. /**
  100225. * number in pixels for canvas height
  100226. */
  100227. height?: number;
  100228. /**
  100229. * multiplier allowing render at a higher or lower resolution
  100230. * If value is defined then height and width will be ignored and taken from camera
  100231. */
  100232. precision?: number;
  100233. /**
  100234. * number in pixels for canvas width
  100235. */
  100236. width?: number;
  100237. }
  100238. }
  100239. declare module BABYLON {
  100240. interface IColor4Like {
  100241. r: float;
  100242. g: float;
  100243. b: float;
  100244. a: float;
  100245. }
  100246. /**
  100247. * Class containing a set of static utilities functions
  100248. */
  100249. export class Tools {
  100250. /**
  100251. * Gets or sets the base URL to use to load assets
  100252. */
  100253. static BaseUrl: string;
  100254. /**
  100255. * Enable/Disable Custom HTTP Request Headers globally.
  100256. * default = false
  100257. * @see CustomRequestHeaders
  100258. */
  100259. static UseCustomRequestHeaders: boolean;
  100260. /**
  100261. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  100262. * i.e. when loading files, where the server/service expects an Authorization header
  100263. */
  100264. static CustomRequestHeaders: {
  100265. [key: string]: string;
  100266. };
  100267. /**
  100268. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  100269. */
  100270. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  100271. /**
  100272. * Default behaviour for cors in the application.
  100273. * It can be a string if the expected behavior is identical in the entire app.
  100274. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  100275. */
  100276. static CorsBehavior: string | ((url: string | string[]) => string);
  100277. /**
  100278. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  100279. * @ignorenaming
  100280. */
  100281. static UseFallbackTexture: boolean;
  100282. /**
  100283. * Use this object to register external classes like custom textures or material
  100284. * to allow the laoders to instantiate them
  100285. */
  100286. static RegisteredExternalClasses: {
  100287. [key: string]: Object;
  100288. };
  100289. /**
  100290. * Texture content used if a texture cannot loaded
  100291. * @ignorenaming
  100292. */
  100293. static fallbackTexture: string;
  100294. /**
  100295. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  100296. * @param u defines the coordinate on X axis
  100297. * @param v defines the coordinate on Y axis
  100298. * @param width defines the width of the source data
  100299. * @param height defines the height of the source data
  100300. * @param pixels defines the source byte array
  100301. * @param color defines the output color
  100302. */
  100303. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  100304. /**
  100305. * Interpolates between a and b via alpha
  100306. * @param a The lower value (returned when alpha = 0)
  100307. * @param b The upper value (returned when alpha = 1)
  100308. * @param alpha The interpolation-factor
  100309. * @return The mixed value
  100310. */
  100311. static Mix(a: number, b: number, alpha: number): number;
  100312. /**
  100313. * Tries to instantiate a new object from a given class name
  100314. * @param className defines the class name to instantiate
  100315. * @returns the new object or null if the system was not able to do the instantiation
  100316. */
  100317. static Instantiate(className: string): any;
  100318. /**
  100319. * Provides a slice function that will work even on IE
  100320. * @param data defines the array to slice
  100321. * @param start defines the start of the data (optional)
  100322. * @param end defines the end of the data (optional)
  100323. * @returns the new sliced array
  100324. */
  100325. static Slice<T>(data: T, start?: number, end?: number): T;
  100326. /**
  100327. * Polyfill for setImmediate
  100328. * @param action defines the action to execute after the current execution block
  100329. */
  100330. static SetImmediate(action: () => void): void;
  100331. /**
  100332. * Function indicating if a number is an exponent of 2
  100333. * @param value defines the value to test
  100334. * @returns true if the value is an exponent of 2
  100335. */
  100336. static IsExponentOfTwo(value: number): boolean;
  100337. private static _tmpFloatArray;
  100338. /**
  100339. * Returns the nearest 32-bit single precision float representation of a Number
  100340. * @param value A Number. If the parameter is of a different type, it will get converted
  100341. * to a number or to NaN if it cannot be converted
  100342. * @returns number
  100343. */
  100344. static FloatRound(value: number): number;
  100345. /**
  100346. * Extracts the filename from a path
  100347. * @param path defines the path to use
  100348. * @returns the filename
  100349. */
  100350. static GetFilename(path: string): string;
  100351. /**
  100352. * Extracts the "folder" part of a path (everything before the filename).
  100353. * @param uri The URI to extract the info from
  100354. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  100355. * @returns The "folder" part of the path
  100356. */
  100357. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  100358. /**
  100359. * Extracts text content from a DOM element hierarchy
  100360. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  100361. */
  100362. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  100363. /**
  100364. * Convert an angle in radians to degrees
  100365. * @param angle defines the angle to convert
  100366. * @returns the angle in degrees
  100367. */
  100368. static ToDegrees(angle: number): number;
  100369. /**
  100370. * Convert an angle in degrees to radians
  100371. * @param angle defines the angle to convert
  100372. * @returns the angle in radians
  100373. */
  100374. static ToRadians(angle: number): number;
  100375. /**
  100376. * Returns an array if obj is not an array
  100377. * @param obj defines the object to evaluate as an array
  100378. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  100379. * @returns either obj directly if obj is an array or a new array containing obj
  100380. */
  100381. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  100382. /**
  100383. * Gets the pointer prefix to use
  100384. * @returns "pointer" if touch is enabled. Else returns "mouse"
  100385. */
  100386. static GetPointerPrefix(): string;
  100387. /**
  100388. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  100389. * @param url define the url we are trying
  100390. * @param element define the dom element where to configure the cors policy
  100391. */
  100392. static SetCorsBehavior(url: string | string[], element: {
  100393. crossOrigin: string | null;
  100394. }): void;
  100395. /**
  100396. * Removes unwanted characters from an url
  100397. * @param url defines the url to clean
  100398. * @returns the cleaned url
  100399. */
  100400. static CleanUrl(url: string): string;
  100401. /**
  100402. * Gets or sets a function used to pre-process url before using them to load assets
  100403. */
  100404. static PreprocessUrl: (url: string) => string;
  100405. /**
  100406. * Loads an image as an HTMLImageElement.
  100407. * @param input url string, ArrayBuffer, or Blob to load
  100408. * @param onLoad callback called when the image successfully loads
  100409. * @param onError callback called when the image fails to load
  100410. * @param offlineProvider offline provider for caching
  100411. * @param mimeType optional mime type
  100412. * @returns the HTMLImageElement of the loaded image
  100413. */
  100414. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  100415. /**
  100416. * Loads a file from a url
  100417. * @param url url string, ArrayBuffer, or Blob to load
  100418. * @param onSuccess callback called when the file successfully loads
  100419. * @param onProgress callback called while file is loading (if the server supports this mode)
  100420. * @param offlineProvider defines the offline provider for caching
  100421. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  100422. * @param onError callback called when the file fails to load
  100423. * @returns a file request object
  100424. */
  100425. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: any) => void): IFileRequest;
  100426. /**
  100427. * Loads a file from a url
  100428. * @param url the file url to load
  100429. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  100430. */
  100431. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  100432. /**
  100433. * Load a script (identified by an url). When the url returns, the
  100434. * content of this file is added into a new script element, attached to the DOM (body element)
  100435. * @param scriptUrl defines the url of the script to laod
  100436. * @param onSuccess defines the callback called when the script is loaded
  100437. * @param onError defines the callback to call if an error occurs
  100438. * @param scriptId defines the id of the script element
  100439. */
  100440. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  100441. /**
  100442. * Load an asynchronous script (identified by an url). When the url returns, the
  100443. * content of this file is added into a new script element, attached to the DOM (body element)
  100444. * @param scriptUrl defines the url of the script to laod
  100445. * @param scriptId defines the id of the script element
  100446. * @returns a promise request object
  100447. */
  100448. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  100449. /**
  100450. * Loads a file from a blob
  100451. * @param fileToLoad defines the blob to use
  100452. * @param callback defines the callback to call when data is loaded
  100453. * @param progressCallback defines the callback to call during loading process
  100454. * @returns a file request object
  100455. */
  100456. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  100457. /**
  100458. * Reads a file from a File object
  100459. * @param file defines the file to load
  100460. * @param onSuccess defines the callback to call when data is loaded
  100461. * @param onProgress defines the callback to call during loading process
  100462. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  100463. * @param onError defines the callback to call when an error occurs
  100464. * @returns a file request object
  100465. */
  100466. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  100467. /**
  100468. * Creates a data url from a given string content
  100469. * @param content defines the content to convert
  100470. * @returns the new data url link
  100471. */
  100472. static FileAsURL(content: string): string;
  100473. /**
  100474. * Format the given number to a specific decimal format
  100475. * @param value defines the number to format
  100476. * @param decimals defines the number of decimals to use
  100477. * @returns the formatted string
  100478. */
  100479. static Format(value: number, decimals?: number): string;
  100480. /**
  100481. * Tries to copy an object by duplicating every property
  100482. * @param source defines the source object
  100483. * @param destination defines the target object
  100484. * @param doNotCopyList defines a list of properties to avoid
  100485. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  100486. */
  100487. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  100488. /**
  100489. * Gets a boolean indicating if the given object has no own property
  100490. * @param obj defines the object to test
  100491. * @returns true if object has no own property
  100492. */
  100493. static IsEmpty(obj: any): boolean;
  100494. /**
  100495. * Function used to register events at window level
  100496. * @param windowElement defines the Window object to use
  100497. * @param events defines the events to register
  100498. */
  100499. static RegisterTopRootEvents(windowElement: Window, events: {
  100500. name: string;
  100501. handler: Nullable<(e: FocusEvent) => any>;
  100502. }[]): void;
  100503. /**
  100504. * Function used to unregister events from window level
  100505. * @param windowElement defines the Window object to use
  100506. * @param events defines the events to unregister
  100507. */
  100508. static UnregisterTopRootEvents(windowElement: Window, events: {
  100509. name: string;
  100510. handler: Nullable<(e: FocusEvent) => any>;
  100511. }[]): void;
  100512. /**
  100513. * @ignore
  100514. */
  100515. static _ScreenshotCanvas: HTMLCanvasElement;
  100516. /**
  100517. * Dumps the current bound framebuffer
  100518. * @param width defines the rendering width
  100519. * @param height defines the rendering height
  100520. * @param engine defines the hosting engine
  100521. * @param successCallback defines the callback triggered once the data are available
  100522. * @param mimeType defines the mime type of the result
  100523. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  100524. */
  100525. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  100526. /**
  100527. * Converts the canvas data to blob.
  100528. * This acts as a polyfill for browsers not supporting the to blob function.
  100529. * @param canvas Defines the canvas to extract the data from
  100530. * @param successCallback Defines the callback triggered once the data are available
  100531. * @param mimeType Defines the mime type of the result
  100532. */
  100533. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  100534. /**
  100535. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  100536. * @param successCallback defines the callback triggered once the data are available
  100537. * @param mimeType defines the mime type of the result
  100538. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  100539. */
  100540. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  100541. /**
  100542. * Downloads a blob in the browser
  100543. * @param blob defines the blob to download
  100544. * @param fileName defines the name of the downloaded file
  100545. */
  100546. static Download(blob: Blob, fileName: string): void;
  100547. /**
  100548. * Captures a screenshot of the current rendering
  100549. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100550. * @param engine defines the rendering engine
  100551. * @param camera defines the source camera
  100552. * @param size This parameter can be set to a single number or to an object with the
  100553. * following (optional) properties: precision, width, height. If a single number is passed,
  100554. * it will be used for both width and height. If an object is passed, the screenshot size
  100555. * will be derived from the parameters. The precision property is a multiplier allowing
  100556. * rendering at a higher or lower resolution
  100557. * @param successCallback defines the callback receives a single parameter which contains the
  100558. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  100559. * src parameter of an <img> to display it
  100560. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  100561. * Check your browser for supported MIME types
  100562. */
  100563. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  100564. /**
  100565. * Captures a screenshot of the current rendering
  100566. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100567. * @param engine defines the rendering engine
  100568. * @param camera defines the source camera
  100569. * @param size This parameter can be set to a single number or to an object with the
  100570. * following (optional) properties: precision, width, height. If a single number is passed,
  100571. * it will be used for both width and height. If an object is passed, the screenshot size
  100572. * will be derived from the parameters. The precision property is a multiplier allowing
  100573. * rendering at a higher or lower resolution
  100574. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  100575. * Check your browser for supported MIME types
  100576. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  100577. * to the src parameter of an <img> to display it
  100578. */
  100579. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  100580. /**
  100581. * Generates an image screenshot from the specified camera.
  100582. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100583. * @param engine The engine to use for rendering
  100584. * @param camera The camera to use for rendering
  100585. * @param size This parameter can be set to a single number or to an object with the
  100586. * following (optional) properties: precision, width, height. If a single number is passed,
  100587. * it will be used for both width and height. If an object is passed, the screenshot size
  100588. * will be derived from the parameters. The precision property is a multiplier allowing
  100589. * rendering at a higher or lower resolution
  100590. * @param successCallback The callback receives a single parameter which contains the
  100591. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  100592. * src parameter of an <img> to display it
  100593. * @param mimeType The MIME type of the screenshot image (default: image/png).
  100594. * Check your browser for supported MIME types
  100595. * @param samples Texture samples (default: 1)
  100596. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  100597. * @param fileName A name for for the downloaded file.
  100598. */
  100599. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  100600. /**
  100601. * Generates an image screenshot from the specified camera.
  100602. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100603. * @param engine The engine to use for rendering
  100604. * @param camera The camera to use for rendering
  100605. * @param size This parameter can be set to a single number or to an object with the
  100606. * following (optional) properties: precision, width, height. If a single number is passed,
  100607. * it will be used for both width and height. If an object is passed, the screenshot size
  100608. * will be derived from the parameters. The precision property is a multiplier allowing
  100609. * rendering at a higher or lower resolution
  100610. * @param mimeType The MIME type of the screenshot image (default: image/png).
  100611. * Check your browser for supported MIME types
  100612. * @param samples Texture samples (default: 1)
  100613. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  100614. * @param fileName A name for for the downloaded file.
  100615. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  100616. * to the src parameter of an <img> to display it
  100617. */
  100618. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  100619. /**
  100620. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  100621. * Be aware Math.random() could cause collisions, but:
  100622. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  100623. * @returns a pseudo random id
  100624. */
  100625. static RandomId(): string;
  100626. /**
  100627. * Test if the given uri is a base64 string
  100628. * @param uri The uri to test
  100629. * @return True if the uri is a base64 string or false otherwise
  100630. */
  100631. static IsBase64(uri: string): boolean;
  100632. /**
  100633. * Decode the given base64 uri.
  100634. * @param uri The uri to decode
  100635. * @return The decoded base64 data.
  100636. */
  100637. static DecodeBase64(uri: string): ArrayBuffer;
  100638. /**
  100639. * Gets the absolute url.
  100640. * @param url the input url
  100641. * @return the absolute url
  100642. */
  100643. static GetAbsoluteUrl(url: string): string;
  100644. /**
  100645. * No log
  100646. */
  100647. static readonly NoneLogLevel: number;
  100648. /**
  100649. * Only message logs
  100650. */
  100651. static readonly MessageLogLevel: number;
  100652. /**
  100653. * Only warning logs
  100654. */
  100655. static readonly WarningLogLevel: number;
  100656. /**
  100657. * Only error logs
  100658. */
  100659. static readonly ErrorLogLevel: number;
  100660. /**
  100661. * All logs
  100662. */
  100663. static readonly AllLogLevel: number;
  100664. /**
  100665. * Gets a value indicating the number of loading errors
  100666. * @ignorenaming
  100667. */
  100668. static readonly errorsCount: number;
  100669. /**
  100670. * Callback called when a new log is added
  100671. */
  100672. static OnNewCacheEntry: (entry: string) => void;
  100673. /**
  100674. * Log a message to the console
  100675. * @param message defines the message to log
  100676. */
  100677. static Log(message: string): void;
  100678. /**
  100679. * Write a warning message to the console
  100680. * @param message defines the message to log
  100681. */
  100682. static Warn(message: string): void;
  100683. /**
  100684. * Write an error message to the console
  100685. * @param message defines the message to log
  100686. */
  100687. static Error(message: string): void;
  100688. /**
  100689. * Gets current log cache (list of logs)
  100690. */
  100691. static readonly LogCache: string;
  100692. /**
  100693. * Clears the log cache
  100694. */
  100695. static ClearLogCache(): void;
  100696. /**
  100697. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  100698. */
  100699. static LogLevels: number;
  100700. /**
  100701. * Checks if the window object exists
  100702. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  100703. */
  100704. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  100705. /**
  100706. * No performance log
  100707. */
  100708. static readonly PerformanceNoneLogLevel: number;
  100709. /**
  100710. * Use user marks to log performance
  100711. */
  100712. static readonly PerformanceUserMarkLogLevel: number;
  100713. /**
  100714. * Log performance to the console
  100715. */
  100716. static readonly PerformanceConsoleLogLevel: number;
  100717. private static _performance;
  100718. /**
  100719. * Sets the current performance log level
  100720. */
  100721. static PerformanceLogLevel: number;
  100722. private static _StartPerformanceCounterDisabled;
  100723. private static _EndPerformanceCounterDisabled;
  100724. private static _StartUserMark;
  100725. private static _EndUserMark;
  100726. private static _StartPerformanceConsole;
  100727. private static _EndPerformanceConsole;
  100728. /**
  100729. * Starts a performance counter
  100730. */
  100731. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  100732. /**
  100733. * Ends a specific performance coutner
  100734. */
  100735. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  100736. /**
  100737. * Gets either window.performance.now() if supported or Date.now() else
  100738. */
  100739. static readonly Now: number;
  100740. /**
  100741. * This method will return the name of the class used to create the instance of the given object.
  100742. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  100743. * @param object the object to get the class name from
  100744. * @param isType defines if the object is actually a type
  100745. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  100746. */
  100747. static GetClassName(object: any, isType?: boolean): string;
  100748. /**
  100749. * Gets the first element of an array satisfying a given predicate
  100750. * @param array defines the array to browse
  100751. * @param predicate defines the predicate to use
  100752. * @returns null if not found or the element
  100753. */
  100754. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  100755. /**
  100756. * This method will return the name of the full name of the class, including its owning module (if any).
  100757. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator or implementing a method getClassName():string (in which case the module won't be specified).
  100758. * @param object the object to get the class name from
  100759. * @param isType defines if the object is actually a type
  100760. * @return a string that can have two forms: "moduleName.className" if module was specified when the class' Name was registered or "className" if there was not module specified.
  100761. * @ignorenaming
  100762. */
  100763. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  100764. /**
  100765. * Returns a promise that resolves after the given amount of time.
  100766. * @param delay Number of milliseconds to delay
  100767. * @returns Promise that resolves after the given amount of time
  100768. */
  100769. static DelayAsync(delay: number): Promise<void>;
  100770. }
  100771. /**
  100772. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  100773. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  100774. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  100775. * @param name The name of the class, case should be preserved
  100776. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  100777. */
  100778. export function className(name: string, module?: string): (target: Object) => void;
  100779. /**
  100780. * An implementation of a loop for asynchronous functions.
  100781. */
  100782. export class AsyncLoop {
  100783. /**
  100784. * Defines the number of iterations for the loop
  100785. */
  100786. iterations: number;
  100787. /**
  100788. * Defines the current index of the loop.
  100789. */
  100790. index: number;
  100791. private _done;
  100792. private _fn;
  100793. private _successCallback;
  100794. /**
  100795. * Constructor.
  100796. * @param iterations the number of iterations.
  100797. * @param func the function to run each iteration
  100798. * @param successCallback the callback that will be called upon succesful execution
  100799. * @param offset starting offset.
  100800. */
  100801. constructor(
  100802. /**
  100803. * Defines the number of iterations for the loop
  100804. */
  100805. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  100806. /**
  100807. * Execute the next iteration. Must be called after the last iteration was finished.
  100808. */
  100809. executeNext(): void;
  100810. /**
  100811. * Break the loop and run the success callback.
  100812. */
  100813. breakLoop(): void;
  100814. /**
  100815. * Create and run an async loop.
  100816. * @param iterations the number of iterations.
  100817. * @param fn the function to run each iteration
  100818. * @param successCallback the callback that will be called upon succesful execution
  100819. * @param offset starting offset.
  100820. * @returns the created async loop object
  100821. */
  100822. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  100823. /**
  100824. * A for-loop that will run a given number of iterations synchronous and the rest async.
  100825. * @param iterations total number of iterations
  100826. * @param syncedIterations number of synchronous iterations in each async iteration.
  100827. * @param fn the function to call each iteration.
  100828. * @param callback a success call back that will be called when iterating stops.
  100829. * @param breakFunction a break condition (optional)
  100830. * @param timeout timeout settings for the setTimeout function. default - 0.
  100831. * @returns the created async loop object
  100832. */
  100833. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  100834. }
  100835. }
  100836. declare module BABYLON {
  100837. /**
  100838. * This class implement a typical dictionary using a string as key and the generic type T as value.
  100839. * The underlying implementation relies on an associative array to ensure the best performances.
  100840. * The value can be anything including 'null' but except 'undefined'
  100841. */
  100842. export class StringDictionary<T> {
  100843. /**
  100844. * This will clear this dictionary and copy the content from the 'source' one.
  100845. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  100846. * @param source the dictionary to take the content from and copy to this dictionary
  100847. */
  100848. copyFrom(source: StringDictionary<T>): void;
  100849. /**
  100850. * Get a value based from its key
  100851. * @param key the given key to get the matching value from
  100852. * @return the value if found, otherwise undefined is returned
  100853. */
  100854. get(key: string): T | undefined;
  100855. /**
  100856. * Get a value from its key or add it if it doesn't exist.
  100857. * This method will ensure you that a given key/data will be present in the dictionary.
  100858. * @param key the given key to get the matching value from
  100859. * @param factory the factory that will create the value if the key is not present in the dictionary.
  100860. * The factory will only be invoked if there's no data for the given key.
  100861. * @return the value corresponding to the key.
  100862. */
  100863. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  100864. /**
  100865. * Get a value from its key if present in the dictionary otherwise add it
  100866. * @param key the key to get the value from
  100867. * @param val if there's no such key/value pair in the dictionary add it with this value
  100868. * @return the value corresponding to the key
  100869. */
  100870. getOrAdd(key: string, val: T): T;
  100871. /**
  100872. * Check if there's a given key in the dictionary
  100873. * @param key the key to check for
  100874. * @return true if the key is present, false otherwise
  100875. */
  100876. contains(key: string): boolean;
  100877. /**
  100878. * Add a new key and its corresponding value
  100879. * @param key the key to add
  100880. * @param value the value corresponding to the key
  100881. * @return true if the operation completed successfully, false if we couldn't insert the key/value because there was already this key in the dictionary
  100882. */
  100883. add(key: string, value: T): boolean;
  100884. /**
  100885. * Update a specific value associated to a key
  100886. * @param key defines the key to use
  100887. * @param value defines the value to store
  100888. * @returns true if the value was updated (or false if the key was not found)
  100889. */
  100890. set(key: string, value: T): boolean;
  100891. /**
  100892. * Get the element of the given key and remove it from the dictionary
  100893. * @param key defines the key to search
  100894. * @returns the value associated with the key or null if not found
  100895. */
  100896. getAndRemove(key: string): Nullable<T>;
  100897. /**
  100898. * Remove a key/value from the dictionary.
  100899. * @param key the key to remove
  100900. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  100901. */
  100902. remove(key: string): boolean;
  100903. /**
  100904. * Clear the whole content of the dictionary
  100905. */
  100906. clear(): void;
  100907. /**
  100908. * Gets the current count
  100909. */
  100910. readonly count: number;
  100911. /**
  100912. * Execute a callback on each key/val of the dictionary.
  100913. * Note that you can remove any element in this dictionary in the callback implementation
  100914. * @param callback the callback to execute on a given key/value pair
  100915. */
  100916. forEach(callback: (key: string, val: T) => void): void;
  100917. /**
  100918. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  100919. * If the callback returns null or undefined the method will iterate to the next key/value pair
  100920. * Note that you can remove any element in this dictionary in the callback implementation
  100921. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  100922. * @returns the first item
  100923. */
  100924. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  100925. private _count;
  100926. private _data;
  100927. }
  100928. }
  100929. declare module BABYLON {
  100930. /** @hidden */
  100931. export interface ICollisionCoordinator {
  100932. createCollider(): Collider;
  100933. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  100934. init(scene: Scene): void;
  100935. }
  100936. /** @hidden */
  100937. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  100938. private _scene;
  100939. private _scaledPosition;
  100940. private _scaledVelocity;
  100941. private _finalPosition;
  100942. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  100943. createCollider(): Collider;
  100944. init(scene: Scene): void;
  100945. private _collideWithWorld;
  100946. }
  100947. }
  100948. declare module BABYLON {
  100949. /**
  100950. * Class used to manage all inputs for the scene.
  100951. */
  100952. export class InputManager {
  100953. /** The distance in pixel that you have to move to prevent some events */
  100954. static DragMovementThreshold: number;
  100955. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  100956. static LongPressDelay: number;
  100957. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  100958. static DoubleClickDelay: number;
  100959. /** If you need to check double click without raising a single click at first click, enable this flag */
  100960. static ExclusiveDoubleClickMode: boolean;
  100961. private _wheelEventName;
  100962. private _onPointerMove;
  100963. private _onPointerDown;
  100964. private _onPointerUp;
  100965. private _initClickEvent;
  100966. private _initActionManager;
  100967. private _delayedSimpleClick;
  100968. private _delayedSimpleClickTimeout;
  100969. private _previousDelayedSimpleClickTimeout;
  100970. private _meshPickProceed;
  100971. private _previousButtonPressed;
  100972. private _currentPickResult;
  100973. private _previousPickResult;
  100974. private _totalPointersPressed;
  100975. private _doubleClickOccured;
  100976. private _pointerOverMesh;
  100977. private _pickedDownMesh;
  100978. private _pickedUpMesh;
  100979. private _pointerX;
  100980. private _pointerY;
  100981. private _unTranslatedPointerX;
  100982. private _unTranslatedPointerY;
  100983. private _startingPointerPosition;
  100984. private _previousStartingPointerPosition;
  100985. private _startingPointerTime;
  100986. private _previousStartingPointerTime;
  100987. private _pointerCaptures;
  100988. private _onKeyDown;
  100989. private _onKeyUp;
  100990. private _onCanvasFocusObserver;
  100991. private _onCanvasBlurObserver;
  100992. private _scene;
  100993. /**
  100994. * Creates a new InputManager
  100995. * @param scene defines the hosting scene
  100996. */
  100997. constructor(scene: Scene);
  100998. /**
  100999. * Gets the mesh that is currently under the pointer
  101000. */
  101001. readonly meshUnderPointer: Nullable<AbstractMesh>;
  101002. /**
  101003. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  101004. */
  101005. readonly unTranslatedPointer: Vector2;
  101006. /**
  101007. * Gets or sets the current on-screen X position of the pointer
  101008. */
  101009. pointerX: number;
  101010. /**
  101011. * Gets or sets the current on-screen Y position of the pointer
  101012. */
  101013. pointerY: number;
  101014. private _updatePointerPosition;
  101015. private _processPointerMove;
  101016. private _setRayOnPointerInfo;
  101017. private _checkPrePointerObservable;
  101018. /**
  101019. * Use this method to simulate a pointer move on a mesh
  101020. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101021. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101022. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101023. */
  101024. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  101025. /**
  101026. * Use this method to simulate a pointer down on a mesh
  101027. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101028. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101029. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101030. */
  101031. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  101032. private _processPointerDown;
  101033. /** @hidden */
  101034. _isPointerSwiping(): boolean;
  101035. /**
  101036. * Use this method to simulate a pointer up on a mesh
  101037. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101038. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101039. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101040. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  101041. */
  101042. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  101043. private _processPointerUp;
  101044. /**
  101045. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  101046. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  101047. * @returns true if the pointer was captured
  101048. */
  101049. isPointerCaptured(pointerId?: number): boolean;
  101050. /**
  101051. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  101052. * @param attachUp defines if you want to attach events to pointerup
  101053. * @param attachDown defines if you want to attach events to pointerdown
  101054. * @param attachMove defines if you want to attach events to pointermove
  101055. */
  101056. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  101057. /**
  101058. * Detaches all event handlers
  101059. */
  101060. detachControl(): void;
  101061. /**
  101062. * Force the value of meshUnderPointer
  101063. * @param mesh defines the mesh to use
  101064. */
  101065. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  101066. /**
  101067. * Gets the mesh under the pointer
  101068. * @returns a Mesh or null if no mesh is under the pointer
  101069. */
  101070. getPointerOverMesh(): Nullable<AbstractMesh>;
  101071. }
  101072. }
  101073. declare module BABYLON {
  101074. /**
  101075. * Helper class used to generate session unique ID
  101076. */
  101077. export class UniqueIdGenerator {
  101078. private static _UniqueIdCounter;
  101079. /**
  101080. * Gets an unique (relatively to the current scene) Id
  101081. */
  101082. static readonly UniqueId: number;
  101083. }
  101084. }
  101085. declare module BABYLON {
  101086. /**
  101087. * This class defines the direct association between an animation and a target
  101088. */
  101089. export class TargetedAnimation {
  101090. /**
  101091. * Animation to perform
  101092. */
  101093. animation: Animation;
  101094. /**
  101095. * Target to animate
  101096. */
  101097. target: any;
  101098. /**
  101099. * Serialize the object
  101100. * @returns the JSON object representing the current entity
  101101. */
  101102. serialize(): any;
  101103. }
  101104. /**
  101105. * Use this class to create coordinated animations on multiple targets
  101106. */
  101107. export class AnimationGroup implements IDisposable {
  101108. /** The name of the animation group */
  101109. name: string;
  101110. private _scene;
  101111. private _targetedAnimations;
  101112. private _animatables;
  101113. private _from;
  101114. private _to;
  101115. private _isStarted;
  101116. private _isPaused;
  101117. private _speedRatio;
  101118. private _loopAnimation;
  101119. /**
  101120. * Gets or sets the unique id of the node
  101121. */
  101122. uniqueId: number;
  101123. /**
  101124. * This observable will notify when one animation have ended
  101125. */
  101126. onAnimationEndObservable: Observable<TargetedAnimation>;
  101127. /**
  101128. * Observer raised when one animation loops
  101129. */
  101130. onAnimationLoopObservable: Observable<TargetedAnimation>;
  101131. /**
  101132. * Observer raised when all animations have looped
  101133. */
  101134. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  101135. /**
  101136. * This observable will notify when all animations have ended.
  101137. */
  101138. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  101139. /**
  101140. * This observable will notify when all animations have paused.
  101141. */
  101142. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  101143. /**
  101144. * This observable will notify when all animations are playing.
  101145. */
  101146. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  101147. /**
  101148. * Gets the first frame
  101149. */
  101150. readonly from: number;
  101151. /**
  101152. * Gets the last frame
  101153. */
  101154. readonly to: number;
  101155. /**
  101156. * Define if the animations are started
  101157. */
  101158. readonly isStarted: boolean;
  101159. /**
  101160. * Gets a value indicating that the current group is playing
  101161. */
  101162. readonly isPlaying: boolean;
  101163. /**
  101164. * Gets or sets the speed ratio to use for all animations
  101165. */
  101166. /**
  101167. * Gets or sets the speed ratio to use for all animations
  101168. */
  101169. speedRatio: number;
  101170. /**
  101171. * Gets or sets if all animations should loop or not
  101172. */
  101173. loopAnimation: boolean;
  101174. /**
  101175. * Gets the targeted animations for this animation group
  101176. */
  101177. readonly targetedAnimations: Array<TargetedAnimation>;
  101178. /**
  101179. * returning the list of animatables controlled by this animation group.
  101180. */
  101181. readonly animatables: Array<Animatable>;
  101182. /**
  101183. * Instantiates a new Animation Group.
  101184. * This helps managing several animations at once.
  101185. * @see http://doc.babylonjs.com/how_to/group
  101186. * @param name Defines the name of the group
  101187. * @param scene Defines the scene the group belongs to
  101188. */
  101189. constructor(
  101190. /** The name of the animation group */
  101191. name: string, scene?: Nullable<Scene>);
  101192. /**
  101193. * Add an animation (with its target) in the group
  101194. * @param animation defines the animation we want to add
  101195. * @param target defines the target of the animation
  101196. * @returns the TargetedAnimation object
  101197. */
  101198. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  101199. /**
  101200. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  101201. * It can add constant keys at begin or end
  101202. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  101203. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  101204. * @returns the animation group
  101205. */
  101206. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  101207. private _animationLoopCount;
  101208. private _animationLoopFlags;
  101209. private _processLoop;
  101210. /**
  101211. * Start all animations on given targets
  101212. * @param loop defines if animations must loop
  101213. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  101214. * @param from defines the from key (optional)
  101215. * @param to defines the to key (optional)
  101216. * @returns the current animation group
  101217. */
  101218. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  101219. /**
  101220. * Pause all animations
  101221. * @returns the animation group
  101222. */
  101223. pause(): AnimationGroup;
  101224. /**
  101225. * Play all animations to initial state
  101226. * This function will start() the animations if they were not started or will restart() them if they were paused
  101227. * @param loop defines if animations must loop
  101228. * @returns the animation group
  101229. */
  101230. play(loop?: boolean): AnimationGroup;
  101231. /**
  101232. * Reset all animations to initial state
  101233. * @returns the animation group
  101234. */
  101235. reset(): AnimationGroup;
  101236. /**
  101237. * Restart animations from key 0
  101238. * @returns the animation group
  101239. */
  101240. restart(): AnimationGroup;
  101241. /**
  101242. * Stop all animations
  101243. * @returns the animation group
  101244. */
  101245. stop(): AnimationGroup;
  101246. /**
  101247. * Set animation weight for all animatables
  101248. * @param weight defines the weight to use
  101249. * @return the animationGroup
  101250. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  101251. */
  101252. setWeightForAllAnimatables(weight: number): AnimationGroup;
  101253. /**
  101254. * Synchronize and normalize all animatables with a source animatable
  101255. * @param root defines the root animatable to synchronize with
  101256. * @return the animationGroup
  101257. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  101258. */
  101259. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  101260. /**
  101261. * Goes to a specific frame in this animation group
  101262. * @param frame the frame number to go to
  101263. * @return the animationGroup
  101264. */
  101265. goToFrame(frame: number): AnimationGroup;
  101266. /**
  101267. * Dispose all associated resources
  101268. */
  101269. dispose(): void;
  101270. private _checkAnimationGroupEnded;
  101271. /**
  101272. * Clone the current animation group and returns a copy
  101273. * @param newName defines the name of the new group
  101274. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  101275. * @returns the new aniamtion group
  101276. */
  101277. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  101278. /**
  101279. * Serializes the animationGroup to an object
  101280. * @returns Serialized object
  101281. */
  101282. serialize(): any;
  101283. /**
  101284. * Returns a new AnimationGroup object parsed from the source provided.
  101285. * @param parsedAnimationGroup defines the source
  101286. * @param scene defines the scene that will receive the animationGroup
  101287. * @returns a new AnimationGroup
  101288. */
  101289. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  101290. /**
  101291. * Returns the string "AnimationGroup"
  101292. * @returns "AnimationGroup"
  101293. */
  101294. getClassName(): string;
  101295. /**
  101296. * Creates a detailled string about the object
  101297. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  101298. * @returns a string representing the object
  101299. */
  101300. toString(fullDetails?: boolean): string;
  101301. }
  101302. }
  101303. declare module BABYLON {
  101304. /**
  101305. * Define an interface for all classes that will hold resources
  101306. */
  101307. export interface IDisposable {
  101308. /**
  101309. * Releases all held resources
  101310. */
  101311. dispose(): void;
  101312. }
  101313. /** Interface defining initialization parameters for Scene class */
  101314. export interface SceneOptions {
  101315. /**
  101316. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  101317. * It will improve performance when the number of geometries becomes important.
  101318. */
  101319. useGeometryUniqueIdsMap?: boolean;
  101320. /**
  101321. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  101322. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  101323. */
  101324. useMaterialMeshMap?: boolean;
  101325. /**
  101326. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  101327. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  101328. */
  101329. useClonedMeshhMap?: boolean;
  101330. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  101331. virtual?: boolean;
  101332. }
  101333. /**
  101334. * Represents a scene to be rendered by the engine.
  101335. * @see http://doc.babylonjs.com/features/scene
  101336. */
  101337. export class Scene extends AbstractScene implements IAnimatable {
  101338. /** The fog is deactivated */
  101339. static readonly FOGMODE_NONE: number;
  101340. /** The fog density is following an exponential function */
  101341. static readonly FOGMODE_EXP: number;
  101342. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  101343. static readonly FOGMODE_EXP2: number;
  101344. /** The fog density is following a linear function. */
  101345. static readonly FOGMODE_LINEAR: number;
  101346. /**
  101347. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  101348. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101349. */
  101350. static MinDeltaTime: number;
  101351. /**
  101352. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  101353. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101354. */
  101355. static MaxDeltaTime: number;
  101356. /**
  101357. * Factory used to create the default material.
  101358. * @param name The name of the material to create
  101359. * @param scene The scene to create the material for
  101360. * @returns The default material
  101361. */
  101362. static DefaultMaterialFactory(scene: Scene): Material;
  101363. /**
  101364. * Factory used to create the a collision coordinator.
  101365. * @returns The collision coordinator
  101366. */
  101367. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  101368. /** @hidden */
  101369. _inputManager: InputManager;
  101370. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  101371. cameraToUseForPointers: Nullable<Camera>;
  101372. /** @hidden */
  101373. readonly _isScene: boolean;
  101374. /**
  101375. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  101376. */
  101377. autoClear: boolean;
  101378. /**
  101379. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  101380. */
  101381. autoClearDepthAndStencil: boolean;
  101382. /**
  101383. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  101384. */
  101385. clearColor: Color4;
  101386. /**
  101387. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  101388. */
  101389. ambientColor: Color3;
  101390. /**
  101391. * This is use to store the default BRDF lookup for PBR materials in your scene.
  101392. * It should only be one of the following (if not the default embedded one):
  101393. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  101394. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  101395. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  101396. * The material properties need to be setup according to the type of texture in use.
  101397. */
  101398. environmentBRDFTexture: BaseTexture;
  101399. /** @hidden */
  101400. protected _environmentTexture: Nullable<BaseTexture>;
  101401. /**
  101402. * Texture used in all pbr material as the reflection texture.
  101403. * As in the majority of the scene they are the same (exception for multi room and so on),
  101404. * this is easier to reference from here than from all the materials.
  101405. */
  101406. /**
  101407. * Texture used in all pbr material as the reflection texture.
  101408. * As in the majority of the scene they are the same (exception for multi room and so on),
  101409. * this is easier to set here than in all the materials.
  101410. */
  101411. environmentTexture: Nullable<BaseTexture>;
  101412. /** @hidden */
  101413. protected _environmentIntensity: number;
  101414. /**
  101415. * Intensity of the environment in all pbr material.
  101416. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  101417. * As in the majority of the scene they are the same (exception for multi room and so on),
  101418. * this is easier to reference from here than from all the materials.
  101419. */
  101420. /**
  101421. * Intensity of the environment in all pbr material.
  101422. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  101423. * As in the majority of the scene they are the same (exception for multi room and so on),
  101424. * this is easier to set here than in all the materials.
  101425. */
  101426. environmentIntensity: number;
  101427. /** @hidden */
  101428. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101429. /**
  101430. * Default image processing configuration used either in the rendering
  101431. * Forward main pass or through the imageProcessingPostProcess if present.
  101432. * As in the majority of the scene they are the same (exception for multi camera),
  101433. * this is easier to reference from here than from all the materials and post process.
  101434. *
  101435. * No setter as we it is a shared configuration, you can set the values instead.
  101436. */
  101437. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  101438. private _forceWireframe;
  101439. /**
  101440. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  101441. */
  101442. forceWireframe: boolean;
  101443. private _forcePointsCloud;
  101444. /**
  101445. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  101446. */
  101447. forcePointsCloud: boolean;
  101448. /**
  101449. * Gets or sets the active clipplane 1
  101450. */
  101451. clipPlane: Nullable<Plane>;
  101452. /**
  101453. * Gets or sets the active clipplane 2
  101454. */
  101455. clipPlane2: Nullable<Plane>;
  101456. /**
  101457. * Gets or sets the active clipplane 3
  101458. */
  101459. clipPlane3: Nullable<Plane>;
  101460. /**
  101461. * Gets or sets the active clipplane 4
  101462. */
  101463. clipPlane4: Nullable<Plane>;
  101464. /**
  101465. * Gets or sets a boolean indicating if animations are enabled
  101466. */
  101467. animationsEnabled: boolean;
  101468. private _animationPropertiesOverride;
  101469. /**
  101470. * Gets or sets the animation properties override
  101471. */
  101472. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  101473. /**
  101474. * Gets or sets a boolean indicating if a constant deltatime has to be used
  101475. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  101476. */
  101477. useConstantAnimationDeltaTime: boolean;
  101478. /**
  101479. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  101480. * Please note that it requires to run a ray cast through the scene on every frame
  101481. */
  101482. constantlyUpdateMeshUnderPointer: boolean;
  101483. /**
  101484. * Defines the HTML cursor to use when hovering over interactive elements
  101485. */
  101486. hoverCursor: string;
  101487. /**
  101488. * Defines the HTML default cursor to use (empty by default)
  101489. */
  101490. defaultCursor: string;
  101491. /**
  101492. * Defines wether cursors are handled by the scene.
  101493. */
  101494. doNotHandleCursors: boolean;
  101495. /**
  101496. * This is used to call preventDefault() on pointer down
  101497. * in order to block unwanted artifacts like system double clicks
  101498. */
  101499. preventDefaultOnPointerDown: boolean;
  101500. /**
  101501. * This is used to call preventDefault() on pointer up
  101502. * in order to block unwanted artifacts like system double clicks
  101503. */
  101504. preventDefaultOnPointerUp: boolean;
  101505. /**
  101506. * Gets or sets user defined metadata
  101507. */
  101508. metadata: any;
  101509. /**
  101510. * For internal use only. Please do not use.
  101511. */
  101512. reservedDataStore: any;
  101513. /**
  101514. * Gets the name of the plugin used to load this scene (null by default)
  101515. */
  101516. loadingPluginName: string;
  101517. /**
  101518. * Use this array to add regular expressions used to disable offline support for specific urls
  101519. */
  101520. disableOfflineSupportExceptionRules: RegExp[];
  101521. /**
  101522. * An event triggered when the scene is disposed.
  101523. */
  101524. onDisposeObservable: Observable<Scene>;
  101525. private _onDisposeObserver;
  101526. /** Sets a function to be executed when this scene is disposed. */
  101527. onDispose: () => void;
  101528. /**
  101529. * An event triggered before rendering the scene (right after animations and physics)
  101530. */
  101531. onBeforeRenderObservable: Observable<Scene>;
  101532. private _onBeforeRenderObserver;
  101533. /** Sets a function to be executed before rendering this scene */
  101534. beforeRender: Nullable<() => void>;
  101535. /**
  101536. * An event triggered after rendering the scene
  101537. */
  101538. onAfterRenderObservable: Observable<Scene>;
  101539. /**
  101540. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  101541. */
  101542. onAfterRenderCameraObservable: Observable<Camera>;
  101543. private _onAfterRenderObserver;
  101544. /** Sets a function to be executed after rendering this scene */
  101545. afterRender: Nullable<() => void>;
  101546. /**
  101547. * An event triggered before animating the scene
  101548. */
  101549. onBeforeAnimationsObservable: Observable<Scene>;
  101550. /**
  101551. * An event triggered after animations processing
  101552. */
  101553. onAfterAnimationsObservable: Observable<Scene>;
  101554. /**
  101555. * An event triggered before draw calls are ready to be sent
  101556. */
  101557. onBeforeDrawPhaseObservable: Observable<Scene>;
  101558. /**
  101559. * An event triggered after draw calls have been sent
  101560. */
  101561. onAfterDrawPhaseObservable: Observable<Scene>;
  101562. /**
  101563. * An event triggered when the scene is ready
  101564. */
  101565. onReadyObservable: Observable<Scene>;
  101566. /**
  101567. * An event triggered before rendering a camera
  101568. */
  101569. onBeforeCameraRenderObservable: Observable<Camera>;
  101570. private _onBeforeCameraRenderObserver;
  101571. /** Sets a function to be executed before rendering a camera*/
  101572. beforeCameraRender: () => void;
  101573. /**
  101574. * An event triggered after rendering a camera
  101575. */
  101576. onAfterCameraRenderObservable: Observable<Camera>;
  101577. private _onAfterCameraRenderObserver;
  101578. /** Sets a function to be executed after rendering a camera*/
  101579. afterCameraRender: () => void;
  101580. /**
  101581. * An event triggered when active meshes evaluation is about to start
  101582. */
  101583. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  101584. /**
  101585. * An event triggered when active meshes evaluation is done
  101586. */
  101587. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  101588. /**
  101589. * An event triggered when particles rendering is about to start
  101590. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  101591. */
  101592. onBeforeParticlesRenderingObservable: Observable<Scene>;
  101593. /**
  101594. * An event triggered when particles rendering is done
  101595. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  101596. */
  101597. onAfterParticlesRenderingObservable: Observable<Scene>;
  101598. /**
  101599. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  101600. */
  101601. onDataLoadedObservable: Observable<Scene>;
  101602. /**
  101603. * An event triggered when a camera is created
  101604. */
  101605. onNewCameraAddedObservable: Observable<Camera>;
  101606. /**
  101607. * An event triggered when a camera is removed
  101608. */
  101609. onCameraRemovedObservable: Observable<Camera>;
  101610. /**
  101611. * An event triggered when a light is created
  101612. */
  101613. onNewLightAddedObservable: Observable<Light>;
  101614. /**
  101615. * An event triggered when a light is removed
  101616. */
  101617. onLightRemovedObservable: Observable<Light>;
  101618. /**
  101619. * An event triggered when a geometry is created
  101620. */
  101621. onNewGeometryAddedObservable: Observable<Geometry>;
  101622. /**
  101623. * An event triggered when a geometry is removed
  101624. */
  101625. onGeometryRemovedObservable: Observable<Geometry>;
  101626. /**
  101627. * An event triggered when a transform node is created
  101628. */
  101629. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  101630. /**
  101631. * An event triggered when a transform node is removed
  101632. */
  101633. onTransformNodeRemovedObservable: Observable<TransformNode>;
  101634. /**
  101635. * An event triggered when a mesh is created
  101636. */
  101637. onNewMeshAddedObservable: Observable<AbstractMesh>;
  101638. /**
  101639. * An event triggered when a mesh is removed
  101640. */
  101641. onMeshRemovedObservable: Observable<AbstractMesh>;
  101642. /**
  101643. * An event triggered when a skeleton is created
  101644. */
  101645. onNewSkeletonAddedObservable: Observable<Skeleton>;
  101646. /**
  101647. * An event triggered when a skeleton is removed
  101648. */
  101649. onSkeletonRemovedObservable: Observable<Skeleton>;
  101650. /**
  101651. * An event triggered when a material is created
  101652. */
  101653. onNewMaterialAddedObservable: Observable<Material>;
  101654. /**
  101655. * An event triggered when a material is removed
  101656. */
  101657. onMaterialRemovedObservable: Observable<Material>;
  101658. /**
  101659. * An event triggered when a texture is created
  101660. */
  101661. onNewTextureAddedObservable: Observable<BaseTexture>;
  101662. /**
  101663. * An event triggered when a texture is removed
  101664. */
  101665. onTextureRemovedObservable: Observable<BaseTexture>;
  101666. /**
  101667. * An event triggered when render targets are about to be rendered
  101668. * Can happen multiple times per frame.
  101669. */
  101670. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  101671. /**
  101672. * An event triggered when render targets were rendered.
  101673. * Can happen multiple times per frame.
  101674. */
  101675. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  101676. /**
  101677. * An event triggered before calculating deterministic simulation step
  101678. */
  101679. onBeforeStepObservable: Observable<Scene>;
  101680. /**
  101681. * An event triggered after calculating deterministic simulation step
  101682. */
  101683. onAfterStepObservable: Observable<Scene>;
  101684. /**
  101685. * An event triggered when the activeCamera property is updated
  101686. */
  101687. onActiveCameraChanged: Observable<Scene>;
  101688. /**
  101689. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  101690. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  101691. * If you wish to register an Observer only for a given set of renderingGroup, use the mask with a combination of the renderingGroup index elevated to the power of two (1 for renderingGroup 0, 2 for renderingrOup1, 4 for 2 and 8 for 3)
  101692. */
  101693. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  101694. /**
  101695. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  101696. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  101697. * If you wish to register an Observer only for a given set of renderingGroup, use the mask with a combination of the renderingGroup index elevated to the power of two (1 for renderingGroup 0, 2 for renderingrOup1, 4 for 2 and 8 for 3)
  101698. */
  101699. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  101700. /**
  101701. * This Observable will when a mesh has been imported into the scene.
  101702. */
  101703. onMeshImportedObservable: Observable<AbstractMesh>;
  101704. /**
  101705. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  101706. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  101707. */
  101708. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  101709. /** @hidden */
  101710. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  101711. /**
  101712. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  101713. */
  101714. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  101715. /**
  101716. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  101717. */
  101718. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  101719. /**
  101720. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  101721. */
  101722. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  101723. /** Callback called when a pointer move is detected */
  101724. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  101725. /** Callback called when a pointer down is detected */
  101726. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  101727. /** Callback called when a pointer up is detected */
  101728. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  101729. /** Callback called when a pointer pick is detected */
  101730. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  101731. /**
  101732. * This observable event is triggered when any ponter event is triggered. It is registered during Scene.attachControl() and it is called BEFORE the 3D engine process anything (mesh/sprite picking for instance).
  101733. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  101734. */
  101735. onPrePointerObservable: Observable<PointerInfoPre>;
  101736. /**
  101737. * Observable event triggered each time an input event is received from the rendering canvas
  101738. */
  101739. onPointerObservable: Observable<PointerInfo>;
  101740. /**
  101741. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  101742. */
  101743. readonly unTranslatedPointer: Vector2;
  101744. /**
  101745. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  101746. */
  101747. static DragMovementThreshold: number;
  101748. /**
  101749. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  101750. */
  101751. static LongPressDelay: number;
  101752. /**
  101753. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  101754. */
  101755. static DoubleClickDelay: number;
  101756. /** If you need to check double click without raising a single click at first click, enable this flag */
  101757. static ExclusiveDoubleClickMode: boolean;
  101758. /** @hidden */
  101759. _mirroredCameraPosition: Nullable<Vector3>;
  101760. /**
  101761. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  101762. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  101763. */
  101764. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  101765. /**
  101766. * Observable event triggered each time an keyboard event is received from the hosting window
  101767. */
  101768. onKeyboardObservable: Observable<KeyboardInfo>;
  101769. private _useRightHandedSystem;
  101770. /**
  101771. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  101772. */
  101773. useRightHandedSystem: boolean;
  101774. private _timeAccumulator;
  101775. private _currentStepId;
  101776. private _currentInternalStep;
  101777. /**
  101778. * Sets the step Id used by deterministic lock step
  101779. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101780. * @param newStepId defines the step Id
  101781. */
  101782. setStepId(newStepId: number): void;
  101783. /**
  101784. * Gets the step Id used by deterministic lock step
  101785. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101786. * @returns the step Id
  101787. */
  101788. getStepId(): number;
  101789. /**
  101790. * Gets the internal step used by deterministic lock step
  101791. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101792. * @returns the internal step
  101793. */
  101794. getInternalStep(): number;
  101795. private _fogEnabled;
  101796. /**
  101797. * Gets or sets a boolean indicating if fog is enabled on this scene
  101798. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101799. * (Default is true)
  101800. */
  101801. fogEnabled: boolean;
  101802. private _fogMode;
  101803. /**
  101804. * Gets or sets the fog mode to use
  101805. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101806. * | mode | value |
  101807. * | --- | --- |
  101808. * | FOGMODE_NONE | 0 |
  101809. * | FOGMODE_EXP | 1 |
  101810. * | FOGMODE_EXP2 | 2 |
  101811. * | FOGMODE_LINEAR | 3 |
  101812. */
  101813. fogMode: number;
  101814. /**
  101815. * Gets or sets the fog color to use
  101816. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101817. * (Default is Color3(0.2, 0.2, 0.3))
  101818. */
  101819. fogColor: Color3;
  101820. /**
  101821. * Gets or sets the fog density to use
  101822. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101823. * (Default is 0.1)
  101824. */
  101825. fogDensity: number;
  101826. /**
  101827. * Gets or sets the fog start distance to use
  101828. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101829. * (Default is 0)
  101830. */
  101831. fogStart: number;
  101832. /**
  101833. * Gets or sets the fog end distance to use
  101834. * @see http://doc.babylonjs.com/babylon101/environment#fog
  101835. * (Default is 1000)
  101836. */
  101837. fogEnd: number;
  101838. private _shadowsEnabled;
  101839. /**
  101840. * Gets or sets a boolean indicating if shadows are enabled on this scene
  101841. */
  101842. shadowsEnabled: boolean;
  101843. private _lightsEnabled;
  101844. /**
  101845. * Gets or sets a boolean indicating if lights are enabled on this scene
  101846. */
  101847. lightsEnabled: boolean;
  101848. /** All of the active cameras added to this scene. */
  101849. activeCameras: Camera[];
  101850. /** @hidden */
  101851. _activeCamera: Nullable<Camera>;
  101852. /** Gets or sets the current active camera */
  101853. activeCamera: Nullable<Camera>;
  101854. private _defaultMaterial;
  101855. /** The default material used on meshes when no material is affected */
  101856. /** The default material used on meshes when no material is affected */
  101857. defaultMaterial: Material;
  101858. private _texturesEnabled;
  101859. /**
  101860. * Gets or sets a boolean indicating if textures are enabled on this scene
  101861. */
  101862. texturesEnabled: boolean;
  101863. /**
  101864. * Gets or sets a boolean indicating if particles are enabled on this scene
  101865. */
  101866. particlesEnabled: boolean;
  101867. /**
  101868. * Gets or sets a boolean indicating if sprites are enabled on this scene
  101869. */
  101870. spritesEnabled: boolean;
  101871. private _skeletonsEnabled;
  101872. /**
  101873. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  101874. */
  101875. skeletonsEnabled: boolean;
  101876. /**
  101877. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  101878. */
  101879. lensFlaresEnabled: boolean;
  101880. /**
  101881. * Gets or sets a boolean indicating if collisions are enabled on this scene
  101882. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  101883. */
  101884. collisionsEnabled: boolean;
  101885. private _collisionCoordinator;
  101886. /** @hidden */
  101887. readonly collisionCoordinator: ICollisionCoordinator;
  101888. /**
  101889. * Defines the gravity applied to this scene (used only for collisions)
  101890. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  101891. */
  101892. gravity: Vector3;
  101893. /**
  101894. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  101895. */
  101896. postProcessesEnabled: boolean;
  101897. /**
  101898. * The list of postprocesses added to the scene
  101899. */
  101900. postProcesses: PostProcess[];
  101901. /**
  101902. * Gets the current postprocess manager
  101903. */
  101904. postProcessManager: PostProcessManager;
  101905. /**
  101906. * Gets or sets a boolean indicating if render targets are enabled on this scene
  101907. */
  101908. renderTargetsEnabled: boolean;
  101909. /**
  101910. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  101911. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  101912. */
  101913. dumpNextRenderTargets: boolean;
  101914. /**
  101915. * The list of user defined render targets added to the scene
  101916. */
  101917. customRenderTargets: RenderTargetTexture[];
  101918. /**
  101919. * Defines if texture loading must be delayed
  101920. * If true, textures will only be loaded when they need to be rendered
  101921. */
  101922. useDelayedTextureLoading: boolean;
  101923. /**
  101924. * Gets the list of meshes imported to the scene through SceneLoader
  101925. */
  101926. importedMeshesFiles: String[];
  101927. /**
  101928. * Gets or sets a boolean indicating if probes are enabled on this scene
  101929. */
  101930. probesEnabled: boolean;
  101931. /**
  101932. * Gets or sets the current offline provider to use to store scene data
  101933. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  101934. */
  101935. offlineProvider: IOfflineProvider;
  101936. /**
  101937. * Gets or sets the action manager associated with the scene
  101938. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  101939. */
  101940. actionManager: AbstractActionManager;
  101941. private _meshesForIntersections;
  101942. /**
  101943. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  101944. */
  101945. proceduralTexturesEnabled: boolean;
  101946. private _engine;
  101947. private _totalVertices;
  101948. /** @hidden */
  101949. _activeIndices: PerfCounter;
  101950. /** @hidden */
  101951. _activeParticles: PerfCounter;
  101952. /** @hidden */
  101953. _activeBones: PerfCounter;
  101954. private _animationRatio;
  101955. /** @hidden */
  101956. _animationTimeLast: number;
  101957. /** @hidden */
  101958. _animationTime: number;
  101959. /**
  101960. * Gets or sets a general scale for animation speed
  101961. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  101962. */
  101963. animationTimeScale: number;
  101964. /** @hidden */
  101965. _cachedMaterial: Nullable<Material>;
  101966. /** @hidden */
  101967. _cachedEffect: Nullable<Effect>;
  101968. /** @hidden */
  101969. _cachedVisibility: Nullable<number>;
  101970. private _renderId;
  101971. private _frameId;
  101972. private _executeWhenReadyTimeoutId;
  101973. private _intermediateRendering;
  101974. private _viewUpdateFlag;
  101975. private _projectionUpdateFlag;
  101976. /** @hidden */
  101977. _toBeDisposed: Nullable<IDisposable>[];
  101978. private _activeRequests;
  101979. /** @hidden */
  101980. _pendingData: any[];
  101981. private _isDisposed;
  101982. /**
  101983. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  101984. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  101985. */
  101986. dispatchAllSubMeshesOfActiveMeshes: boolean;
  101987. private _activeMeshes;
  101988. private _processedMaterials;
  101989. private _renderTargets;
  101990. /** @hidden */
  101991. _activeParticleSystems: SmartArray<IParticleSystem>;
  101992. private _activeSkeletons;
  101993. private _softwareSkinnedMeshes;
  101994. private _renderingManager;
  101995. /** @hidden */
  101996. _activeAnimatables: Animatable[];
  101997. private _transformMatrix;
  101998. private _sceneUbo;
  101999. /** @hidden */
  102000. _viewMatrix: Matrix;
  102001. private _projectionMatrix;
  102002. /** @hidden */
  102003. _forcedViewPosition: Nullable<Vector3>;
  102004. /** @hidden */
  102005. _frustumPlanes: Plane[];
  102006. /**
  102007. * Gets the list of frustum planes (built from the active camera)
  102008. */
  102009. readonly frustumPlanes: Plane[];
  102010. /**
  102011. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  102012. * This is useful if there are more lights that the maximum simulteanous authorized
  102013. */
  102014. requireLightSorting: boolean;
  102015. /** @hidden */
  102016. readonly useMaterialMeshMap: boolean;
  102017. /** @hidden */
  102018. readonly useClonedMeshhMap: boolean;
  102019. private _externalData;
  102020. private _uid;
  102021. /**
  102022. * @hidden
  102023. * Backing store of defined scene components.
  102024. */
  102025. _components: ISceneComponent[];
  102026. /**
  102027. * @hidden
  102028. * Backing store of defined scene components.
  102029. */
  102030. _serializableComponents: ISceneSerializableComponent[];
  102031. /**
  102032. * List of components to register on the next registration step.
  102033. */
  102034. private _transientComponents;
  102035. /**
  102036. * Registers the transient components if needed.
  102037. */
  102038. private _registerTransientComponents;
  102039. /**
  102040. * @hidden
  102041. * Add a component to the scene.
  102042. * Note that the ccomponent could be registered on th next frame if this is called after
  102043. * the register component stage.
  102044. * @param component Defines the component to add to the scene
  102045. */
  102046. _addComponent(component: ISceneComponent): void;
  102047. /**
  102048. * @hidden
  102049. * Gets a component from the scene.
  102050. * @param name defines the name of the component to retrieve
  102051. * @returns the component or null if not present
  102052. */
  102053. _getComponent(name: string): Nullable<ISceneComponent>;
  102054. /**
  102055. * @hidden
  102056. * Defines the actions happening before camera updates.
  102057. */
  102058. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  102059. /**
  102060. * @hidden
  102061. * Defines the actions happening before clear the canvas.
  102062. */
  102063. _beforeClearStage: Stage<SimpleStageAction>;
  102064. /**
  102065. * @hidden
  102066. * Defines the actions when collecting render targets for the frame.
  102067. */
  102068. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  102069. /**
  102070. * @hidden
  102071. * Defines the actions happening for one camera in the frame.
  102072. */
  102073. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  102074. /**
  102075. * @hidden
  102076. * Defines the actions happening during the per mesh ready checks.
  102077. */
  102078. _isReadyForMeshStage: Stage<MeshStageAction>;
  102079. /**
  102080. * @hidden
  102081. * Defines the actions happening before evaluate active mesh checks.
  102082. */
  102083. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  102084. /**
  102085. * @hidden
  102086. * Defines the actions happening during the evaluate sub mesh checks.
  102087. */
  102088. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  102089. /**
  102090. * @hidden
  102091. * Defines the actions happening during the active mesh stage.
  102092. */
  102093. _activeMeshStage: Stage<ActiveMeshStageAction>;
  102094. /**
  102095. * @hidden
  102096. * Defines the actions happening during the per camera render target step.
  102097. */
  102098. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  102099. /**
  102100. * @hidden
  102101. * Defines the actions happening just before the active camera is drawing.
  102102. */
  102103. _beforeCameraDrawStage: Stage<CameraStageAction>;
  102104. /**
  102105. * @hidden
  102106. * Defines the actions happening just before a render target is drawing.
  102107. */
  102108. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  102109. /**
  102110. * @hidden
  102111. * Defines the actions happening just before a rendering group is drawing.
  102112. */
  102113. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  102114. /**
  102115. * @hidden
  102116. * Defines the actions happening just before a mesh is drawing.
  102117. */
  102118. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  102119. /**
  102120. * @hidden
  102121. * Defines the actions happening just after a mesh has been drawn.
  102122. */
  102123. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  102124. /**
  102125. * @hidden
  102126. * Defines the actions happening just after a rendering group has been drawn.
  102127. */
  102128. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  102129. /**
  102130. * @hidden
  102131. * Defines the actions happening just after the active camera has been drawn.
  102132. */
  102133. _afterCameraDrawStage: Stage<CameraStageAction>;
  102134. /**
  102135. * @hidden
  102136. * Defines the actions happening just after a render target has been drawn.
  102137. */
  102138. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  102139. /**
  102140. * @hidden
  102141. * Defines the actions happening just after rendering all cameras and computing intersections.
  102142. */
  102143. _afterRenderStage: Stage<SimpleStageAction>;
  102144. /**
  102145. * @hidden
  102146. * Defines the actions happening when a pointer move event happens.
  102147. */
  102148. _pointerMoveStage: Stage<PointerMoveStageAction>;
  102149. /**
  102150. * @hidden
  102151. * Defines the actions happening when a pointer down event happens.
  102152. */
  102153. _pointerDownStage: Stage<PointerUpDownStageAction>;
  102154. /**
  102155. * @hidden
  102156. * Defines the actions happening when a pointer up event happens.
  102157. */
  102158. _pointerUpStage: Stage<PointerUpDownStageAction>;
  102159. /**
  102160. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  102161. */
  102162. private geometriesByUniqueId;
  102163. /**
  102164. * Creates a new Scene
  102165. * @param engine defines the engine to use to render this scene
  102166. * @param options defines the scene options
  102167. */
  102168. constructor(engine: Engine, options?: SceneOptions);
  102169. /**
  102170. * Gets a string idenfifying the name of the class
  102171. * @returns "Scene" string
  102172. */
  102173. getClassName(): string;
  102174. private _defaultMeshCandidates;
  102175. /**
  102176. * @hidden
  102177. */
  102178. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  102179. private _defaultSubMeshCandidates;
  102180. /**
  102181. * @hidden
  102182. */
  102183. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  102184. /**
  102185. * Sets the default candidate providers for the scene.
  102186. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  102187. * and getCollidingSubMeshCandidates to their default function
  102188. */
  102189. setDefaultCandidateProviders(): void;
  102190. /**
  102191. * Gets the mesh that is currently under the pointer
  102192. */
  102193. readonly meshUnderPointer: Nullable<AbstractMesh>;
  102194. /**
  102195. * Gets or sets the current on-screen X position of the pointer
  102196. */
  102197. pointerX: number;
  102198. /**
  102199. * Gets or sets the current on-screen Y position of the pointer
  102200. */
  102201. pointerY: number;
  102202. /**
  102203. * Gets the cached material (ie. the latest rendered one)
  102204. * @returns the cached material
  102205. */
  102206. getCachedMaterial(): Nullable<Material>;
  102207. /**
  102208. * Gets the cached effect (ie. the latest rendered one)
  102209. * @returns the cached effect
  102210. */
  102211. getCachedEffect(): Nullable<Effect>;
  102212. /**
  102213. * Gets the cached visibility state (ie. the latest rendered one)
  102214. * @returns the cached visibility state
  102215. */
  102216. getCachedVisibility(): Nullable<number>;
  102217. /**
  102218. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  102219. * @param material defines the current material
  102220. * @param effect defines the current effect
  102221. * @param visibility defines the current visibility state
  102222. * @returns true if one parameter is not cached
  102223. */
  102224. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  102225. /**
  102226. * Gets the engine associated with the scene
  102227. * @returns an Engine
  102228. */
  102229. getEngine(): Engine;
  102230. /**
  102231. * Gets the total number of vertices rendered per frame
  102232. * @returns the total number of vertices rendered per frame
  102233. */
  102234. getTotalVertices(): number;
  102235. /**
  102236. * Gets the performance counter for total vertices
  102237. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102238. */
  102239. readonly totalVerticesPerfCounter: PerfCounter;
  102240. /**
  102241. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  102242. * @returns the total number of active indices rendered per frame
  102243. */
  102244. getActiveIndices(): number;
  102245. /**
  102246. * Gets the performance counter for active indices
  102247. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102248. */
  102249. readonly totalActiveIndicesPerfCounter: PerfCounter;
  102250. /**
  102251. * Gets the total number of active particles rendered per frame
  102252. * @returns the total number of active particles rendered per frame
  102253. */
  102254. getActiveParticles(): number;
  102255. /**
  102256. * Gets the performance counter for active particles
  102257. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102258. */
  102259. readonly activeParticlesPerfCounter: PerfCounter;
  102260. /**
  102261. * Gets the total number of active bones rendered per frame
  102262. * @returns the total number of active bones rendered per frame
  102263. */
  102264. getActiveBones(): number;
  102265. /**
  102266. * Gets the performance counter for active bones
  102267. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102268. */
  102269. readonly activeBonesPerfCounter: PerfCounter;
  102270. /**
  102271. * Gets the array of active meshes
  102272. * @returns an array of AbstractMesh
  102273. */
  102274. getActiveMeshes(): SmartArray<AbstractMesh>;
  102275. /**
  102276. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  102277. * @returns a number
  102278. */
  102279. getAnimationRatio(): number;
  102280. /**
  102281. * Gets an unique Id for the current render phase
  102282. * @returns a number
  102283. */
  102284. getRenderId(): number;
  102285. /**
  102286. * Gets an unique Id for the current frame
  102287. * @returns a number
  102288. */
  102289. getFrameId(): number;
  102290. /** Call this function if you want to manually increment the render Id*/
  102291. incrementRenderId(): void;
  102292. private _createUbo;
  102293. /**
  102294. * Use this method to simulate a pointer move on a mesh
  102295. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  102296. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  102297. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  102298. * @returns the current scene
  102299. */
  102300. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  102301. /**
  102302. * Use this method to simulate a pointer down on a mesh
  102303. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  102304. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  102305. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  102306. * @returns the current scene
  102307. */
  102308. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  102309. /**
  102310. * Use this method to simulate a pointer up on a mesh
  102311. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  102312. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  102313. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  102314. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  102315. * @returns the current scene
  102316. */
  102317. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  102318. /**
  102319. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  102320. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  102321. * @returns true if the pointer was captured
  102322. */
  102323. isPointerCaptured(pointerId?: number): boolean;
  102324. /**
  102325. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  102326. * @param attachUp defines if you want to attach events to pointerup
  102327. * @param attachDown defines if you want to attach events to pointerdown
  102328. * @param attachMove defines if you want to attach events to pointermove
  102329. */
  102330. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  102331. /** Detaches all event handlers*/
  102332. detachControl(): void;
  102333. /**
  102334. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  102335. * Delay loaded resources are not taking in account
  102336. * @return true if all required resources are ready
  102337. */
  102338. isReady(): boolean;
  102339. /** Resets all cached information relative to material (including effect and visibility) */
  102340. resetCachedMaterial(): void;
  102341. /**
  102342. * Registers a function to be called before every frame render
  102343. * @param func defines the function to register
  102344. */
  102345. registerBeforeRender(func: () => void): void;
  102346. /**
  102347. * Unregisters a function called before every frame render
  102348. * @param func defines the function to unregister
  102349. */
  102350. unregisterBeforeRender(func: () => void): void;
  102351. /**
  102352. * Registers a function to be called after every frame render
  102353. * @param func defines the function to register
  102354. */
  102355. registerAfterRender(func: () => void): void;
  102356. /**
  102357. * Unregisters a function called after every frame render
  102358. * @param func defines the function to unregister
  102359. */
  102360. unregisterAfterRender(func: () => void): void;
  102361. private _executeOnceBeforeRender;
  102362. /**
  102363. * The provided function will run before render once and will be disposed afterwards.
  102364. * A timeout delay can be provided so that the function will be executed in N ms.
  102365. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  102366. * @param func The function to be executed.
  102367. * @param timeout optional delay in ms
  102368. */
  102369. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  102370. /** @hidden */
  102371. _addPendingData(data: any): void;
  102372. /** @hidden */
  102373. _removePendingData(data: any): void;
  102374. /**
  102375. * Returns the number of items waiting to be loaded
  102376. * @returns the number of items waiting to be loaded
  102377. */
  102378. getWaitingItemsCount(): number;
  102379. /**
  102380. * Returns a boolean indicating if the scene is still loading data
  102381. */
  102382. readonly isLoading: boolean;
  102383. /**
  102384. * Registers a function to be executed when the scene is ready
  102385. * @param {Function} func - the function to be executed
  102386. */
  102387. executeWhenReady(func: () => void): void;
  102388. /**
  102389. * Returns a promise that resolves when the scene is ready
  102390. * @returns A promise that resolves when the scene is ready
  102391. */
  102392. whenReadyAsync(): Promise<void>;
  102393. /** @hidden */
  102394. _checkIsReady(): void;
  102395. /**
  102396. * Gets all animatable attached to the scene
  102397. */
  102398. readonly animatables: Animatable[];
  102399. /**
  102400. * Resets the last animation time frame.
  102401. * Useful to override when animations start running when loading a scene for the first time.
  102402. */
  102403. resetLastAnimationTimeFrame(): void;
  102404. /**
  102405. * Gets the current view matrix
  102406. * @returns a Matrix
  102407. */
  102408. getViewMatrix(): Matrix;
  102409. /**
  102410. * Gets the current projection matrix
  102411. * @returns a Matrix
  102412. */
  102413. getProjectionMatrix(): Matrix;
  102414. /**
  102415. * Gets the current transform matrix
  102416. * @returns a Matrix made of View * Projection
  102417. */
  102418. getTransformMatrix(): Matrix;
  102419. /**
  102420. * Sets the current transform matrix
  102421. * @param viewL defines the View matrix to use
  102422. * @param projectionL defines the Projection matrix to use
  102423. * @param viewR defines the right View matrix to use (if provided)
  102424. * @param projectionR defines the right Projection matrix to use (if provided)
  102425. */
  102426. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  102427. /**
  102428. * Gets the uniform buffer used to store scene data
  102429. * @returns a UniformBuffer
  102430. */
  102431. getSceneUniformBuffer(): UniformBuffer;
  102432. /**
  102433. * Gets an unique (relatively to the current scene) Id
  102434. * @returns an unique number for the scene
  102435. */
  102436. getUniqueId(): number;
  102437. /**
  102438. * Add a mesh to the list of scene's meshes
  102439. * @param newMesh defines the mesh to add
  102440. * @param recursive if all child meshes should also be added to the scene
  102441. */
  102442. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  102443. /**
  102444. * Remove a mesh for the list of scene's meshes
  102445. * @param toRemove defines the mesh to remove
  102446. * @param recursive if all child meshes should also be removed from the scene
  102447. * @returns the index where the mesh was in the mesh list
  102448. */
  102449. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  102450. /**
  102451. * Add a transform node to the list of scene's transform nodes
  102452. * @param newTransformNode defines the transform node to add
  102453. */
  102454. addTransformNode(newTransformNode: TransformNode): void;
  102455. /**
  102456. * Remove a transform node for the list of scene's transform nodes
  102457. * @param toRemove defines the transform node to remove
  102458. * @returns the index where the transform node was in the transform node list
  102459. */
  102460. removeTransformNode(toRemove: TransformNode): number;
  102461. /**
  102462. * Remove a skeleton for the list of scene's skeletons
  102463. * @param toRemove defines the skeleton to remove
  102464. * @returns the index where the skeleton was in the skeleton list
  102465. */
  102466. removeSkeleton(toRemove: Skeleton): number;
  102467. /**
  102468. * Remove a morph target for the list of scene's morph targets
  102469. * @param toRemove defines the morph target to remove
  102470. * @returns the index where the morph target was in the morph target list
  102471. */
  102472. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  102473. /**
  102474. * Remove a light for the list of scene's lights
  102475. * @param toRemove defines the light to remove
  102476. * @returns the index where the light was in the light list
  102477. */
  102478. removeLight(toRemove: Light): number;
  102479. /**
  102480. * Remove a camera for the list of scene's cameras
  102481. * @param toRemove defines the camera to remove
  102482. * @returns the index where the camera was in the camera list
  102483. */
  102484. removeCamera(toRemove: Camera): number;
  102485. /**
  102486. * Remove a particle system for the list of scene's particle systems
  102487. * @param toRemove defines the particle system to remove
  102488. * @returns the index where the particle system was in the particle system list
  102489. */
  102490. removeParticleSystem(toRemove: IParticleSystem): number;
  102491. /**
  102492. * Remove a animation for the list of scene's animations
  102493. * @param toRemove defines the animation to remove
  102494. * @returns the index where the animation was in the animation list
  102495. */
  102496. removeAnimation(toRemove: Animation): number;
  102497. /**
  102498. * Will stop the animation of the given target
  102499. * @param target - the target
  102500. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  102501. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  102502. */
  102503. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  102504. /**
  102505. * Removes the given animation group from this scene.
  102506. * @param toRemove The animation group to remove
  102507. * @returns The index of the removed animation group
  102508. */
  102509. removeAnimationGroup(toRemove: AnimationGroup): number;
  102510. /**
  102511. * Removes the given multi-material from this scene.
  102512. * @param toRemove The multi-material to remove
  102513. * @returns The index of the removed multi-material
  102514. */
  102515. removeMultiMaterial(toRemove: MultiMaterial): number;
  102516. /**
  102517. * Removes the given material from this scene.
  102518. * @param toRemove The material to remove
  102519. * @returns The index of the removed material
  102520. */
  102521. removeMaterial(toRemove: Material): number;
  102522. /**
  102523. * Removes the given action manager from this scene.
  102524. * @param toRemove The action manager to remove
  102525. * @returns The index of the removed action manager
  102526. */
  102527. removeActionManager(toRemove: AbstractActionManager): number;
  102528. /**
  102529. * Removes the given texture from this scene.
  102530. * @param toRemove The texture to remove
  102531. * @returns The index of the removed texture
  102532. */
  102533. removeTexture(toRemove: BaseTexture): number;
  102534. /**
  102535. * Adds the given light to this scene
  102536. * @param newLight The light to add
  102537. */
  102538. addLight(newLight: Light): void;
  102539. /**
  102540. * Sorts the list list based on light priorities
  102541. */
  102542. sortLightsByPriority(): void;
  102543. /**
  102544. * Adds the given camera to this scene
  102545. * @param newCamera The camera to add
  102546. */
  102547. addCamera(newCamera: Camera): void;
  102548. /**
  102549. * Adds the given skeleton to this scene
  102550. * @param newSkeleton The skeleton to add
  102551. */
  102552. addSkeleton(newSkeleton: Skeleton): void;
  102553. /**
  102554. * Adds the given particle system to this scene
  102555. * @param newParticleSystem The particle system to add
  102556. */
  102557. addParticleSystem(newParticleSystem: IParticleSystem): void;
  102558. /**
  102559. * Adds the given animation to this scene
  102560. * @param newAnimation The animation to add
  102561. */
  102562. addAnimation(newAnimation: Animation): void;
  102563. /**
  102564. * Adds the given animation group to this scene.
  102565. * @param newAnimationGroup The animation group to add
  102566. */
  102567. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  102568. /**
  102569. * Adds the given multi-material to this scene
  102570. * @param newMultiMaterial The multi-material to add
  102571. */
  102572. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  102573. /**
  102574. * Adds the given material to this scene
  102575. * @param newMaterial The material to add
  102576. */
  102577. addMaterial(newMaterial: Material): void;
  102578. /**
  102579. * Adds the given morph target to this scene
  102580. * @param newMorphTargetManager The morph target to add
  102581. */
  102582. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  102583. /**
  102584. * Adds the given geometry to this scene
  102585. * @param newGeometry The geometry to add
  102586. */
  102587. addGeometry(newGeometry: Geometry): void;
  102588. /**
  102589. * Adds the given action manager to this scene
  102590. * @param newActionManager The action manager to add
  102591. */
  102592. addActionManager(newActionManager: AbstractActionManager): void;
  102593. /**
  102594. * Adds the given texture to this scene.
  102595. * @param newTexture The texture to add
  102596. */
  102597. addTexture(newTexture: BaseTexture): void;
  102598. /**
  102599. * Switch active camera
  102600. * @param newCamera defines the new active camera
  102601. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  102602. */
  102603. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  102604. /**
  102605. * sets the active camera of the scene using its ID
  102606. * @param id defines the camera's ID
  102607. * @return the new active camera or null if none found.
  102608. */
  102609. setActiveCameraByID(id: string): Nullable<Camera>;
  102610. /**
  102611. * sets the active camera of the scene using its name
  102612. * @param name defines the camera's name
  102613. * @returns the new active camera or null if none found.
  102614. */
  102615. setActiveCameraByName(name: string): Nullable<Camera>;
  102616. /**
  102617. * get an animation group using its name
  102618. * @param name defines the material's name
  102619. * @return the animation group or null if none found.
  102620. */
  102621. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  102622. /**
  102623. * Get a material using its unique id
  102624. * @param uniqueId defines the material's unique id
  102625. * @return the material or null if none found.
  102626. */
  102627. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  102628. /**
  102629. * get a material using its id
  102630. * @param id defines the material's ID
  102631. * @return the material or null if none found.
  102632. */
  102633. getMaterialByID(id: string): Nullable<Material>;
  102634. /**
  102635. * Gets a the last added material using a given id
  102636. * @param id defines the material's ID
  102637. * @return the last material with the given id or null if none found.
  102638. */
  102639. getLastMaterialByID(id: string): Nullable<Material>;
  102640. /**
  102641. * Gets a material using its name
  102642. * @param name defines the material's name
  102643. * @return the material or null if none found.
  102644. */
  102645. getMaterialByName(name: string): Nullable<Material>;
  102646. /**
  102647. * Get a texture using its unique id
  102648. * @param uniqueId defines the texture's unique id
  102649. * @return the texture or null if none found.
  102650. */
  102651. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  102652. /**
  102653. * Gets a camera using its id
  102654. * @param id defines the id to look for
  102655. * @returns the camera or null if not found
  102656. */
  102657. getCameraByID(id: string): Nullable<Camera>;
  102658. /**
  102659. * Gets a camera using its unique id
  102660. * @param uniqueId defines the unique id to look for
  102661. * @returns the camera or null if not found
  102662. */
  102663. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  102664. /**
  102665. * Gets a camera using its name
  102666. * @param name defines the camera's name
  102667. * @return the camera or null if none found.
  102668. */
  102669. getCameraByName(name: string): Nullable<Camera>;
  102670. /**
  102671. * Gets a bone using its id
  102672. * @param id defines the bone's id
  102673. * @return the bone or null if not found
  102674. */
  102675. getBoneByID(id: string): Nullable<Bone>;
  102676. /**
  102677. * Gets a bone using its id
  102678. * @param name defines the bone's name
  102679. * @return the bone or null if not found
  102680. */
  102681. getBoneByName(name: string): Nullable<Bone>;
  102682. /**
  102683. * Gets a light node using its name
  102684. * @param name defines the the light's name
  102685. * @return the light or null if none found.
  102686. */
  102687. getLightByName(name: string): Nullable<Light>;
  102688. /**
  102689. * Gets a light node using its id
  102690. * @param id defines the light's id
  102691. * @return the light or null if none found.
  102692. */
  102693. getLightByID(id: string): Nullable<Light>;
  102694. /**
  102695. * Gets a light node using its scene-generated unique ID
  102696. * @param uniqueId defines the light's unique id
  102697. * @return the light or null if none found.
  102698. */
  102699. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  102700. /**
  102701. * Gets a particle system by id
  102702. * @param id defines the particle system id
  102703. * @return the corresponding system or null if none found
  102704. */
  102705. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  102706. /**
  102707. * Gets a geometry using its ID
  102708. * @param id defines the geometry's id
  102709. * @return the geometry or null if none found.
  102710. */
  102711. getGeometryByID(id: string): Nullable<Geometry>;
  102712. private _getGeometryByUniqueID;
  102713. /**
  102714. * Add a new geometry to this scene
  102715. * @param geometry defines the geometry to be added to the scene.
  102716. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  102717. * @return a boolean defining if the geometry was added or not
  102718. */
  102719. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  102720. /**
  102721. * Removes an existing geometry
  102722. * @param geometry defines the geometry to be removed from the scene
  102723. * @return a boolean defining if the geometry was removed or not
  102724. */
  102725. removeGeometry(geometry: Geometry): boolean;
  102726. /**
  102727. * Gets the list of geometries attached to the scene
  102728. * @returns an array of Geometry
  102729. */
  102730. getGeometries(): Geometry[];
  102731. /**
  102732. * Gets the first added mesh found of a given ID
  102733. * @param id defines the id to search for
  102734. * @return the mesh found or null if not found at all
  102735. */
  102736. getMeshByID(id: string): Nullable<AbstractMesh>;
  102737. /**
  102738. * Gets a list of meshes using their id
  102739. * @param id defines the id to search for
  102740. * @returns a list of meshes
  102741. */
  102742. getMeshesByID(id: string): Array<AbstractMesh>;
  102743. /**
  102744. * Gets the first added transform node found of a given ID
  102745. * @param id defines the id to search for
  102746. * @return the found transform node or null if not found at all.
  102747. */
  102748. getTransformNodeByID(id: string): Nullable<TransformNode>;
  102749. /**
  102750. * Gets a transform node with its auto-generated unique id
  102751. * @param uniqueId efines the unique id to search for
  102752. * @return the found transform node or null if not found at all.
  102753. */
  102754. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  102755. /**
  102756. * Gets a list of transform nodes using their id
  102757. * @param id defines the id to search for
  102758. * @returns a list of transform nodes
  102759. */
  102760. getTransformNodesByID(id: string): Array<TransformNode>;
  102761. /**
  102762. * Gets a mesh with its auto-generated unique id
  102763. * @param uniqueId defines the unique id to search for
  102764. * @return the found mesh or null if not found at all.
  102765. */
  102766. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  102767. /**
  102768. * Gets a the last added mesh using a given id
  102769. * @param id defines the id to search for
  102770. * @return the found mesh or null if not found at all.
  102771. */
  102772. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  102773. /**
  102774. * Gets a the last added node (Mesh, Camera, Light) using a given id
  102775. * @param id defines the id to search for
  102776. * @return the found node or null if not found at all
  102777. */
  102778. getLastEntryByID(id: string): Nullable<Node>;
  102779. /**
  102780. * Gets a node (Mesh, Camera, Light) using a given id
  102781. * @param id defines the id to search for
  102782. * @return the found node or null if not found at all
  102783. */
  102784. getNodeByID(id: string): Nullable<Node>;
  102785. /**
  102786. * Gets a node (Mesh, Camera, Light) using a given name
  102787. * @param name defines the name to search for
  102788. * @return the found node or null if not found at all.
  102789. */
  102790. getNodeByName(name: string): Nullable<Node>;
  102791. /**
  102792. * Gets a mesh using a given name
  102793. * @param name defines the name to search for
  102794. * @return the found mesh or null if not found at all.
  102795. */
  102796. getMeshByName(name: string): Nullable<AbstractMesh>;
  102797. /**
  102798. * Gets a transform node using a given name
  102799. * @param name defines the name to search for
  102800. * @return the found transform node or null if not found at all.
  102801. */
  102802. getTransformNodeByName(name: string): Nullable<TransformNode>;
  102803. /**
  102804. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  102805. * @param id defines the id to search for
  102806. * @return the found skeleton or null if not found at all.
  102807. */
  102808. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  102809. /**
  102810. * Gets a skeleton using a given auto generated unique id
  102811. * @param uniqueId defines the unique id to search for
  102812. * @return the found skeleton or null if not found at all.
  102813. */
  102814. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  102815. /**
  102816. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  102817. * @param id defines the id to search for
  102818. * @return the found skeleton or null if not found at all.
  102819. */
  102820. getSkeletonById(id: string): Nullable<Skeleton>;
  102821. /**
  102822. * Gets a skeleton using a given name
  102823. * @param name defines the name to search for
  102824. * @return the found skeleton or null if not found at all.
  102825. */
  102826. getSkeletonByName(name: string): Nullable<Skeleton>;
  102827. /**
  102828. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  102829. * @param id defines the id to search for
  102830. * @return the found morph target manager or null if not found at all.
  102831. */
  102832. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  102833. /**
  102834. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  102835. * @param id defines the id to search for
  102836. * @return the found morph target or null if not found at all.
  102837. */
  102838. getMorphTargetById(id: string): Nullable<MorphTarget>;
  102839. /**
  102840. * Gets a boolean indicating if the given mesh is active
  102841. * @param mesh defines the mesh to look for
  102842. * @returns true if the mesh is in the active list
  102843. */
  102844. isActiveMesh(mesh: AbstractMesh): boolean;
  102845. /**
  102846. * Return a unique id as a string which can serve as an identifier for the scene
  102847. */
  102848. readonly uid: string;
  102849. /**
  102850. * Add an externaly attached data from its key.
  102851. * This method call will fail and return false, if such key already exists.
  102852. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  102853. * @param key the unique key that identifies the data
  102854. * @param data the data object to associate to the key for this Engine instance
  102855. * @return true if no such key were already present and the data was added successfully, false otherwise
  102856. */
  102857. addExternalData<T>(key: string, data: T): boolean;
  102858. /**
  102859. * Get an externaly attached data from its key
  102860. * @param key the unique key that identifies the data
  102861. * @return the associated data, if present (can be null), or undefined if not present
  102862. */
  102863. getExternalData<T>(key: string): Nullable<T>;
  102864. /**
  102865. * Get an externaly attached data from its key, create it using a factory if it's not already present
  102866. * @param key the unique key that identifies the data
  102867. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  102868. * @return the associated data, can be null if the factory returned null.
  102869. */
  102870. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  102871. /**
  102872. * Remove an externaly attached data from the Engine instance
  102873. * @param key the unique key that identifies the data
  102874. * @return true if the data was successfully removed, false if it doesn't exist
  102875. */
  102876. removeExternalData(key: string): boolean;
  102877. private _evaluateSubMesh;
  102878. /**
  102879. * Clear the processed materials smart array preventing retention point in material dispose.
  102880. */
  102881. freeProcessedMaterials(): void;
  102882. private _preventFreeActiveMeshesAndRenderingGroups;
  102883. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  102884. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  102885. * when disposing several meshes in a row or a hierarchy of meshes.
  102886. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  102887. */
  102888. blockfreeActiveMeshesAndRenderingGroups: boolean;
  102889. /**
  102890. * Clear the active meshes smart array preventing retention point in mesh dispose.
  102891. */
  102892. freeActiveMeshes(): void;
  102893. /**
  102894. * Clear the info related to rendering groups preventing retention points during dispose.
  102895. */
  102896. freeRenderingGroups(): void;
  102897. /** @hidden */
  102898. _isInIntermediateRendering(): boolean;
  102899. /**
  102900. * Lambda returning the list of potentially active meshes.
  102901. */
  102902. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  102903. /**
  102904. * Lambda returning the list of potentially active sub meshes.
  102905. */
  102906. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  102907. /**
  102908. * Lambda returning the list of potentially intersecting sub meshes.
  102909. */
  102910. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  102911. /**
  102912. * Lambda returning the list of potentially colliding sub meshes.
  102913. */
  102914. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  102915. private _activeMeshesFrozen;
  102916. /**
  102917. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  102918. * @returns the current scene
  102919. */
  102920. freezeActiveMeshes(): Scene;
  102921. /**
  102922. * Use this function to restart evaluating active meshes on every frame
  102923. * @returns the current scene
  102924. */
  102925. unfreezeActiveMeshes(): Scene;
  102926. private _evaluateActiveMeshes;
  102927. private _activeMesh;
  102928. /**
  102929. * Update the transform matrix to update from the current active camera
  102930. * @param force defines a boolean used to force the update even if cache is up to date
  102931. */
  102932. updateTransformMatrix(force?: boolean): void;
  102933. private _bindFrameBuffer;
  102934. /** @hidden */
  102935. _allowPostProcessClearColor: boolean;
  102936. /** @hidden */
  102937. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  102938. private _processSubCameras;
  102939. private _checkIntersections;
  102940. /** @hidden */
  102941. _advancePhysicsEngineStep(step: number): void;
  102942. /**
  102943. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  102944. */
  102945. getDeterministicFrameTime: () => number;
  102946. /** @hidden */
  102947. _animate(): void;
  102948. /** Execute all animations (for a frame) */
  102949. animate(): void;
  102950. /**
  102951. * Render the scene
  102952. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  102953. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  102954. */
  102955. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  102956. /**
  102957. * Freeze all materials
  102958. * A frozen material will not be updatable but should be faster to render
  102959. */
  102960. freezeMaterials(): void;
  102961. /**
  102962. * Unfreeze all materials
  102963. * A frozen material will not be updatable but should be faster to render
  102964. */
  102965. unfreezeMaterials(): void;
  102966. /**
  102967. * Releases all held ressources
  102968. */
  102969. dispose(): void;
  102970. /**
  102971. * Gets if the scene is already disposed
  102972. */
  102973. readonly isDisposed: boolean;
  102974. /**
  102975. * Call this function to reduce memory footprint of the scene.
  102976. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  102977. */
  102978. clearCachedVertexData(): void;
  102979. /**
  102980. * This function will remove the local cached buffer data from texture.
  102981. * It will save memory but will prevent the texture from being rebuilt
  102982. */
  102983. cleanCachedTextureBuffer(): void;
  102984. /**
  102985. * Get the world extend vectors with an optional filter
  102986. *
  102987. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  102988. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  102989. */
  102990. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  102991. min: Vector3;
  102992. max: Vector3;
  102993. };
  102994. /**
  102995. * Creates a ray that can be used to pick in the scene
  102996. * @param x defines the x coordinate of the origin (on-screen)
  102997. * @param y defines the y coordinate of the origin (on-screen)
  102998. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  102999. * @param camera defines the camera to use for the picking
  103000. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  103001. * @returns a Ray
  103002. */
  103003. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  103004. /**
  103005. * Creates a ray that can be used to pick in the scene
  103006. * @param x defines the x coordinate of the origin (on-screen)
  103007. * @param y defines the y coordinate of the origin (on-screen)
  103008. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  103009. * @param result defines the ray where to store the picking ray
  103010. * @param camera defines the camera to use for the picking
  103011. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  103012. * @returns the current scene
  103013. */
  103014. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  103015. /**
  103016. * Creates a ray that can be used to pick in the scene
  103017. * @param x defines the x coordinate of the origin (on-screen)
  103018. * @param y defines the y coordinate of the origin (on-screen)
  103019. * @param camera defines the camera to use for the picking
  103020. * @returns a Ray
  103021. */
  103022. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  103023. /**
  103024. * Creates a ray that can be used to pick in the scene
  103025. * @param x defines the x coordinate of the origin (on-screen)
  103026. * @param y defines the y coordinate of the origin (on-screen)
  103027. * @param result defines the ray where to store the picking ray
  103028. * @param camera defines the camera to use for the picking
  103029. * @returns the current scene
  103030. */
  103031. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  103032. /** Launch a ray to try to pick a mesh in the scene
  103033. * @param x position on screen
  103034. * @param y position on screen
  103035. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true
  103036. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  103037. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  103038. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103039. * @returns a PickingInfo
  103040. */
  103041. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  103042. /** Use the given ray to pick a mesh in the scene
  103043. * @param ray The ray to use to pick meshes
  103044. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must have isPickable set to true
  103045. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  103046. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103047. * @returns a PickingInfo
  103048. */
  103049. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  103050. /**
  103051. * Launch a ray to try to pick a mesh in the scene
  103052. * @param x X position on screen
  103053. * @param y Y position on screen
  103054. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true
  103055. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  103056. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103057. * @returns an array of PickingInfo
  103058. */
  103059. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  103060. /**
  103061. * Launch a ray to try to pick a mesh in the scene
  103062. * @param ray Ray to use
  103063. * @param predicate Predicate function used to determine eligible meshes. Can be set to null. In this case, a mesh must be enabled, visible and with isPickable set to true
  103064. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103065. * @returns an array of PickingInfo
  103066. */
  103067. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  103068. /**
  103069. * Force the value of meshUnderPointer
  103070. * @param mesh defines the mesh to use
  103071. */
  103072. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  103073. /**
  103074. * Gets the mesh under the pointer
  103075. * @returns a Mesh or null if no mesh is under the pointer
  103076. */
  103077. getPointerOverMesh(): Nullable<AbstractMesh>;
  103078. /** @hidden */
  103079. _rebuildGeometries(): void;
  103080. /** @hidden */
  103081. _rebuildTextures(): void;
  103082. private _getByTags;
  103083. /**
  103084. * Get a list of meshes by tags
  103085. * @param tagsQuery defines the tags query to use
  103086. * @param forEach defines a predicate used to filter results
  103087. * @returns an array of Mesh
  103088. */
  103089. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  103090. /**
  103091. * Get a list of cameras by tags
  103092. * @param tagsQuery defines the tags query to use
  103093. * @param forEach defines a predicate used to filter results
  103094. * @returns an array of Camera
  103095. */
  103096. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  103097. /**
  103098. * Get a list of lights by tags
  103099. * @param tagsQuery defines the tags query to use
  103100. * @param forEach defines a predicate used to filter results
  103101. * @returns an array of Light
  103102. */
  103103. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  103104. /**
  103105. * Get a list of materials by tags
  103106. * @param tagsQuery defines the tags query to use
  103107. * @param forEach defines a predicate used to filter results
  103108. * @returns an array of Material
  103109. */
  103110. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  103111. /**
  103112. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103113. * This allowed control for front to back rendering or reversly depending of the special needs.
  103114. *
  103115. * @param renderingGroupId The rendering group id corresponding to its index
  103116. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103117. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103118. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103119. */
  103120. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  103121. /**
  103122. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103123. *
  103124. * @param renderingGroupId The rendering group id corresponding to its index
  103125. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103126. * @param depth Automatically clears depth between groups if true and autoClear is true.
  103127. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  103128. */
  103129. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  103130. /**
  103131. * Gets the current auto clear configuration for one rendering group of the rendering
  103132. * manager.
  103133. * @param index the rendering group index to get the information for
  103134. * @returns The auto clear setup for the requested rendering group
  103135. */
  103136. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  103137. private _blockMaterialDirtyMechanism;
  103138. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  103139. blockMaterialDirtyMechanism: boolean;
  103140. /**
  103141. * Will flag all materials as dirty to trigger new shader compilation
  103142. * @param flag defines the flag used to specify which material part must be marked as dirty
  103143. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  103144. */
  103145. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  103146. /** @hidden */
  103147. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  103148. /** @hidden */
  103149. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  103150. /** @hidden */
  103151. _requestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  103152. /** @hidden */
  103153. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  103154. /** @hidden */
  103155. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  103156. /** @hidden */
  103157. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  103158. }
  103159. }
  103160. declare module BABYLON {
  103161. /**
  103162. * Set of assets to keep when moving a scene into an asset container.
  103163. */
  103164. export class KeepAssets extends AbstractScene {
  103165. }
  103166. /**
  103167. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  103168. */
  103169. export class InstantiatedEntries {
  103170. /**
  103171. * List of new root nodes (eg. nodes with no parent)
  103172. */
  103173. rootNodes: TransformNode[];
  103174. /**
  103175. * List of new skeletons
  103176. */
  103177. skeletons: Skeleton[];
  103178. /**
  103179. * List of new animation groups
  103180. */
  103181. animationGroups: AnimationGroup[];
  103182. }
  103183. /**
  103184. * Container with a set of assets that can be added or removed from a scene.
  103185. */
  103186. export class AssetContainer extends AbstractScene {
  103187. /**
  103188. * The scene the AssetContainer belongs to.
  103189. */
  103190. scene: Scene;
  103191. /**
  103192. * Instantiates an AssetContainer.
  103193. * @param scene The scene the AssetContainer belongs to.
  103194. */
  103195. constructor(scene: Scene);
  103196. /**
  103197. * Instantiate or clone all meshes and add the new ones to the scene.
  103198. * Skeletons and animation groups will all be cloned
  103199. * @param nameFunction defines an optional function used to get new names for clones
  103200. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  103201. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  103202. */
  103203. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  103204. /**
  103205. * Adds all the assets from the container to the scene.
  103206. */
  103207. addAllToScene(): void;
  103208. /**
  103209. * Removes all the assets in the container from the scene
  103210. */
  103211. removeAllFromScene(): void;
  103212. /**
  103213. * Disposes all the assets in the container
  103214. */
  103215. dispose(): void;
  103216. private _moveAssets;
  103217. /**
  103218. * Removes all the assets contained in the scene and adds them to the container.
  103219. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  103220. */
  103221. moveAllFromScene(keepAssets?: KeepAssets): void;
  103222. /**
  103223. * Adds all meshes in the asset container to a root mesh that can be used to position all the contained meshes. The root mesh is then added to the front of the meshes in the assetContainer.
  103224. * @returns the root mesh
  103225. */
  103226. createRootMesh(): Mesh;
  103227. }
  103228. }
  103229. declare module BABYLON {
  103230. /**
  103231. * Defines how the parser contract is defined.
  103232. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  103233. */
  103234. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  103235. /**
  103236. * Defines how the individual parser contract is defined.
  103237. * These parser can parse an individual asset
  103238. */
  103239. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  103240. /**
  103241. * Base class of the scene acting as a container for the different elements composing a scene.
  103242. * This class is dynamically extended by the different components of the scene increasing
  103243. * flexibility and reducing coupling
  103244. */
  103245. export abstract class AbstractScene {
  103246. /**
  103247. * Stores the list of available parsers in the application.
  103248. */
  103249. private static _BabylonFileParsers;
  103250. /**
  103251. * Stores the list of available individual parsers in the application.
  103252. */
  103253. private static _IndividualBabylonFileParsers;
  103254. /**
  103255. * Adds a parser in the list of available ones
  103256. * @param name Defines the name of the parser
  103257. * @param parser Defines the parser to add
  103258. */
  103259. static AddParser(name: string, parser: BabylonFileParser): void;
  103260. /**
  103261. * Gets a general parser from the list of avaialble ones
  103262. * @param name Defines the name of the parser
  103263. * @returns the requested parser or null
  103264. */
  103265. static GetParser(name: string): Nullable<BabylonFileParser>;
  103266. /**
  103267. * Adds n individual parser in the list of available ones
  103268. * @param name Defines the name of the parser
  103269. * @param parser Defines the parser to add
  103270. */
  103271. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  103272. /**
  103273. * Gets an individual parser from the list of avaialble ones
  103274. * @param name Defines the name of the parser
  103275. * @returns the requested parser or null
  103276. */
  103277. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  103278. /**
  103279. * Parser json data and populate both a scene and its associated container object
  103280. * @param jsonData Defines the data to parse
  103281. * @param scene Defines the scene to parse the data for
  103282. * @param container Defines the container attached to the parsing sequence
  103283. * @param rootUrl Defines the root url of the data
  103284. */
  103285. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  103286. /**
  103287. * Gets the list of root nodes (ie. nodes with no parent)
  103288. */
  103289. rootNodes: Node[];
  103290. /** All of the cameras added to this scene
  103291. * @see http://doc.babylonjs.com/babylon101/cameras
  103292. */
  103293. cameras: Camera[];
  103294. /**
  103295. * All of the lights added to this scene
  103296. * @see http://doc.babylonjs.com/babylon101/lights
  103297. */
  103298. lights: Light[];
  103299. /**
  103300. * All of the (abstract) meshes added to this scene
  103301. */
  103302. meshes: AbstractMesh[];
  103303. /**
  103304. * The list of skeletons added to the scene
  103305. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  103306. */
  103307. skeletons: Skeleton[];
  103308. /**
  103309. * All of the particle systems added to this scene
  103310. * @see http://doc.babylonjs.com/babylon101/particles
  103311. */
  103312. particleSystems: IParticleSystem[];
  103313. /**
  103314. * Gets a list of Animations associated with the scene
  103315. */
  103316. animations: Animation[];
  103317. /**
  103318. * All of the animation groups added to this scene
  103319. * @see http://doc.babylonjs.com/how_to/group
  103320. */
  103321. animationGroups: AnimationGroup[];
  103322. /**
  103323. * All of the multi-materials added to this scene
  103324. * @see http://doc.babylonjs.com/how_to/multi_materials
  103325. */
  103326. multiMaterials: MultiMaterial[];
  103327. /**
  103328. * All of the materials added to this scene
  103329. * In the context of a Scene, it is not supposed to be modified manually.
  103330. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  103331. * Note also that the order of the Material within the array is not significant and might change.
  103332. * @see http://doc.babylonjs.com/babylon101/materials
  103333. */
  103334. materials: Material[];
  103335. /**
  103336. * The list of morph target managers added to the scene
  103337. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  103338. */
  103339. morphTargetManagers: MorphTargetManager[];
  103340. /**
  103341. * The list of geometries used in the scene.
  103342. */
  103343. geometries: Geometry[];
  103344. /**
  103345. * All of the tranform nodes added to this scene
  103346. * In the context of a Scene, it is not supposed to be modified manually.
  103347. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  103348. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  103349. * @see http://doc.babylonjs.com/how_to/transformnode
  103350. */
  103351. transformNodes: TransformNode[];
  103352. /**
  103353. * ActionManagers available on the scene.
  103354. */
  103355. actionManagers: AbstractActionManager[];
  103356. /**
  103357. * Textures to keep.
  103358. */
  103359. textures: BaseTexture[];
  103360. /**
  103361. * Environment texture for the scene
  103362. */
  103363. environmentTexture: Nullable<BaseTexture>;
  103364. }
  103365. }
  103366. declare module BABYLON {
  103367. /**
  103368. * Interface used to define options for Sound class
  103369. */
  103370. export interface ISoundOptions {
  103371. /**
  103372. * Does the sound autoplay once loaded.
  103373. */
  103374. autoplay?: boolean;
  103375. /**
  103376. * Does the sound loop after it finishes playing once.
  103377. */
  103378. loop?: boolean;
  103379. /**
  103380. * Sound's volume
  103381. */
  103382. volume?: number;
  103383. /**
  103384. * Is it a spatial sound?
  103385. */
  103386. spatialSound?: boolean;
  103387. /**
  103388. * Maximum distance to hear that sound
  103389. */
  103390. maxDistance?: number;
  103391. /**
  103392. * Uses user defined attenuation function
  103393. */
  103394. useCustomAttenuation?: boolean;
  103395. /**
  103396. * Define the roll off factor of spatial sounds.
  103397. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103398. */
  103399. rolloffFactor?: number;
  103400. /**
  103401. * Define the reference distance the sound should be heard perfectly.
  103402. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103403. */
  103404. refDistance?: number;
  103405. /**
  103406. * Define the distance attenuation model the sound will follow.
  103407. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103408. */
  103409. distanceModel?: string;
  103410. /**
  103411. * Defines the playback speed (1 by default)
  103412. */
  103413. playbackRate?: number;
  103414. /**
  103415. * Defines if the sound is from a streaming source
  103416. */
  103417. streaming?: boolean;
  103418. /**
  103419. * Defines an optional length (in seconds) inside the sound file
  103420. */
  103421. length?: number;
  103422. /**
  103423. * Defines an optional offset (in seconds) inside the sound file
  103424. */
  103425. offset?: number;
  103426. /**
  103427. * If true, URLs will not be required to state the audio file codec to use.
  103428. */
  103429. skipCodecCheck?: boolean;
  103430. }
  103431. /**
  103432. * Defines a sound that can be played in the application.
  103433. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  103434. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103435. */
  103436. export class Sound {
  103437. /**
  103438. * The name of the sound in the scene.
  103439. */
  103440. name: string;
  103441. /**
  103442. * Does the sound autoplay once loaded.
  103443. */
  103444. autoplay: boolean;
  103445. /**
  103446. * Does the sound loop after it finishes playing once.
  103447. */
  103448. loop: boolean;
  103449. /**
  103450. * Does the sound use a custom attenuation curve to simulate the falloff
  103451. * happening when the source gets further away from the camera.
  103452. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  103453. */
  103454. useCustomAttenuation: boolean;
  103455. /**
  103456. * The sound track id this sound belongs to.
  103457. */
  103458. soundTrackId: number;
  103459. /**
  103460. * Is this sound currently played.
  103461. */
  103462. isPlaying: boolean;
  103463. /**
  103464. * Is this sound currently paused.
  103465. */
  103466. isPaused: boolean;
  103467. /**
  103468. * Does this sound enables spatial sound.
  103469. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103470. */
  103471. spatialSound: boolean;
  103472. /**
  103473. * Define the reference distance the sound should be heard perfectly.
  103474. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103475. */
  103476. refDistance: number;
  103477. /**
  103478. * Define the roll off factor of spatial sounds.
  103479. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103480. */
  103481. rolloffFactor: number;
  103482. /**
  103483. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  103484. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103485. */
  103486. maxDistance: number;
  103487. /**
  103488. * Define the distance attenuation model the sound will follow.
  103489. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103490. */
  103491. distanceModel: string;
  103492. /**
  103493. * @hidden
  103494. * Back Compat
  103495. **/
  103496. onended: () => any;
  103497. /**
  103498. * Observable event when the current playing sound finishes.
  103499. */
  103500. onEndedObservable: Observable<Sound>;
  103501. private _panningModel;
  103502. private _playbackRate;
  103503. private _streaming;
  103504. private _startTime;
  103505. private _startOffset;
  103506. private _position;
  103507. /** @hidden */
  103508. _positionInEmitterSpace: boolean;
  103509. private _localDirection;
  103510. private _volume;
  103511. private _isReadyToPlay;
  103512. private _isDirectional;
  103513. private _readyToPlayCallback;
  103514. private _audioBuffer;
  103515. private _soundSource;
  103516. private _streamingSource;
  103517. private _soundPanner;
  103518. private _soundGain;
  103519. private _inputAudioNode;
  103520. private _outputAudioNode;
  103521. private _coneInnerAngle;
  103522. private _coneOuterAngle;
  103523. private _coneOuterGain;
  103524. private _scene;
  103525. private _connectedTransformNode;
  103526. private _customAttenuationFunction;
  103527. private _registerFunc;
  103528. private _isOutputConnected;
  103529. private _htmlAudioElement;
  103530. private _urlType;
  103531. private _length?;
  103532. private _offset?;
  103533. /** @hidden */
  103534. static _SceneComponentInitialization: (scene: Scene) => void;
  103535. /**
  103536. * Create a sound and attach it to a scene
  103537. * @param name Name of your sound
  103538. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  103539. * @param scene defines the scene the sound belongs to
  103540. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  103541. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  103542. */
  103543. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  103544. /**
  103545. * Release the sound and its associated resources
  103546. */
  103547. dispose(): void;
  103548. /**
  103549. * Gets if the sounds is ready to be played or not.
  103550. * @returns true if ready, otherwise false
  103551. */
  103552. isReady(): boolean;
  103553. private _soundLoaded;
  103554. /**
  103555. * Sets the data of the sound from an audiobuffer
  103556. * @param audioBuffer The audioBuffer containing the data
  103557. */
  103558. setAudioBuffer(audioBuffer: AudioBuffer): void;
  103559. /**
  103560. * Updates the current sounds options such as maxdistance, loop...
  103561. * @param options A JSON object containing values named as the object properties
  103562. */
  103563. updateOptions(options: ISoundOptions): void;
  103564. private _createSpatialParameters;
  103565. private _updateSpatialParameters;
  103566. /**
  103567. * Switch the panning model to HRTF:
  103568. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  103569. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103570. */
  103571. switchPanningModelToHRTF(): void;
  103572. /**
  103573. * Switch the panning model to Equal Power:
  103574. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  103575. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103576. */
  103577. switchPanningModelToEqualPower(): void;
  103578. private _switchPanningModel;
  103579. /**
  103580. * Connect this sound to a sound track audio node like gain...
  103581. * @param soundTrackAudioNode the sound track audio node to connect to
  103582. */
  103583. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  103584. /**
  103585. * Transform this sound into a directional source
  103586. * @param coneInnerAngle Size of the inner cone in degree
  103587. * @param coneOuterAngle Size of the outer cone in degree
  103588. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  103589. */
  103590. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  103591. /**
  103592. * Gets or sets the inner angle for the directional cone.
  103593. */
  103594. /**
  103595. * Gets or sets the inner angle for the directional cone.
  103596. */
  103597. directionalConeInnerAngle: number;
  103598. /**
  103599. * Gets or sets the outer angle for the directional cone.
  103600. */
  103601. /**
  103602. * Gets or sets the outer angle for the directional cone.
  103603. */
  103604. directionalConeOuterAngle: number;
  103605. /**
  103606. * Sets the position of the emitter if spatial sound is enabled
  103607. * @param newPosition Defines the new posisiton
  103608. */
  103609. setPosition(newPosition: Vector3): void;
  103610. /**
  103611. * Sets the local direction of the emitter if spatial sound is enabled
  103612. * @param newLocalDirection Defines the new local direction
  103613. */
  103614. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  103615. private _updateDirection;
  103616. /** @hidden */
  103617. updateDistanceFromListener(): void;
  103618. /**
  103619. * Sets a new custom attenuation function for the sound.
  103620. * @param callback Defines the function used for the attenuation
  103621. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  103622. */
  103623. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  103624. /**
  103625. * Play the sound
  103626. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  103627. * @param offset (optional) Start the sound at a specific time in seconds
  103628. * @param length (optional) Sound duration (in seconds)
  103629. */
  103630. play(time?: number, offset?: number, length?: number): void;
  103631. private _onended;
  103632. /**
  103633. * Stop the sound
  103634. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  103635. */
  103636. stop(time?: number): void;
  103637. /**
  103638. * Put the sound in pause
  103639. */
  103640. pause(): void;
  103641. /**
  103642. * Sets a dedicated volume for this sounds
  103643. * @param newVolume Define the new volume of the sound
  103644. * @param time Define time for gradual change to new volume
  103645. */
  103646. setVolume(newVolume: number, time?: number): void;
  103647. /**
  103648. * Set the sound play back rate
  103649. * @param newPlaybackRate Define the playback rate the sound should be played at
  103650. */
  103651. setPlaybackRate(newPlaybackRate: number): void;
  103652. /**
  103653. * Gets the volume of the sound.
  103654. * @returns the volume of the sound
  103655. */
  103656. getVolume(): number;
  103657. /**
  103658. * Attach the sound to a dedicated mesh
  103659. * @param transformNode The transform node to connect the sound with
  103660. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  103661. */
  103662. attachToMesh(transformNode: TransformNode): void;
  103663. /**
  103664. * Detach the sound from the previously attached mesh
  103665. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  103666. */
  103667. detachFromMesh(): void;
  103668. private _onRegisterAfterWorldMatrixUpdate;
  103669. /**
  103670. * Clone the current sound in the scene.
  103671. * @returns the new sound clone
  103672. */
  103673. clone(): Nullable<Sound>;
  103674. /**
  103675. * Gets the current underlying audio buffer containing the data
  103676. * @returns the audio buffer
  103677. */
  103678. getAudioBuffer(): Nullable<AudioBuffer>;
  103679. /**
  103680. * Serializes the Sound in a JSON representation
  103681. * @returns the JSON representation of the sound
  103682. */
  103683. serialize(): any;
  103684. /**
  103685. * Parse a JSON representation of a sound to innstantiate in a given scene
  103686. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  103687. * @param scene Define the scene the new parsed sound should be created in
  103688. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  103689. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  103690. * @returns the newly parsed sound
  103691. */
  103692. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  103693. }
  103694. }
  103695. declare module BABYLON {
  103696. /**
  103697. * This defines an action helpful to play a defined sound on a triggered action.
  103698. */
  103699. export class PlaySoundAction extends Action {
  103700. private _sound;
  103701. /**
  103702. * Instantiate the action
  103703. * @param triggerOptions defines the trigger options
  103704. * @param sound defines the sound to play
  103705. * @param condition defines the trigger related conditions
  103706. */
  103707. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  103708. /** @hidden */
  103709. _prepare(): void;
  103710. /**
  103711. * Execute the action and play the sound.
  103712. */
  103713. execute(): void;
  103714. /**
  103715. * Serializes the actions and its related information.
  103716. * @param parent defines the object to serialize in
  103717. * @returns the serialized object
  103718. */
  103719. serialize(parent: any): any;
  103720. }
  103721. /**
  103722. * This defines an action helpful to stop a defined sound on a triggered action.
  103723. */
  103724. export class StopSoundAction extends Action {
  103725. private _sound;
  103726. /**
  103727. * Instantiate the action
  103728. * @param triggerOptions defines the trigger options
  103729. * @param sound defines the sound to stop
  103730. * @param condition defines the trigger related conditions
  103731. */
  103732. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  103733. /** @hidden */
  103734. _prepare(): void;
  103735. /**
  103736. * Execute the action and stop the sound.
  103737. */
  103738. execute(): void;
  103739. /**
  103740. * Serializes the actions and its related information.
  103741. * @param parent defines the object to serialize in
  103742. * @returns the serialized object
  103743. */
  103744. serialize(parent: any): any;
  103745. }
  103746. }
  103747. declare module BABYLON {
  103748. /**
  103749. * This defines an action responsible to change the value of a property
  103750. * by interpolating between its current value and the newly set one once triggered.
  103751. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  103752. */
  103753. export class InterpolateValueAction extends Action {
  103754. /**
  103755. * Defines the path of the property where the value should be interpolated
  103756. */
  103757. propertyPath: string;
  103758. /**
  103759. * Defines the target value at the end of the interpolation.
  103760. */
  103761. value: any;
  103762. /**
  103763. * Defines the time it will take for the property to interpolate to the value.
  103764. */
  103765. duration: number;
  103766. /**
  103767. * Defines if the other scene animations should be stopped when the action has been triggered
  103768. */
  103769. stopOtherAnimations?: boolean;
  103770. /**
  103771. * Defines a callback raised once the interpolation animation has been done.
  103772. */
  103773. onInterpolationDone?: () => void;
  103774. /**
  103775. * Observable triggered once the interpolation animation has been done.
  103776. */
  103777. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  103778. private _target;
  103779. private _effectiveTarget;
  103780. private _property;
  103781. /**
  103782. * Instantiate the action
  103783. * @param triggerOptions defines the trigger options
  103784. * @param target defines the object containing the value to interpolate
  103785. * @param propertyPath defines the path to the property in the target object
  103786. * @param value defines the target value at the end of the interpolation
  103787. * @param duration deines the time it will take for the property to interpolate to the value.
  103788. * @param condition defines the trigger related conditions
  103789. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  103790. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  103791. */
  103792. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  103793. /** @hidden */
  103794. _prepare(): void;
  103795. /**
  103796. * Execute the action starts the value interpolation.
  103797. */
  103798. execute(): void;
  103799. /**
  103800. * Serializes the actions and its related information.
  103801. * @param parent defines the object to serialize in
  103802. * @returns the serialized object
  103803. */
  103804. serialize(parent: any): any;
  103805. }
  103806. }
  103807. declare module BABYLON {
  103808. /**
  103809. * Options allowed during the creation of a sound track.
  103810. */
  103811. export interface ISoundTrackOptions {
  103812. /**
  103813. * The volume the sound track should take during creation
  103814. */
  103815. volume?: number;
  103816. /**
  103817. * Define if the sound track is the main sound track of the scene
  103818. */
  103819. mainTrack?: boolean;
  103820. }
  103821. /**
  103822. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  103823. * It will be also used in a future release to apply effects on a specific track.
  103824. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  103825. */
  103826. export class SoundTrack {
  103827. /**
  103828. * The unique identifier of the sound track in the scene.
  103829. */
  103830. id: number;
  103831. /**
  103832. * The list of sounds included in the sound track.
  103833. */
  103834. soundCollection: Array<Sound>;
  103835. private _outputAudioNode;
  103836. private _scene;
  103837. private _isMainTrack;
  103838. private _connectedAnalyser;
  103839. private _options;
  103840. private _isInitialized;
  103841. /**
  103842. * Creates a new sound track.
  103843. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  103844. * @param scene Define the scene the sound track belongs to
  103845. * @param options
  103846. */
  103847. constructor(scene: Scene, options?: ISoundTrackOptions);
  103848. private _initializeSoundTrackAudioGraph;
  103849. /**
  103850. * Release the sound track and its associated resources
  103851. */
  103852. dispose(): void;
  103853. /**
  103854. * Adds a sound to this sound track
  103855. * @param sound define the cound to add
  103856. * @ignoreNaming
  103857. */
  103858. AddSound(sound: Sound): void;
  103859. /**
  103860. * Removes a sound to this sound track
  103861. * @param sound define the cound to remove
  103862. * @ignoreNaming
  103863. */
  103864. RemoveSound(sound: Sound): void;
  103865. /**
  103866. * Set a global volume for the full sound track.
  103867. * @param newVolume Define the new volume of the sound track
  103868. */
  103869. setVolume(newVolume: number): void;
  103870. /**
  103871. * Switch the panning model to HRTF:
  103872. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  103873. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103874. */
  103875. switchPanningModelToHRTF(): void;
  103876. /**
  103877. * Switch the panning model to Equal Power:
  103878. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  103879. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103880. */
  103881. switchPanningModelToEqualPower(): void;
  103882. /**
  103883. * Connect the sound track to an audio analyser allowing some amazing
  103884. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  103885. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  103886. * @param analyser The analyser to connect to the engine
  103887. */
  103888. connectToAnalyser(analyser: Analyser): void;
  103889. }
  103890. }
  103891. declare module BABYLON {
  103892. interface AbstractScene {
  103893. /**
  103894. * The list of sounds used in the scene.
  103895. */
  103896. sounds: Nullable<Array<Sound>>;
  103897. }
  103898. interface Scene {
  103899. /**
  103900. * @hidden
  103901. * Backing field
  103902. */
  103903. _mainSoundTrack: SoundTrack;
  103904. /**
  103905. * The main sound track played by the scene.
  103906. * It cotains your primary collection of sounds.
  103907. */
  103908. mainSoundTrack: SoundTrack;
  103909. /**
  103910. * The list of sound tracks added to the scene
  103911. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103912. */
  103913. soundTracks: Nullable<Array<SoundTrack>>;
  103914. /**
  103915. * Gets a sound using a given name
  103916. * @param name defines the name to search for
  103917. * @return the found sound or null if not found at all.
  103918. */
  103919. getSoundByName(name: string): Nullable<Sound>;
  103920. /**
  103921. * Gets or sets if audio support is enabled
  103922. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103923. */
  103924. audioEnabled: boolean;
  103925. /**
  103926. * Gets or sets if audio will be output to headphones
  103927. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103928. */
  103929. headphone: boolean;
  103930. /**
  103931. * Gets or sets custom audio listener position provider
  103932. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103933. */
  103934. audioListenerPositionProvider: Nullable<() => Vector3>;
  103935. /**
  103936. * Gets or sets a refresh rate when using 3D audio positioning
  103937. */
  103938. audioPositioningRefreshRate: number;
  103939. }
  103940. /**
  103941. * Defines the sound scene component responsible to manage any sounds
  103942. * in a given scene.
  103943. */
  103944. export class AudioSceneComponent implements ISceneSerializableComponent {
  103945. /**
  103946. * The component name helpfull to identify the component in the list of scene components.
  103947. */
  103948. readonly name: string;
  103949. /**
  103950. * The scene the component belongs to.
  103951. */
  103952. scene: Scene;
  103953. private _audioEnabled;
  103954. /**
  103955. * Gets whether audio is enabled or not.
  103956. * Please use related enable/disable method to switch state.
  103957. */
  103958. readonly audioEnabled: boolean;
  103959. private _headphone;
  103960. /**
  103961. * Gets whether audio is outputing to headphone or not.
  103962. * Please use the according Switch methods to change output.
  103963. */
  103964. readonly headphone: boolean;
  103965. /**
  103966. * Gets or sets a refresh rate when using 3D audio positioning
  103967. */
  103968. audioPositioningRefreshRate: number;
  103969. private _audioListenerPositionProvider;
  103970. /**
  103971. * Gets the current audio listener position provider
  103972. */
  103973. /**
  103974. * Sets a custom listener position for all sounds in the scene
  103975. * By default, this is the position of the first active camera
  103976. */
  103977. audioListenerPositionProvider: Nullable<() => Vector3>;
  103978. /**
  103979. * Creates a new instance of the component for the given scene
  103980. * @param scene Defines the scene to register the component in
  103981. */
  103982. constructor(scene: Scene);
  103983. /**
  103984. * Registers the component in a given scene
  103985. */
  103986. register(): void;
  103987. /**
  103988. * Rebuilds the elements related to this component in case of
  103989. * context lost for instance.
  103990. */
  103991. rebuild(): void;
  103992. /**
  103993. * Serializes the component data to the specified json object
  103994. * @param serializationObject The object to serialize to
  103995. */
  103996. serialize(serializationObject: any): void;
  103997. /**
  103998. * Adds all the elements from the container to the scene
  103999. * @param container the container holding the elements
  104000. */
  104001. addFromContainer(container: AbstractScene): void;
  104002. /**
  104003. * Removes all the elements in the container from the scene
  104004. * @param container contains the elements to remove
  104005. * @param dispose if the removed element should be disposed (default: false)
  104006. */
  104007. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  104008. /**
  104009. * Disposes the component and the associated ressources.
  104010. */
  104011. dispose(): void;
  104012. /**
  104013. * Disables audio in the associated scene.
  104014. */
  104015. disableAudio(): void;
  104016. /**
  104017. * Enables audio in the associated scene.
  104018. */
  104019. enableAudio(): void;
  104020. /**
  104021. * Switch audio to headphone output.
  104022. */
  104023. switchAudioModeForHeadphones(): void;
  104024. /**
  104025. * Switch audio to normal speakers.
  104026. */
  104027. switchAudioModeForNormalSpeakers(): void;
  104028. private _cachedCameraDirection;
  104029. private _cachedCameraPosition;
  104030. private _lastCheck;
  104031. private _afterRender;
  104032. }
  104033. }
  104034. declare module BABYLON {
  104035. /**
  104036. * Wraps one or more Sound objects and selects one with random weight for playback.
  104037. */
  104038. export class WeightedSound {
  104039. /** When true a Sound will be selected and played when the current playing Sound completes. */
  104040. loop: boolean;
  104041. private _coneInnerAngle;
  104042. private _coneOuterAngle;
  104043. private _volume;
  104044. /** A Sound is currently playing. */
  104045. isPlaying: boolean;
  104046. /** A Sound is currently paused. */
  104047. isPaused: boolean;
  104048. private _sounds;
  104049. private _weights;
  104050. private _currentIndex?;
  104051. /**
  104052. * Creates a new WeightedSound from the list of sounds given.
  104053. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  104054. * @param sounds Array of Sounds that will be selected from.
  104055. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  104056. */
  104057. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  104058. /**
  104059. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  104060. */
  104061. /**
  104062. * The size of cone in degress for a directional sound in which there will be no attenuation.
  104063. */
  104064. directionalConeInnerAngle: number;
  104065. /**
  104066. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  104067. * Listener angles between innerAngle and outerAngle will falloff linearly.
  104068. */
  104069. /**
  104070. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  104071. * Listener angles between innerAngle and outerAngle will falloff linearly.
  104072. */
  104073. directionalConeOuterAngle: number;
  104074. /**
  104075. * Playback volume.
  104076. */
  104077. /**
  104078. * Playback volume.
  104079. */
  104080. volume: number;
  104081. private _onended;
  104082. /**
  104083. * Suspend playback
  104084. */
  104085. pause(): void;
  104086. /**
  104087. * Stop playback
  104088. */
  104089. stop(): void;
  104090. /**
  104091. * Start playback.
  104092. * @param startOffset Position the clip head at a specific time in seconds.
  104093. */
  104094. play(startOffset?: number): void;
  104095. }
  104096. }
  104097. declare module BABYLON {
  104098. /**
  104099. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  104100. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  104101. */
  104102. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  104103. /**
  104104. * Gets the name of the behavior.
  104105. */
  104106. readonly name: string;
  104107. /**
  104108. * The easing function used by animations
  104109. */
  104110. static EasingFunction: BackEase;
  104111. /**
  104112. * The easing mode used by animations
  104113. */
  104114. static EasingMode: number;
  104115. /**
  104116. * The duration of the animation, in milliseconds
  104117. */
  104118. transitionDuration: number;
  104119. /**
  104120. * Length of the distance animated by the transition when lower radius is reached
  104121. */
  104122. lowerRadiusTransitionRange: number;
  104123. /**
  104124. * Length of the distance animated by the transition when upper radius is reached
  104125. */
  104126. upperRadiusTransitionRange: number;
  104127. private _autoTransitionRange;
  104128. /**
  104129. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  104130. */
  104131. /**
  104132. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  104133. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  104134. */
  104135. autoTransitionRange: boolean;
  104136. private _attachedCamera;
  104137. private _onAfterCheckInputsObserver;
  104138. private _onMeshTargetChangedObserver;
  104139. /**
  104140. * Initializes the behavior.
  104141. */
  104142. init(): void;
  104143. /**
  104144. * Attaches the behavior to its arc rotate camera.
  104145. * @param camera Defines the camera to attach the behavior to
  104146. */
  104147. attach(camera: ArcRotateCamera): void;
  104148. /**
  104149. * Detaches the behavior from its current arc rotate camera.
  104150. */
  104151. detach(): void;
  104152. private _radiusIsAnimating;
  104153. private _radiusBounceTransition;
  104154. private _animatables;
  104155. private _cachedWheelPrecision;
  104156. /**
  104157. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  104158. * @param radiusLimit The limit to check against.
  104159. * @return Bool to indicate if at limit.
  104160. */
  104161. private _isRadiusAtLimit;
  104162. /**
  104163. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  104164. * @param radiusDelta The delta by which to animate to. Can be negative.
  104165. */
  104166. private _applyBoundRadiusAnimation;
  104167. /**
  104168. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  104169. */
  104170. protected _clearAnimationLocks(): void;
  104171. /**
  104172. * Stops and removes all animations that have been applied to the camera
  104173. */
  104174. stopAllAnimations(): void;
  104175. }
  104176. }
  104177. declare module BABYLON {
  104178. /**
  104179. * The framing behavior (FramingBehavior) is designed to automatically position an ArcRotateCamera when its target is set to a mesh. It is also useful if you want to prevent the camera to go under a virtual horizontal plane.
  104180. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  104181. */
  104182. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  104183. /**
  104184. * Gets the name of the behavior.
  104185. */
  104186. readonly name: string;
  104187. private _mode;
  104188. private _radiusScale;
  104189. private _positionScale;
  104190. private _defaultElevation;
  104191. private _elevationReturnTime;
  104192. private _elevationReturnWaitTime;
  104193. private _zoomStopsAnimation;
  104194. private _framingTime;
  104195. /**
  104196. * The easing function used by animations
  104197. */
  104198. static EasingFunction: ExponentialEase;
  104199. /**
  104200. * The easing mode used by animations
  104201. */
  104202. static EasingMode: number;
  104203. /**
  104204. * Sets the current mode used by the behavior
  104205. */
  104206. /**
  104207. * Gets current mode used by the behavior.
  104208. */
  104209. mode: number;
  104210. /**
  104211. * Sets the scale applied to the radius (1 by default)
  104212. */
  104213. /**
  104214. * Gets the scale applied to the radius
  104215. */
  104216. radiusScale: number;
  104217. /**
  104218. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  104219. */
  104220. /**
  104221. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  104222. */
  104223. positionScale: number;
  104224. /**
  104225. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  104226. * behaviour is triggered, in radians.
  104227. */
  104228. /**
  104229. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  104230. * behaviour is triggered, in radians.
  104231. */
  104232. defaultElevation: number;
  104233. /**
  104234. * Sets the time (in milliseconds) taken to return to the default beta position.
  104235. * Negative value indicates camera should not return to default.
  104236. */
  104237. /**
  104238. * Gets the time (in milliseconds) taken to return to the default beta position.
  104239. * Negative value indicates camera should not return to default.
  104240. */
  104241. elevationReturnTime: number;
  104242. /**
  104243. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  104244. */
  104245. /**
  104246. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  104247. */
  104248. elevationReturnWaitTime: number;
  104249. /**
  104250. * Sets the flag that indicates if user zooming should stop animation.
  104251. */
  104252. /**
  104253. * Gets the flag that indicates if user zooming should stop animation.
  104254. */
  104255. zoomStopsAnimation: boolean;
  104256. /**
  104257. * Sets the transition time when framing the mesh, in milliseconds
  104258. */
  104259. /**
  104260. * Gets the transition time when framing the mesh, in milliseconds
  104261. */
  104262. framingTime: number;
  104263. /**
  104264. * Define if the behavior should automatically change the configured
  104265. * camera limits and sensibilities.
  104266. */
  104267. autoCorrectCameraLimitsAndSensibility: boolean;
  104268. private _onPrePointerObservableObserver;
  104269. private _onAfterCheckInputsObserver;
  104270. private _onMeshTargetChangedObserver;
  104271. private _attachedCamera;
  104272. private _isPointerDown;
  104273. private _lastInteractionTime;
  104274. /**
  104275. * Initializes the behavior.
  104276. */
  104277. init(): void;
  104278. /**
  104279. * Attaches the behavior to its arc rotate camera.
  104280. * @param camera Defines the camera to attach the behavior to
  104281. */
  104282. attach(camera: ArcRotateCamera): void;
  104283. /**
  104284. * Detaches the behavior from its current arc rotate camera.
  104285. */
  104286. detach(): void;
  104287. private _animatables;
  104288. private _betaIsAnimating;
  104289. private _betaTransition;
  104290. private _radiusTransition;
  104291. private _vectorTransition;
  104292. /**
  104293. * Targets the given mesh and updates zoom level accordingly.
  104294. * @param mesh The mesh to target.
  104295. * @param radius Optional. If a cached radius position already exists, overrides default.
  104296. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  104297. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104298. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104299. */
  104300. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104301. /**
  104302. * Targets the given mesh with its children and updates zoom level accordingly.
  104303. * @param mesh The mesh to target.
  104304. * @param radius Optional. If a cached radius position already exists, overrides default.
  104305. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  104306. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104307. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104308. */
  104309. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104310. /**
  104311. * Targets the given meshes with their children and updates zoom level accordingly.
  104312. * @param meshes The mesh to target.
  104313. * @param radius Optional. If a cached radius position already exists, overrides default.
  104314. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  104315. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104316. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104317. */
  104318. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104319. /**
  104320. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  104321. * @param minimumWorld Determines the smaller position of the bounding box extend
  104322. * @param maximumWorld Determines the bigger position of the bounding box extend
  104323. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104324. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104325. */
  104326. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104327. /**
  104328. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  104329. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  104330. * frustum width.
  104331. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  104332. * to fully enclose the mesh in the viewing frustum.
  104333. */
  104334. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  104335. /**
  104336. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  104337. * is automatically returned to its default position (expected to be above ground plane).
  104338. */
  104339. private _maintainCameraAboveGround;
  104340. /**
  104341. * Returns the frustum slope based on the canvas ratio and camera FOV
  104342. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  104343. */
  104344. private _getFrustumSlope;
  104345. /**
  104346. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  104347. */
  104348. private _clearAnimationLocks;
  104349. /**
  104350. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  104351. */
  104352. private _applyUserInteraction;
  104353. /**
  104354. * Stops and removes all animations that have been applied to the camera
  104355. */
  104356. stopAllAnimations(): void;
  104357. /**
  104358. * Gets a value indicating if the user is moving the camera
  104359. */
  104360. readonly isUserIsMoving: boolean;
  104361. /**
  104362. * The camera can move all the way towards the mesh.
  104363. */
  104364. static IgnoreBoundsSizeMode: number;
  104365. /**
  104366. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  104367. */
  104368. static FitFrustumSidesMode: number;
  104369. }
  104370. }
  104371. declare module BABYLON {
  104372. /**
  104373. * Base class for Camera Pointer Inputs.
  104374. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  104375. * for example usage.
  104376. */
  104377. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  104378. /**
  104379. * Defines the camera the input is attached to.
  104380. */
  104381. abstract camera: Camera;
  104382. /**
  104383. * Whether keyboard modifier keys are pressed at time of last mouse event.
  104384. */
  104385. protected _altKey: boolean;
  104386. protected _ctrlKey: boolean;
  104387. protected _metaKey: boolean;
  104388. protected _shiftKey: boolean;
  104389. /**
  104390. * Which mouse buttons were pressed at time of last mouse event.
  104391. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  104392. */
  104393. protected _buttonsPressed: number;
  104394. /**
  104395. * Defines the buttons associated with the input to handle camera move.
  104396. */
  104397. buttons: number[];
  104398. /**
  104399. * Attach the input controls to a specific dom element to get the input from.
  104400. * @param element Defines the element the controls should be listened from
  104401. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104402. */
  104403. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  104404. /**
  104405. * Detach the current controls from the specified dom element.
  104406. * @param element Defines the element to stop listening the inputs from
  104407. */
  104408. detachControl(element: Nullable<HTMLElement>): void;
  104409. /**
  104410. * Gets the class name of the current input.
  104411. * @returns the class name
  104412. */
  104413. getClassName(): string;
  104414. /**
  104415. * Get the friendly name associated with the input class.
  104416. * @returns the input friendly name
  104417. */
  104418. getSimpleName(): string;
  104419. /**
  104420. * Called on pointer POINTERDOUBLETAP event.
  104421. * Override this method to provide functionality on POINTERDOUBLETAP event.
  104422. */
  104423. protected onDoubleTap(type: string): void;
  104424. /**
  104425. * Called on pointer POINTERMOVE event if only a single touch is active.
  104426. * Override this method to provide functionality.
  104427. */
  104428. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  104429. /**
  104430. * Called on pointer POINTERMOVE event if multiple touches are active.
  104431. * Override this method to provide functionality.
  104432. */
  104433. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  104434. /**
  104435. * Called on JS contextmenu event.
  104436. * Override this method to provide functionality.
  104437. */
  104438. protected onContextMenu(evt: PointerEvent): void;
  104439. /**
  104440. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  104441. * press.
  104442. * Override this method to provide functionality.
  104443. */
  104444. protected onButtonDown(evt: PointerEvent): void;
  104445. /**
  104446. * Called each time a new POINTERUP event occurs. Ie, for each button
  104447. * release.
  104448. * Override this method to provide functionality.
  104449. */
  104450. protected onButtonUp(evt: PointerEvent): void;
  104451. /**
  104452. * Called when window becomes inactive.
  104453. * Override this method to provide functionality.
  104454. */
  104455. protected onLostFocus(): void;
  104456. private _pointerInput;
  104457. private _observer;
  104458. private _onLostFocus;
  104459. private pointA;
  104460. private pointB;
  104461. }
  104462. }
  104463. declare module BABYLON {
  104464. /**
  104465. * Manage the pointers inputs to control an arc rotate camera.
  104466. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104467. */
  104468. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  104469. /**
  104470. * Defines the camera the input is attached to.
  104471. */
  104472. camera: ArcRotateCamera;
  104473. /**
  104474. * Gets the class name of the current input.
  104475. * @returns the class name
  104476. */
  104477. getClassName(): string;
  104478. /**
  104479. * Defines the buttons associated with the input to handle camera move.
  104480. */
  104481. buttons: number[];
  104482. /**
  104483. * Defines the pointer angular sensibility along the X axis or how fast is
  104484. * the camera rotating.
  104485. */
  104486. angularSensibilityX: number;
  104487. /**
  104488. * Defines the pointer angular sensibility along the Y axis or how fast is
  104489. * the camera rotating.
  104490. */
  104491. angularSensibilityY: number;
  104492. /**
  104493. * Defines the pointer pinch precision or how fast is the camera zooming.
  104494. */
  104495. pinchPrecision: number;
  104496. /**
  104497. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  104498. * from 0.
  104499. * It defines the percentage of current camera.radius to use as delta when
  104500. * pinch zoom is used.
  104501. */
  104502. pinchDeltaPercentage: number;
  104503. /**
  104504. * Defines the pointer panning sensibility or how fast is the camera moving.
  104505. */
  104506. panningSensibility: number;
  104507. /**
  104508. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  104509. */
  104510. multiTouchPanning: boolean;
  104511. /**
  104512. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  104513. * zoom (pinch) through multitouch.
  104514. */
  104515. multiTouchPanAndZoom: boolean;
  104516. /**
  104517. * Revers pinch action direction.
  104518. */
  104519. pinchInwards: boolean;
  104520. private _isPanClick;
  104521. private _twoFingerActivityCount;
  104522. private _isPinching;
  104523. /**
  104524. * Called on pointer POINTERMOVE event if only a single touch is active.
  104525. */
  104526. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  104527. /**
  104528. * Called on pointer POINTERDOUBLETAP event.
  104529. */
  104530. protected onDoubleTap(type: string): void;
  104531. /**
  104532. * Called on pointer POINTERMOVE event if multiple touches are active.
  104533. */
  104534. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  104535. /**
  104536. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  104537. * press.
  104538. */
  104539. protected onButtonDown(evt: PointerEvent): void;
  104540. /**
  104541. * Called each time a new POINTERUP event occurs. Ie, for each button
  104542. * release.
  104543. */
  104544. protected onButtonUp(evt: PointerEvent): void;
  104545. /**
  104546. * Called when window becomes inactive.
  104547. */
  104548. protected onLostFocus(): void;
  104549. }
  104550. }
  104551. declare module BABYLON {
  104552. /**
  104553. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  104554. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104555. */
  104556. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  104557. /**
  104558. * Defines the camera the input is attached to.
  104559. */
  104560. camera: ArcRotateCamera;
  104561. /**
  104562. * Defines the list of key codes associated with the up action (increase alpha)
  104563. */
  104564. keysUp: number[];
  104565. /**
  104566. * Defines the list of key codes associated with the down action (decrease alpha)
  104567. */
  104568. keysDown: number[];
  104569. /**
  104570. * Defines the list of key codes associated with the left action (increase beta)
  104571. */
  104572. keysLeft: number[];
  104573. /**
  104574. * Defines the list of key codes associated with the right action (decrease beta)
  104575. */
  104576. keysRight: number[];
  104577. /**
  104578. * Defines the list of key codes associated with the reset action.
  104579. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  104580. */
  104581. keysReset: number[];
  104582. /**
  104583. * Defines the panning sensibility of the inputs.
  104584. * (How fast is the camera paning)
  104585. */
  104586. panningSensibility: number;
  104587. /**
  104588. * Defines the zooming sensibility of the inputs.
  104589. * (How fast is the camera zooming)
  104590. */
  104591. zoomingSensibility: number;
  104592. /**
  104593. * Defines wether maintaining the alt key down switch the movement mode from
  104594. * orientation to zoom.
  104595. */
  104596. useAltToZoom: boolean;
  104597. /**
  104598. * Rotation speed of the camera
  104599. */
  104600. angularSpeed: number;
  104601. private _keys;
  104602. private _ctrlPressed;
  104603. private _altPressed;
  104604. private _onCanvasBlurObserver;
  104605. private _onKeyboardObserver;
  104606. private _engine;
  104607. private _scene;
  104608. /**
  104609. * Attach the input controls to a specific dom element to get the input from.
  104610. * @param element Defines the element the controls should be listened from
  104611. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104612. */
  104613. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  104614. /**
  104615. * Detach the current controls from the specified dom element.
  104616. * @param element Defines the element to stop listening the inputs from
  104617. */
  104618. detachControl(element: Nullable<HTMLElement>): void;
  104619. /**
  104620. * Update the current camera state depending on the inputs that have been used this frame.
  104621. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  104622. */
  104623. checkInputs(): void;
  104624. /**
  104625. * Gets the class name of the current intput.
  104626. * @returns the class name
  104627. */
  104628. getClassName(): string;
  104629. /**
  104630. * Get the friendly name associated with the input class.
  104631. * @returns the input friendly name
  104632. */
  104633. getSimpleName(): string;
  104634. }
  104635. }
  104636. declare module BABYLON {
  104637. /**
  104638. * Manage the mouse wheel inputs to control an arc rotate camera.
  104639. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104640. */
  104641. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  104642. /**
  104643. * Defines the camera the input is attached to.
  104644. */
  104645. camera: ArcRotateCamera;
  104646. /**
  104647. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  104648. */
  104649. wheelPrecision: number;
  104650. /**
  104651. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  104652. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  104653. */
  104654. wheelDeltaPercentage: number;
  104655. private _wheel;
  104656. private _observer;
  104657. private computeDeltaFromMouseWheelLegacyEvent;
  104658. /**
  104659. * Attach the input controls to a specific dom element to get the input from.
  104660. * @param element Defines the element the controls should be listened from
  104661. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104662. */
  104663. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  104664. /**
  104665. * Detach the current controls from the specified dom element.
  104666. * @param element Defines the element to stop listening the inputs from
  104667. */
  104668. detachControl(element: Nullable<HTMLElement>): void;
  104669. /**
  104670. * Gets the class name of the current intput.
  104671. * @returns the class name
  104672. */
  104673. getClassName(): string;
  104674. /**
  104675. * Get the friendly name associated with the input class.
  104676. * @returns the input friendly name
  104677. */
  104678. getSimpleName(): string;
  104679. }
  104680. }
  104681. declare module BABYLON {
  104682. /**
  104683. * Default Inputs manager for the ArcRotateCamera.
  104684. * It groups all the default supported inputs for ease of use.
  104685. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104686. */
  104687. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  104688. /**
  104689. * Instantiates a new ArcRotateCameraInputsManager.
  104690. * @param camera Defines the camera the inputs belong to
  104691. */
  104692. constructor(camera: ArcRotateCamera);
  104693. /**
  104694. * Add mouse wheel input support to the input manager.
  104695. * @returns the current input manager
  104696. */
  104697. addMouseWheel(): ArcRotateCameraInputsManager;
  104698. /**
  104699. * Add pointers input support to the input manager.
  104700. * @returns the current input manager
  104701. */
  104702. addPointers(): ArcRotateCameraInputsManager;
  104703. /**
  104704. * Add keyboard input support to the input manager.
  104705. * @returns the current input manager
  104706. */
  104707. addKeyboard(): ArcRotateCameraInputsManager;
  104708. }
  104709. }
  104710. declare module BABYLON {
  104711. /**
  104712. * This represents an orbital type of camera.
  104713. *
  104714. * This camera always points towards a given target position and can be rotated around that target with the target as the centre of rotation. It can be controlled with cursors and mouse, or with touch events.
  104715. * Think of this camera as one orbiting its target position, or more imaginatively as a spy satellite orbiting the earth. Its position relative to the target (earth) can be set by three parameters, alpha (radians) the longitudinal rotation, beta (radians) the latitudinal rotation and radius the distance from the target position.
  104716. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  104717. */
  104718. export class ArcRotateCamera extends TargetCamera {
  104719. /**
  104720. * Defines the rotation angle of the camera along the longitudinal axis.
  104721. */
  104722. alpha: number;
  104723. /**
  104724. * Defines the rotation angle of the camera along the latitudinal axis.
  104725. */
  104726. beta: number;
  104727. /**
  104728. * Defines the radius of the camera from it s target point.
  104729. */
  104730. radius: number;
  104731. protected _target: Vector3;
  104732. protected _targetHost: Nullable<AbstractMesh>;
  104733. /**
  104734. * Defines the target point of the camera.
  104735. * The camera looks towards it form the radius distance.
  104736. */
  104737. target: Vector3;
  104738. /**
  104739. * Define the current local position of the camera in the scene
  104740. */
  104741. position: Vector3;
  104742. protected _upVector: Vector3;
  104743. protected _upToYMatrix: Matrix;
  104744. protected _YToUpMatrix: Matrix;
  104745. /**
  104746. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  104747. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  104748. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  104749. */
  104750. upVector: Vector3;
  104751. /**
  104752. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  104753. */
  104754. setMatUp(): void;
  104755. /**
  104756. * Current inertia value on the longitudinal axis.
  104757. * The bigger this number the longer it will take for the camera to stop.
  104758. */
  104759. inertialAlphaOffset: number;
  104760. /**
  104761. * Current inertia value on the latitudinal axis.
  104762. * The bigger this number the longer it will take for the camera to stop.
  104763. */
  104764. inertialBetaOffset: number;
  104765. /**
  104766. * Current inertia value on the radius axis.
  104767. * The bigger this number the longer it will take for the camera to stop.
  104768. */
  104769. inertialRadiusOffset: number;
  104770. /**
  104771. * Minimum allowed angle on the longitudinal axis.
  104772. * This can help limiting how the Camera is able to move in the scene.
  104773. */
  104774. lowerAlphaLimit: Nullable<number>;
  104775. /**
  104776. * Maximum allowed angle on the longitudinal axis.
  104777. * This can help limiting how the Camera is able to move in the scene.
  104778. */
  104779. upperAlphaLimit: Nullable<number>;
  104780. /**
  104781. * Minimum allowed angle on the latitudinal axis.
  104782. * This can help limiting how the Camera is able to move in the scene.
  104783. */
  104784. lowerBetaLimit: number;
  104785. /**
  104786. * Maximum allowed angle on the latitudinal axis.
  104787. * This can help limiting how the Camera is able to move in the scene.
  104788. */
  104789. upperBetaLimit: number;
  104790. /**
  104791. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  104792. * This can help limiting how the Camera is able to move in the scene.
  104793. */
  104794. lowerRadiusLimit: Nullable<number>;
  104795. /**
  104796. * Maximum allowed distance of the camera to the target (The camera can not get further).
  104797. * This can help limiting how the Camera is able to move in the scene.
  104798. */
  104799. upperRadiusLimit: Nullable<number>;
  104800. /**
  104801. * Defines the current inertia value used during panning of the camera along the X axis.
  104802. */
  104803. inertialPanningX: number;
  104804. /**
  104805. * Defines the current inertia value used during panning of the camera along the Y axis.
  104806. */
  104807. inertialPanningY: number;
  104808. /**
  104809. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  104810. * Basically if your fingers moves away from more than this distance you will be considered
  104811. * in pinch mode.
  104812. */
  104813. pinchToPanMaxDistance: number;
  104814. /**
  104815. * Defines the maximum distance the camera can pan.
  104816. * This could help keeping the cammera always in your scene.
  104817. */
  104818. panningDistanceLimit: Nullable<number>;
  104819. /**
  104820. * Defines the target of the camera before paning.
  104821. */
  104822. panningOriginTarget: Vector3;
  104823. /**
  104824. * Defines the value of the inertia used during panning.
  104825. * 0 would mean stop inertia and one would mean no decelleration at all.
  104826. */
  104827. panningInertia: number;
  104828. /**
  104829. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  104830. */
  104831. angularSensibilityX: number;
  104832. /**
  104833. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  104834. */
  104835. angularSensibilityY: number;
  104836. /**
  104837. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  104838. */
  104839. pinchPrecision: number;
  104840. /**
  104841. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  104842. * It will be used instead of pinchDeltaPrecision if different from 0.
  104843. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  104844. */
  104845. pinchDeltaPercentage: number;
  104846. /**
  104847. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  104848. */
  104849. panningSensibility: number;
  104850. /**
  104851. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  104852. */
  104853. keysUp: number[];
  104854. /**
  104855. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  104856. */
  104857. keysDown: number[];
  104858. /**
  104859. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  104860. */
  104861. keysLeft: number[];
  104862. /**
  104863. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  104864. */
  104865. keysRight: number[];
  104866. /**
  104867. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  104868. */
  104869. wheelPrecision: number;
  104870. /**
  104871. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  104872. * It will be used instead of pinchDeltaPrecision if different from 0.
  104873. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  104874. */
  104875. wheelDeltaPercentage: number;
  104876. /**
  104877. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  104878. */
  104879. zoomOnFactor: number;
  104880. /**
  104881. * Defines a screen offset for the camera position.
  104882. */
  104883. targetScreenOffset: Vector2;
  104884. /**
  104885. * Allows the camera to be completely reversed.
  104886. * If false the camera can not arrive upside down.
  104887. */
  104888. allowUpsideDown: boolean;
  104889. /**
  104890. * Define if double tap/click is used to restore the previously saved state of the camera.
  104891. */
  104892. useInputToRestoreState: boolean;
  104893. /** @hidden */
  104894. _viewMatrix: Matrix;
  104895. /** @hidden */
  104896. _useCtrlForPanning: boolean;
  104897. /** @hidden */
  104898. _panningMouseButton: number;
  104899. /**
  104900. * Defines the input associated to the camera.
  104901. */
  104902. inputs: ArcRotateCameraInputsManager;
  104903. /** @hidden */
  104904. _reset: () => void;
  104905. /**
  104906. * Defines the allowed panning axis.
  104907. */
  104908. panningAxis: Vector3;
  104909. protected _localDirection: Vector3;
  104910. protected _transformedDirection: Vector3;
  104911. private _bouncingBehavior;
  104912. /**
  104913. * Gets the bouncing behavior of the camera if it has been enabled.
  104914. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  104915. */
  104916. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  104917. /**
  104918. * Defines if the bouncing behavior of the camera is enabled on the camera.
  104919. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  104920. */
  104921. useBouncingBehavior: boolean;
  104922. private _framingBehavior;
  104923. /**
  104924. * Gets the framing behavior of the camera if it has been enabled.
  104925. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  104926. */
  104927. readonly framingBehavior: Nullable<FramingBehavior>;
  104928. /**
  104929. * Defines if the framing behavior of the camera is enabled on the camera.
  104930. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  104931. */
  104932. useFramingBehavior: boolean;
  104933. private _autoRotationBehavior;
  104934. /**
  104935. * Gets the auto rotation behavior of the camera if it has been enabled.
  104936. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  104937. */
  104938. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  104939. /**
  104940. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  104941. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  104942. */
  104943. useAutoRotationBehavior: boolean;
  104944. /**
  104945. * Observable triggered when the mesh target has been changed on the camera.
  104946. */
  104947. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  104948. /**
  104949. * Event raised when the camera is colliding with a mesh.
  104950. */
  104951. onCollide: (collidedMesh: AbstractMesh) => void;
  104952. /**
  104953. * Defines whether the camera should check collision with the objects oh the scene.
  104954. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  104955. */
  104956. checkCollisions: boolean;
  104957. /**
  104958. * Defines the collision radius of the camera.
  104959. * This simulates a sphere around the camera.
  104960. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  104961. */
  104962. collisionRadius: Vector3;
  104963. protected _collider: Collider;
  104964. protected _previousPosition: Vector3;
  104965. protected _collisionVelocity: Vector3;
  104966. protected _newPosition: Vector3;
  104967. protected _previousAlpha: number;
  104968. protected _previousBeta: number;
  104969. protected _previousRadius: number;
  104970. protected _collisionTriggered: boolean;
  104971. protected _targetBoundingCenter: Nullable<Vector3>;
  104972. private _computationVector;
  104973. /**
  104974. * Instantiates a new ArcRotateCamera in a given scene
  104975. * @param name Defines the name of the camera
  104976. * @param alpha Defines the camera rotation along the logitudinal axis
  104977. * @param beta Defines the camera rotation along the latitudinal axis
  104978. * @param radius Defines the camera distance from its target
  104979. * @param target Defines the camera target
  104980. * @param scene Defines the scene the camera belongs to
  104981. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  104982. */
  104983. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  104984. /** @hidden */
  104985. _initCache(): void;
  104986. /** @hidden */
  104987. _updateCache(ignoreParentClass?: boolean): void;
  104988. protected _getTargetPosition(): Vector3;
  104989. private _storedAlpha;
  104990. private _storedBeta;
  104991. private _storedRadius;
  104992. private _storedTarget;
  104993. private _storedTargetScreenOffset;
  104994. /**
  104995. * Stores the current state of the camera (alpha, beta, radius and target)
  104996. * @returns the camera itself
  104997. */
  104998. storeState(): Camera;
  104999. /**
  105000. * @hidden
  105001. * Restored camera state. You must call storeState() first
  105002. */
  105003. _restoreStateValues(): boolean;
  105004. /** @hidden */
  105005. _isSynchronizedViewMatrix(): boolean;
  105006. /**
  105007. * Attached controls to the current camera.
  105008. * @param element Defines the element the controls should be listened from
  105009. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105010. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  105011. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  105012. */
  105013. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  105014. /**
  105015. * Detach the current controls from the camera.
  105016. * The camera will stop reacting to inputs.
  105017. * @param element Defines the element to stop listening the inputs from
  105018. */
  105019. detachControl(element: HTMLElement): void;
  105020. /** @hidden */
  105021. _checkInputs(): void;
  105022. protected _checkLimits(): void;
  105023. /**
  105024. * Rebuilds angles (alpha, beta) and radius from the give position and target
  105025. */
  105026. rebuildAnglesAndRadius(): void;
  105027. /**
  105028. * Use a position to define the current camera related information like alpha, beta and radius
  105029. * @param position Defines the position to set the camera at
  105030. */
  105031. setPosition(position: Vector3): void;
  105032. /**
  105033. * Defines the target the camera should look at.
  105034. * This will automatically adapt alpha beta and radius to fit within the new target.
  105035. * @param target Defines the new target as a Vector or a mesh
  105036. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  105037. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  105038. */
  105039. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  105040. /** @hidden */
  105041. _getViewMatrix(): Matrix;
  105042. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  105043. /**
  105044. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  105045. * @param meshes Defines the mesh to zoom on
  105046. * @param doNotUpdateMaxZ Defines whether or not maxZ should be updated whilst zooming on the mesh (this can happen if the mesh is big and the maxradius pretty small for instance)
  105047. */
  105048. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  105049. /**
  105050. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  105051. * The target will be changed but the radius
  105052. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  105053. * @param doNotUpdateMaxZ Defines whether or not maxZ should be updated whilst zooming on the mesh (this can happen if the mesh is big and the maxradius pretty small for instance)
  105054. */
  105055. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  105056. min: Vector3;
  105057. max: Vector3;
  105058. distance: number;
  105059. }, doNotUpdateMaxZ?: boolean): void;
  105060. /**
  105061. * @override
  105062. * Override Camera.createRigCamera
  105063. */
  105064. createRigCamera(name: string, cameraIndex: number): Camera;
  105065. /**
  105066. * @hidden
  105067. * @override
  105068. * Override Camera._updateRigCameras
  105069. */
  105070. _updateRigCameras(): void;
  105071. /**
  105072. * Destroy the camera and release the current resources hold by it.
  105073. */
  105074. dispose(): void;
  105075. /**
  105076. * Gets the current object class name.
  105077. * @return the class name
  105078. */
  105079. getClassName(): string;
  105080. }
  105081. }
  105082. declare module BABYLON {
  105083. /**
  105084. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  105085. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  105086. */
  105087. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  105088. /**
  105089. * Gets the name of the behavior.
  105090. */
  105091. readonly name: string;
  105092. private _zoomStopsAnimation;
  105093. private _idleRotationSpeed;
  105094. private _idleRotationWaitTime;
  105095. private _idleRotationSpinupTime;
  105096. /**
  105097. * Sets the flag that indicates if user zooming should stop animation.
  105098. */
  105099. /**
  105100. * Gets the flag that indicates if user zooming should stop animation.
  105101. */
  105102. zoomStopsAnimation: boolean;
  105103. /**
  105104. * Sets the default speed at which the camera rotates around the model.
  105105. */
  105106. /**
  105107. * Gets the default speed at which the camera rotates around the model.
  105108. */
  105109. idleRotationSpeed: number;
  105110. /**
  105111. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  105112. */
  105113. /**
  105114. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  105115. */
  105116. idleRotationWaitTime: number;
  105117. /**
  105118. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  105119. */
  105120. /**
  105121. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  105122. */
  105123. idleRotationSpinupTime: number;
  105124. /**
  105125. * Gets a value indicating if the camera is currently rotating because of this behavior
  105126. */
  105127. readonly rotationInProgress: boolean;
  105128. private _onPrePointerObservableObserver;
  105129. private _onAfterCheckInputsObserver;
  105130. private _attachedCamera;
  105131. private _isPointerDown;
  105132. private _lastFrameTime;
  105133. private _lastInteractionTime;
  105134. private _cameraRotationSpeed;
  105135. /**
  105136. * Initializes the behavior.
  105137. */
  105138. init(): void;
  105139. /**
  105140. * Attaches the behavior to its arc rotate camera.
  105141. * @param camera Defines the camera to attach the behavior to
  105142. */
  105143. attach(camera: ArcRotateCamera): void;
  105144. /**
  105145. * Detaches the behavior from its current arc rotate camera.
  105146. */
  105147. detach(): void;
  105148. /**
  105149. * Returns true if user is scrolling.
  105150. * @return true if user is scrolling.
  105151. */
  105152. private _userIsZooming;
  105153. private _lastFrameRadius;
  105154. private _shouldAnimationStopForInteraction;
  105155. /**
  105156. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  105157. */
  105158. private _applyUserInteraction;
  105159. private _userIsMoving;
  105160. }
  105161. }
  105162. declare module BABYLON {
  105163. /**
  105164. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  105165. */
  105166. export class AttachToBoxBehavior implements Behavior<Mesh> {
  105167. private ui;
  105168. /**
  105169. * The name of the behavior
  105170. */
  105171. name: string;
  105172. /**
  105173. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  105174. */
  105175. distanceAwayFromFace: number;
  105176. /**
  105177. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  105178. */
  105179. distanceAwayFromBottomOfFace: number;
  105180. private _faceVectors;
  105181. private _target;
  105182. private _scene;
  105183. private _onRenderObserver;
  105184. private _tmpMatrix;
  105185. private _tmpVector;
  105186. /**
  105187. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  105188. * @param ui The transform node that should be attched to the mesh
  105189. */
  105190. constructor(ui: TransformNode);
  105191. /**
  105192. * Initializes the behavior
  105193. */
  105194. init(): void;
  105195. private _closestFace;
  105196. private _zeroVector;
  105197. private _lookAtTmpMatrix;
  105198. private _lookAtToRef;
  105199. /**
  105200. * Attaches the AttachToBoxBehavior to the passed in mesh
  105201. * @param target The mesh that the specified node will be attached to
  105202. */
  105203. attach(target: Mesh): void;
  105204. /**
  105205. * Detaches the behavior from the mesh
  105206. */
  105207. detach(): void;
  105208. }
  105209. }
  105210. declare module BABYLON {
  105211. /**
  105212. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  105213. */
  105214. export class FadeInOutBehavior implements Behavior<Mesh> {
  105215. /**
  105216. * Time in milliseconds to delay before fading in (Default: 0)
  105217. */
  105218. delay: number;
  105219. /**
  105220. * Time in milliseconds for the mesh to fade in (Default: 300)
  105221. */
  105222. fadeInTime: number;
  105223. private _millisecondsPerFrame;
  105224. private _hovered;
  105225. private _hoverValue;
  105226. private _ownerNode;
  105227. /**
  105228. * Instatiates the FadeInOutBehavior
  105229. */
  105230. constructor();
  105231. /**
  105232. * The name of the behavior
  105233. */
  105234. readonly name: string;
  105235. /**
  105236. * Initializes the behavior
  105237. */
  105238. init(): void;
  105239. /**
  105240. * Attaches the fade behavior on the passed in mesh
  105241. * @param ownerNode The mesh that will be faded in/out once attached
  105242. */
  105243. attach(ownerNode: Mesh): void;
  105244. /**
  105245. * Detaches the behavior from the mesh
  105246. */
  105247. detach(): void;
  105248. /**
  105249. * Triggers the mesh to begin fading in or out
  105250. * @param value if the object should fade in or out (true to fade in)
  105251. */
  105252. fadeIn(value: boolean): void;
  105253. private _update;
  105254. private _setAllVisibility;
  105255. }
  105256. }
  105257. declare module BABYLON {
  105258. /**
  105259. * Class containing a set of static utilities functions for managing Pivots
  105260. * @hidden
  105261. */
  105262. export class PivotTools {
  105263. private static _PivotCached;
  105264. private static _OldPivotPoint;
  105265. private static _PivotTranslation;
  105266. private static _PivotTmpVector;
  105267. /** @hidden */
  105268. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  105269. /** @hidden */
  105270. static _RestorePivotPoint(mesh: AbstractMesh): void;
  105271. }
  105272. }
  105273. declare module BABYLON {
  105274. /**
  105275. * Class containing static functions to help procedurally build meshes
  105276. */
  105277. export class PlaneBuilder {
  105278. /**
  105279. * Creates a plane mesh
  105280. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  105281. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  105282. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  105283. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  105284. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  105285. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  105286. * @param name defines the name of the mesh
  105287. * @param options defines the options used to create the mesh
  105288. * @param scene defines the hosting scene
  105289. * @returns the plane mesh
  105290. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  105291. */
  105292. static CreatePlane(name: string, options: {
  105293. size?: number;
  105294. width?: number;
  105295. height?: number;
  105296. sideOrientation?: number;
  105297. frontUVs?: Vector4;
  105298. backUVs?: Vector4;
  105299. updatable?: boolean;
  105300. sourcePlane?: Plane;
  105301. }, scene?: Nullable<Scene>): Mesh;
  105302. }
  105303. }
  105304. declare module BABYLON {
  105305. /**
  105306. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  105307. */
  105308. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  105309. private static _AnyMouseID;
  105310. /**
  105311. * Abstract mesh the behavior is set on
  105312. */
  105313. attachedNode: AbstractMesh;
  105314. private _dragPlane;
  105315. private _scene;
  105316. private _pointerObserver;
  105317. private _beforeRenderObserver;
  105318. private static _planeScene;
  105319. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  105320. /**
  105321. * The maximum tolerated angle between the drag plane and dragging pointer rays to trigger pointer events. Set to 0 to allow any angle (default: 0)
  105322. */
  105323. maxDragAngle: number;
  105324. /**
  105325. * @hidden
  105326. */
  105327. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  105328. /**
  105329. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  105330. */
  105331. currentDraggingPointerID: number;
  105332. /**
  105333. * The last position where the pointer hit the drag plane in world space
  105334. */
  105335. lastDragPosition: Vector3;
  105336. /**
  105337. * If the behavior is currently in a dragging state
  105338. */
  105339. dragging: boolean;
  105340. /**
  105341. * The distance towards the target drag position to move each frame. This can be useful to avoid jitter. Set this to 1 for no delay. (Default: 0.2)
  105342. */
  105343. dragDeltaRatio: number;
  105344. /**
  105345. * If the drag plane orientation should be updated during the dragging (Default: true)
  105346. */
  105347. updateDragPlane: boolean;
  105348. private _debugMode;
  105349. private _moving;
  105350. /**
  105351. * Fires each time the attached mesh is dragged with the pointer
  105352. * * delta between last drag position and current drag position in world space
  105353. * * dragDistance along the drag axis
  105354. * * dragPlaneNormal normal of the current drag plane used during the drag
  105355. * * dragPlanePoint in world space where the drag intersects the drag plane
  105356. */
  105357. onDragObservable: Observable<{
  105358. delta: Vector3;
  105359. dragPlanePoint: Vector3;
  105360. dragPlaneNormal: Vector3;
  105361. dragDistance: number;
  105362. pointerId: number;
  105363. }>;
  105364. /**
  105365. * Fires each time a drag begins (eg. mouse down on mesh)
  105366. */
  105367. onDragStartObservable: Observable<{
  105368. dragPlanePoint: Vector3;
  105369. pointerId: number;
  105370. }>;
  105371. /**
  105372. * Fires each time a drag ends (eg. mouse release after drag)
  105373. */
  105374. onDragEndObservable: Observable<{
  105375. dragPlanePoint: Vector3;
  105376. pointerId: number;
  105377. }>;
  105378. /**
  105379. * If the attached mesh should be moved when dragged
  105380. */
  105381. moveAttached: boolean;
  105382. /**
  105383. * If the drag behavior will react to drag events (Default: true)
  105384. */
  105385. enabled: boolean;
  105386. /**
  105387. * If pointer events should start and release the drag (Default: true)
  105388. */
  105389. startAndReleaseDragOnPointerEvents: boolean;
  105390. /**
  105391. * If camera controls should be detached during the drag
  105392. */
  105393. detachCameraControls: boolean;
  105394. /**
  105395. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  105396. */
  105397. useObjectOrienationForDragging: boolean;
  105398. private _options;
  105399. /**
  105400. * Creates a pointer drag behavior that can be attached to a mesh
  105401. * @param options The drag axis or normal of the plane that will be dragged across. If no options are specified the drag plane will always face the ray's origin (eg. camera)
  105402. */
  105403. constructor(options?: {
  105404. dragAxis?: Vector3;
  105405. dragPlaneNormal?: Vector3;
  105406. });
  105407. /**
  105408. * Predicate to determine if it is valid to move the object to a new position when it is moved
  105409. */
  105410. validateDrag: (targetPosition: Vector3) => boolean;
  105411. /**
  105412. * The name of the behavior
  105413. */
  105414. readonly name: string;
  105415. /**
  105416. * Initializes the behavior
  105417. */
  105418. init(): void;
  105419. private _tmpVector;
  105420. private _alternatePickedPoint;
  105421. private _worldDragAxis;
  105422. private _targetPosition;
  105423. private _attachedElement;
  105424. /**
  105425. * Attaches the drag behavior the passed in mesh
  105426. * @param ownerNode The mesh that will be dragged around once attached
  105427. * @param predicate Predicate to use for pick filtering
  105428. */
  105429. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  105430. /**
  105431. * Force relase the drag action by code.
  105432. */
  105433. releaseDrag(): void;
  105434. private _startDragRay;
  105435. private _lastPointerRay;
  105436. /**
  105437. * Simulates the start of a pointer drag event on the behavior
  105438. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  105439. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  105440. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  105441. */
  105442. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  105443. private _startDrag;
  105444. private _dragDelta;
  105445. private _moveDrag;
  105446. private _pickWithRayOnDragPlane;
  105447. private _pointA;
  105448. private _pointB;
  105449. private _pointC;
  105450. private _lineA;
  105451. private _lineB;
  105452. private _localAxis;
  105453. private _lookAt;
  105454. private _updateDragPlanePosition;
  105455. /**
  105456. * Detaches the behavior from the mesh
  105457. */
  105458. detach(): void;
  105459. }
  105460. }
  105461. declare module BABYLON {
  105462. /**
  105463. * A behavior that when attached to a mesh will allow the mesh to be scaled
  105464. */
  105465. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  105466. private _dragBehaviorA;
  105467. private _dragBehaviorB;
  105468. private _startDistance;
  105469. private _initialScale;
  105470. private _targetScale;
  105471. private _ownerNode;
  105472. private _sceneRenderObserver;
  105473. /**
  105474. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  105475. */
  105476. constructor();
  105477. /**
  105478. * The name of the behavior
  105479. */
  105480. readonly name: string;
  105481. /**
  105482. * Initializes the behavior
  105483. */
  105484. init(): void;
  105485. private _getCurrentDistance;
  105486. /**
  105487. * Attaches the scale behavior the passed in mesh
  105488. * @param ownerNode The mesh that will be scaled around once attached
  105489. */
  105490. attach(ownerNode: Mesh): void;
  105491. /**
  105492. * Detaches the behavior from the mesh
  105493. */
  105494. detach(): void;
  105495. }
  105496. }
  105497. declare module BABYLON {
  105498. /**
  105499. * A behavior that when attached to a mesh will allow the mesh to be dragged around based on directions and origin of the pointer's ray
  105500. */
  105501. export class SixDofDragBehavior implements Behavior<Mesh> {
  105502. private static _virtualScene;
  105503. private _ownerNode;
  105504. private _sceneRenderObserver;
  105505. private _scene;
  105506. private _targetPosition;
  105507. private _virtualOriginMesh;
  105508. private _virtualDragMesh;
  105509. private _pointerObserver;
  105510. private _moving;
  105511. private _startingOrientation;
  105512. /**
  105513. * How much faster the object should move when the controller is moving towards it. This is useful to bring objects that are far away from the user to them faster. Set this to 0 to avoid any speed increase. (Default: 3)
  105514. */
  105515. private zDragFactor;
  105516. /**
  105517. * If the object should rotate to face the drag origin
  105518. */
  105519. rotateDraggedObject: boolean;
  105520. /**
  105521. * If the behavior is currently in a dragging state
  105522. */
  105523. dragging: boolean;
  105524. /**
  105525. * The distance towards the target drag position to move each frame. This can be useful to avoid jitter. Set this to 1 for no delay. (Default: 0.2)
  105526. */
  105527. dragDeltaRatio: number;
  105528. /**
  105529. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  105530. */
  105531. currentDraggingPointerID: number;
  105532. /**
  105533. * If camera controls should be detached during the drag
  105534. */
  105535. detachCameraControls: boolean;
  105536. /**
  105537. * Fires each time a drag starts
  105538. */
  105539. onDragStartObservable: Observable<{}>;
  105540. /**
  105541. * Fires each time a drag ends (eg. mouse release after drag)
  105542. */
  105543. onDragEndObservable: Observable<{}>;
  105544. /**
  105545. * Instantiates a behavior that when attached to a mesh will allow the mesh to be dragged around based on directions and origin of the pointer's ray
  105546. */
  105547. constructor();
  105548. /**
  105549. * The name of the behavior
  105550. */
  105551. readonly name: string;
  105552. /**
  105553. * Initializes the behavior
  105554. */
  105555. init(): void;
  105556. /**
  105557. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  105558. */
  105559. private readonly _pointerCamera;
  105560. /**
  105561. * Attaches the scale behavior the passed in mesh
  105562. * @param ownerNode The mesh that will be scaled around once attached
  105563. */
  105564. attach(ownerNode: Mesh): void;
  105565. /**
  105566. * Detaches the behavior from the mesh
  105567. */
  105568. detach(): void;
  105569. }
  105570. }
  105571. declare module BABYLON {
  105572. /**
  105573. * Class used to apply inverse kinematics to bones
  105574. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  105575. */
  105576. export class BoneIKController {
  105577. private static _tmpVecs;
  105578. private static _tmpQuat;
  105579. private static _tmpMats;
  105580. /**
  105581. * Gets or sets the target mesh
  105582. */
  105583. targetMesh: AbstractMesh;
  105584. /** Gets or sets the mesh used as pole */
  105585. poleTargetMesh: AbstractMesh;
  105586. /**
  105587. * Gets or sets the bone used as pole
  105588. */
  105589. poleTargetBone: Nullable<Bone>;
  105590. /**
  105591. * Gets or sets the target position
  105592. */
  105593. targetPosition: Vector3;
  105594. /**
  105595. * Gets or sets the pole target position
  105596. */
  105597. poleTargetPosition: Vector3;
  105598. /**
  105599. * Gets or sets the pole target local offset
  105600. */
  105601. poleTargetLocalOffset: Vector3;
  105602. /**
  105603. * Gets or sets the pole angle
  105604. */
  105605. poleAngle: number;
  105606. /**
  105607. * Gets or sets the mesh associated with the controller
  105608. */
  105609. mesh: AbstractMesh;
  105610. /**
  105611. * The amount to slerp (spherical linear interpolation) to the target. Set this to a value between 0 and 1 (a value of 1 disables slerp)
  105612. */
  105613. slerpAmount: number;
  105614. private _bone1Quat;
  105615. private _bone1Mat;
  105616. private _bone2Ang;
  105617. private _bone1;
  105618. private _bone2;
  105619. private _bone1Length;
  105620. private _bone2Length;
  105621. private _maxAngle;
  105622. private _maxReach;
  105623. private _rightHandedSystem;
  105624. private _bendAxis;
  105625. private _slerping;
  105626. private _adjustRoll;
  105627. /**
  105628. * Gets or sets maximum allowed angle
  105629. */
  105630. maxAngle: number;
  105631. /**
  105632. * Creates a new BoneIKController
  105633. * @param mesh defines the mesh to control
  105634. * @param bone defines the bone to control
  105635. * @param options defines options to set up the controller
  105636. */
  105637. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  105638. targetMesh?: AbstractMesh;
  105639. poleTargetMesh?: AbstractMesh;
  105640. poleTargetBone?: Bone;
  105641. poleTargetLocalOffset?: Vector3;
  105642. poleAngle?: number;
  105643. bendAxis?: Vector3;
  105644. maxAngle?: number;
  105645. slerpAmount?: number;
  105646. });
  105647. private _setMaxAngle;
  105648. /**
  105649. * Force the controller to update the bones
  105650. */
  105651. update(): void;
  105652. }
  105653. }
  105654. declare module BABYLON {
  105655. /**
  105656. * Class used to make a bone look toward a point in space
  105657. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  105658. */
  105659. export class BoneLookController {
  105660. private static _tmpVecs;
  105661. private static _tmpQuat;
  105662. private static _tmpMats;
  105663. /**
  105664. * The target Vector3 that the bone will look at
  105665. */
  105666. target: Vector3;
  105667. /**
  105668. * The mesh that the bone is attached to
  105669. */
  105670. mesh: AbstractMesh;
  105671. /**
  105672. * The bone that will be looking to the target
  105673. */
  105674. bone: Bone;
  105675. /**
  105676. * The up axis of the coordinate system that is used when the bone is rotated
  105677. */
  105678. upAxis: Vector3;
  105679. /**
  105680. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  105681. */
  105682. upAxisSpace: Space;
  105683. /**
  105684. * Used to make an adjustment to the yaw of the bone
  105685. */
  105686. adjustYaw: number;
  105687. /**
  105688. * Used to make an adjustment to the pitch of the bone
  105689. */
  105690. adjustPitch: number;
  105691. /**
  105692. * Used to make an adjustment to the roll of the bone
  105693. */
  105694. adjustRoll: number;
  105695. /**
  105696. * The amount to slerp (spherical linear interpolation) to the target. Set this to a value between 0 and 1 (a value of 1 disables slerp)
  105697. */
  105698. slerpAmount: number;
  105699. private _minYaw;
  105700. private _maxYaw;
  105701. private _minPitch;
  105702. private _maxPitch;
  105703. private _minYawSin;
  105704. private _minYawCos;
  105705. private _maxYawSin;
  105706. private _maxYawCos;
  105707. private _midYawConstraint;
  105708. private _minPitchTan;
  105709. private _maxPitchTan;
  105710. private _boneQuat;
  105711. private _slerping;
  105712. private _transformYawPitch;
  105713. private _transformYawPitchInv;
  105714. private _firstFrameSkipped;
  105715. private _yawRange;
  105716. private _fowardAxis;
  105717. /**
  105718. * Gets or sets the minimum yaw angle that the bone can look to
  105719. */
  105720. minYaw: number;
  105721. /**
  105722. * Gets or sets the maximum yaw angle that the bone can look to
  105723. */
  105724. maxYaw: number;
  105725. /**
  105726. * Gets or sets the minimum pitch angle that the bone can look to
  105727. */
  105728. minPitch: number;
  105729. /**
  105730. * Gets or sets the maximum pitch angle that the bone can look to
  105731. */
  105732. maxPitch: number;
  105733. /**
  105734. * Create a BoneLookController
  105735. * @param mesh the mesh that the bone belongs to
  105736. * @param bone the bone that will be looking to the target
  105737. * @param target the target Vector3 to look at
  105738. * @param options optional settings:
  105739. * * maxYaw: the maximum angle the bone will yaw to
  105740. * * minYaw: the minimum angle the bone will yaw to
  105741. * * maxPitch: the maximum angle the bone will pitch to
  105742. * * minPitch: the minimum angle the bone will yaw to
  105743. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  105744. * * upAxis: the up axis of the coordinate system
  105745. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  105746. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  105747. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  105748. * * adjustYaw: used to make an adjustment to the yaw of the bone
  105749. * * adjustPitch: used to make an adjustment to the pitch of the bone
  105750. * * adjustRoll: used to make an adjustment to the roll of the bone
  105751. **/
  105752. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  105753. maxYaw?: number;
  105754. minYaw?: number;
  105755. maxPitch?: number;
  105756. minPitch?: number;
  105757. slerpAmount?: number;
  105758. upAxis?: Vector3;
  105759. upAxisSpace?: Space;
  105760. yawAxis?: Vector3;
  105761. pitchAxis?: Vector3;
  105762. adjustYaw?: number;
  105763. adjustPitch?: number;
  105764. adjustRoll?: number;
  105765. });
  105766. /**
  105767. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  105768. */
  105769. update(): void;
  105770. private _getAngleDiff;
  105771. private _getAngleBetween;
  105772. private _isAngleBetween;
  105773. }
  105774. }
  105775. declare module BABYLON {
  105776. /**
  105777. * Manage the gamepad inputs to control an arc rotate camera.
  105778. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105779. */
  105780. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  105781. /**
  105782. * Defines the camera the input is attached to.
  105783. */
  105784. camera: ArcRotateCamera;
  105785. /**
  105786. * Defines the gamepad the input is gathering event from.
  105787. */
  105788. gamepad: Nullable<Gamepad>;
  105789. /**
  105790. * Defines the gamepad rotation sensiblity.
  105791. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  105792. */
  105793. gamepadRotationSensibility: number;
  105794. /**
  105795. * Defines the gamepad move sensiblity.
  105796. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  105797. */
  105798. gamepadMoveSensibility: number;
  105799. private _yAxisScale;
  105800. /**
  105801. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  105802. */
  105803. invertYAxis: boolean;
  105804. private _onGamepadConnectedObserver;
  105805. private _onGamepadDisconnectedObserver;
  105806. /**
  105807. * Attach the input controls to a specific dom element to get the input from.
  105808. * @param element Defines the element the controls should be listened from
  105809. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105810. */
  105811. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105812. /**
  105813. * Detach the current controls from the specified dom element.
  105814. * @param element Defines the element to stop listening the inputs from
  105815. */
  105816. detachControl(element: Nullable<HTMLElement>): void;
  105817. /**
  105818. * Update the current camera state depending on the inputs that have been used this frame.
  105819. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  105820. */
  105821. checkInputs(): void;
  105822. /**
  105823. * Gets the class name of the current intput.
  105824. * @returns the class name
  105825. */
  105826. getClassName(): string;
  105827. /**
  105828. * Get the friendly name associated with the input class.
  105829. * @returns the input friendly name
  105830. */
  105831. getSimpleName(): string;
  105832. }
  105833. }
  105834. declare module BABYLON {
  105835. interface ArcRotateCameraInputsManager {
  105836. /**
  105837. * Add orientation input support to the input manager.
  105838. * @returns the current input manager
  105839. */
  105840. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  105841. }
  105842. /**
  105843. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  105844. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105845. */
  105846. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  105847. /**
  105848. * Defines the camera the input is attached to.
  105849. */
  105850. camera: ArcRotateCamera;
  105851. /**
  105852. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  105853. */
  105854. alphaCorrection: number;
  105855. /**
  105856. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  105857. */
  105858. gammaCorrection: number;
  105859. private _alpha;
  105860. private _gamma;
  105861. private _dirty;
  105862. private _deviceOrientationHandler;
  105863. /**
  105864. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  105865. */
  105866. constructor();
  105867. /**
  105868. * Attach the input controls to a specific dom element to get the input from.
  105869. * @param element Defines the element the controls should be listened from
  105870. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105871. */
  105872. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105873. /** @hidden */
  105874. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  105875. /**
  105876. * Update the current camera state depending on the inputs that have been used this frame.
  105877. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  105878. */
  105879. checkInputs(): void;
  105880. /**
  105881. * Detach the current controls from the specified dom element.
  105882. * @param element Defines the element to stop listening the inputs from
  105883. */
  105884. detachControl(element: Nullable<HTMLElement>): void;
  105885. /**
  105886. * Gets the class name of the current intput.
  105887. * @returns the class name
  105888. */
  105889. getClassName(): string;
  105890. /**
  105891. * Get the friendly name associated with the input class.
  105892. * @returns the input friendly name
  105893. */
  105894. getSimpleName(): string;
  105895. }
  105896. }
  105897. declare module BABYLON {
  105898. /**
  105899. * Listen to mouse events to control the camera.
  105900. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105901. */
  105902. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  105903. /**
  105904. * Defines the camera the input is attached to.
  105905. */
  105906. camera: FlyCamera;
  105907. /**
  105908. * Defines if touch is enabled. (Default is true.)
  105909. */
  105910. touchEnabled: boolean;
  105911. /**
  105912. * Defines the buttons associated with the input to handle camera rotation.
  105913. */
  105914. buttons: number[];
  105915. /**
  105916. * Assign buttons for Yaw control.
  105917. */
  105918. buttonsYaw: number[];
  105919. /**
  105920. * Assign buttons for Pitch control.
  105921. */
  105922. buttonsPitch: number[];
  105923. /**
  105924. * Assign buttons for Roll control.
  105925. */
  105926. buttonsRoll: number[];
  105927. /**
  105928. * Detect if any button is being pressed while mouse is moved.
  105929. * -1 = Mouse locked.
  105930. * 0 = Left button.
  105931. * 1 = Middle Button.
  105932. * 2 = Right Button.
  105933. */
  105934. activeButton: number;
  105935. /**
  105936. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  105937. * Higher values reduce its sensitivity.
  105938. */
  105939. angularSensibility: number;
  105940. private _mousemoveCallback;
  105941. private _observer;
  105942. private _rollObserver;
  105943. private previousPosition;
  105944. private noPreventDefault;
  105945. private element;
  105946. /**
  105947. * Listen to mouse events to control the camera.
  105948. * @param touchEnabled Define if touch is enabled. (Default is true.)
  105949. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105950. */
  105951. constructor(touchEnabled?: boolean);
  105952. /**
  105953. * Attach the mouse control to the HTML DOM element.
  105954. * @param element Defines the element that listens to the input events.
  105955. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  105956. */
  105957. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105958. /**
  105959. * Detach the current controls from the specified dom element.
  105960. * @param element Defines the element to stop listening the inputs from
  105961. */
  105962. detachControl(element: Nullable<HTMLElement>): void;
  105963. /**
  105964. * Gets the class name of the current input.
  105965. * @returns the class name.
  105966. */
  105967. getClassName(): string;
  105968. /**
  105969. * Get the friendly name associated with the input class.
  105970. * @returns the input's friendly name.
  105971. */
  105972. getSimpleName(): string;
  105973. private _pointerInput;
  105974. private _onMouseMove;
  105975. /**
  105976. * Rotate camera by mouse offset.
  105977. */
  105978. private rotateCamera;
  105979. }
  105980. }
  105981. declare module BABYLON {
  105982. /**
  105983. * Default Inputs manager for the FlyCamera.
  105984. * It groups all the default supported inputs for ease of use.
  105985. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105986. */
  105987. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  105988. /**
  105989. * Instantiates a new FlyCameraInputsManager.
  105990. * @param camera Defines the camera the inputs belong to.
  105991. */
  105992. constructor(camera: FlyCamera);
  105993. /**
  105994. * Add keyboard input support to the input manager.
  105995. * @returns the new FlyCameraKeyboardMoveInput().
  105996. */
  105997. addKeyboard(): FlyCameraInputsManager;
  105998. /**
  105999. * Add mouse input support to the input manager.
  106000. * @param touchEnabled Enable touch screen support.
  106001. * @returns the new FlyCameraMouseInput().
  106002. */
  106003. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  106004. }
  106005. }
  106006. declare module BABYLON {
  106007. /**
  106008. * This is a flying camera, designed for 3D movement and rotation in all directions,
  106009. * such as in a 3D Space Shooter or a Flight Simulator.
  106010. */
  106011. export class FlyCamera extends TargetCamera {
  106012. /**
  106013. * Define the collision ellipsoid of the camera.
  106014. * This is helpful for simulating a camera body, like a player's body.
  106015. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  106016. */
  106017. ellipsoid: Vector3;
  106018. /**
  106019. * Define an offset for the position of the ellipsoid around the camera.
  106020. * This can be helpful if the camera is attached away from the player's body center,
  106021. * such as at its head.
  106022. */
  106023. ellipsoidOffset: Vector3;
  106024. /**
  106025. * Enable or disable collisions of the camera with the rest of the scene objects.
  106026. */
  106027. checkCollisions: boolean;
  106028. /**
  106029. * Enable or disable gravity on the camera.
  106030. */
  106031. applyGravity: boolean;
  106032. /**
  106033. * Define the current direction the camera is moving to.
  106034. */
  106035. cameraDirection: Vector3;
  106036. /**
  106037. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  106038. * This overrides and empties cameraRotation.
  106039. */
  106040. rotationQuaternion: Quaternion;
  106041. /**
  106042. * Track Roll to maintain the wanted Rolling when looking around.
  106043. */
  106044. _trackRoll: number;
  106045. /**
  106046. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  106047. */
  106048. rollCorrect: number;
  106049. /**
  106050. * Mimic a banked turn, Rolling the camera when Yawing.
  106051. * It's recommended to use rollCorrect = 10 for faster banking correction.
  106052. */
  106053. bankedTurn: boolean;
  106054. /**
  106055. * Limit in radians for how much Roll banking will add. (Default: 90°)
  106056. */
  106057. bankedTurnLimit: number;
  106058. /**
  106059. * Value of 0 disables the banked Roll.
  106060. * Value of 1 is equal to the Yaw angle in radians.
  106061. */
  106062. bankedTurnMultiplier: number;
  106063. /**
  106064. * The inputs manager loads all the input sources, such as keyboard and mouse.
  106065. */
  106066. inputs: FlyCameraInputsManager;
  106067. /**
  106068. * Gets the input sensibility for mouse input.
  106069. * Higher values reduce sensitivity.
  106070. */
  106071. /**
  106072. * Sets the input sensibility for a mouse input.
  106073. * Higher values reduce sensitivity.
  106074. */
  106075. angularSensibility: number;
  106076. /**
  106077. * Get the keys for camera movement forward.
  106078. */
  106079. /**
  106080. * Set the keys for camera movement forward.
  106081. */
  106082. keysForward: number[];
  106083. /**
  106084. * Get the keys for camera movement backward.
  106085. */
  106086. keysBackward: number[];
  106087. /**
  106088. * Get the keys for camera movement up.
  106089. */
  106090. /**
  106091. * Set the keys for camera movement up.
  106092. */
  106093. keysUp: number[];
  106094. /**
  106095. * Get the keys for camera movement down.
  106096. */
  106097. /**
  106098. * Set the keys for camera movement down.
  106099. */
  106100. keysDown: number[];
  106101. /**
  106102. * Get the keys for camera movement left.
  106103. */
  106104. /**
  106105. * Set the keys for camera movement left.
  106106. */
  106107. keysLeft: number[];
  106108. /**
  106109. * Set the keys for camera movement right.
  106110. */
  106111. /**
  106112. * Set the keys for camera movement right.
  106113. */
  106114. keysRight: number[];
  106115. /**
  106116. * Event raised when the camera collides with a mesh in the scene.
  106117. */
  106118. onCollide: (collidedMesh: AbstractMesh) => void;
  106119. private _collider;
  106120. private _needMoveForGravity;
  106121. private _oldPosition;
  106122. private _diffPosition;
  106123. private _newPosition;
  106124. /** @hidden */
  106125. _localDirection: Vector3;
  106126. /** @hidden */
  106127. _transformedDirection: Vector3;
  106128. /**
  106129. * Instantiates a FlyCamera.
  106130. * This is a flying camera, designed for 3D movement and rotation in all directions,
  106131. * such as in a 3D Space Shooter or a Flight Simulator.
  106132. * @param name Define the name of the camera in the scene.
  106133. * @param position Define the starting position of the camera in the scene.
  106134. * @param scene Define the scene the camera belongs to.
  106135. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  106136. */
  106137. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  106138. /**
  106139. * Attach a control to the HTML DOM element.
  106140. * @param element Defines the element that listens to the input events.
  106141. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  106142. */
  106143. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106144. /**
  106145. * Detach a control from the HTML DOM element.
  106146. * The camera will stop reacting to that input.
  106147. * @param element Defines the element that listens to the input events.
  106148. */
  106149. detachControl(element: HTMLElement): void;
  106150. private _collisionMask;
  106151. /**
  106152. * Get the mask that the camera ignores in collision events.
  106153. */
  106154. /**
  106155. * Set the mask that the camera ignores in collision events.
  106156. */
  106157. collisionMask: number;
  106158. /** @hidden */
  106159. _collideWithWorld(displacement: Vector3): void;
  106160. /** @hidden */
  106161. private _onCollisionPositionChange;
  106162. /** @hidden */
  106163. _checkInputs(): void;
  106164. /** @hidden */
  106165. _decideIfNeedsToMove(): boolean;
  106166. /** @hidden */
  106167. _updatePosition(): void;
  106168. /**
  106169. * Restore the Roll to its target value at the rate specified.
  106170. * @param rate - Higher means slower restoring.
  106171. * @hidden
  106172. */
  106173. restoreRoll(rate: number): void;
  106174. /**
  106175. * Destroy the camera and release the current resources held by it.
  106176. */
  106177. dispose(): void;
  106178. /**
  106179. * Get the current object class name.
  106180. * @returns the class name.
  106181. */
  106182. getClassName(): string;
  106183. }
  106184. }
  106185. declare module BABYLON {
  106186. /**
  106187. * Listen to keyboard events to control the camera.
  106188. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106189. */
  106190. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  106191. /**
  106192. * Defines the camera the input is attached to.
  106193. */
  106194. camera: FlyCamera;
  106195. /**
  106196. * The list of keyboard keys used to control the forward move of the camera.
  106197. */
  106198. keysForward: number[];
  106199. /**
  106200. * The list of keyboard keys used to control the backward move of the camera.
  106201. */
  106202. keysBackward: number[];
  106203. /**
  106204. * The list of keyboard keys used to control the forward move of the camera.
  106205. */
  106206. keysUp: number[];
  106207. /**
  106208. * The list of keyboard keys used to control the backward move of the camera.
  106209. */
  106210. keysDown: number[];
  106211. /**
  106212. * The list of keyboard keys used to control the right strafe move of the camera.
  106213. */
  106214. keysRight: number[];
  106215. /**
  106216. * The list of keyboard keys used to control the left strafe move of the camera.
  106217. */
  106218. keysLeft: number[];
  106219. private _keys;
  106220. private _onCanvasBlurObserver;
  106221. private _onKeyboardObserver;
  106222. private _engine;
  106223. private _scene;
  106224. /**
  106225. * Attach the input controls to a specific dom element to get the input from.
  106226. * @param element Defines the element the controls should be listened from
  106227. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106228. */
  106229. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106230. /**
  106231. * Detach the current controls from the specified dom element.
  106232. * @param element Defines the element to stop listening the inputs from
  106233. */
  106234. detachControl(element: Nullable<HTMLElement>): void;
  106235. /**
  106236. * Gets the class name of the current intput.
  106237. * @returns the class name
  106238. */
  106239. getClassName(): string;
  106240. /** @hidden */
  106241. _onLostFocus(e: FocusEvent): void;
  106242. /**
  106243. * Get the friendly name associated with the input class.
  106244. * @returns the input friendly name
  106245. */
  106246. getSimpleName(): string;
  106247. /**
  106248. * Update the current camera state depending on the inputs that have been used this frame.
  106249. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106250. */
  106251. checkInputs(): void;
  106252. }
  106253. }
  106254. declare module BABYLON {
  106255. /**
  106256. * Manage the mouse wheel inputs to control a follow camera.
  106257. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106258. */
  106259. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  106260. /**
  106261. * Defines the camera the input is attached to.
  106262. */
  106263. camera: FollowCamera;
  106264. /**
  106265. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  106266. */
  106267. axisControlRadius: boolean;
  106268. /**
  106269. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  106270. */
  106271. axisControlHeight: boolean;
  106272. /**
  106273. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  106274. */
  106275. axisControlRotation: boolean;
  106276. /**
  106277. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  106278. * relation to mouseWheel events.
  106279. */
  106280. wheelPrecision: number;
  106281. /**
  106282. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  106283. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  106284. */
  106285. wheelDeltaPercentage: number;
  106286. private _wheel;
  106287. private _observer;
  106288. /**
  106289. * Attach the input controls to a specific dom element to get the input from.
  106290. * @param element Defines the element the controls should be listened from
  106291. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106292. */
  106293. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106294. /**
  106295. * Detach the current controls from the specified dom element.
  106296. * @param element Defines the element to stop listening the inputs from
  106297. */
  106298. detachControl(element: Nullable<HTMLElement>): void;
  106299. /**
  106300. * Gets the class name of the current intput.
  106301. * @returns the class name
  106302. */
  106303. getClassName(): string;
  106304. /**
  106305. * Get the friendly name associated with the input class.
  106306. * @returns the input friendly name
  106307. */
  106308. getSimpleName(): string;
  106309. }
  106310. }
  106311. declare module BABYLON {
  106312. /**
  106313. * Manage the pointers inputs to control an follow camera.
  106314. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106315. */
  106316. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  106317. /**
  106318. * Defines the camera the input is attached to.
  106319. */
  106320. camera: FollowCamera;
  106321. /**
  106322. * Gets the class name of the current input.
  106323. * @returns the class name
  106324. */
  106325. getClassName(): string;
  106326. /**
  106327. * Defines the pointer angular sensibility along the X axis or how fast is
  106328. * the camera rotating.
  106329. * A negative number will reverse the axis direction.
  106330. */
  106331. angularSensibilityX: number;
  106332. /**
  106333. * Defines the pointer angular sensibility along the Y axis or how fast is
  106334. * the camera rotating.
  106335. * A negative number will reverse the axis direction.
  106336. */
  106337. angularSensibilityY: number;
  106338. /**
  106339. * Defines the pointer pinch precision or how fast is the camera zooming.
  106340. * A negative number will reverse the axis direction.
  106341. */
  106342. pinchPrecision: number;
  106343. /**
  106344. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  106345. * from 0.
  106346. * It defines the percentage of current camera.radius to use as delta when
  106347. * pinch zoom is used.
  106348. */
  106349. pinchDeltaPercentage: number;
  106350. /**
  106351. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  106352. */
  106353. axisXControlRadius: boolean;
  106354. /**
  106355. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  106356. */
  106357. axisXControlHeight: boolean;
  106358. /**
  106359. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  106360. */
  106361. axisXControlRotation: boolean;
  106362. /**
  106363. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  106364. */
  106365. axisYControlRadius: boolean;
  106366. /**
  106367. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  106368. */
  106369. axisYControlHeight: boolean;
  106370. /**
  106371. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  106372. */
  106373. axisYControlRotation: boolean;
  106374. /**
  106375. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  106376. */
  106377. axisPinchControlRadius: boolean;
  106378. /**
  106379. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  106380. */
  106381. axisPinchControlHeight: boolean;
  106382. /**
  106383. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  106384. */
  106385. axisPinchControlRotation: boolean;
  106386. /**
  106387. * Log error messages if basic misconfiguration has occurred.
  106388. */
  106389. warningEnable: boolean;
  106390. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  106391. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  106392. private _warningCounter;
  106393. private _warning;
  106394. }
  106395. }
  106396. declare module BABYLON {
  106397. /**
  106398. * Default Inputs manager for the FollowCamera.
  106399. * It groups all the default supported inputs for ease of use.
  106400. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106401. */
  106402. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  106403. /**
  106404. * Instantiates a new FollowCameraInputsManager.
  106405. * @param camera Defines the camera the inputs belong to
  106406. */
  106407. constructor(camera: FollowCamera);
  106408. /**
  106409. * Add keyboard input support to the input manager.
  106410. * @returns the current input manager
  106411. */
  106412. addKeyboard(): FollowCameraInputsManager;
  106413. /**
  106414. * Add mouse wheel input support to the input manager.
  106415. * @returns the current input manager
  106416. */
  106417. addMouseWheel(): FollowCameraInputsManager;
  106418. /**
  106419. * Add pointers input support to the input manager.
  106420. * @returns the current input manager
  106421. */
  106422. addPointers(): FollowCameraInputsManager;
  106423. /**
  106424. * Add orientation input support to the input manager.
  106425. * @returns the current input manager
  106426. */
  106427. addVRDeviceOrientation(): FollowCameraInputsManager;
  106428. }
  106429. }
  106430. declare module BABYLON {
  106431. /**
  106432. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  106433. * an arc rotate version arcFollowCamera are available.
  106434. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106435. */
  106436. export class FollowCamera extends TargetCamera {
  106437. /**
  106438. * Distance the follow camera should follow an object at
  106439. */
  106440. radius: number;
  106441. /**
  106442. * Minimum allowed distance of the camera to the axis of rotation
  106443. * (The camera can not get closer).
  106444. * This can help limiting how the Camera is able to move in the scene.
  106445. */
  106446. lowerRadiusLimit: Nullable<number>;
  106447. /**
  106448. * Maximum allowed distance of the camera to the axis of rotation
  106449. * (The camera can not get further).
  106450. * This can help limiting how the Camera is able to move in the scene.
  106451. */
  106452. upperRadiusLimit: Nullable<number>;
  106453. /**
  106454. * Define a rotation offset between the camera and the object it follows
  106455. */
  106456. rotationOffset: number;
  106457. /**
  106458. * Minimum allowed angle to camera position relative to target object.
  106459. * This can help limiting how the Camera is able to move in the scene.
  106460. */
  106461. lowerRotationOffsetLimit: Nullable<number>;
  106462. /**
  106463. * Maximum allowed angle to camera position relative to target object.
  106464. * This can help limiting how the Camera is able to move in the scene.
  106465. */
  106466. upperRotationOffsetLimit: Nullable<number>;
  106467. /**
  106468. * Define a height offset between the camera and the object it follows.
  106469. * It can help following an object from the top (like a car chaing a plane)
  106470. */
  106471. heightOffset: number;
  106472. /**
  106473. * Minimum allowed height of camera position relative to target object.
  106474. * This can help limiting how the Camera is able to move in the scene.
  106475. */
  106476. lowerHeightOffsetLimit: Nullable<number>;
  106477. /**
  106478. * Maximum allowed height of camera position relative to target object.
  106479. * This can help limiting how the Camera is able to move in the scene.
  106480. */
  106481. upperHeightOffsetLimit: Nullable<number>;
  106482. /**
  106483. * Define how fast the camera can accelerate to follow it s target.
  106484. */
  106485. cameraAcceleration: number;
  106486. /**
  106487. * Define the speed limit of the camera following an object.
  106488. */
  106489. maxCameraSpeed: number;
  106490. /**
  106491. * Define the target of the camera.
  106492. */
  106493. lockedTarget: Nullable<AbstractMesh>;
  106494. /**
  106495. * Defines the input associated with the camera.
  106496. */
  106497. inputs: FollowCameraInputsManager;
  106498. /**
  106499. * Instantiates the follow camera.
  106500. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106501. * @param name Define the name of the camera in the scene
  106502. * @param position Define the position of the camera
  106503. * @param scene Define the scene the camera belong to
  106504. * @param lockedTarget Define the target of the camera
  106505. */
  106506. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  106507. private _follow;
  106508. /**
  106509. * Attached controls to the current camera.
  106510. * @param element Defines the element the controls should be listened from
  106511. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106512. */
  106513. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106514. /**
  106515. * Detach the current controls from the camera.
  106516. * The camera will stop reacting to inputs.
  106517. * @param element Defines the element to stop listening the inputs from
  106518. */
  106519. detachControl(element: HTMLElement): void;
  106520. /** @hidden */
  106521. _checkInputs(): void;
  106522. private _checkLimits;
  106523. /**
  106524. * Gets the camera class name.
  106525. * @returns the class name
  106526. */
  106527. getClassName(): string;
  106528. }
  106529. /**
  106530. * Arc Rotate version of the follow camera.
  106531. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  106532. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106533. */
  106534. export class ArcFollowCamera extends TargetCamera {
  106535. /** The longitudinal angle of the camera */
  106536. alpha: number;
  106537. /** The latitudinal angle of the camera */
  106538. beta: number;
  106539. /** The radius of the camera from its target */
  106540. radius: number;
  106541. /** Define the camera target (the messh it should follow) */
  106542. target: Nullable<AbstractMesh>;
  106543. private _cartesianCoordinates;
  106544. /**
  106545. * Instantiates a new ArcFollowCamera
  106546. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106547. * @param name Define the name of the camera
  106548. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  106549. * @param beta Define the rotation angle of the camera around the elevation axis
  106550. * @param radius Define the radius of the camera from its target point
  106551. * @param target Define the target of the camera
  106552. * @param scene Define the scene the camera belongs to
  106553. */
  106554. constructor(name: string,
  106555. /** The longitudinal angle of the camera */
  106556. alpha: number,
  106557. /** The latitudinal angle of the camera */
  106558. beta: number,
  106559. /** The radius of the camera from its target */
  106560. radius: number,
  106561. /** Define the camera target (the messh it should follow) */
  106562. target: Nullable<AbstractMesh>, scene: Scene);
  106563. private _follow;
  106564. /** @hidden */
  106565. _checkInputs(): void;
  106566. /**
  106567. * Returns the class name of the object.
  106568. * It is mostly used internally for serialization purposes.
  106569. */
  106570. getClassName(): string;
  106571. }
  106572. }
  106573. declare module BABYLON {
  106574. /**
  106575. * Manage the keyboard inputs to control the movement of a follow camera.
  106576. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106577. */
  106578. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  106579. /**
  106580. * Defines the camera the input is attached to.
  106581. */
  106582. camera: FollowCamera;
  106583. /**
  106584. * Defines the list of key codes associated with the up action (increase heightOffset)
  106585. */
  106586. keysHeightOffsetIncr: number[];
  106587. /**
  106588. * Defines the list of key codes associated with the down action (decrease heightOffset)
  106589. */
  106590. keysHeightOffsetDecr: number[];
  106591. /**
  106592. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  106593. */
  106594. keysHeightOffsetModifierAlt: boolean;
  106595. /**
  106596. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  106597. */
  106598. keysHeightOffsetModifierCtrl: boolean;
  106599. /**
  106600. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  106601. */
  106602. keysHeightOffsetModifierShift: boolean;
  106603. /**
  106604. * Defines the list of key codes associated with the left action (increase rotationOffset)
  106605. */
  106606. keysRotationOffsetIncr: number[];
  106607. /**
  106608. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  106609. */
  106610. keysRotationOffsetDecr: number[];
  106611. /**
  106612. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  106613. */
  106614. keysRotationOffsetModifierAlt: boolean;
  106615. /**
  106616. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  106617. */
  106618. keysRotationOffsetModifierCtrl: boolean;
  106619. /**
  106620. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  106621. */
  106622. keysRotationOffsetModifierShift: boolean;
  106623. /**
  106624. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  106625. */
  106626. keysRadiusIncr: number[];
  106627. /**
  106628. * Defines the list of key codes associated with the zoom-out action (increase radius)
  106629. */
  106630. keysRadiusDecr: number[];
  106631. /**
  106632. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  106633. */
  106634. keysRadiusModifierAlt: boolean;
  106635. /**
  106636. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  106637. */
  106638. keysRadiusModifierCtrl: boolean;
  106639. /**
  106640. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  106641. */
  106642. keysRadiusModifierShift: boolean;
  106643. /**
  106644. * Defines the rate of change of heightOffset.
  106645. */
  106646. heightSensibility: number;
  106647. /**
  106648. * Defines the rate of change of rotationOffset.
  106649. */
  106650. rotationSensibility: number;
  106651. /**
  106652. * Defines the rate of change of radius.
  106653. */
  106654. radiusSensibility: number;
  106655. private _keys;
  106656. private _ctrlPressed;
  106657. private _altPressed;
  106658. private _shiftPressed;
  106659. private _onCanvasBlurObserver;
  106660. private _onKeyboardObserver;
  106661. private _engine;
  106662. private _scene;
  106663. /**
  106664. * Attach the input controls to a specific dom element to get the input from.
  106665. * @param element Defines the element the controls should be listened from
  106666. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106667. */
  106668. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106669. /**
  106670. * Detach the current controls from the specified dom element.
  106671. * @param element Defines the element to stop listening the inputs from
  106672. */
  106673. detachControl(element: Nullable<HTMLElement>): void;
  106674. /**
  106675. * Update the current camera state depending on the inputs that have been used this frame.
  106676. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106677. */
  106678. checkInputs(): void;
  106679. /**
  106680. * Gets the class name of the current input.
  106681. * @returns the class name
  106682. */
  106683. getClassName(): string;
  106684. /**
  106685. * Get the friendly name associated with the input class.
  106686. * @returns the input friendly name
  106687. */
  106688. getSimpleName(): string;
  106689. /**
  106690. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  106691. * allow modification of the heightOffset value.
  106692. */
  106693. private _modifierHeightOffset;
  106694. /**
  106695. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  106696. * allow modification of the rotationOffset value.
  106697. */
  106698. private _modifierRotationOffset;
  106699. /**
  106700. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  106701. * allow modification of the radius value.
  106702. */
  106703. private _modifierRadius;
  106704. }
  106705. }
  106706. declare module BABYLON {
  106707. interface FreeCameraInputsManager {
  106708. /**
  106709. * @hidden
  106710. */
  106711. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  106712. /**
  106713. * Add orientation input support to the input manager.
  106714. * @returns the current input manager
  106715. */
  106716. addDeviceOrientation(): FreeCameraInputsManager;
  106717. }
  106718. /**
  106719. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  106720. * Screen rotation is taken into account.
  106721. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106722. */
  106723. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  106724. private _camera;
  106725. private _screenOrientationAngle;
  106726. private _constantTranform;
  106727. private _screenQuaternion;
  106728. private _alpha;
  106729. private _beta;
  106730. private _gamma;
  106731. /**
  106732. * Can be used to detect if a device orientation sensor is availible on a device
  106733. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  106734. * @returns a promise that will resolve on orientation change
  106735. */
  106736. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  106737. /**
  106738. * @hidden
  106739. */
  106740. _onDeviceOrientationChangedObservable: Observable<void>;
  106741. /**
  106742. * Instantiates a new input
  106743. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106744. */
  106745. constructor();
  106746. /**
  106747. * Define the camera controlled by the input.
  106748. */
  106749. camera: FreeCamera;
  106750. /**
  106751. * Attach the input controls to a specific dom element to get the input from.
  106752. * @param element Defines the element the controls should be listened from
  106753. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106754. */
  106755. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106756. private _orientationChanged;
  106757. private _deviceOrientation;
  106758. /**
  106759. * Detach the current controls from the specified dom element.
  106760. * @param element Defines the element to stop listening the inputs from
  106761. */
  106762. detachControl(element: Nullable<HTMLElement>): void;
  106763. /**
  106764. * Update the current camera state depending on the inputs that have been used this frame.
  106765. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106766. */
  106767. checkInputs(): void;
  106768. /**
  106769. * Gets the class name of the current intput.
  106770. * @returns the class name
  106771. */
  106772. getClassName(): string;
  106773. /**
  106774. * Get the friendly name associated with the input class.
  106775. * @returns the input friendly name
  106776. */
  106777. getSimpleName(): string;
  106778. }
  106779. }
  106780. declare module BABYLON {
  106781. /**
  106782. * Manage the gamepad inputs to control a free camera.
  106783. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106784. */
  106785. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  106786. /**
  106787. * Define the camera the input is attached to.
  106788. */
  106789. camera: FreeCamera;
  106790. /**
  106791. * Define the Gamepad controlling the input
  106792. */
  106793. gamepad: Nullable<Gamepad>;
  106794. /**
  106795. * Defines the gamepad rotation sensiblity.
  106796. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  106797. */
  106798. gamepadAngularSensibility: number;
  106799. /**
  106800. * Defines the gamepad move sensiblity.
  106801. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  106802. */
  106803. gamepadMoveSensibility: number;
  106804. private _yAxisScale;
  106805. /**
  106806. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  106807. */
  106808. invertYAxis: boolean;
  106809. private _onGamepadConnectedObserver;
  106810. private _onGamepadDisconnectedObserver;
  106811. private _cameraTransform;
  106812. private _deltaTransform;
  106813. private _vector3;
  106814. private _vector2;
  106815. /**
  106816. * Attach the input controls to a specific dom element to get the input from.
  106817. * @param element Defines the element the controls should be listened from
  106818. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106819. */
  106820. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106821. /**
  106822. * Detach the current controls from the specified dom element.
  106823. * @param element Defines the element to stop listening the inputs from
  106824. */
  106825. detachControl(element: Nullable<HTMLElement>): void;
  106826. /**
  106827. * Update the current camera state depending on the inputs that have been used this frame.
  106828. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106829. */
  106830. checkInputs(): void;
  106831. /**
  106832. * Gets the class name of the current intput.
  106833. * @returns the class name
  106834. */
  106835. getClassName(): string;
  106836. /**
  106837. * Get the friendly name associated with the input class.
  106838. * @returns the input friendly name
  106839. */
  106840. getSimpleName(): string;
  106841. }
  106842. }
  106843. declare module BABYLON {
  106844. /**
  106845. * Defines the potential axis of a Joystick
  106846. */
  106847. export enum JoystickAxis {
  106848. /** X axis */
  106849. X = 0,
  106850. /** Y axis */
  106851. Y = 1,
  106852. /** Z axis */
  106853. Z = 2
  106854. }
  106855. /**
  106856. * Class used to define virtual joystick (used in touch mode)
  106857. */
  106858. export class VirtualJoystick {
  106859. /**
  106860. * Gets or sets a boolean indicating that left and right values must be inverted
  106861. */
  106862. reverseLeftRight: boolean;
  106863. /**
  106864. * Gets or sets a boolean indicating that up and down values must be inverted
  106865. */
  106866. reverseUpDown: boolean;
  106867. /**
  106868. * Gets the offset value for the position (ie. the change of the position value)
  106869. */
  106870. deltaPosition: Vector3;
  106871. /**
  106872. * Gets a boolean indicating if the virtual joystick was pressed
  106873. */
  106874. pressed: boolean;
  106875. /**
  106876. * Canvas the virtual joystick will render onto, default z-index of this is 5
  106877. */
  106878. static Canvas: Nullable<HTMLCanvasElement>;
  106879. private static _globalJoystickIndex;
  106880. private static vjCanvasContext;
  106881. private static vjCanvasWidth;
  106882. private static vjCanvasHeight;
  106883. private static halfWidth;
  106884. private _action;
  106885. private _axisTargetedByLeftAndRight;
  106886. private _axisTargetedByUpAndDown;
  106887. private _joystickSensibility;
  106888. private _inversedSensibility;
  106889. private _joystickPointerID;
  106890. private _joystickColor;
  106891. private _joystickPointerPos;
  106892. private _joystickPreviousPointerPos;
  106893. private _joystickPointerStartPos;
  106894. private _deltaJoystickVector;
  106895. private _leftJoystick;
  106896. private _touches;
  106897. private _onPointerDownHandlerRef;
  106898. private _onPointerMoveHandlerRef;
  106899. private _onPointerUpHandlerRef;
  106900. private _onResize;
  106901. /**
  106902. * Creates a new virtual joystick
  106903. * @param leftJoystick defines that the joystick is for left hand (false by default)
  106904. */
  106905. constructor(leftJoystick?: boolean);
  106906. /**
  106907. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  106908. * @param newJoystickSensibility defines the new sensibility
  106909. */
  106910. setJoystickSensibility(newJoystickSensibility: number): void;
  106911. private _onPointerDown;
  106912. private _onPointerMove;
  106913. private _onPointerUp;
  106914. /**
  106915. * Change the color of the virtual joystick
  106916. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  106917. */
  106918. setJoystickColor(newColor: string): void;
  106919. /**
  106920. * Defines a callback to call when the joystick is touched
  106921. * @param action defines the callback
  106922. */
  106923. setActionOnTouch(action: () => any): void;
  106924. /**
  106925. * Defines which axis you'd like to control for left & right
  106926. * @param axis defines the axis to use
  106927. */
  106928. setAxisForLeftRight(axis: JoystickAxis): void;
  106929. /**
  106930. * Defines which axis you'd like to control for up & down
  106931. * @param axis defines the axis to use
  106932. */
  106933. setAxisForUpDown(axis: JoystickAxis): void;
  106934. private _drawVirtualJoystick;
  106935. /**
  106936. * Release internal HTML canvas
  106937. */
  106938. releaseCanvas(): void;
  106939. }
  106940. }
  106941. declare module BABYLON {
  106942. interface FreeCameraInputsManager {
  106943. /**
  106944. * Add virtual joystick input support to the input manager.
  106945. * @returns the current input manager
  106946. */
  106947. addVirtualJoystick(): FreeCameraInputsManager;
  106948. }
  106949. /**
  106950. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  106951. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106952. */
  106953. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  106954. /**
  106955. * Defines the camera the input is attached to.
  106956. */
  106957. camera: FreeCamera;
  106958. private _leftjoystick;
  106959. private _rightjoystick;
  106960. /**
  106961. * Gets the left stick of the virtual joystick.
  106962. * @returns The virtual Joystick
  106963. */
  106964. getLeftJoystick(): VirtualJoystick;
  106965. /**
  106966. * Gets the right stick of the virtual joystick.
  106967. * @returns The virtual Joystick
  106968. */
  106969. getRightJoystick(): VirtualJoystick;
  106970. /**
  106971. * Update the current camera state depending on the inputs that have been used this frame.
  106972. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106973. */
  106974. checkInputs(): void;
  106975. /**
  106976. * Attach the input controls to a specific dom element to get the input from.
  106977. * @param element Defines the element the controls should be listened from
  106978. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106979. */
  106980. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106981. /**
  106982. * Detach the current controls from the specified dom element.
  106983. * @param element Defines the element to stop listening the inputs from
  106984. */
  106985. detachControl(element: Nullable<HTMLElement>): void;
  106986. /**
  106987. * Gets the class name of the current intput.
  106988. * @returns the class name
  106989. */
  106990. getClassName(): string;
  106991. /**
  106992. * Get the friendly name associated with the input class.
  106993. * @returns the input friendly name
  106994. */
  106995. getSimpleName(): string;
  106996. }
  106997. }
  106998. declare module BABYLON {
  106999. /**
  107000. * This represents a FPS type of camera controlled by touch.
  107001. * This is like a universal camera minus the Gamepad controls.
  107002. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107003. */
  107004. export class TouchCamera extends FreeCamera {
  107005. /**
  107006. * Defines the touch sensibility for rotation.
  107007. * The higher the faster.
  107008. */
  107009. touchAngularSensibility: number;
  107010. /**
  107011. * Defines the touch sensibility for move.
  107012. * The higher the faster.
  107013. */
  107014. touchMoveSensibility: number;
  107015. /**
  107016. * Instantiates a new touch camera.
  107017. * This represents a FPS type of camera controlled by touch.
  107018. * This is like a universal camera minus the Gamepad controls.
  107019. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107020. * @param name Define the name of the camera in the scene
  107021. * @param position Define the start position of the camera in the scene
  107022. * @param scene Define the scene the camera belongs to
  107023. */
  107024. constructor(name: string, position: Vector3, scene: Scene);
  107025. /**
  107026. * Gets the current object class name.
  107027. * @return the class name
  107028. */
  107029. getClassName(): string;
  107030. /** @hidden */
  107031. _setupInputs(): void;
  107032. }
  107033. }
  107034. declare module BABYLON {
  107035. /**
  107036. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  107037. * being tilted forward or back and left or right.
  107038. */
  107039. export class DeviceOrientationCamera extends FreeCamera {
  107040. private _initialQuaternion;
  107041. private _quaternionCache;
  107042. private _tmpDragQuaternion;
  107043. private _disablePointerInputWhenUsingDeviceOrientation;
  107044. /**
  107045. * Creates a new device orientation camera
  107046. * @param name The name of the camera
  107047. * @param position The start position camera
  107048. * @param scene The scene the camera belongs to
  107049. */
  107050. constructor(name: string, position: Vector3, scene: Scene);
  107051. /**
  107052. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  107053. */
  107054. disablePointerInputWhenUsingDeviceOrientation: boolean;
  107055. private _dragFactor;
  107056. /**
  107057. * Enabled turning on the y axis when the orientation sensor is active
  107058. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  107059. */
  107060. enableHorizontalDragging(dragFactor?: number): void;
  107061. /**
  107062. * Gets the current instance class name ("DeviceOrientationCamera").
  107063. * This helps avoiding instanceof at run time.
  107064. * @returns the class name
  107065. */
  107066. getClassName(): string;
  107067. /**
  107068. * @hidden
  107069. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  107070. */
  107071. _checkInputs(): void;
  107072. /**
  107073. * Reset the camera to its default orientation on the specified axis only.
  107074. * @param axis The axis to reset
  107075. */
  107076. resetToCurrentRotation(axis?: Axis): void;
  107077. }
  107078. }
  107079. declare module BABYLON {
  107080. /**
  107081. * Defines supported buttons for XBox360 compatible gamepads
  107082. */
  107083. export enum Xbox360Button {
  107084. /** A */
  107085. A = 0,
  107086. /** B */
  107087. B = 1,
  107088. /** X */
  107089. X = 2,
  107090. /** Y */
  107091. Y = 3,
  107092. /** Start */
  107093. Start = 4,
  107094. /** Back */
  107095. Back = 5,
  107096. /** Left button */
  107097. LB = 6,
  107098. /** Right button */
  107099. RB = 7,
  107100. /** Left stick */
  107101. LeftStick = 8,
  107102. /** Right stick */
  107103. RightStick = 9
  107104. }
  107105. /** Defines values for XBox360 DPad */
  107106. export enum Xbox360Dpad {
  107107. /** Up */
  107108. Up = 0,
  107109. /** Down */
  107110. Down = 1,
  107111. /** Left */
  107112. Left = 2,
  107113. /** Right */
  107114. Right = 3
  107115. }
  107116. /**
  107117. * Defines a XBox360 gamepad
  107118. */
  107119. export class Xbox360Pad extends Gamepad {
  107120. private _leftTrigger;
  107121. private _rightTrigger;
  107122. private _onlefttriggerchanged;
  107123. private _onrighttriggerchanged;
  107124. private _onbuttondown;
  107125. private _onbuttonup;
  107126. private _ondpaddown;
  107127. private _ondpadup;
  107128. /** Observable raised when a button is pressed */
  107129. onButtonDownObservable: Observable<Xbox360Button>;
  107130. /** Observable raised when a button is released */
  107131. onButtonUpObservable: Observable<Xbox360Button>;
  107132. /** Observable raised when a pad is pressed */
  107133. onPadDownObservable: Observable<Xbox360Dpad>;
  107134. /** Observable raised when a pad is released */
  107135. onPadUpObservable: Observable<Xbox360Dpad>;
  107136. private _buttonA;
  107137. private _buttonB;
  107138. private _buttonX;
  107139. private _buttonY;
  107140. private _buttonBack;
  107141. private _buttonStart;
  107142. private _buttonLB;
  107143. private _buttonRB;
  107144. private _buttonLeftStick;
  107145. private _buttonRightStick;
  107146. private _dPadUp;
  107147. private _dPadDown;
  107148. private _dPadLeft;
  107149. private _dPadRight;
  107150. private _isXboxOnePad;
  107151. /**
  107152. * Creates a new XBox360 gamepad object
  107153. * @param id defines the id of this gamepad
  107154. * @param index defines its index
  107155. * @param gamepad defines the internal HTML gamepad object
  107156. * @param xboxOne defines if it is a XBox One gamepad
  107157. */
  107158. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  107159. /**
  107160. * Defines the callback to call when left trigger is pressed
  107161. * @param callback defines the callback to use
  107162. */
  107163. onlefttriggerchanged(callback: (value: number) => void): void;
  107164. /**
  107165. * Defines the callback to call when right trigger is pressed
  107166. * @param callback defines the callback to use
  107167. */
  107168. onrighttriggerchanged(callback: (value: number) => void): void;
  107169. /**
  107170. * Gets the left trigger value
  107171. */
  107172. /**
  107173. * Sets the left trigger value
  107174. */
  107175. leftTrigger: number;
  107176. /**
  107177. * Gets the right trigger value
  107178. */
  107179. /**
  107180. * Sets the right trigger value
  107181. */
  107182. rightTrigger: number;
  107183. /**
  107184. * Defines the callback to call when a button is pressed
  107185. * @param callback defines the callback to use
  107186. */
  107187. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  107188. /**
  107189. * Defines the callback to call when a button is released
  107190. * @param callback defines the callback to use
  107191. */
  107192. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  107193. /**
  107194. * Defines the callback to call when a pad is pressed
  107195. * @param callback defines the callback to use
  107196. */
  107197. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  107198. /**
  107199. * Defines the callback to call when a pad is released
  107200. * @param callback defines the callback to use
  107201. */
  107202. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  107203. private _setButtonValue;
  107204. private _setDPadValue;
  107205. /**
  107206. * Gets the value of the `A` button
  107207. */
  107208. /**
  107209. * Sets the value of the `A` button
  107210. */
  107211. buttonA: number;
  107212. /**
  107213. * Gets the value of the `B` button
  107214. */
  107215. /**
  107216. * Sets the value of the `B` button
  107217. */
  107218. buttonB: number;
  107219. /**
  107220. * Gets the value of the `X` button
  107221. */
  107222. /**
  107223. * Sets the value of the `X` button
  107224. */
  107225. buttonX: number;
  107226. /**
  107227. * Gets the value of the `Y` button
  107228. */
  107229. /**
  107230. * Sets the value of the `Y` button
  107231. */
  107232. buttonY: number;
  107233. /**
  107234. * Gets the value of the `Start` button
  107235. */
  107236. /**
  107237. * Sets the value of the `Start` button
  107238. */
  107239. buttonStart: number;
  107240. /**
  107241. * Gets the value of the `Back` button
  107242. */
  107243. /**
  107244. * Sets the value of the `Back` button
  107245. */
  107246. buttonBack: number;
  107247. /**
  107248. * Gets the value of the `Left` button
  107249. */
  107250. /**
  107251. * Sets the value of the `Left` button
  107252. */
  107253. buttonLB: number;
  107254. /**
  107255. * Gets the value of the `Right` button
  107256. */
  107257. /**
  107258. * Sets the value of the `Right` button
  107259. */
  107260. buttonRB: number;
  107261. /**
  107262. * Gets the value of the Left joystick
  107263. */
  107264. /**
  107265. * Sets the value of the Left joystick
  107266. */
  107267. buttonLeftStick: number;
  107268. /**
  107269. * Gets the value of the Right joystick
  107270. */
  107271. /**
  107272. * Sets the value of the Right joystick
  107273. */
  107274. buttonRightStick: number;
  107275. /**
  107276. * Gets the value of D-pad up
  107277. */
  107278. /**
  107279. * Sets the value of D-pad up
  107280. */
  107281. dPadUp: number;
  107282. /**
  107283. * Gets the value of D-pad down
  107284. */
  107285. /**
  107286. * Sets the value of D-pad down
  107287. */
  107288. dPadDown: number;
  107289. /**
  107290. * Gets the value of D-pad left
  107291. */
  107292. /**
  107293. * Sets the value of D-pad left
  107294. */
  107295. dPadLeft: number;
  107296. /**
  107297. * Gets the value of D-pad right
  107298. */
  107299. /**
  107300. * Sets the value of D-pad right
  107301. */
  107302. dPadRight: number;
  107303. /**
  107304. * Force the gamepad to synchronize with device values
  107305. */
  107306. update(): void;
  107307. /**
  107308. * Disposes the gamepad
  107309. */
  107310. dispose(): void;
  107311. }
  107312. }
  107313. declare module BABYLON {
  107314. /**
  107315. * Defines supported buttons for DualShock compatible gamepads
  107316. */
  107317. export enum DualShockButton {
  107318. /** Cross */
  107319. Cross = 0,
  107320. /** Circle */
  107321. Circle = 1,
  107322. /** Square */
  107323. Square = 2,
  107324. /** Triangle */
  107325. Triangle = 3,
  107326. /** Options */
  107327. Options = 4,
  107328. /** Share */
  107329. Share = 5,
  107330. /** L1 */
  107331. L1 = 6,
  107332. /** R1 */
  107333. R1 = 7,
  107334. /** Left stick */
  107335. LeftStick = 8,
  107336. /** Right stick */
  107337. RightStick = 9
  107338. }
  107339. /** Defines values for DualShock DPad */
  107340. export enum DualShockDpad {
  107341. /** Up */
  107342. Up = 0,
  107343. /** Down */
  107344. Down = 1,
  107345. /** Left */
  107346. Left = 2,
  107347. /** Right */
  107348. Right = 3
  107349. }
  107350. /**
  107351. * Defines a DualShock gamepad
  107352. */
  107353. export class DualShockPad extends Gamepad {
  107354. private _leftTrigger;
  107355. private _rightTrigger;
  107356. private _onlefttriggerchanged;
  107357. private _onrighttriggerchanged;
  107358. private _onbuttondown;
  107359. private _onbuttonup;
  107360. private _ondpaddown;
  107361. private _ondpadup;
  107362. /** Observable raised when a button is pressed */
  107363. onButtonDownObservable: Observable<DualShockButton>;
  107364. /** Observable raised when a button is released */
  107365. onButtonUpObservable: Observable<DualShockButton>;
  107366. /** Observable raised when a pad is pressed */
  107367. onPadDownObservable: Observable<DualShockDpad>;
  107368. /** Observable raised when a pad is released */
  107369. onPadUpObservable: Observable<DualShockDpad>;
  107370. private _buttonCross;
  107371. private _buttonCircle;
  107372. private _buttonSquare;
  107373. private _buttonTriangle;
  107374. private _buttonShare;
  107375. private _buttonOptions;
  107376. private _buttonL1;
  107377. private _buttonR1;
  107378. private _buttonLeftStick;
  107379. private _buttonRightStick;
  107380. private _dPadUp;
  107381. private _dPadDown;
  107382. private _dPadLeft;
  107383. private _dPadRight;
  107384. /**
  107385. * Creates a new DualShock gamepad object
  107386. * @param id defines the id of this gamepad
  107387. * @param index defines its index
  107388. * @param gamepad defines the internal HTML gamepad object
  107389. */
  107390. constructor(id: string, index: number, gamepad: any);
  107391. /**
  107392. * Defines the callback to call when left trigger is pressed
  107393. * @param callback defines the callback to use
  107394. */
  107395. onlefttriggerchanged(callback: (value: number) => void): void;
  107396. /**
  107397. * Defines the callback to call when right trigger is pressed
  107398. * @param callback defines the callback to use
  107399. */
  107400. onrighttriggerchanged(callback: (value: number) => void): void;
  107401. /**
  107402. * Gets the left trigger value
  107403. */
  107404. /**
  107405. * Sets the left trigger value
  107406. */
  107407. leftTrigger: number;
  107408. /**
  107409. * Gets the right trigger value
  107410. */
  107411. /**
  107412. * Sets the right trigger value
  107413. */
  107414. rightTrigger: number;
  107415. /**
  107416. * Defines the callback to call when a button is pressed
  107417. * @param callback defines the callback to use
  107418. */
  107419. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  107420. /**
  107421. * Defines the callback to call when a button is released
  107422. * @param callback defines the callback to use
  107423. */
  107424. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  107425. /**
  107426. * Defines the callback to call when a pad is pressed
  107427. * @param callback defines the callback to use
  107428. */
  107429. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  107430. /**
  107431. * Defines the callback to call when a pad is released
  107432. * @param callback defines the callback to use
  107433. */
  107434. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  107435. private _setButtonValue;
  107436. private _setDPadValue;
  107437. /**
  107438. * Gets the value of the `Cross` button
  107439. */
  107440. /**
  107441. * Sets the value of the `Cross` button
  107442. */
  107443. buttonCross: number;
  107444. /**
  107445. * Gets the value of the `Circle` button
  107446. */
  107447. /**
  107448. * Sets the value of the `Circle` button
  107449. */
  107450. buttonCircle: number;
  107451. /**
  107452. * Gets the value of the `Square` button
  107453. */
  107454. /**
  107455. * Sets the value of the `Square` button
  107456. */
  107457. buttonSquare: number;
  107458. /**
  107459. * Gets the value of the `Triangle` button
  107460. */
  107461. /**
  107462. * Sets the value of the `Triangle` button
  107463. */
  107464. buttonTriangle: number;
  107465. /**
  107466. * Gets the value of the `Options` button
  107467. */
  107468. /**
  107469. * Sets the value of the `Options` button
  107470. */
  107471. buttonOptions: number;
  107472. /**
  107473. * Gets the value of the `Share` button
  107474. */
  107475. /**
  107476. * Sets the value of the `Share` button
  107477. */
  107478. buttonShare: number;
  107479. /**
  107480. * Gets the value of the `L1` button
  107481. */
  107482. /**
  107483. * Sets the value of the `L1` button
  107484. */
  107485. buttonL1: number;
  107486. /**
  107487. * Gets the value of the `R1` button
  107488. */
  107489. /**
  107490. * Sets the value of the `R1` button
  107491. */
  107492. buttonR1: number;
  107493. /**
  107494. * Gets the value of the Left joystick
  107495. */
  107496. /**
  107497. * Sets the value of the Left joystick
  107498. */
  107499. buttonLeftStick: number;
  107500. /**
  107501. * Gets the value of the Right joystick
  107502. */
  107503. /**
  107504. * Sets the value of the Right joystick
  107505. */
  107506. buttonRightStick: number;
  107507. /**
  107508. * Gets the value of D-pad up
  107509. */
  107510. /**
  107511. * Sets the value of D-pad up
  107512. */
  107513. dPadUp: number;
  107514. /**
  107515. * Gets the value of D-pad down
  107516. */
  107517. /**
  107518. * Sets the value of D-pad down
  107519. */
  107520. dPadDown: number;
  107521. /**
  107522. * Gets the value of D-pad left
  107523. */
  107524. /**
  107525. * Sets the value of D-pad left
  107526. */
  107527. dPadLeft: number;
  107528. /**
  107529. * Gets the value of D-pad right
  107530. */
  107531. /**
  107532. * Sets the value of D-pad right
  107533. */
  107534. dPadRight: number;
  107535. /**
  107536. * Force the gamepad to synchronize with device values
  107537. */
  107538. update(): void;
  107539. /**
  107540. * Disposes the gamepad
  107541. */
  107542. dispose(): void;
  107543. }
  107544. }
  107545. declare module BABYLON {
  107546. /**
  107547. * Manager for handling gamepads
  107548. */
  107549. export class GamepadManager {
  107550. private _scene?;
  107551. private _babylonGamepads;
  107552. private _oneGamepadConnected;
  107553. /** @hidden */
  107554. _isMonitoring: boolean;
  107555. private _gamepadEventSupported;
  107556. private _gamepadSupport;
  107557. /**
  107558. * observable to be triggered when the gamepad controller has been connected
  107559. */
  107560. onGamepadConnectedObservable: Observable<Gamepad>;
  107561. /**
  107562. * observable to be triggered when the gamepad controller has been disconnected
  107563. */
  107564. onGamepadDisconnectedObservable: Observable<Gamepad>;
  107565. private _onGamepadConnectedEvent;
  107566. private _onGamepadDisconnectedEvent;
  107567. /**
  107568. * Initializes the gamepad manager
  107569. * @param _scene BabylonJS scene
  107570. */
  107571. constructor(_scene?: Scene | undefined);
  107572. /**
  107573. * The gamepads in the game pad manager
  107574. */
  107575. readonly gamepads: Gamepad[];
  107576. /**
  107577. * Get the gamepad controllers based on type
  107578. * @param type The type of gamepad controller
  107579. * @returns Nullable gamepad
  107580. */
  107581. getGamepadByType(type?: number): Nullable<Gamepad>;
  107582. /**
  107583. * Disposes the gamepad manager
  107584. */
  107585. dispose(): void;
  107586. private _addNewGamepad;
  107587. private _startMonitoringGamepads;
  107588. private _stopMonitoringGamepads;
  107589. /** @hidden */
  107590. _checkGamepadsStatus(): void;
  107591. private _updateGamepadObjects;
  107592. }
  107593. }
  107594. declare module BABYLON {
  107595. interface Scene {
  107596. /** @hidden */
  107597. _gamepadManager: Nullable<GamepadManager>;
  107598. /**
  107599. * Gets the gamepad manager associated with the scene
  107600. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  107601. */
  107602. gamepadManager: GamepadManager;
  107603. }
  107604. /**
  107605. * Interface representing a free camera inputs manager
  107606. */
  107607. interface FreeCameraInputsManager {
  107608. /**
  107609. * Adds gamepad input support to the FreeCameraInputsManager.
  107610. * @returns the FreeCameraInputsManager
  107611. */
  107612. addGamepad(): FreeCameraInputsManager;
  107613. }
  107614. /**
  107615. * Interface representing an arc rotate camera inputs manager
  107616. */
  107617. interface ArcRotateCameraInputsManager {
  107618. /**
  107619. * Adds gamepad input support to the ArcRotateCamera InputManager.
  107620. * @returns the camera inputs manager
  107621. */
  107622. addGamepad(): ArcRotateCameraInputsManager;
  107623. }
  107624. /**
  107625. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  107626. */
  107627. export class GamepadSystemSceneComponent implements ISceneComponent {
  107628. /**
  107629. * The component name helpfull to identify the component in the list of scene components.
  107630. */
  107631. readonly name: string;
  107632. /**
  107633. * The scene the component belongs to.
  107634. */
  107635. scene: Scene;
  107636. /**
  107637. * Creates a new instance of the component for the given scene
  107638. * @param scene Defines the scene to register the component in
  107639. */
  107640. constructor(scene: Scene);
  107641. /**
  107642. * Registers the component in a given scene
  107643. */
  107644. register(): void;
  107645. /**
  107646. * Rebuilds the elements related to this component in case of
  107647. * context lost for instance.
  107648. */
  107649. rebuild(): void;
  107650. /**
  107651. * Disposes the component and the associated ressources
  107652. */
  107653. dispose(): void;
  107654. private _beforeCameraUpdate;
  107655. }
  107656. }
  107657. declare module BABYLON {
  107658. /**
  107659. * The Universal Camera is the one to choose for first person shooter type games, and works with all the keyboard, mouse, touch and gamepads. This replaces the earlier Free Camera,
  107660. * which still works and will still be found in many Playgrounds.
  107661. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107662. */
  107663. export class UniversalCamera extends TouchCamera {
  107664. /**
  107665. * Defines the gamepad rotation sensiblity.
  107666. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  107667. */
  107668. gamepadAngularSensibility: number;
  107669. /**
  107670. * Defines the gamepad move sensiblity.
  107671. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  107672. */
  107673. gamepadMoveSensibility: number;
  107674. /**
  107675. * The Universal Camera is the one to choose for first person shooter type games, and works with all the keyboard, mouse, touch and gamepads. This replaces the earlier Free Camera,
  107676. * which still works and will still be found in many Playgrounds.
  107677. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107678. * @param name Define the name of the camera in the scene
  107679. * @param position Define the start position of the camera in the scene
  107680. * @param scene Define the scene the camera belongs to
  107681. */
  107682. constructor(name: string, position: Vector3, scene: Scene);
  107683. /**
  107684. * Gets the current object class name.
  107685. * @return the class name
  107686. */
  107687. getClassName(): string;
  107688. }
  107689. }
  107690. declare module BABYLON {
  107691. /**
  107692. * This represents a FPS type of camera. This is only here for back compat purpose.
  107693. * Please use the UniversalCamera instead as both are identical.
  107694. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107695. */
  107696. export class GamepadCamera extends UniversalCamera {
  107697. /**
  107698. * Instantiates a new Gamepad Camera
  107699. * This represents a FPS type of camera. This is only here for back compat purpose.
  107700. * Please use the UniversalCamera instead as both are identical.
  107701. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107702. * @param name Define the name of the camera in the scene
  107703. * @param position Define the start position of the camera in the scene
  107704. * @param scene Define the scene the camera belongs to
  107705. */
  107706. constructor(name: string, position: Vector3, scene: Scene);
  107707. /**
  107708. * Gets the current object class name.
  107709. * @return the class name
  107710. */
  107711. getClassName(): string;
  107712. }
  107713. }
  107714. declare module BABYLON {
  107715. /** @hidden */
  107716. export var passPixelShader: {
  107717. name: string;
  107718. shader: string;
  107719. };
  107720. }
  107721. declare module BABYLON {
  107722. /** @hidden */
  107723. export var passCubePixelShader: {
  107724. name: string;
  107725. shader: string;
  107726. };
  107727. }
  107728. declare module BABYLON {
  107729. /**
  107730. * PassPostProcess which produces an output the same as it's input
  107731. */
  107732. export class PassPostProcess extends PostProcess {
  107733. /**
  107734. * Creates the PassPostProcess
  107735. * @param name The name of the effect.
  107736. * @param options The required width/height ratio to downsize to before computing the render pass.
  107737. * @param camera The camera to apply the render pass to.
  107738. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  107739. * @param engine The engine which the post process will be applied. (default: current engine)
  107740. * @param reusable If the post process can be reused on the same frame. (default: false)
  107741. * @param textureType The type of texture to be used when performing the post processing.
  107742. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  107743. */
  107744. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  107745. }
  107746. /**
  107747. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  107748. */
  107749. export class PassCubePostProcess extends PostProcess {
  107750. private _face;
  107751. /**
  107752. * Gets or sets the cube face to display.
  107753. * * 0 is +X
  107754. * * 1 is -X
  107755. * * 2 is +Y
  107756. * * 3 is -Y
  107757. * * 4 is +Z
  107758. * * 5 is -Z
  107759. */
  107760. face: number;
  107761. /**
  107762. * Creates the PassCubePostProcess
  107763. * @param name The name of the effect.
  107764. * @param options The required width/height ratio to downsize to before computing the render pass.
  107765. * @param camera The camera to apply the render pass to.
  107766. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  107767. * @param engine The engine which the post process will be applied. (default: current engine)
  107768. * @param reusable If the post process can be reused on the same frame. (default: false)
  107769. * @param textureType The type of texture to be used when performing the post processing.
  107770. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  107771. */
  107772. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  107773. }
  107774. }
  107775. declare module BABYLON {
  107776. /** @hidden */
  107777. export var anaglyphPixelShader: {
  107778. name: string;
  107779. shader: string;
  107780. };
  107781. }
  107782. declare module BABYLON {
  107783. /**
  107784. * Postprocess used to generate anaglyphic rendering
  107785. */
  107786. export class AnaglyphPostProcess extends PostProcess {
  107787. private _passedProcess;
  107788. /**
  107789. * Creates a new AnaglyphPostProcess
  107790. * @param name defines postprocess name
  107791. * @param options defines creation options or target ratio scale
  107792. * @param rigCameras defines cameras using this postprocess
  107793. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  107794. * @param engine defines hosting engine
  107795. * @param reusable defines if the postprocess will be reused multiple times per frame
  107796. */
  107797. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  107798. }
  107799. }
  107800. declare module BABYLON {
  107801. /**
  107802. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  107803. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107804. */
  107805. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  107806. /**
  107807. * Creates a new AnaglyphArcRotateCamera
  107808. * @param name defines camera name
  107809. * @param alpha defines alpha angle (in radians)
  107810. * @param beta defines beta angle (in radians)
  107811. * @param radius defines radius
  107812. * @param target defines camera target
  107813. * @param interaxialDistance defines distance between each color axis
  107814. * @param scene defines the hosting scene
  107815. */
  107816. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  107817. /**
  107818. * Gets camera class name
  107819. * @returns AnaglyphArcRotateCamera
  107820. */
  107821. getClassName(): string;
  107822. }
  107823. }
  107824. declare module BABYLON {
  107825. /**
  107826. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  107827. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107828. */
  107829. export class AnaglyphFreeCamera extends FreeCamera {
  107830. /**
  107831. * Creates a new AnaglyphFreeCamera
  107832. * @param name defines camera name
  107833. * @param position defines initial position
  107834. * @param interaxialDistance defines distance between each color axis
  107835. * @param scene defines the hosting scene
  107836. */
  107837. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  107838. /**
  107839. * Gets camera class name
  107840. * @returns AnaglyphFreeCamera
  107841. */
  107842. getClassName(): string;
  107843. }
  107844. }
  107845. declare module BABYLON {
  107846. /**
  107847. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  107848. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107849. */
  107850. export class AnaglyphGamepadCamera extends GamepadCamera {
  107851. /**
  107852. * Creates a new AnaglyphGamepadCamera
  107853. * @param name defines camera name
  107854. * @param position defines initial position
  107855. * @param interaxialDistance defines distance between each color axis
  107856. * @param scene defines the hosting scene
  107857. */
  107858. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  107859. /**
  107860. * Gets camera class name
  107861. * @returns AnaglyphGamepadCamera
  107862. */
  107863. getClassName(): string;
  107864. }
  107865. }
  107866. declare module BABYLON {
  107867. /**
  107868. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  107869. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  107870. */
  107871. export class AnaglyphUniversalCamera extends UniversalCamera {
  107872. /**
  107873. * Creates a new AnaglyphUniversalCamera
  107874. * @param name defines camera name
  107875. * @param position defines initial position
  107876. * @param interaxialDistance defines distance between each color axis
  107877. * @param scene defines the hosting scene
  107878. */
  107879. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  107880. /**
  107881. * Gets camera class name
  107882. * @returns AnaglyphUniversalCamera
  107883. */
  107884. getClassName(): string;
  107885. }
  107886. }
  107887. declare module BABYLON {
  107888. /** @hidden */
  107889. export var stereoscopicInterlacePixelShader: {
  107890. name: string;
  107891. shader: string;
  107892. };
  107893. }
  107894. declare module BABYLON {
  107895. /**
  107896. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  107897. */
  107898. export class StereoscopicInterlacePostProcess extends PostProcess {
  107899. private _stepSize;
  107900. private _passedProcess;
  107901. /**
  107902. * Initializes a StereoscopicInterlacePostProcess
  107903. * @param name The name of the effect.
  107904. * @param rigCameras The rig cameras to be appled to the post process
  107905. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  107906. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  107907. * @param engine The engine which the post process will be applied. (default: current engine)
  107908. * @param reusable If the post process can be reused on the same frame. (default: false)
  107909. */
  107910. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  107911. }
  107912. }
  107913. declare module BABYLON {
  107914. /**
  107915. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  107916. * @see http://doc.babylonjs.com/features/cameras
  107917. */
  107918. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  107919. /**
  107920. * Creates a new StereoscopicArcRotateCamera
  107921. * @param name defines camera name
  107922. * @param alpha defines alpha angle (in radians)
  107923. * @param beta defines beta angle (in radians)
  107924. * @param radius defines radius
  107925. * @param target defines camera target
  107926. * @param interaxialDistance defines distance between each color axis
  107927. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107928. * @param scene defines the hosting scene
  107929. */
  107930. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107931. /**
  107932. * Gets camera class name
  107933. * @returns StereoscopicArcRotateCamera
  107934. */
  107935. getClassName(): string;
  107936. }
  107937. }
  107938. declare module BABYLON {
  107939. /**
  107940. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  107941. * @see http://doc.babylonjs.com/features/cameras
  107942. */
  107943. export class StereoscopicFreeCamera extends FreeCamera {
  107944. /**
  107945. * Creates a new StereoscopicFreeCamera
  107946. * @param name defines camera name
  107947. * @param position defines initial position
  107948. * @param interaxialDistance defines distance between each color axis
  107949. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107950. * @param scene defines the hosting scene
  107951. */
  107952. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107953. /**
  107954. * Gets camera class name
  107955. * @returns StereoscopicFreeCamera
  107956. */
  107957. getClassName(): string;
  107958. }
  107959. }
  107960. declare module BABYLON {
  107961. /**
  107962. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  107963. * @see http://doc.babylonjs.com/features/cameras
  107964. */
  107965. export class StereoscopicGamepadCamera extends GamepadCamera {
  107966. /**
  107967. * Creates a new StereoscopicGamepadCamera
  107968. * @param name defines camera name
  107969. * @param position defines initial position
  107970. * @param interaxialDistance defines distance between each color axis
  107971. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107972. * @param scene defines the hosting scene
  107973. */
  107974. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107975. /**
  107976. * Gets camera class name
  107977. * @returns StereoscopicGamepadCamera
  107978. */
  107979. getClassName(): string;
  107980. }
  107981. }
  107982. declare module BABYLON {
  107983. /**
  107984. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  107985. * @see http://doc.babylonjs.com/features/cameras
  107986. */
  107987. export class StereoscopicUniversalCamera extends UniversalCamera {
  107988. /**
  107989. * Creates a new StereoscopicUniversalCamera
  107990. * @param name defines camera name
  107991. * @param position defines initial position
  107992. * @param interaxialDistance defines distance between each color axis
  107993. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  107994. * @param scene defines the hosting scene
  107995. */
  107996. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  107997. /**
  107998. * Gets camera class name
  107999. * @returns StereoscopicUniversalCamera
  108000. */
  108001. getClassName(): string;
  108002. }
  108003. }
  108004. declare module BABYLON {
  108005. /**
  108006. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  108007. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  108008. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  108009. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  108010. */
  108011. export class VirtualJoysticksCamera extends FreeCamera {
  108012. /**
  108013. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  108014. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  108015. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  108016. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  108017. * @param name Define the name of the camera in the scene
  108018. * @param position Define the start position of the camera in the scene
  108019. * @param scene Define the scene the camera belongs to
  108020. */
  108021. constructor(name: string, position: Vector3, scene: Scene);
  108022. /**
  108023. * Gets the current object class name.
  108024. * @return the class name
  108025. */
  108026. getClassName(): string;
  108027. }
  108028. }
  108029. declare module BABYLON {
  108030. /**
  108031. * This represents all the required metrics to create a VR camera.
  108032. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  108033. */
  108034. export class VRCameraMetrics {
  108035. /**
  108036. * Define the horizontal resolution off the screen.
  108037. */
  108038. hResolution: number;
  108039. /**
  108040. * Define the vertical resolution off the screen.
  108041. */
  108042. vResolution: number;
  108043. /**
  108044. * Define the horizontal screen size.
  108045. */
  108046. hScreenSize: number;
  108047. /**
  108048. * Define the vertical screen size.
  108049. */
  108050. vScreenSize: number;
  108051. /**
  108052. * Define the vertical screen center position.
  108053. */
  108054. vScreenCenter: number;
  108055. /**
  108056. * Define the distance of the eyes to the screen.
  108057. */
  108058. eyeToScreenDistance: number;
  108059. /**
  108060. * Define the distance between both lenses
  108061. */
  108062. lensSeparationDistance: number;
  108063. /**
  108064. * Define the distance between both viewer's eyes.
  108065. */
  108066. interpupillaryDistance: number;
  108067. /**
  108068. * Define the distortion factor of the VR postprocess.
  108069. * Please, touch with care.
  108070. */
  108071. distortionK: number[];
  108072. /**
  108073. * Define the chromatic aberration correction factors for the VR post process.
  108074. */
  108075. chromaAbCorrection: number[];
  108076. /**
  108077. * Define the scale factor of the post process.
  108078. * The smaller the better but the slower.
  108079. */
  108080. postProcessScaleFactor: number;
  108081. /**
  108082. * Define an offset for the lens center.
  108083. */
  108084. lensCenterOffset: number;
  108085. /**
  108086. * Define if the current vr camera should compensate the distortion of the lense or not.
  108087. */
  108088. compensateDistortion: boolean;
  108089. /**
  108090. * Defines if multiview should be enabled when rendering (Default: false)
  108091. */
  108092. multiviewEnabled: boolean;
  108093. /**
  108094. * Gets the rendering aspect ratio based on the provided resolutions.
  108095. */
  108096. readonly aspectRatio: number;
  108097. /**
  108098. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  108099. */
  108100. readonly aspectRatioFov: number;
  108101. /**
  108102. * @hidden
  108103. */
  108104. readonly leftHMatrix: Matrix;
  108105. /**
  108106. * @hidden
  108107. */
  108108. readonly rightHMatrix: Matrix;
  108109. /**
  108110. * @hidden
  108111. */
  108112. readonly leftPreViewMatrix: Matrix;
  108113. /**
  108114. * @hidden
  108115. */
  108116. readonly rightPreViewMatrix: Matrix;
  108117. /**
  108118. * Get the default VRMetrics based on the most generic setup.
  108119. * @returns the default vr metrics
  108120. */
  108121. static GetDefault(): VRCameraMetrics;
  108122. }
  108123. }
  108124. declare module BABYLON {
  108125. /** @hidden */
  108126. export var vrDistortionCorrectionPixelShader: {
  108127. name: string;
  108128. shader: string;
  108129. };
  108130. }
  108131. declare module BABYLON {
  108132. /**
  108133. * VRDistortionCorrectionPostProcess used for mobile VR
  108134. */
  108135. export class VRDistortionCorrectionPostProcess extends PostProcess {
  108136. private _isRightEye;
  108137. private _distortionFactors;
  108138. private _postProcessScaleFactor;
  108139. private _lensCenterOffset;
  108140. private _scaleIn;
  108141. private _scaleFactor;
  108142. private _lensCenter;
  108143. /**
  108144. * Initializes the VRDistortionCorrectionPostProcess
  108145. * @param name The name of the effect.
  108146. * @param camera The camera to apply the render pass to.
  108147. * @param isRightEye If this is for the right eye distortion
  108148. * @param vrMetrics All the required metrics for the VR camera
  108149. */
  108150. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  108151. }
  108152. }
  108153. declare module BABYLON {
  108154. /**
  108155. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  108156. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  108157. */
  108158. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  108159. /**
  108160. * Creates a new VRDeviceOrientationArcRotateCamera
  108161. * @param name defines camera name
  108162. * @param alpha defines the camera rotation along the logitudinal axis
  108163. * @param beta defines the camera rotation along the latitudinal axis
  108164. * @param radius defines the camera distance from its target
  108165. * @param target defines the camera target
  108166. * @param scene defines the scene the camera belongs to
  108167. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  108168. * @param vrCameraMetrics defines the vr metrics associated to the camera
  108169. */
  108170. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  108171. /**
  108172. * Gets camera class name
  108173. * @returns VRDeviceOrientationArcRotateCamera
  108174. */
  108175. getClassName(): string;
  108176. }
  108177. }
  108178. declare module BABYLON {
  108179. /**
  108180. * Camera used to simulate VR rendering (based on FreeCamera)
  108181. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  108182. */
  108183. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  108184. /**
  108185. * Creates a new VRDeviceOrientationFreeCamera
  108186. * @param name defines camera name
  108187. * @param position defines the start position of the camera
  108188. * @param scene defines the scene the camera belongs to
  108189. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  108190. * @param vrCameraMetrics defines the vr metrics associated to the camera
  108191. */
  108192. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  108193. /**
  108194. * Gets camera class name
  108195. * @returns VRDeviceOrientationFreeCamera
  108196. */
  108197. getClassName(): string;
  108198. }
  108199. }
  108200. declare module BABYLON {
  108201. /**
  108202. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  108203. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  108204. */
  108205. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  108206. /**
  108207. * Creates a new VRDeviceOrientationGamepadCamera
  108208. * @param name defines camera name
  108209. * @param position defines the start position of the camera
  108210. * @param scene defines the scene the camera belongs to
  108211. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  108212. * @param vrCameraMetrics defines the vr metrics associated to the camera
  108213. */
  108214. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  108215. /**
  108216. * Gets camera class name
  108217. * @returns VRDeviceOrientationGamepadCamera
  108218. */
  108219. getClassName(): string;
  108220. }
  108221. }
  108222. declare module BABYLON {
  108223. /**
  108224. * Base class of materials working in push mode in babylon JS
  108225. * @hidden
  108226. */
  108227. export class PushMaterial extends Material {
  108228. protected _activeEffect: Effect;
  108229. protected _normalMatrix: Matrix;
  108230. /**
  108231. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  108232. * This means that the material can keep using a previous shader while a new one is being compiled.
  108233. * This is mostly used when shader parallel compilation is supported (true by default)
  108234. */
  108235. allowShaderHotSwapping: boolean;
  108236. constructor(name: string, scene: Scene);
  108237. getEffect(): Effect;
  108238. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  108239. /**
  108240. * Binds the given world matrix to the active effect
  108241. *
  108242. * @param world the matrix to bind
  108243. */
  108244. bindOnlyWorldMatrix(world: Matrix): void;
  108245. /**
  108246. * Binds the given normal matrix to the active effect
  108247. *
  108248. * @param normalMatrix the matrix to bind
  108249. */
  108250. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  108251. bind(world: Matrix, mesh?: Mesh): void;
  108252. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  108253. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  108254. }
  108255. }
  108256. declare module BABYLON {
  108257. /**
  108258. * This groups all the flags used to control the materials channel.
  108259. */
  108260. export class MaterialFlags {
  108261. private static _DiffuseTextureEnabled;
  108262. /**
  108263. * Are diffuse textures enabled in the application.
  108264. */
  108265. static DiffuseTextureEnabled: boolean;
  108266. private static _AmbientTextureEnabled;
  108267. /**
  108268. * Are ambient textures enabled in the application.
  108269. */
  108270. static AmbientTextureEnabled: boolean;
  108271. private static _OpacityTextureEnabled;
  108272. /**
  108273. * Are opacity textures enabled in the application.
  108274. */
  108275. static OpacityTextureEnabled: boolean;
  108276. private static _ReflectionTextureEnabled;
  108277. /**
  108278. * Are reflection textures enabled in the application.
  108279. */
  108280. static ReflectionTextureEnabled: boolean;
  108281. private static _EmissiveTextureEnabled;
  108282. /**
  108283. * Are emissive textures enabled in the application.
  108284. */
  108285. static EmissiveTextureEnabled: boolean;
  108286. private static _SpecularTextureEnabled;
  108287. /**
  108288. * Are specular textures enabled in the application.
  108289. */
  108290. static SpecularTextureEnabled: boolean;
  108291. private static _BumpTextureEnabled;
  108292. /**
  108293. * Are bump textures enabled in the application.
  108294. */
  108295. static BumpTextureEnabled: boolean;
  108296. private static _LightmapTextureEnabled;
  108297. /**
  108298. * Are lightmap textures enabled in the application.
  108299. */
  108300. static LightmapTextureEnabled: boolean;
  108301. private static _RefractionTextureEnabled;
  108302. /**
  108303. * Are refraction textures enabled in the application.
  108304. */
  108305. static RefractionTextureEnabled: boolean;
  108306. private static _ColorGradingTextureEnabled;
  108307. /**
  108308. * Are color grading textures enabled in the application.
  108309. */
  108310. static ColorGradingTextureEnabled: boolean;
  108311. private static _FresnelEnabled;
  108312. /**
  108313. * Are fresnels enabled in the application.
  108314. */
  108315. static FresnelEnabled: boolean;
  108316. private static _ClearCoatTextureEnabled;
  108317. /**
  108318. * Are clear coat textures enabled in the application.
  108319. */
  108320. static ClearCoatTextureEnabled: boolean;
  108321. private static _ClearCoatBumpTextureEnabled;
  108322. /**
  108323. * Are clear coat bump textures enabled in the application.
  108324. */
  108325. static ClearCoatBumpTextureEnabled: boolean;
  108326. private static _ClearCoatTintTextureEnabled;
  108327. /**
  108328. * Are clear coat tint textures enabled in the application.
  108329. */
  108330. static ClearCoatTintTextureEnabled: boolean;
  108331. private static _SheenTextureEnabled;
  108332. /**
  108333. * Are sheen textures enabled in the application.
  108334. */
  108335. static SheenTextureEnabled: boolean;
  108336. private static _AnisotropicTextureEnabled;
  108337. /**
  108338. * Are anisotropic textures enabled in the application.
  108339. */
  108340. static AnisotropicTextureEnabled: boolean;
  108341. private static _ThicknessTextureEnabled;
  108342. /**
  108343. * Are thickness textures enabled in the application.
  108344. */
  108345. static ThicknessTextureEnabled: boolean;
  108346. }
  108347. }
  108348. declare module BABYLON {
  108349. /** @hidden */
  108350. export var defaultFragmentDeclaration: {
  108351. name: string;
  108352. shader: string;
  108353. };
  108354. }
  108355. declare module BABYLON {
  108356. /** @hidden */
  108357. export var defaultUboDeclaration: {
  108358. name: string;
  108359. shader: string;
  108360. };
  108361. }
  108362. declare module BABYLON {
  108363. /** @hidden */
  108364. export var lightFragmentDeclaration: {
  108365. name: string;
  108366. shader: string;
  108367. };
  108368. }
  108369. declare module BABYLON {
  108370. /** @hidden */
  108371. export var lightUboDeclaration: {
  108372. name: string;
  108373. shader: string;
  108374. };
  108375. }
  108376. declare module BABYLON {
  108377. /** @hidden */
  108378. export var lightsFragmentFunctions: {
  108379. name: string;
  108380. shader: string;
  108381. };
  108382. }
  108383. declare module BABYLON {
  108384. /** @hidden */
  108385. export var shadowsFragmentFunctions: {
  108386. name: string;
  108387. shader: string;
  108388. };
  108389. }
  108390. declare module BABYLON {
  108391. /** @hidden */
  108392. export var fresnelFunction: {
  108393. name: string;
  108394. shader: string;
  108395. };
  108396. }
  108397. declare module BABYLON {
  108398. /** @hidden */
  108399. export var reflectionFunction: {
  108400. name: string;
  108401. shader: string;
  108402. };
  108403. }
  108404. declare module BABYLON {
  108405. /** @hidden */
  108406. export var bumpFragmentFunctions: {
  108407. name: string;
  108408. shader: string;
  108409. };
  108410. }
  108411. declare module BABYLON {
  108412. /** @hidden */
  108413. export var logDepthDeclaration: {
  108414. name: string;
  108415. shader: string;
  108416. };
  108417. }
  108418. declare module BABYLON {
  108419. /** @hidden */
  108420. export var bumpFragment: {
  108421. name: string;
  108422. shader: string;
  108423. };
  108424. }
  108425. declare module BABYLON {
  108426. /** @hidden */
  108427. export var depthPrePass: {
  108428. name: string;
  108429. shader: string;
  108430. };
  108431. }
  108432. declare module BABYLON {
  108433. /** @hidden */
  108434. export var lightFragment: {
  108435. name: string;
  108436. shader: string;
  108437. };
  108438. }
  108439. declare module BABYLON {
  108440. /** @hidden */
  108441. export var logDepthFragment: {
  108442. name: string;
  108443. shader: string;
  108444. };
  108445. }
  108446. declare module BABYLON {
  108447. /** @hidden */
  108448. export var defaultPixelShader: {
  108449. name: string;
  108450. shader: string;
  108451. };
  108452. }
  108453. declare module BABYLON {
  108454. /** @hidden */
  108455. export var defaultVertexDeclaration: {
  108456. name: string;
  108457. shader: string;
  108458. };
  108459. }
  108460. declare module BABYLON {
  108461. /** @hidden */
  108462. export var bumpVertexDeclaration: {
  108463. name: string;
  108464. shader: string;
  108465. };
  108466. }
  108467. declare module BABYLON {
  108468. /** @hidden */
  108469. export var bumpVertex: {
  108470. name: string;
  108471. shader: string;
  108472. };
  108473. }
  108474. declare module BABYLON {
  108475. /** @hidden */
  108476. export var fogVertex: {
  108477. name: string;
  108478. shader: string;
  108479. };
  108480. }
  108481. declare module BABYLON {
  108482. /** @hidden */
  108483. export var shadowsVertex: {
  108484. name: string;
  108485. shader: string;
  108486. };
  108487. }
  108488. declare module BABYLON {
  108489. /** @hidden */
  108490. export var pointCloudVertex: {
  108491. name: string;
  108492. shader: string;
  108493. };
  108494. }
  108495. declare module BABYLON {
  108496. /** @hidden */
  108497. export var logDepthVertex: {
  108498. name: string;
  108499. shader: string;
  108500. };
  108501. }
  108502. declare module BABYLON {
  108503. /** @hidden */
  108504. export var defaultVertexShader: {
  108505. name: string;
  108506. shader: string;
  108507. };
  108508. }
  108509. declare module BABYLON {
  108510. /** @hidden */
  108511. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  108512. MAINUV1: boolean;
  108513. MAINUV2: boolean;
  108514. DIFFUSE: boolean;
  108515. DIFFUSEDIRECTUV: number;
  108516. AMBIENT: boolean;
  108517. AMBIENTDIRECTUV: number;
  108518. OPACITY: boolean;
  108519. OPACITYDIRECTUV: number;
  108520. OPACITYRGB: boolean;
  108521. REFLECTION: boolean;
  108522. EMISSIVE: boolean;
  108523. EMISSIVEDIRECTUV: number;
  108524. SPECULAR: boolean;
  108525. SPECULARDIRECTUV: number;
  108526. BUMP: boolean;
  108527. BUMPDIRECTUV: number;
  108528. PARALLAX: boolean;
  108529. PARALLAXOCCLUSION: boolean;
  108530. SPECULAROVERALPHA: boolean;
  108531. CLIPPLANE: boolean;
  108532. CLIPPLANE2: boolean;
  108533. CLIPPLANE3: boolean;
  108534. CLIPPLANE4: boolean;
  108535. ALPHATEST: boolean;
  108536. DEPTHPREPASS: boolean;
  108537. ALPHAFROMDIFFUSE: boolean;
  108538. POINTSIZE: boolean;
  108539. FOG: boolean;
  108540. SPECULARTERM: boolean;
  108541. DIFFUSEFRESNEL: boolean;
  108542. OPACITYFRESNEL: boolean;
  108543. REFLECTIONFRESNEL: boolean;
  108544. REFRACTIONFRESNEL: boolean;
  108545. EMISSIVEFRESNEL: boolean;
  108546. FRESNEL: boolean;
  108547. NORMAL: boolean;
  108548. UV1: boolean;
  108549. UV2: boolean;
  108550. VERTEXCOLOR: boolean;
  108551. VERTEXALPHA: boolean;
  108552. NUM_BONE_INFLUENCERS: number;
  108553. BonesPerMesh: number;
  108554. BONETEXTURE: boolean;
  108555. INSTANCES: boolean;
  108556. GLOSSINESS: boolean;
  108557. ROUGHNESS: boolean;
  108558. EMISSIVEASILLUMINATION: boolean;
  108559. LINKEMISSIVEWITHDIFFUSE: boolean;
  108560. REFLECTIONFRESNELFROMSPECULAR: boolean;
  108561. LIGHTMAP: boolean;
  108562. LIGHTMAPDIRECTUV: number;
  108563. OBJECTSPACE_NORMALMAP: boolean;
  108564. USELIGHTMAPASSHADOWMAP: boolean;
  108565. REFLECTIONMAP_3D: boolean;
  108566. REFLECTIONMAP_SPHERICAL: boolean;
  108567. REFLECTIONMAP_PLANAR: boolean;
  108568. REFLECTIONMAP_CUBIC: boolean;
  108569. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  108570. REFLECTIONMAP_PROJECTION: boolean;
  108571. REFLECTIONMAP_SKYBOX: boolean;
  108572. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  108573. REFLECTIONMAP_EXPLICIT: boolean;
  108574. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  108575. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  108576. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  108577. INVERTCUBICMAP: boolean;
  108578. LOGARITHMICDEPTH: boolean;
  108579. REFRACTION: boolean;
  108580. REFRACTIONMAP_3D: boolean;
  108581. REFLECTIONOVERALPHA: boolean;
  108582. TWOSIDEDLIGHTING: boolean;
  108583. SHADOWFLOAT: boolean;
  108584. MORPHTARGETS: boolean;
  108585. MORPHTARGETS_NORMAL: boolean;
  108586. MORPHTARGETS_TANGENT: boolean;
  108587. MORPHTARGETS_UV: boolean;
  108588. NUM_MORPH_INFLUENCERS: number;
  108589. NONUNIFORMSCALING: boolean;
  108590. PREMULTIPLYALPHA: boolean;
  108591. IMAGEPROCESSING: boolean;
  108592. VIGNETTE: boolean;
  108593. VIGNETTEBLENDMODEMULTIPLY: boolean;
  108594. VIGNETTEBLENDMODEOPAQUE: boolean;
  108595. TONEMAPPING: boolean;
  108596. TONEMAPPING_ACES: boolean;
  108597. CONTRAST: boolean;
  108598. COLORCURVES: boolean;
  108599. COLORGRADING: boolean;
  108600. COLORGRADING3D: boolean;
  108601. SAMPLER3DGREENDEPTH: boolean;
  108602. SAMPLER3DBGRMAP: boolean;
  108603. IMAGEPROCESSINGPOSTPROCESS: boolean;
  108604. MULTIVIEW: boolean;
  108605. /**
  108606. * If the reflection texture on this material is in linear color space
  108607. * @hidden
  108608. */
  108609. IS_REFLECTION_LINEAR: boolean;
  108610. /**
  108611. * If the refraction texture on this material is in linear color space
  108612. * @hidden
  108613. */
  108614. IS_REFRACTION_LINEAR: boolean;
  108615. EXPOSURE: boolean;
  108616. constructor();
  108617. setReflectionMode(modeToEnable: string): void;
  108618. }
  108619. /**
  108620. * This is the default material used in Babylon. It is the best trade off between quality
  108621. * and performances.
  108622. * @see http://doc.babylonjs.com/babylon101/materials
  108623. */
  108624. export class StandardMaterial extends PushMaterial {
  108625. private _diffuseTexture;
  108626. /**
  108627. * The basic texture of the material as viewed under a light.
  108628. */
  108629. diffuseTexture: Nullable<BaseTexture>;
  108630. private _ambientTexture;
  108631. /**
  108632. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  108633. */
  108634. ambientTexture: Nullable<BaseTexture>;
  108635. private _opacityTexture;
  108636. /**
  108637. * Define the transparency of the material from a texture.
  108638. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  108639. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  108640. */
  108641. opacityTexture: Nullable<BaseTexture>;
  108642. private _reflectionTexture;
  108643. /**
  108644. * Define the texture used to display the reflection.
  108645. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108646. */
  108647. reflectionTexture: Nullable<BaseTexture>;
  108648. private _emissiveTexture;
  108649. /**
  108650. * Define texture of the material as if self lit.
  108651. * This will be mixed in the final result even in the absence of light.
  108652. */
  108653. emissiveTexture: Nullable<BaseTexture>;
  108654. private _specularTexture;
  108655. /**
  108656. * Define how the color and intensity of the highlight given by the light in the material.
  108657. */
  108658. specularTexture: Nullable<BaseTexture>;
  108659. private _bumpTexture;
  108660. /**
  108661. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  108662. * These are made by creating a normal map from an image. The means to do this can be found on the web, a search for 'normal map generator' will bring up free and paid for methods of doing this.
  108663. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  108664. */
  108665. bumpTexture: Nullable<BaseTexture>;
  108666. private _lightmapTexture;
  108667. /**
  108668. * Complex lighting can be computationally expensive to compute at runtime.
  108669. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  108670. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  108671. */
  108672. lightmapTexture: Nullable<BaseTexture>;
  108673. private _refractionTexture;
  108674. /**
  108675. * Define the texture used to display the refraction.
  108676. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108677. */
  108678. refractionTexture: Nullable<BaseTexture>;
  108679. /**
  108680. * The color of the material lit by the environmental background lighting.
  108681. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  108682. */
  108683. ambientColor: Color3;
  108684. /**
  108685. * The basic color of the material as viewed under a light.
  108686. */
  108687. diffuseColor: Color3;
  108688. /**
  108689. * Define how the color and intensity of the highlight given by the light in the material.
  108690. */
  108691. specularColor: Color3;
  108692. /**
  108693. * Define the color of the material as if self lit.
  108694. * This will be mixed in the final result even in the absence of light.
  108695. */
  108696. emissiveColor: Color3;
  108697. /**
  108698. * Defines how sharp are the highlights in the material.
  108699. * The bigger the value the sharper giving a more glossy feeling to the result.
  108700. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  108701. */
  108702. specularPower: number;
  108703. private _useAlphaFromDiffuseTexture;
  108704. /**
  108705. * Does the transparency come from the diffuse texture alpha channel.
  108706. */
  108707. useAlphaFromDiffuseTexture: boolean;
  108708. private _useEmissiveAsIllumination;
  108709. /**
  108710. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  108711. */
  108712. useEmissiveAsIllumination: boolean;
  108713. private _linkEmissiveWithDiffuse;
  108714. /**
  108715. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  108716. * the emissive level when the final color is close to one.
  108717. */
  108718. linkEmissiveWithDiffuse: boolean;
  108719. private _useSpecularOverAlpha;
  108720. /**
  108721. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  108722. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  108723. */
  108724. useSpecularOverAlpha: boolean;
  108725. private _useReflectionOverAlpha;
  108726. /**
  108727. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  108728. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  108729. */
  108730. useReflectionOverAlpha: boolean;
  108731. private _disableLighting;
  108732. /**
  108733. * Does lights from the scene impacts this material.
  108734. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  108735. */
  108736. disableLighting: boolean;
  108737. private _useObjectSpaceNormalMap;
  108738. /**
  108739. * Allows using an object space normal map (instead of tangent space).
  108740. */
  108741. useObjectSpaceNormalMap: boolean;
  108742. private _useParallax;
  108743. /**
  108744. * Is parallax enabled or not.
  108745. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  108746. */
  108747. useParallax: boolean;
  108748. private _useParallaxOcclusion;
  108749. /**
  108750. * Is parallax occlusion enabled or not.
  108751. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  108752. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  108753. */
  108754. useParallaxOcclusion: boolean;
  108755. /**
  108756. * Apply a scaling factor that determine which "depth" the height map should reprensent. A value between 0.05 and 0.1 is reasonnable in Parallax, you can reach 0.2 using Parallax Occlusion.
  108757. */
  108758. parallaxScaleBias: number;
  108759. private _roughness;
  108760. /**
  108761. * Helps to define how blurry the reflections should appears in the material.
  108762. */
  108763. roughness: number;
  108764. /**
  108765. * In case of refraction, define the value of the index of refraction.
  108766. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108767. */
  108768. indexOfRefraction: number;
  108769. /**
  108770. * Invert the refraction texture alongside the y axis.
  108771. * It can be useful with procedural textures or probe for instance.
  108772. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  108773. */
  108774. invertRefractionY: boolean;
  108775. /**
  108776. * Defines the alpha limits in alpha test mode.
  108777. */
  108778. alphaCutOff: number;
  108779. private _useLightmapAsShadowmap;
  108780. /**
  108781. * In case of light mapping, define whether the map contains light or shadow informations.
  108782. */
  108783. useLightmapAsShadowmap: boolean;
  108784. private _diffuseFresnelParameters;
  108785. /**
  108786. * Define the diffuse fresnel parameters of the material.
  108787. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108788. */
  108789. diffuseFresnelParameters: FresnelParameters;
  108790. private _opacityFresnelParameters;
  108791. /**
  108792. * Define the opacity fresnel parameters of the material.
  108793. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108794. */
  108795. opacityFresnelParameters: FresnelParameters;
  108796. private _reflectionFresnelParameters;
  108797. /**
  108798. * Define the reflection fresnel parameters of the material.
  108799. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108800. */
  108801. reflectionFresnelParameters: FresnelParameters;
  108802. private _refractionFresnelParameters;
  108803. /**
  108804. * Define the refraction fresnel parameters of the material.
  108805. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108806. */
  108807. refractionFresnelParameters: FresnelParameters;
  108808. private _emissiveFresnelParameters;
  108809. /**
  108810. * Define the emissive fresnel parameters of the material.
  108811. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108812. */
  108813. emissiveFresnelParameters: FresnelParameters;
  108814. private _useReflectionFresnelFromSpecular;
  108815. /**
  108816. * If true automatically deducts the fresnels values from the material specularity.
  108817. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  108818. */
  108819. useReflectionFresnelFromSpecular: boolean;
  108820. private _useGlossinessFromSpecularMapAlpha;
  108821. /**
  108822. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  108823. */
  108824. useGlossinessFromSpecularMapAlpha: boolean;
  108825. private _maxSimultaneousLights;
  108826. /**
  108827. * Defines the maximum number of lights that can be used in the material
  108828. */
  108829. maxSimultaneousLights: number;
  108830. private _invertNormalMapX;
  108831. /**
  108832. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  108833. */
  108834. invertNormalMapX: boolean;
  108835. private _invertNormalMapY;
  108836. /**
  108837. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  108838. */
  108839. invertNormalMapY: boolean;
  108840. private _twoSidedLighting;
  108841. /**
  108842. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  108843. */
  108844. twoSidedLighting: boolean;
  108845. /**
  108846. * Default configuration related to image processing available in the standard Material.
  108847. */
  108848. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  108849. /**
  108850. * Gets the image processing configuration used either in this material.
  108851. */
  108852. /**
  108853. * Sets the Default image processing configuration used either in the this material.
  108854. *
  108855. * If sets to null, the scene one is in use.
  108856. */
  108857. imageProcessingConfiguration: ImageProcessingConfiguration;
  108858. /**
  108859. * Keep track of the image processing observer to allow dispose and replace.
  108860. */
  108861. private _imageProcessingObserver;
  108862. /**
  108863. * Attaches a new image processing configuration to the Standard Material.
  108864. * @param configuration
  108865. */
  108866. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  108867. /**
  108868. * Gets wether the color curves effect is enabled.
  108869. */
  108870. /**
  108871. * Sets wether the color curves effect is enabled.
  108872. */
  108873. cameraColorCurvesEnabled: boolean;
  108874. /**
  108875. * Gets wether the color grading effect is enabled.
  108876. */
  108877. /**
  108878. * Gets wether the color grading effect is enabled.
  108879. */
  108880. cameraColorGradingEnabled: boolean;
  108881. /**
  108882. * Gets wether tonemapping is enabled or not.
  108883. */
  108884. /**
  108885. * Sets wether tonemapping is enabled or not
  108886. */
  108887. cameraToneMappingEnabled: boolean;
  108888. /**
  108889. * The camera exposure used on this material.
  108890. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  108891. * This corresponds to a photographic exposure.
  108892. */
  108893. /**
  108894. * The camera exposure used on this material.
  108895. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  108896. * This corresponds to a photographic exposure.
  108897. */
  108898. cameraExposure: number;
  108899. /**
  108900. * Gets The camera contrast used on this material.
  108901. */
  108902. /**
  108903. * Sets The camera contrast used on this material.
  108904. */
  108905. cameraContrast: number;
  108906. /**
  108907. * Gets the Color Grading 2D Lookup Texture.
  108908. */
  108909. /**
  108910. * Sets the Color Grading 2D Lookup Texture.
  108911. */
  108912. cameraColorGradingTexture: Nullable<BaseTexture>;
  108913. /**
  108914. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  108915. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  108916. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  108917. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  108918. */
  108919. /**
  108920. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  108921. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  108922. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  108923. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  108924. */
  108925. cameraColorCurves: Nullable<ColorCurves>;
  108926. /**
  108927. * Custom callback helping to override the default shader used in the material.
  108928. */
  108929. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  108930. protected _renderTargets: SmartArray<RenderTargetTexture>;
  108931. protected _worldViewProjectionMatrix: Matrix;
  108932. protected _globalAmbientColor: Color3;
  108933. protected _useLogarithmicDepth: boolean;
  108934. protected _rebuildInParallel: boolean;
  108935. /**
  108936. * Instantiates a new standard material.
  108937. * This is the default material used in Babylon. It is the best trade off between quality
  108938. * and performances.
  108939. * @see http://doc.babylonjs.com/babylon101/materials
  108940. * @param name Define the name of the material in the scene
  108941. * @param scene Define the scene the material belong to
  108942. */
  108943. constructor(name: string, scene: Scene);
  108944. /**
  108945. * Gets a boolean indicating that current material needs to register RTT
  108946. */
  108947. readonly hasRenderTargetTextures: boolean;
  108948. /**
  108949. * Gets the current class name of the material e.g. "StandardMaterial"
  108950. * Mainly use in serialization.
  108951. * @returns the class name
  108952. */
  108953. getClassName(): string;
  108954. /**
  108955. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  108956. * You can try switching to logarithmic depth.
  108957. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  108958. */
  108959. useLogarithmicDepth: boolean;
  108960. /**
  108961. * Specifies if the material will require alpha blending
  108962. * @returns a boolean specifying if alpha blending is needed
  108963. */
  108964. needAlphaBlending(): boolean;
  108965. /**
  108966. * Specifies if this material should be rendered in alpha test mode
  108967. * @returns a boolean specifying if an alpha test is needed.
  108968. */
  108969. needAlphaTesting(): boolean;
  108970. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  108971. /**
  108972. * Get the texture used for alpha test purpose.
  108973. * @returns the diffuse texture in case of the standard material.
  108974. */
  108975. getAlphaTestTexture(): Nullable<BaseTexture>;
  108976. /**
  108977. * Get if the submesh is ready to be used and all its information available.
  108978. * Child classes can use it to update shaders
  108979. * @param mesh defines the mesh to check
  108980. * @param subMesh defines which submesh to check
  108981. * @param useInstances specifies that instances should be used
  108982. * @returns a boolean indicating that the submesh is ready or not
  108983. */
  108984. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  108985. /**
  108986. * Builds the material UBO layouts.
  108987. * Used internally during the effect preparation.
  108988. */
  108989. buildUniformLayout(): void;
  108990. /**
  108991. * Unbinds the material from the mesh
  108992. */
  108993. unbind(): void;
  108994. /**
  108995. * Binds the submesh to this material by preparing the effect and shader to draw
  108996. * @param world defines the world transformation matrix
  108997. * @param mesh defines the mesh containing the submesh
  108998. * @param subMesh defines the submesh to bind the material to
  108999. */
  109000. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  109001. /**
  109002. * Get the list of animatables in the material.
  109003. * @returns the list of animatables object used in the material
  109004. */
  109005. getAnimatables(): IAnimatable[];
  109006. /**
  109007. * Gets the active textures from the material
  109008. * @returns an array of textures
  109009. */
  109010. getActiveTextures(): BaseTexture[];
  109011. /**
  109012. * Specifies if the material uses a texture
  109013. * @param texture defines the texture to check against the material
  109014. * @returns a boolean specifying if the material uses the texture
  109015. */
  109016. hasTexture(texture: BaseTexture): boolean;
  109017. /**
  109018. * Disposes the material
  109019. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  109020. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  109021. */
  109022. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  109023. /**
  109024. * Makes a duplicate of the material, and gives it a new name
  109025. * @param name defines the new name for the duplicated material
  109026. * @returns the cloned material
  109027. */
  109028. clone(name: string): StandardMaterial;
  109029. /**
  109030. * Serializes this material in a JSON representation
  109031. * @returns the serialized material object
  109032. */
  109033. serialize(): any;
  109034. /**
  109035. * Creates a standard material from parsed material data
  109036. * @param source defines the JSON representation of the material
  109037. * @param scene defines the hosting scene
  109038. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  109039. * @returns a new standard material
  109040. */
  109041. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  109042. /**
  109043. * Are diffuse textures enabled in the application.
  109044. */
  109045. static DiffuseTextureEnabled: boolean;
  109046. /**
  109047. * Are ambient textures enabled in the application.
  109048. */
  109049. static AmbientTextureEnabled: boolean;
  109050. /**
  109051. * Are opacity textures enabled in the application.
  109052. */
  109053. static OpacityTextureEnabled: boolean;
  109054. /**
  109055. * Are reflection textures enabled in the application.
  109056. */
  109057. static ReflectionTextureEnabled: boolean;
  109058. /**
  109059. * Are emissive textures enabled in the application.
  109060. */
  109061. static EmissiveTextureEnabled: boolean;
  109062. /**
  109063. * Are specular textures enabled in the application.
  109064. */
  109065. static SpecularTextureEnabled: boolean;
  109066. /**
  109067. * Are bump textures enabled in the application.
  109068. */
  109069. static BumpTextureEnabled: boolean;
  109070. /**
  109071. * Are lightmap textures enabled in the application.
  109072. */
  109073. static LightmapTextureEnabled: boolean;
  109074. /**
  109075. * Are refraction textures enabled in the application.
  109076. */
  109077. static RefractionTextureEnabled: boolean;
  109078. /**
  109079. * Are color grading textures enabled in the application.
  109080. */
  109081. static ColorGradingTextureEnabled: boolean;
  109082. /**
  109083. * Are fresnels enabled in the application.
  109084. */
  109085. static FresnelEnabled: boolean;
  109086. }
  109087. }
  109088. declare module BABYLON {
  109089. /** @hidden */
  109090. export var imageProcessingPixelShader: {
  109091. name: string;
  109092. shader: string;
  109093. };
  109094. }
  109095. declare module BABYLON {
  109096. /**
  109097. * ImageProcessingPostProcess
  109098. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  109099. */
  109100. export class ImageProcessingPostProcess extends PostProcess {
  109101. /**
  109102. * Default configuration related to image processing available in the PBR Material.
  109103. */
  109104. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  109105. /**
  109106. * Gets the image processing configuration used either in this material.
  109107. */
  109108. /**
  109109. * Sets the Default image processing configuration used either in the this material.
  109110. *
  109111. * If sets to null, the scene one is in use.
  109112. */
  109113. imageProcessingConfiguration: ImageProcessingConfiguration;
  109114. /**
  109115. * Keep track of the image processing observer to allow dispose and replace.
  109116. */
  109117. private _imageProcessingObserver;
  109118. /**
  109119. * Attaches a new image processing configuration to the PBR Material.
  109120. * @param configuration
  109121. */
  109122. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  109123. /**
  109124. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  109125. */
  109126. /**
  109127. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  109128. */
  109129. colorCurves: Nullable<ColorCurves>;
  109130. /**
  109131. * Gets wether the color curves effect is enabled.
  109132. */
  109133. /**
  109134. * Sets wether the color curves effect is enabled.
  109135. */
  109136. colorCurvesEnabled: boolean;
  109137. /**
  109138. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  109139. */
  109140. /**
  109141. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  109142. */
  109143. colorGradingTexture: Nullable<BaseTexture>;
  109144. /**
  109145. * Gets wether the color grading effect is enabled.
  109146. */
  109147. /**
  109148. * Gets wether the color grading effect is enabled.
  109149. */
  109150. colorGradingEnabled: boolean;
  109151. /**
  109152. * Gets exposure used in the effect.
  109153. */
  109154. /**
  109155. * Sets exposure used in the effect.
  109156. */
  109157. exposure: number;
  109158. /**
  109159. * Gets wether tonemapping is enabled or not.
  109160. */
  109161. /**
  109162. * Sets wether tonemapping is enabled or not
  109163. */
  109164. toneMappingEnabled: boolean;
  109165. /**
  109166. * Gets the type of tone mapping effect.
  109167. */
  109168. /**
  109169. * Sets the type of tone mapping effect.
  109170. */
  109171. toneMappingType: number;
  109172. /**
  109173. * Gets contrast used in the effect.
  109174. */
  109175. /**
  109176. * Sets contrast used in the effect.
  109177. */
  109178. contrast: number;
  109179. /**
  109180. * Gets Vignette stretch size.
  109181. */
  109182. /**
  109183. * Sets Vignette stretch size.
  109184. */
  109185. vignetteStretch: number;
  109186. /**
  109187. * Gets Vignette centre X Offset.
  109188. */
  109189. /**
  109190. * Sets Vignette centre X Offset.
  109191. */
  109192. vignetteCentreX: number;
  109193. /**
  109194. * Gets Vignette centre Y Offset.
  109195. */
  109196. /**
  109197. * Sets Vignette centre Y Offset.
  109198. */
  109199. vignetteCentreY: number;
  109200. /**
  109201. * Gets Vignette weight or intensity of the vignette effect.
  109202. */
  109203. /**
  109204. * Sets Vignette weight or intensity of the vignette effect.
  109205. */
  109206. vignetteWeight: number;
  109207. /**
  109208. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  109209. * if vignetteEnabled is set to true.
  109210. */
  109211. /**
  109212. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  109213. * if vignetteEnabled is set to true.
  109214. */
  109215. vignetteColor: Color4;
  109216. /**
  109217. * Gets Camera field of view used by the Vignette effect.
  109218. */
  109219. /**
  109220. * Sets Camera field of view used by the Vignette effect.
  109221. */
  109222. vignetteCameraFov: number;
  109223. /**
  109224. * Gets the vignette blend mode allowing different kind of effect.
  109225. */
  109226. /**
  109227. * Sets the vignette blend mode allowing different kind of effect.
  109228. */
  109229. vignetteBlendMode: number;
  109230. /**
  109231. * Gets wether the vignette effect is enabled.
  109232. */
  109233. /**
  109234. * Sets wether the vignette effect is enabled.
  109235. */
  109236. vignetteEnabled: boolean;
  109237. private _fromLinearSpace;
  109238. /**
  109239. * Gets wether the input of the processing is in Gamma or Linear Space.
  109240. */
  109241. /**
  109242. * Sets wether the input of the processing is in Gamma or Linear Space.
  109243. */
  109244. fromLinearSpace: boolean;
  109245. /**
  109246. * Defines cache preventing GC.
  109247. */
  109248. private _defines;
  109249. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  109250. /**
  109251. * "ImageProcessingPostProcess"
  109252. * @returns "ImageProcessingPostProcess"
  109253. */
  109254. getClassName(): string;
  109255. protected _updateParameters(): void;
  109256. dispose(camera?: Camera): void;
  109257. }
  109258. }
  109259. declare module BABYLON {
  109260. /**
  109261. * Class containing static functions to help procedurally build meshes
  109262. */
  109263. export class GroundBuilder {
  109264. /**
  109265. * Creates a ground mesh
  109266. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  109267. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  109268. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109269. * @param name defines the name of the mesh
  109270. * @param options defines the options used to create the mesh
  109271. * @param scene defines the hosting scene
  109272. * @returns the ground mesh
  109273. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  109274. */
  109275. static CreateGround(name: string, options: {
  109276. width?: number;
  109277. height?: number;
  109278. subdivisions?: number;
  109279. subdivisionsX?: number;
  109280. subdivisionsY?: number;
  109281. updatable?: boolean;
  109282. }, scene: any): Mesh;
  109283. /**
  109284. * Creates a tiled ground mesh
  109285. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  109286. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  109287. * * The parameter `subdivisions` is a javascript object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  109288. * * The parameter `precision` is a javascript object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  109289. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109290. * @param name defines the name of the mesh
  109291. * @param options defines the options used to create the mesh
  109292. * @param scene defines the hosting scene
  109293. * @returns the tiled ground mesh
  109294. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  109295. */
  109296. static CreateTiledGround(name: string, options: {
  109297. xmin: number;
  109298. zmin: number;
  109299. xmax: number;
  109300. zmax: number;
  109301. subdivisions?: {
  109302. w: number;
  109303. h: number;
  109304. };
  109305. precision?: {
  109306. w: number;
  109307. h: number;
  109308. };
  109309. updatable?: boolean;
  109310. }, scene?: Nullable<Scene>): Mesh;
  109311. /**
  109312. * Creates a ground mesh from a height map
  109313. * * The parameter `url` sets the URL of the height map image resource.
  109314. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  109315. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  109316. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  109317. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  109318. * * The parameter `colorFilter` (optional Color3, default (0.3, 0.59, 0.11) ) is the filter to apply to the image pixel colors to compute the height.
  109319. * * The parameter `onReady` is a javascript callback function that will be called once the mesh is just built (the height map download can last some time).
  109320. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  109321. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109322. * @param name defines the name of the mesh
  109323. * @param url defines the url to the height map
  109324. * @param options defines the options used to create the mesh
  109325. * @param scene defines the hosting scene
  109326. * @returns the ground mesh
  109327. * @see https://doc.babylonjs.com/babylon101/height_map
  109328. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  109329. */
  109330. static CreateGroundFromHeightMap(name: string, url: string, options: {
  109331. width?: number;
  109332. height?: number;
  109333. subdivisions?: number;
  109334. minHeight?: number;
  109335. maxHeight?: number;
  109336. colorFilter?: Color3;
  109337. alphaFilter?: number;
  109338. updatable?: boolean;
  109339. onReady?: (mesh: GroundMesh) => void;
  109340. }, scene?: Nullable<Scene>): GroundMesh;
  109341. }
  109342. }
  109343. declare module BABYLON {
  109344. /**
  109345. * Class containing static functions to help procedurally build meshes
  109346. */
  109347. export class TorusBuilder {
  109348. /**
  109349. * Creates a torus mesh
  109350. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  109351. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  109352. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  109353. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109354. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109355. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109356. * @param name defines the name of the mesh
  109357. * @param options defines the options used to create the mesh
  109358. * @param scene defines the hosting scene
  109359. * @returns the torus mesh
  109360. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  109361. */
  109362. static CreateTorus(name: string, options: {
  109363. diameter?: number;
  109364. thickness?: number;
  109365. tessellation?: number;
  109366. updatable?: boolean;
  109367. sideOrientation?: number;
  109368. frontUVs?: Vector4;
  109369. backUVs?: Vector4;
  109370. }, scene: any): Mesh;
  109371. }
  109372. }
  109373. declare module BABYLON {
  109374. /**
  109375. * Class containing static functions to help procedurally build meshes
  109376. */
  109377. export class CylinderBuilder {
  109378. /**
  109379. * Creates a cylinder or a cone mesh
  109380. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  109381. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  109382. * * The parameters `diameterTop` and `diameterBottom` overwrite the parameter `diameter` and set respectively the top cap and bottom cap diameter (floats, default 1). The parameter "diameterBottom" can't be zero.
  109383. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  109384. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  109385. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  109386. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  109387. * * The parameter `cap` sets the way the cylinder is capped. Possible values : BABYLON.Mesh.NO_CAP, BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL (default).
  109388. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  109389. * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of n Color3 elements) and `faceUV` (an array of n Vector4 elements).
  109390. * * The value of n is the number of cylinder faces. If the cylinder has only 1 subdivisions, n equals : top face + cylinder surface + bottom face = 3
  109391. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  109392. * * Finally, if the cylinder has 5 independent subdivisions and is enclose, n equals : top face + 5 x (stripe surface + 2 closing faces) + bottom face = 2 + 5 * 3 = 17
  109393. * * Each array (color or UVs) is always ordered the same way : the first element is the bottom cap, the last element is the top cap. The other elements are each a ring surface.
  109394. * * If `enclose` is false, a ring surface is one element.
  109395. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  109396. * * Example how to set colors and textures on a sliced cylinder : https://www.html5gamedevs.com/topic/17945-creating-a-closed-slice-of-a-cylinder/#comment-106379
  109397. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109398. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109399. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109400. * @param name defines the name of the mesh
  109401. * @param options defines the options used to create the mesh
  109402. * @param scene defines the hosting scene
  109403. * @returns the cylinder mesh
  109404. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  109405. */
  109406. static CreateCylinder(name: string, options: {
  109407. height?: number;
  109408. diameterTop?: number;
  109409. diameterBottom?: number;
  109410. diameter?: number;
  109411. tessellation?: number;
  109412. subdivisions?: number;
  109413. arc?: number;
  109414. faceColors?: Color4[];
  109415. faceUV?: Vector4[];
  109416. updatable?: boolean;
  109417. hasRings?: boolean;
  109418. enclose?: boolean;
  109419. cap?: number;
  109420. sideOrientation?: number;
  109421. frontUVs?: Vector4;
  109422. backUVs?: Vector4;
  109423. }, scene: any): Mesh;
  109424. }
  109425. }
  109426. declare module BABYLON {
  109427. /**
  109428. * Options to modify the vr teleportation behavior.
  109429. */
  109430. export interface VRTeleportationOptions {
  109431. /**
  109432. * The name of the mesh which should be used as the teleportation floor. (default: null)
  109433. */
  109434. floorMeshName?: string;
  109435. /**
  109436. * A list of meshes to be used as the teleportation floor. (default: empty)
  109437. */
  109438. floorMeshes?: Mesh[];
  109439. }
  109440. /**
  109441. * Options to modify the vr experience helper's behavior.
  109442. */
  109443. export interface VRExperienceHelperOptions extends WebVROptions {
  109444. /**
  109445. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  109446. */
  109447. createDeviceOrientationCamera?: boolean;
  109448. /**
  109449. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  109450. */
  109451. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  109452. /**
  109453. * Uses the main button on the controller to toggle the laser casted. (default: true)
  109454. */
  109455. laserToggle?: boolean;
  109456. /**
  109457. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  109458. */
  109459. floorMeshes?: Mesh[];
  109460. /**
  109461. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  109462. */
  109463. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  109464. }
  109465. /**
  109466. * Event containing information after VR has been entered
  109467. */
  109468. export class OnAfterEnteringVRObservableEvent {
  109469. /**
  109470. * If entering vr was successful
  109471. */
  109472. success: boolean;
  109473. }
  109474. /**
  109475. * Helps to quickly add VR support to an existing scene.
  109476. * See http://doc.babylonjs.com/how_to/webvr_helper
  109477. */
  109478. export class VRExperienceHelper {
  109479. /** Options to modify the vr experience helper's behavior. */
  109480. webVROptions: VRExperienceHelperOptions;
  109481. private _scene;
  109482. private _position;
  109483. private _btnVR;
  109484. private _btnVRDisplayed;
  109485. private _webVRsupported;
  109486. private _webVRready;
  109487. private _webVRrequesting;
  109488. private _webVRpresenting;
  109489. private _hasEnteredVR;
  109490. private _fullscreenVRpresenting;
  109491. private _inputElement;
  109492. private _webVRCamera;
  109493. private _vrDeviceOrientationCamera;
  109494. private _deviceOrientationCamera;
  109495. private _existingCamera;
  109496. private _onKeyDown;
  109497. private _onVrDisplayPresentChange;
  109498. private _onVRDisplayChanged;
  109499. private _onVRRequestPresentStart;
  109500. private _onVRRequestPresentComplete;
  109501. /**
  109502. * Gets or sets a boolean indicating that gaze can be enabled even if pointer lock is not engage (useful on iOS where fullscreen mode and pointer lock are not supported)
  109503. */
  109504. enableGazeEvenWhenNoPointerLock: boolean;
  109505. /**
  109506. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  109507. */
  109508. exitVROnDoubleTap: boolean;
  109509. /**
  109510. * Observable raised right before entering VR.
  109511. */
  109512. onEnteringVRObservable: Observable<VRExperienceHelper>;
  109513. /**
  109514. * Observable raised when entering VR has completed.
  109515. */
  109516. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  109517. /**
  109518. * Observable raised when exiting VR.
  109519. */
  109520. onExitingVRObservable: Observable<VRExperienceHelper>;
  109521. /**
  109522. * Observable raised when controller mesh is loaded.
  109523. */
  109524. onControllerMeshLoadedObservable: Observable<WebVRController>;
  109525. /** Return this.onEnteringVRObservable
  109526. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  109527. */
  109528. readonly onEnteringVR: Observable<VRExperienceHelper>;
  109529. /** Return this.onExitingVRObservable
  109530. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  109531. */
  109532. readonly onExitingVR: Observable<VRExperienceHelper>;
  109533. /** Return this.onControllerMeshLoadedObservable
  109534. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  109535. */
  109536. readonly onControllerMeshLoaded: Observable<WebVRController>;
  109537. private _rayLength;
  109538. private _useCustomVRButton;
  109539. private _teleportationRequested;
  109540. private _teleportActive;
  109541. private _floorMeshName;
  109542. private _floorMeshesCollection;
  109543. private _rotationAllowed;
  109544. private _teleportBackwardsVector;
  109545. private _teleportationTarget;
  109546. private _isDefaultTeleportationTarget;
  109547. private _postProcessMove;
  109548. private _teleportationFillColor;
  109549. private _teleportationBorderColor;
  109550. private _rotationAngle;
  109551. private _haloCenter;
  109552. private _cameraGazer;
  109553. private _padSensibilityUp;
  109554. private _padSensibilityDown;
  109555. private _leftController;
  109556. private _rightController;
  109557. /**
  109558. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  109559. */
  109560. onNewMeshSelected: Observable<AbstractMesh>;
  109561. /**
  109562. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  109563. * This observable will provide the mesh and the controller used to select the mesh
  109564. */
  109565. onMeshSelectedWithController: Observable<{
  109566. mesh: AbstractMesh;
  109567. controller: WebVRController;
  109568. }>;
  109569. /**
  109570. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  109571. */
  109572. onNewMeshPicked: Observable<PickingInfo>;
  109573. private _circleEase;
  109574. /**
  109575. * Observable raised before camera teleportation
  109576. */
  109577. onBeforeCameraTeleport: Observable<Vector3>;
  109578. /**
  109579. * Observable raised after camera teleportation
  109580. */
  109581. onAfterCameraTeleport: Observable<Vector3>;
  109582. /**
  109583. * Observable raised when current selected mesh gets unselected
  109584. */
  109585. onSelectedMeshUnselected: Observable<AbstractMesh>;
  109586. private _raySelectionPredicate;
  109587. /**
  109588. * To be optionaly changed by user to define custom ray selection
  109589. */
  109590. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  109591. /**
  109592. * To be optionaly changed by user to define custom selection logic (after ray selection)
  109593. */
  109594. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  109595. /**
  109596. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  109597. */
  109598. teleportationEnabled: boolean;
  109599. private _defaultHeight;
  109600. private _teleportationInitialized;
  109601. private _interactionsEnabled;
  109602. private _interactionsRequested;
  109603. private _displayGaze;
  109604. private _displayLaserPointer;
  109605. /**
  109606. * The mesh used to display where the user is going to teleport.
  109607. */
  109608. /**
  109609. * Sets the mesh to be used to display where the user is going to teleport.
  109610. */
  109611. teleportationTarget: Mesh;
  109612. /**
  109613. * The mesh used to display where the user is selecting, this mesh will be cloned and set as the gazeTracker for the left and right controller
  109614. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  109615. * See http://doc.babylonjs.com/resources/baking_transformations
  109616. */
  109617. gazeTrackerMesh: Mesh;
  109618. /**
  109619. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  109620. */
  109621. updateGazeTrackerScale: boolean;
  109622. /**
  109623. * If the gaze trackers color should be updated when selecting meshes
  109624. */
  109625. updateGazeTrackerColor: boolean;
  109626. /**
  109627. * If the controller laser color should be updated when selecting meshes
  109628. */
  109629. updateControllerLaserColor: boolean;
  109630. /**
  109631. * The gaze tracking mesh corresponding to the left controller
  109632. */
  109633. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  109634. /**
  109635. * The gaze tracking mesh corresponding to the right controller
  109636. */
  109637. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  109638. /**
  109639. * If the ray of the gaze should be displayed.
  109640. */
  109641. /**
  109642. * Sets if the ray of the gaze should be displayed.
  109643. */
  109644. displayGaze: boolean;
  109645. /**
  109646. * If the ray of the LaserPointer should be displayed.
  109647. */
  109648. /**
  109649. * Sets if the ray of the LaserPointer should be displayed.
  109650. */
  109651. displayLaserPointer: boolean;
  109652. /**
  109653. * The deviceOrientationCamera used as the camera when not in VR.
  109654. */
  109655. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  109656. /**
  109657. * Based on the current WebVR support, returns the current VR camera used.
  109658. */
  109659. readonly currentVRCamera: Nullable<Camera>;
  109660. /**
  109661. * The webVRCamera which is used when in VR.
  109662. */
  109663. readonly webVRCamera: WebVRFreeCamera;
  109664. /**
  109665. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  109666. */
  109667. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  109668. /**
  109669. * The html button that is used to trigger entering into VR.
  109670. */
  109671. readonly vrButton: Nullable<HTMLButtonElement>;
  109672. private readonly _teleportationRequestInitiated;
  109673. /**
  109674. * Defines wether or not Pointer lock should be requested when switching to
  109675. * full screen.
  109676. */
  109677. requestPointerLockOnFullScreen: boolean;
  109678. /**
  109679. * Instantiates a VRExperienceHelper.
  109680. * Helps to quickly add VR support to an existing scene.
  109681. * @param scene The scene the VRExperienceHelper belongs to.
  109682. * @param webVROptions Options to modify the vr experience helper's behavior.
  109683. */
  109684. constructor(scene: Scene,
  109685. /** Options to modify the vr experience helper's behavior. */
  109686. webVROptions?: VRExperienceHelperOptions);
  109687. private _onDefaultMeshLoaded;
  109688. private _onResize;
  109689. private _onFullscreenChange;
  109690. /**
  109691. * Gets a value indicating if we are currently in VR mode.
  109692. */
  109693. readonly isInVRMode: boolean;
  109694. private onVrDisplayPresentChange;
  109695. private onVRDisplayChanged;
  109696. private moveButtonToBottomRight;
  109697. private displayVRButton;
  109698. private updateButtonVisibility;
  109699. private _cachedAngularSensibility;
  109700. /**
  109701. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  109702. * Otherwise, will use the fullscreen API.
  109703. */
  109704. enterVR(): void;
  109705. /**
  109706. * Attempt to exit VR, or fullscreen.
  109707. */
  109708. exitVR(): void;
  109709. /**
  109710. * The position of the vr experience helper.
  109711. */
  109712. /**
  109713. * Sets the position of the vr experience helper.
  109714. */
  109715. position: Vector3;
  109716. /**
  109717. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  109718. */
  109719. enableInteractions(): void;
  109720. private readonly _noControllerIsActive;
  109721. private beforeRender;
  109722. private _isTeleportationFloor;
  109723. /**
  109724. * Adds a floor mesh to be used for teleportation.
  109725. * @param floorMesh the mesh to be used for teleportation.
  109726. */
  109727. addFloorMesh(floorMesh: Mesh): void;
  109728. /**
  109729. * Removes a floor mesh from being used for teleportation.
  109730. * @param floorMesh the mesh to be removed.
  109731. */
  109732. removeFloorMesh(floorMesh: Mesh): void;
  109733. /**
  109734. * Enables interactions and teleportation using the VR controllers and gaze.
  109735. * @param vrTeleportationOptions options to modify teleportation behavior.
  109736. */
  109737. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  109738. private _onNewGamepadConnected;
  109739. private _tryEnableInteractionOnController;
  109740. private _onNewGamepadDisconnected;
  109741. private _enableInteractionOnController;
  109742. private _checkTeleportWithRay;
  109743. private _checkRotate;
  109744. private _checkTeleportBackwards;
  109745. private _enableTeleportationOnController;
  109746. private _createTeleportationCircles;
  109747. private _displayTeleportationTarget;
  109748. private _hideTeleportationTarget;
  109749. private _rotateCamera;
  109750. private _moveTeleportationSelectorTo;
  109751. private _workingVector;
  109752. private _workingQuaternion;
  109753. private _workingMatrix;
  109754. /**
  109755. * Teleports the users feet to the desired location
  109756. * @param location The location where the user's feet should be placed
  109757. */
  109758. teleportCamera(location: Vector3): void;
  109759. private _convertNormalToDirectionOfRay;
  109760. private _castRayAndSelectObject;
  109761. private _notifySelectedMeshUnselected;
  109762. /**
  109763. * Sets the color of the laser ray from the vr controllers.
  109764. * @param color new color for the ray.
  109765. */
  109766. changeLaserColor(color: Color3): void;
  109767. /**
  109768. * Sets the color of the ray from the vr headsets gaze.
  109769. * @param color new color for the ray.
  109770. */
  109771. changeGazeColor(color: Color3): void;
  109772. /**
  109773. * Exits VR and disposes of the vr experience helper
  109774. */
  109775. dispose(): void;
  109776. /**
  109777. * Gets the name of the VRExperienceHelper class
  109778. * @returns "VRExperienceHelper"
  109779. */
  109780. getClassName(): string;
  109781. }
  109782. }
  109783. declare module BABYLON {
  109784. /**
  109785. * States of the webXR experience
  109786. */
  109787. export enum WebXRState {
  109788. /**
  109789. * Transitioning to being in XR mode
  109790. */
  109791. ENTERING_XR = 0,
  109792. /**
  109793. * Transitioning to non XR mode
  109794. */
  109795. EXITING_XR = 1,
  109796. /**
  109797. * In XR mode and presenting
  109798. */
  109799. IN_XR = 2,
  109800. /**
  109801. * Not entered XR mode
  109802. */
  109803. NOT_IN_XR = 3
  109804. }
  109805. /**
  109806. * Abstraction of the XR render target
  109807. */
  109808. export interface WebXRRenderTarget extends IDisposable {
  109809. /**
  109810. * xrpresent context of the canvas which can be used to display/mirror xr content
  109811. */
  109812. canvasContext: WebGLRenderingContext;
  109813. /**
  109814. * xr layer for the canvas
  109815. */
  109816. xrLayer: Nullable<XRWebGLLayer>;
  109817. /**
  109818. * Initializes the xr layer for the session
  109819. * @param xrSession xr session
  109820. * @returns a promise that will resolve once the XR Layer has been created
  109821. */
  109822. initializeXRLayerAsync(xrSession: XRSession): Promise<void>;
  109823. }
  109824. }
  109825. declare module BABYLON {
  109826. /**
  109827. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  109828. */
  109829. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  109830. private _engine;
  109831. private _canvas;
  109832. /**
  109833. * xrpresent context of the canvas which can be used to display/mirror xr content
  109834. */
  109835. canvasContext: WebGLRenderingContext;
  109836. /**
  109837. * xr layer for the canvas
  109838. */
  109839. xrLayer: Nullable<XRWebGLLayer>;
  109840. /**
  109841. * Initializes the xr layer for the session
  109842. * @param xrSession xr session
  109843. * @returns a promise that will resolve once the XR Layer has been created
  109844. */
  109845. initializeXRLayerAsync(xrSession: any): any;
  109846. /**
  109847. * Initializes the canvas to be added/removed upon entering/exiting xr
  109848. * @param engine the Babylon engine
  109849. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  109850. * @param onStateChangedObservable the mechanism by which the canvas will be added/removed based on XR state
  109851. */
  109852. constructor(engine: ThinEngine, canvas?: HTMLCanvasElement, onStateChangedObservable?: Observable<WebXRState>);
  109853. /**
  109854. * Disposes of the object
  109855. */
  109856. dispose(): void;
  109857. private _setManagedOutputCanvas;
  109858. private _addCanvas;
  109859. private _removeCanvas;
  109860. }
  109861. }
  109862. declare module BABYLON {
  109863. /**
  109864. * Manages an XRSession to work with Babylon's engine
  109865. * @see https://doc.babylonjs.com/how_to/webxr
  109866. */
  109867. export class WebXRSessionManager implements IDisposable {
  109868. private scene;
  109869. /**
  109870. * Fires every time a new xrFrame arrives which can be used to update the camera
  109871. */
  109872. onXRFrameObservable: Observable<any>;
  109873. /**
  109874. * Fires when the xr session is ended either by the device or manually done
  109875. */
  109876. onXRSessionEnded: Observable<any>;
  109877. /**
  109878. * Underlying xr session
  109879. */
  109880. session: XRSession;
  109881. /**
  109882. * Type of reference space used when creating the session
  109883. */
  109884. referenceSpace: XRReferenceSpace;
  109885. /**
  109886. * Current XR frame
  109887. */
  109888. currentFrame: Nullable<XRFrame>;
  109889. private _xrNavigator;
  109890. private baseLayer;
  109891. private _rttProvider;
  109892. private _sessionEnded;
  109893. /**
  109894. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  109895. * @param scene The scene which the session should be created for
  109896. */
  109897. constructor(scene: Scene);
  109898. /**
  109899. * Initializes the manager
  109900. * After initialization enterXR can be called to start an XR session
  109901. * @returns Promise which resolves after it is initialized
  109902. */
  109903. initializeAsync(): Promise<void>;
  109904. /**
  109905. * Initializes an xr session
  109906. * @param xrSessionMode mode to initialize
  109907. * @param optionalFeatures defines optional values to pass to the session builder
  109908. * @returns a promise which will resolve once the session has been initialized
  109909. */
  109910. initializeSessionAsync(xrSessionMode: XRSessionMode, optionalFeatures?: any): any;
  109911. /**
  109912. * Sets the reference space on the xr session
  109913. * @param referenceSpace space to set
  109914. * @returns a promise that will resolve once the reference space has been set
  109915. */
  109916. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  109917. /**
  109918. * Updates the render state of the session
  109919. * @param state state to set
  109920. * @returns a promise that resolves once the render state has been updated
  109921. */
  109922. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  109923. /**
  109924. * Starts rendering to the xr layer
  109925. * @returns a promise that will resolve once rendering has started
  109926. */
  109927. startRenderingToXRAsync(): Promise<void>;
  109928. /**
  109929. * Gets the correct render target texture to be rendered this frame for this eye
  109930. * @param eye the eye for which to get the render target
  109931. * @returns the render target for the specified eye
  109932. */
  109933. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  109934. /**
  109935. * Stops the xrSession and restores the renderloop
  109936. * @returns Promise which resolves after it exits XR
  109937. */
  109938. exitXRAsync(): Promise<void>;
  109939. /**
  109940. * Checks if a session would be supported for the creation options specified
  109941. * @param sessionMode session mode to check if supported eg. immersive-vr
  109942. * @returns true if supported
  109943. */
  109944. supportsSessionAsync(sessionMode: XRSessionMode): any;
  109945. /**
  109946. * Creates a WebXRRenderTarget object for the XR session
  109947. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  109948. * @returns a WebXR render target to which the session can render
  109949. */
  109950. getWebXRRenderTarget(onStateChangedObservable?: Observable<WebXRState>): WebXRRenderTarget;
  109951. /**
  109952. * @hidden
  109953. * Converts the render layer of xrSession to a render target
  109954. * @param session session to create render target for
  109955. * @param scene scene the new render target should be created for
  109956. */
  109957. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  109958. /**
  109959. * Disposes of the session manager
  109960. */
  109961. dispose(): void;
  109962. }
  109963. }
  109964. declare module BABYLON {
  109965. /**
  109966. * WebXR Camera which holds the views for the xrSession
  109967. * @see https://doc.babylonjs.com/how_to/webxr
  109968. */
  109969. export class WebXRCamera extends FreeCamera {
  109970. private static _TmpMatrix;
  109971. /**
  109972. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  109973. * @param name the name of the camera
  109974. * @param scene the scene to add the camera to
  109975. */
  109976. constructor(name: string, scene: Scene);
  109977. private _updateNumberOfRigCameras;
  109978. /** @hidden */
  109979. _updateForDualEyeDebugging(): void;
  109980. /**
  109981. * Updates the cameras position from the current pose information of the XR session
  109982. * @param xrSessionManager the session containing pose information
  109983. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  109984. */
  109985. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  109986. }
  109987. }
  109988. declare module BABYLON {
  109989. /**
  109990. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  109991. * @see https://doc.babylonjs.com/how_to/webxr
  109992. */
  109993. export class WebXRExperienceHelper implements IDisposable {
  109994. private scene;
  109995. /**
  109996. * Container which stores the xr camera and controllers as children. This can be used to move the camera/user as the camera's position is updated by the xr device
  109997. */
  109998. container: AbstractMesh;
  109999. /**
  110000. * Camera used to render xr content
  110001. */
  110002. camera: WebXRCamera;
  110003. /**
  110004. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  110005. */
  110006. state: WebXRState;
  110007. private _setState;
  110008. private static _TmpVector;
  110009. /**
  110010. * Fires when the state of the experience helper has changed
  110011. */
  110012. onStateChangedObservable: Observable<WebXRState>;
  110013. /** Session manager used to keep track of xr session */
  110014. sessionManager: WebXRSessionManager;
  110015. private _nonVRCamera;
  110016. private _originalSceneAutoClear;
  110017. private _supported;
  110018. /**
  110019. * Creates the experience helper
  110020. * @param scene the scene to attach the experience helper to
  110021. * @returns a promise for the experience helper
  110022. */
  110023. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  110024. /**
  110025. * Creates a WebXRExperienceHelper
  110026. * @param scene The scene the helper should be created in
  110027. */
  110028. private constructor();
  110029. /**
  110030. * Exits XR mode and returns the scene to its original state
  110031. * @returns promise that resolves after xr mode has exited
  110032. */
  110033. exitXRAsync(): Promise<void>;
  110034. /**
  110035. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  110036. * @param sessionMode options for the XR session
  110037. * @param referenceSpaceType frame of reference of the XR session
  110038. * @param renderTarget the output canvas that will be used to enter XR mode
  110039. * @returns promise that resolves after xr mode has entered
  110040. */
  110041. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget: WebXRRenderTarget): any;
  110042. /**
  110043. * Updates the global position of the camera by moving the camera's container
  110044. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  110045. * @param position The desired global position of the camera
  110046. */
  110047. setPositionOfCameraUsingContainer(position: Vector3): void;
  110048. /**
  110049. * Rotates the xr camera by rotating the camera's container around the camera's position
  110050. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  110051. * @param rotation the desired quaternion rotation to apply to the camera
  110052. */
  110053. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  110054. /**
  110055. * Disposes of the experience helper
  110056. */
  110057. dispose(): void;
  110058. }
  110059. }
  110060. declare module BABYLON {
  110061. /**
  110062. * Button which can be used to enter a different mode of XR
  110063. */
  110064. export class WebXREnterExitUIButton {
  110065. /** button element */
  110066. element: HTMLElement;
  110067. /** XR initialization options for the button */
  110068. sessionMode: XRSessionMode;
  110069. /** Reference space type */
  110070. referenceSpaceType: XRReferenceSpaceType;
  110071. /**
  110072. * Creates a WebXREnterExitUIButton
  110073. * @param element button element
  110074. * @param sessionMode XR initialization session mode
  110075. * @param referenceSpaceType the type of reference space to be used
  110076. */
  110077. constructor(
  110078. /** button element */
  110079. element: HTMLElement,
  110080. /** XR initialization options for the button */
  110081. sessionMode: XRSessionMode,
  110082. /** Reference space type */
  110083. referenceSpaceType: XRReferenceSpaceType);
  110084. /**
  110085. * Overwritable function which can be used to update the button's visuals when the state changes
  110086. * @param activeButton the current active button in the UI
  110087. */
  110088. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  110089. }
  110090. /**
  110091. * Options to create the webXR UI
  110092. */
  110093. export class WebXREnterExitUIOptions {
  110094. /**
  110095. * Context to enter xr with
  110096. */
  110097. renderTarget?: Nullable<WebXRRenderTarget>;
  110098. /**
  110099. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  110100. */
  110101. customButtons?: Array<WebXREnterExitUIButton>;
  110102. }
  110103. /**
  110104. * UI to allow the user to enter/exit XR mode
  110105. */
  110106. export class WebXREnterExitUI implements IDisposable {
  110107. private scene;
  110108. private _overlay;
  110109. private _buttons;
  110110. private _activeButton;
  110111. /**
  110112. * Fired every time the active button is changed.
  110113. *
  110114. * When xr is entered via a button that launches xr that button will be the callback parameter
  110115. *
  110116. * When exiting xr the callback parameter will be null)
  110117. */
  110118. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  110119. /**
  110120. * Creates UI to allow the user to enter/exit XR mode
  110121. * @param scene the scene to add the ui to
  110122. * @param helper the xr experience helper to enter/exit xr with
  110123. * @param options options to configure the UI
  110124. * @returns the created ui
  110125. */
  110126. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  110127. private constructor();
  110128. private _updateButtons;
  110129. /**
  110130. * Disposes of the object
  110131. */
  110132. dispose(): void;
  110133. }
  110134. }
  110135. declare module BABYLON {
  110136. /**
  110137. * Represents an XR input
  110138. */
  110139. export class WebXRController {
  110140. private scene;
  110141. /** The underlying input source for the controller */
  110142. inputSource: XRInputSource;
  110143. private parentContainer;
  110144. /**
  110145. * Represents the part of the controller that is held. This may not exist if the controller is the head mounted display itself, if thats the case only the pointer from the head will be availible
  110146. */
  110147. grip?: AbstractMesh;
  110148. /**
  110149. * Pointer which can be used to select objects or attach a visible laser to
  110150. */
  110151. pointer: AbstractMesh;
  110152. private _gamepadMode;
  110153. /**
  110154. * If available, this is the gamepad object related to this controller.
  110155. * Using this object it is possible to get click events and trackpad changes of the
  110156. * webxr controller that is currently being used.
  110157. */
  110158. gamepadController?: WebVRController;
  110159. /**
  110160. * Event that fires when the controller is removed/disposed
  110161. */
  110162. onDisposeObservable: Observable<{}>;
  110163. private _tmpMatrix;
  110164. private _tmpQuaternion;
  110165. private _tmpVector;
  110166. /**
  110167. * Creates the controller
  110168. * @see https://doc.babylonjs.com/how_to/webxr
  110169. * @param scene the scene which the controller should be associated to
  110170. * @param inputSource the underlying input source for the controller
  110171. * @param parentContainer parent that the controller meshes should be children of
  110172. */
  110173. constructor(scene: Scene,
  110174. /** The underlying input source for the controller */
  110175. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  110176. /**
  110177. * Updates the controller pose based on the given XRFrame
  110178. * @param xrFrame xr frame to update the pose with
  110179. * @param referenceSpace reference space to use
  110180. */
  110181. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  110182. /**
  110183. * Gets a world space ray coming from the controller
  110184. * @param result the resulting ray
  110185. */
  110186. getWorldPointerRayToRef(result: Ray): void;
  110187. /**
  110188. * Get the scene associated with this controller
  110189. * @returns the scene object
  110190. */
  110191. getScene(): Scene;
  110192. /**
  110193. * Disposes of the object
  110194. */
  110195. dispose(): void;
  110196. }
  110197. }
  110198. declare module BABYLON {
  110199. /**
  110200. * XR input used to track XR inputs such as controllers/rays
  110201. */
  110202. export class WebXRInput implements IDisposable {
  110203. /**
  110204. * Base experience the input listens to
  110205. */
  110206. baseExperience: WebXRExperienceHelper;
  110207. /**
  110208. * XR controllers being tracked
  110209. */
  110210. controllers: Array<WebXRController>;
  110211. private _frameObserver;
  110212. private _stateObserver;
  110213. /**
  110214. * Event when a controller has been connected/added
  110215. */
  110216. onControllerAddedObservable: Observable<WebXRController>;
  110217. /**
  110218. * Event when a controller has been removed/disconnected
  110219. */
  110220. onControllerRemovedObservable: Observable<WebXRController>;
  110221. /**
  110222. * Initializes the WebXRInput
  110223. * @param baseExperience experience helper which the input should be created for
  110224. */
  110225. constructor(
  110226. /**
  110227. * Base experience the input listens to
  110228. */
  110229. baseExperience: WebXRExperienceHelper);
  110230. private _onInputSourcesChange;
  110231. private _addAndRemoveControllers;
  110232. /**
  110233. * Disposes of the object
  110234. */
  110235. dispose(): void;
  110236. }
  110237. }
  110238. declare module BABYLON {
  110239. /**
  110240. * Enables teleportation
  110241. */
  110242. export class WebXRControllerTeleportation {
  110243. private _teleportationFillColor;
  110244. private _teleportationBorderColor;
  110245. private _tmpRay;
  110246. private _tmpVector;
  110247. /**
  110248. * Creates a WebXRControllerTeleportation
  110249. * @param input input manager to add teleportation to
  110250. * @param floorMeshes floormeshes which can be teleported to
  110251. */
  110252. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  110253. }
  110254. }
  110255. declare module BABYLON {
  110256. /**
  110257. * Handles pointer input automatically for the pointer of XR controllers
  110258. */
  110259. export class WebXRControllerPointerSelection {
  110260. private static _idCounter;
  110261. private _tmpRay;
  110262. /**
  110263. * Creates a WebXRControllerPointerSelection
  110264. * @param input input manager to setup pointer selection
  110265. */
  110266. constructor(input: WebXRInput);
  110267. private _convertNormalToDirectionOfRay;
  110268. private _updatePointerDistance;
  110269. }
  110270. }
  110271. declare module BABYLON {
  110272. /**
  110273. * Class used to represent data loading progression
  110274. */
  110275. export class SceneLoaderProgressEvent {
  110276. /** defines if data length to load can be evaluated */
  110277. readonly lengthComputable: boolean;
  110278. /** defines the loaded data length */
  110279. readonly loaded: number;
  110280. /** defines the data length to load */
  110281. readonly total: number;
  110282. /**
  110283. * Create a new progress event
  110284. * @param lengthComputable defines if data length to load can be evaluated
  110285. * @param loaded defines the loaded data length
  110286. * @param total defines the data length to load
  110287. */
  110288. constructor(
  110289. /** defines if data length to load can be evaluated */
  110290. lengthComputable: boolean,
  110291. /** defines the loaded data length */
  110292. loaded: number,
  110293. /** defines the data length to load */
  110294. total: number);
  110295. /**
  110296. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  110297. * @param event defines the source event
  110298. * @returns a new SceneLoaderProgressEvent
  110299. */
  110300. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  110301. }
  110302. /**
  110303. * Interface used by SceneLoader plugins to define supported file extensions
  110304. */
  110305. export interface ISceneLoaderPluginExtensions {
  110306. /**
  110307. * Defines the list of supported extensions
  110308. */
  110309. [extension: string]: {
  110310. isBinary: boolean;
  110311. };
  110312. }
  110313. /**
  110314. * Interface used by SceneLoader plugin factory
  110315. */
  110316. export interface ISceneLoaderPluginFactory {
  110317. /**
  110318. * Defines the name of the factory
  110319. */
  110320. name: string;
  110321. /**
  110322. * Function called to create a new plugin
  110323. * @return the new plugin
  110324. */
  110325. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  110326. /**
  110327. * The callback that returns true if the data can be directly loaded.
  110328. * @param data string containing the file data
  110329. * @returns if the data can be loaded directly
  110330. */
  110331. canDirectLoad?(data: string): boolean;
  110332. }
  110333. /**
  110334. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  110335. */
  110336. export interface ISceneLoaderPluginBase {
  110337. /**
  110338. * The friendly name of this plugin.
  110339. */
  110340. name: string;
  110341. /**
  110342. * The file extensions supported by this plugin.
  110343. */
  110344. extensions: string | ISceneLoaderPluginExtensions;
  110345. /**
  110346. * The callback called when loading from a url.
  110347. * @param scene scene loading this url
  110348. * @param url url to load
  110349. * @param onSuccess callback called when the file successfully loads
  110350. * @param onProgress callback called while file is loading (if the server supports this mode)
  110351. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  110352. * @param onError callback called when the file fails to load
  110353. * @returns a file request object
  110354. */
  110355. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  110356. /**
  110357. * The callback called when loading from a file object.
  110358. * @param scene scene loading this file
  110359. * @param file defines the file to load
  110360. * @param onSuccess defines the callback to call when data is loaded
  110361. * @param onProgress defines the callback to call during loading process
  110362. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  110363. * @param onError defines the callback to call when an error occurs
  110364. * @returns a file request object
  110365. */
  110366. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  110367. /**
  110368. * The callback that returns true if the data can be directly loaded.
  110369. * @param data string containing the file data
  110370. * @returns if the data can be loaded directly
  110371. */
  110372. canDirectLoad?(data: string): boolean;
  110373. /**
  110374. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  110375. * @param scene scene loading this data
  110376. * @param data string containing the data
  110377. * @returns data to pass to the plugin
  110378. */
  110379. directLoad?(scene: Scene, data: string): any;
  110380. /**
  110381. * The callback that allows custom handling of the root url based on the response url.
  110382. * @param rootUrl the original root url
  110383. * @param responseURL the response url if available
  110384. * @returns the new root url
  110385. */
  110386. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  110387. }
  110388. /**
  110389. * Interface used to define a SceneLoader plugin
  110390. */
  110391. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  110392. /**
  110393. * Import meshes into a scene.
  110394. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110395. * @param scene The scene to import into
  110396. * @param data The data to import
  110397. * @param rootUrl The root url for scene and resources
  110398. * @param meshes The meshes array to import into
  110399. * @param particleSystems The particle systems array to import into
  110400. * @param skeletons The skeletons array to import into
  110401. * @param onError The callback when import fails
  110402. * @returns True if successful or false otherwise
  110403. */
  110404. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  110405. /**
  110406. * Load into a scene.
  110407. * @param scene The scene to load into
  110408. * @param data The data to import
  110409. * @param rootUrl The root url for scene and resources
  110410. * @param onError The callback when import fails
  110411. * @returns True if successful or false otherwise
  110412. */
  110413. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  110414. /**
  110415. * Load into an asset container.
  110416. * @param scene The scene to load into
  110417. * @param data The data to import
  110418. * @param rootUrl The root url for scene and resources
  110419. * @param onError The callback when import fails
  110420. * @returns The loaded asset container
  110421. */
  110422. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  110423. }
  110424. /**
  110425. * Interface used to define an async SceneLoader plugin
  110426. */
  110427. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  110428. /**
  110429. * Import meshes into a scene.
  110430. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110431. * @param scene The scene to import into
  110432. * @param data The data to import
  110433. * @param rootUrl The root url for scene and resources
  110434. * @param onProgress The callback when the load progresses
  110435. * @param fileName Defines the name of the file to load
  110436. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  110437. */
  110438. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  110439. meshes: AbstractMesh[];
  110440. particleSystems: IParticleSystem[];
  110441. skeletons: Skeleton[];
  110442. animationGroups: AnimationGroup[];
  110443. }>;
  110444. /**
  110445. * Load into a scene.
  110446. * @param scene The scene to load into
  110447. * @param data The data to import
  110448. * @param rootUrl The root url for scene and resources
  110449. * @param onProgress The callback when the load progresses
  110450. * @param fileName Defines the name of the file to load
  110451. * @returns Nothing
  110452. */
  110453. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  110454. /**
  110455. * Load into an asset container.
  110456. * @param scene The scene to load into
  110457. * @param data The data to import
  110458. * @param rootUrl The root url for scene and resources
  110459. * @param onProgress The callback when the load progresses
  110460. * @param fileName Defines the name of the file to load
  110461. * @returns The loaded asset container
  110462. */
  110463. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  110464. }
  110465. /**
  110466. * Class used to load scene from various file formats using registered plugins
  110467. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  110468. */
  110469. export class SceneLoader {
  110470. /**
  110471. * No logging while loading
  110472. */
  110473. static readonly NO_LOGGING: number;
  110474. /**
  110475. * Minimal logging while loading
  110476. */
  110477. static readonly MINIMAL_LOGGING: number;
  110478. /**
  110479. * Summary logging while loading
  110480. */
  110481. static readonly SUMMARY_LOGGING: number;
  110482. /**
  110483. * Detailled logging while loading
  110484. */
  110485. static readonly DETAILED_LOGGING: number;
  110486. /**
  110487. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  110488. */
  110489. static ForceFullSceneLoadingForIncremental: boolean;
  110490. /**
  110491. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  110492. */
  110493. static ShowLoadingScreen: boolean;
  110494. /**
  110495. * Defines the current logging level (while loading the scene)
  110496. * @ignorenaming
  110497. */
  110498. static loggingLevel: number;
  110499. /**
  110500. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  110501. */
  110502. static CleanBoneMatrixWeights: boolean;
  110503. /**
  110504. * Event raised when a plugin is used to load a scene
  110505. */
  110506. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110507. private static _registeredPlugins;
  110508. private static _getDefaultPlugin;
  110509. private static _getPluginForExtension;
  110510. private static _getPluginForDirectLoad;
  110511. private static _getPluginForFilename;
  110512. private static _getDirectLoad;
  110513. private static _loadData;
  110514. private static _getFileInfo;
  110515. /**
  110516. * Gets a plugin that can load the given extension
  110517. * @param extension defines the extension to load
  110518. * @returns a plugin or null if none works
  110519. */
  110520. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  110521. /**
  110522. * Gets a boolean indicating that the given extension can be loaded
  110523. * @param extension defines the extension to load
  110524. * @returns true if the extension is supported
  110525. */
  110526. static IsPluginForExtensionAvailable(extension: string): boolean;
  110527. /**
  110528. * Adds a new plugin to the list of registered plugins
  110529. * @param plugin defines the plugin to add
  110530. */
  110531. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  110532. /**
  110533. * Import meshes into a scene
  110534. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110535. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  110536. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  110537. * @param scene the instance of BABYLON.Scene to append to
  110538. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  110539. * @param onProgress a callback with a progress event for each file being loaded
  110540. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110541. * @param pluginExtension the extension used to determine the plugin
  110542. * @returns The loaded plugin
  110543. */
  110544. static ImportMesh(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], animationGroups: AnimationGroup[]) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110545. /**
  110546. * Import meshes into a scene
  110547. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110548. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  110549. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  110550. * @param scene the instance of BABYLON.Scene to append to
  110551. * @param onProgress a callback with a progress event for each file being loaded
  110552. * @param pluginExtension the extension used to determine the plugin
  110553. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  110554. */
  110555. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  110556. meshes: AbstractMesh[];
  110557. particleSystems: IParticleSystem[];
  110558. skeletons: Skeleton[];
  110559. animationGroups: AnimationGroup[];
  110560. }>;
  110561. /**
  110562. * Load a scene
  110563. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  110564. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  110565. * @param engine is the instance of BABYLON.Engine to use to create the scene
  110566. * @param onSuccess a callback with the scene when import succeeds
  110567. * @param onProgress a callback with a progress event for each file being loaded
  110568. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110569. * @param pluginExtension the extension used to determine the plugin
  110570. * @returns The loaded plugin
  110571. */
  110572. static Load(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110573. /**
  110574. * Load a scene
  110575. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  110576. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  110577. * @param engine is the instance of BABYLON.Engine to use to create the scene
  110578. * @param onProgress a callback with a progress event for each file being loaded
  110579. * @param pluginExtension the extension used to determine the plugin
  110580. * @returns The loaded scene
  110581. */
  110582. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  110583. /**
  110584. * Append a scene
  110585. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  110586. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  110587. * @param scene is the instance of BABYLON.Scene to append to
  110588. * @param onSuccess a callback with the scene when import succeeds
  110589. * @param onProgress a callback with a progress event for each file being loaded
  110590. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110591. * @param pluginExtension the extension used to determine the plugin
  110592. * @returns The loaded plugin
  110593. */
  110594. static Append(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(scene: Scene) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110595. /**
  110596. * Append a scene
  110597. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  110598. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  110599. * @param scene is the instance of BABYLON.Scene to append to
  110600. * @param onProgress a callback with a progress event for each file being loaded
  110601. * @param pluginExtension the extension used to determine the plugin
  110602. * @returns The given scene
  110603. */
  110604. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  110605. /**
  110606. * Load a scene into an asset container
  110607. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  110608. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  110609. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  110610. * @param onSuccess a callback with the scene when import succeeds
  110611. * @param onProgress a callback with a progress event for each file being loaded
  110612. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110613. * @param pluginExtension the extension used to determine the plugin
  110614. * @returns The loaded plugin
  110615. */
  110616. static LoadAssetContainer(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onSuccess?: Nullable<(assets: AssetContainer) => void>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, onError?: Nullable<(scene: Scene, message: string, exception?: any) => void>, pluginExtension?: Nullable<string>): Nullable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110617. /**
  110618. * Load a scene into an asset container
  110619. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  110620. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene (default: empty string)
  110621. * @param scene is the instance of Scene to append to
  110622. * @param onProgress a callback with a progress event for each file being loaded
  110623. * @param pluginExtension the extension used to determine the plugin
  110624. * @returns The loaded asset container
  110625. */
  110626. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  110627. }
  110628. }
  110629. declare module BABYLON {
  110630. /**
  110631. * Generic Controller
  110632. */
  110633. export class GenericController extends WebVRController {
  110634. /**
  110635. * Base Url for the controller model.
  110636. */
  110637. static readonly MODEL_BASE_URL: string;
  110638. /**
  110639. * File name for the controller model.
  110640. */
  110641. static readonly MODEL_FILENAME: string;
  110642. /**
  110643. * Creates a new GenericController from a gamepad
  110644. * @param vrGamepad the gamepad that the controller should be created from
  110645. */
  110646. constructor(vrGamepad: any);
  110647. /**
  110648. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110649. * @param scene scene in which to add meshes
  110650. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110651. */
  110652. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  110653. /**
  110654. * Called once for each button that changed state since the last frame
  110655. * @param buttonIdx Which button index changed
  110656. * @param state New state of the button
  110657. * @param changes Which properties on the state changed since last frame
  110658. */
  110659. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110660. }
  110661. }
  110662. declare module BABYLON {
  110663. /**
  110664. * Defines the WindowsMotionController object that the state of the windows motion controller
  110665. */
  110666. export class WindowsMotionController extends WebVRController {
  110667. /**
  110668. * The base url used to load the left and right controller models
  110669. */
  110670. static MODEL_BASE_URL: string;
  110671. /**
  110672. * The name of the left controller model file
  110673. */
  110674. static MODEL_LEFT_FILENAME: string;
  110675. /**
  110676. * The name of the right controller model file
  110677. */
  110678. static MODEL_RIGHT_FILENAME: string;
  110679. /**
  110680. * The controller name prefix for this controller type
  110681. */
  110682. static readonly GAMEPAD_ID_PREFIX: string;
  110683. /**
  110684. * The controller id pattern for this controller type
  110685. */
  110686. private static readonly GAMEPAD_ID_PATTERN;
  110687. private _loadedMeshInfo;
  110688. private readonly _mapping;
  110689. /**
  110690. * Fired when the trackpad on this controller is clicked
  110691. */
  110692. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  110693. /**
  110694. * Fired when the trackpad on this controller is modified
  110695. */
  110696. onTrackpadValuesChangedObservable: Observable<StickValues>;
  110697. /**
  110698. * The current x and y values of this controller's trackpad
  110699. */
  110700. trackpad: StickValues;
  110701. /**
  110702. * Creates a new WindowsMotionController from a gamepad
  110703. * @param vrGamepad the gamepad that the controller should be created from
  110704. */
  110705. constructor(vrGamepad: any);
  110706. /**
  110707. * Fired when the trigger on this controller is modified
  110708. */
  110709. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110710. /**
  110711. * Fired when the menu button on this controller is modified
  110712. */
  110713. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110714. /**
  110715. * Fired when the grip button on this controller is modified
  110716. */
  110717. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110718. /**
  110719. * Fired when the thumbstick button on this controller is modified
  110720. */
  110721. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110722. /**
  110723. * Fired when the touchpad button on this controller is modified
  110724. */
  110725. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110726. /**
  110727. * Fired when the touchpad values on this controller are modified
  110728. */
  110729. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  110730. private _updateTrackpad;
  110731. /**
  110732. * Called once per frame by the engine.
  110733. */
  110734. update(): void;
  110735. /**
  110736. * Called once for each button that changed state since the last frame
  110737. * @param buttonIdx Which button index changed
  110738. * @param state New state of the button
  110739. * @param changes Which properties on the state changed since last frame
  110740. */
  110741. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110742. /**
  110743. * Moves the buttons on the controller mesh based on their current state
  110744. * @param buttonName the name of the button to move
  110745. * @param buttonValue the value of the button which determines the buttons new position
  110746. */
  110747. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  110748. /**
  110749. * Moves the axis on the controller mesh based on its current state
  110750. * @param axis the index of the axis
  110751. * @param axisValue the value of the axis which determines the meshes new position
  110752. * @hidden
  110753. */
  110754. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  110755. /**
  110756. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110757. * @param scene scene in which to add meshes
  110758. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110759. */
  110760. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  110761. /**
  110762. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  110763. * can be transformed by button presses and axes values, based on this._mapping.
  110764. *
  110765. * @param scene scene in which the meshes exist
  110766. * @param meshes list of meshes that make up the controller model to process
  110767. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  110768. */
  110769. private processModel;
  110770. private createMeshInfo;
  110771. /**
  110772. * Gets the ray of the controller in the direction the controller is pointing
  110773. * @param length the length the resulting ray should be
  110774. * @returns a ray in the direction the controller is pointing
  110775. */
  110776. getForwardRay(length?: number): Ray;
  110777. /**
  110778. * Disposes of the controller
  110779. */
  110780. dispose(): void;
  110781. }
  110782. }
  110783. declare module BABYLON {
  110784. /**
  110785. * Oculus Touch Controller
  110786. */
  110787. export class OculusTouchController extends WebVRController {
  110788. /**
  110789. * Base Url for the controller model.
  110790. */
  110791. static MODEL_BASE_URL: string;
  110792. /**
  110793. * File name for the left controller model.
  110794. */
  110795. static MODEL_LEFT_FILENAME: string;
  110796. /**
  110797. * File name for the right controller model.
  110798. */
  110799. static MODEL_RIGHT_FILENAME: string;
  110800. /**
  110801. * Base Url for the Quest controller model.
  110802. */
  110803. static QUEST_MODEL_BASE_URL: string;
  110804. /**
  110805. * @hidden
  110806. * If the controllers are running on a device that needs the updated Quest controller models
  110807. */
  110808. static _IsQuest: boolean;
  110809. /**
  110810. * Fired when the secondary trigger on this controller is modified
  110811. */
  110812. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  110813. /**
  110814. * Fired when the thumb rest on this controller is modified
  110815. */
  110816. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  110817. /**
  110818. * Creates a new OculusTouchController from a gamepad
  110819. * @param vrGamepad the gamepad that the controller should be created from
  110820. */
  110821. constructor(vrGamepad: any);
  110822. /**
  110823. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110824. * @param scene scene in which to add meshes
  110825. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110826. */
  110827. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  110828. /**
  110829. * Fired when the A button on this controller is modified
  110830. */
  110831. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110832. /**
  110833. * Fired when the B button on this controller is modified
  110834. */
  110835. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110836. /**
  110837. * Fired when the X button on this controller is modified
  110838. */
  110839. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110840. /**
  110841. * Fired when the Y button on this controller is modified
  110842. */
  110843. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110844. /**
  110845. * Called once for each button that changed state since the last frame
  110846. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  110847. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  110848. * 2) secondary trigger (same)
  110849. * 3) A (right) X (left), touch, pressed = value
  110850. * 4) B / Y
  110851. * 5) thumb rest
  110852. * @param buttonIdx Which button index changed
  110853. * @param state New state of the button
  110854. * @param changes Which properties on the state changed since last frame
  110855. */
  110856. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110857. }
  110858. }
  110859. declare module BABYLON {
  110860. /**
  110861. * Vive Controller
  110862. */
  110863. export class ViveController extends WebVRController {
  110864. /**
  110865. * Base Url for the controller model.
  110866. */
  110867. static MODEL_BASE_URL: string;
  110868. /**
  110869. * File name for the controller model.
  110870. */
  110871. static MODEL_FILENAME: string;
  110872. /**
  110873. * Creates a new ViveController from a gamepad
  110874. * @param vrGamepad the gamepad that the controller should be created from
  110875. */
  110876. constructor(vrGamepad: any);
  110877. /**
  110878. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  110879. * @param scene scene in which to add meshes
  110880. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  110881. */
  110882. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  110883. /**
  110884. * Fired when the left button on this controller is modified
  110885. */
  110886. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110887. /**
  110888. * Fired when the right button on this controller is modified
  110889. */
  110890. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110891. /**
  110892. * Fired when the menu button on this controller is modified
  110893. */
  110894. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  110895. /**
  110896. * Called once for each button that changed state since the last frame
  110897. * Vive mapping:
  110898. * 0: touchpad
  110899. * 1: trigger
  110900. * 2: left AND right buttons
  110901. * 3: menu button
  110902. * @param buttonIdx Which button index changed
  110903. * @param state New state of the button
  110904. * @param changes Which properties on the state changed since last frame
  110905. */
  110906. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  110907. }
  110908. }
  110909. declare module BABYLON {
  110910. /**
  110911. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  110912. */
  110913. export class WebXRControllerModelLoader {
  110914. /**
  110915. * Creates the WebXRControllerModelLoader
  110916. * @param input xr input that creates the controllers
  110917. */
  110918. constructor(input: WebXRInput);
  110919. }
  110920. }
  110921. declare module BABYLON {
  110922. /**
  110923. * Contains an array of blocks representing the octree
  110924. */
  110925. export interface IOctreeContainer<T> {
  110926. /**
  110927. * Blocks within the octree
  110928. */
  110929. blocks: Array<OctreeBlock<T>>;
  110930. }
  110931. /**
  110932. * Class used to store a cell in an octree
  110933. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  110934. */
  110935. export class OctreeBlock<T> {
  110936. /**
  110937. * Gets the content of the current block
  110938. */
  110939. entries: T[];
  110940. /**
  110941. * Gets the list of block children
  110942. */
  110943. blocks: Array<OctreeBlock<T>>;
  110944. private _depth;
  110945. private _maxDepth;
  110946. private _capacity;
  110947. private _minPoint;
  110948. private _maxPoint;
  110949. private _boundingVectors;
  110950. private _creationFunc;
  110951. /**
  110952. * Creates a new block
  110953. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  110954. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  110955. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  110956. * @param depth defines the current depth of this block in the octree
  110957. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  110958. * @param creationFunc defines a callback to call when an element is added to the block
  110959. */
  110960. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  110961. /**
  110962. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  110963. */
  110964. readonly capacity: number;
  110965. /**
  110966. * Gets the minimum vector (in world space) of the block's bounding box
  110967. */
  110968. readonly minPoint: Vector3;
  110969. /**
  110970. * Gets the maximum vector (in world space) of the block's bounding box
  110971. */
  110972. readonly maxPoint: Vector3;
  110973. /**
  110974. * Add a new element to this block
  110975. * @param entry defines the element to add
  110976. */
  110977. addEntry(entry: T): void;
  110978. /**
  110979. * Remove an element from this block
  110980. * @param entry defines the element to remove
  110981. */
  110982. removeEntry(entry: T): void;
  110983. /**
  110984. * Add an array of elements to this block
  110985. * @param entries defines the array of elements to add
  110986. */
  110987. addEntries(entries: T[]): void;
  110988. /**
  110989. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  110990. * @param frustumPlanes defines the frustum planes to test
  110991. * @param selection defines the array to store current content if selection is positive
  110992. * @param allowDuplicate defines if the selection array can contains duplicated entries
  110993. */
  110994. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  110995. /**
  110996. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  110997. * @param sphereCenter defines the bounding sphere center
  110998. * @param sphereRadius defines the bounding sphere radius
  110999. * @param selection defines the array to store current content if selection is positive
  111000. * @param allowDuplicate defines if the selection array can contains duplicated entries
  111001. */
  111002. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  111003. /**
  111004. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  111005. * @param ray defines the ray to test with
  111006. * @param selection defines the array to store current content if selection is positive
  111007. */
  111008. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  111009. /**
  111010. * Subdivide the content into child blocks (this block will then be empty)
  111011. */
  111012. createInnerBlocks(): void;
  111013. /**
  111014. * @hidden
  111015. */
  111016. static _CreateBlocks<T>(worldMin: Vector3, worldMax: Vector3, entries: T[], maxBlockCapacity: number, currentDepth: number, maxDepth: number, target: IOctreeContainer<T>, creationFunc: (entry: T, block: OctreeBlock<T>) => void): void;
  111017. }
  111018. }
  111019. declare module BABYLON {
  111020. /**
  111021. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  111022. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111023. */
  111024. export class Octree<T> {
  111025. /** Defines the maximum depth (sub-levels) for your octree. Default value is 2, which means 8 8 8 = 512 blocks :) (This parameter takes precedence over capacity.) */
  111026. maxDepth: number;
  111027. /**
  111028. * Blocks within the octree containing objects
  111029. */
  111030. blocks: Array<OctreeBlock<T>>;
  111031. /**
  111032. * Content stored in the octree
  111033. */
  111034. dynamicContent: T[];
  111035. private _maxBlockCapacity;
  111036. private _selectionContent;
  111037. private _creationFunc;
  111038. /**
  111039. * Creates a octree
  111040. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111041. * @param creationFunc function to be used to instatiate the octree
  111042. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  111043. * @param maxDepth defines the maximum depth (sub-levels) for your octree. Default value is 2, which means 8 8 8 = 512 blocks :) (This parameter takes precedence over capacity.)
  111044. */
  111045. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  111046. /** Defines the maximum depth (sub-levels) for your octree. Default value is 2, which means 8 8 8 = 512 blocks :) (This parameter takes precedence over capacity.) */
  111047. maxDepth?: number);
  111048. /**
  111049. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  111050. * @param worldMin worldMin for the octree blocks var blockSize = new Vector3((worldMax.x - worldMin.x) / 2, (worldMax.y - worldMin.y) / 2, (worldMax.z - worldMin.z) / 2);
  111051. * @param worldMax worldMax for the octree blocks var blockSize = new Vector3((worldMax.x - worldMin.x) / 2, (worldMax.y - worldMin.y) / 2, (worldMax.z - worldMin.z) / 2);
  111052. * @param entries meshes to be added to the octree blocks
  111053. */
  111054. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  111055. /**
  111056. * Adds a mesh to the octree
  111057. * @param entry Mesh to add to the octree
  111058. */
  111059. addMesh(entry: T): void;
  111060. /**
  111061. * Remove an element from the octree
  111062. * @param entry defines the element to remove
  111063. */
  111064. removeMesh(entry: T): void;
  111065. /**
  111066. * Selects an array of meshes within the frustum
  111067. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  111068. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  111069. * @returns array of meshes within the frustum
  111070. */
  111071. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  111072. /**
  111073. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  111074. * @param sphereCenter defines the bounding sphere center
  111075. * @param sphereRadius defines the bounding sphere radius
  111076. * @param allowDuplicate defines if the selection array can contains duplicated entries
  111077. * @returns an array of objects that intersect the sphere
  111078. */
  111079. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  111080. /**
  111081. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  111082. * @param ray defines the ray to test with
  111083. * @returns array of intersected objects
  111084. */
  111085. intersectsRay(ray: Ray): SmartArray<T>;
  111086. /**
  111087. * Adds a mesh into the octree block if it intersects the block
  111088. */
  111089. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  111090. /**
  111091. * Adds a submesh into the octree block if it intersects the block
  111092. */
  111093. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  111094. }
  111095. }
  111096. declare module BABYLON {
  111097. interface Scene {
  111098. /**
  111099. * @hidden
  111100. * Backing Filed
  111101. */
  111102. _selectionOctree: Octree<AbstractMesh>;
  111103. /**
  111104. * Gets the octree used to boost mesh selection (picking)
  111105. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111106. */
  111107. selectionOctree: Octree<AbstractMesh>;
  111108. /**
  111109. * Creates or updates the octree used to boost selection (picking)
  111110. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111111. * @param maxCapacity defines the maximum capacity per leaf
  111112. * @param maxDepth defines the maximum depth of the octree
  111113. * @returns an octree of AbstractMesh
  111114. */
  111115. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  111116. }
  111117. interface AbstractMesh {
  111118. /**
  111119. * @hidden
  111120. * Backing Field
  111121. */
  111122. _submeshesOctree: Octree<SubMesh>;
  111123. /**
  111124. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  111125. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  111126. * @param maxCapacity defines the maximum size of each block (64 by default)
  111127. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  111128. * @returns the new octree
  111129. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  111130. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111131. */
  111132. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  111133. }
  111134. /**
  111135. * Defines the octree scene component responsible to manage any octrees
  111136. * in a given scene.
  111137. */
  111138. export class OctreeSceneComponent {
  111139. /**
  111140. * The component name help to identify the component in the list of scene components.
  111141. */
  111142. readonly name: string;
  111143. /**
  111144. * The scene the component belongs to.
  111145. */
  111146. scene: Scene;
  111147. /**
  111148. * Indicates if the meshes have been checked to make sure they are isEnabled()
  111149. */
  111150. readonly checksIsEnabled: boolean;
  111151. /**
  111152. * Creates a new instance of the component for the given scene
  111153. * @param scene Defines the scene to register the component in
  111154. */
  111155. constructor(scene: Scene);
  111156. /**
  111157. * Registers the component in a given scene
  111158. */
  111159. register(): void;
  111160. /**
  111161. * Return the list of active meshes
  111162. * @returns the list of active meshes
  111163. */
  111164. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  111165. /**
  111166. * Return the list of active sub meshes
  111167. * @param mesh The mesh to get the candidates sub meshes from
  111168. * @returns the list of active sub meshes
  111169. */
  111170. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  111171. private _tempRay;
  111172. /**
  111173. * Return the list of sub meshes intersecting with a given local ray
  111174. * @param mesh defines the mesh to find the submesh for
  111175. * @param localRay defines the ray in local space
  111176. * @returns the list of intersecting sub meshes
  111177. */
  111178. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  111179. /**
  111180. * Return the list of sub meshes colliding with a collider
  111181. * @param mesh defines the mesh to find the submesh for
  111182. * @param collider defines the collider to evaluate the collision against
  111183. * @returns the list of colliding sub meshes
  111184. */
  111185. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  111186. /**
  111187. * Rebuilds the elements related to this component in case of
  111188. * context lost for instance.
  111189. */
  111190. rebuild(): void;
  111191. /**
  111192. * Disposes the component and the associated ressources.
  111193. */
  111194. dispose(): void;
  111195. }
  111196. }
  111197. declare module BABYLON {
  111198. /**
  111199. * Renders a layer on top of an existing scene
  111200. */
  111201. export class UtilityLayerRenderer implements IDisposable {
  111202. /** the original scene that will be rendered on top of */
  111203. originalScene: Scene;
  111204. private _pointerCaptures;
  111205. private _lastPointerEvents;
  111206. private static _DefaultUtilityLayer;
  111207. private static _DefaultKeepDepthUtilityLayer;
  111208. private _sharedGizmoLight;
  111209. private _renderCamera;
  111210. /**
  111211. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  111212. * @returns the camera that is used when rendering the utility layer
  111213. */
  111214. getRenderCamera(): Nullable<Camera>;
  111215. /**
  111216. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  111217. * @param cam the camera that should be used when rendering the utility layer
  111218. */
  111219. setRenderCamera(cam: Nullable<Camera>): void;
  111220. /**
  111221. * @hidden
  111222. * Light which used by gizmos to get light shading
  111223. */
  111224. _getSharedGizmoLight(): HemisphericLight;
  111225. /**
  111226. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  111227. */
  111228. pickUtilitySceneFirst: boolean;
  111229. /**
  111230. * A shared utility layer that can be used to overlay objects into a scene (Depth map of the previous scene is cleared before drawing on top of it)
  111231. */
  111232. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  111233. /**
  111234. * A shared utility layer that can be used to embed objects into a scene (Depth map of the previous scene is not cleared before drawing on top of it)
  111235. */
  111236. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  111237. /**
  111238. * The scene that is rendered on top of the original scene
  111239. */
  111240. utilityLayerScene: Scene;
  111241. /**
  111242. * If the utility layer should automatically be rendered on top of existing scene
  111243. */
  111244. shouldRender: boolean;
  111245. /**
  111246. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  111247. */
  111248. onlyCheckPointerDownEvents: boolean;
  111249. /**
  111250. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  111251. */
  111252. processAllEvents: boolean;
  111253. /**
  111254. * Observable raised when the pointer move from the utility layer scene to the main scene
  111255. */
  111256. onPointerOutObservable: Observable<number>;
  111257. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  111258. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  111259. private _afterRenderObserver;
  111260. private _sceneDisposeObserver;
  111261. private _originalPointerObserver;
  111262. /**
  111263. * Instantiates a UtilityLayerRenderer
  111264. * @param originalScene the original scene that will be rendered on top of
  111265. * @param handleEvents boolean indicating if the utility layer should handle events
  111266. */
  111267. constructor(
  111268. /** the original scene that will be rendered on top of */
  111269. originalScene: Scene, handleEvents?: boolean);
  111270. private _notifyObservers;
  111271. /**
  111272. * Renders the utility layers scene on top of the original scene
  111273. */
  111274. render(): void;
  111275. /**
  111276. * Disposes of the renderer
  111277. */
  111278. dispose(): void;
  111279. private _updateCamera;
  111280. }
  111281. }
  111282. declare module BABYLON {
  111283. /**
  111284. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  111285. */
  111286. export class Gizmo implements IDisposable {
  111287. /** The utility layer the gizmo will be added to */
  111288. gizmoLayer: UtilityLayerRenderer;
  111289. /**
  111290. * The root mesh of the gizmo
  111291. */
  111292. _rootMesh: Mesh;
  111293. private _attachedMesh;
  111294. /**
  111295. * Ratio for the scale of the gizmo (Default: 1)
  111296. */
  111297. scaleRatio: number;
  111298. /**
  111299. * If a custom mesh has been set (Default: false)
  111300. */
  111301. protected _customMeshSet: boolean;
  111302. /**
  111303. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  111304. * * When set, interactions will be enabled
  111305. */
  111306. attachedMesh: Nullable<AbstractMesh>;
  111307. /**
  111308. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  111309. * @param mesh The mesh to replace the default mesh of the gizmo
  111310. */
  111311. setCustomMesh(mesh: Mesh): void;
  111312. /**
  111313. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  111314. */
  111315. updateGizmoRotationToMatchAttachedMesh: boolean;
  111316. /**
  111317. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  111318. */
  111319. updateGizmoPositionToMatchAttachedMesh: boolean;
  111320. /**
  111321. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  111322. */
  111323. updateScale: boolean;
  111324. protected _interactionsEnabled: boolean;
  111325. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  111326. private _beforeRenderObserver;
  111327. private _tempVector;
  111328. /**
  111329. * Creates a gizmo
  111330. * @param gizmoLayer The utility layer the gizmo will be added to
  111331. */
  111332. constructor(
  111333. /** The utility layer the gizmo will be added to */
  111334. gizmoLayer?: UtilityLayerRenderer);
  111335. /**
  111336. * Updates the gizmo to match the attached mesh's position/rotation
  111337. */
  111338. protected _update(): void;
  111339. /**
  111340. * Disposes of the gizmo
  111341. */
  111342. dispose(): void;
  111343. }
  111344. }
  111345. declare module BABYLON {
  111346. /**
  111347. * Single plane drag gizmo
  111348. */
  111349. export class PlaneDragGizmo extends Gizmo {
  111350. /**
  111351. * Drag behavior responsible for the gizmos dragging interactions
  111352. */
  111353. dragBehavior: PointerDragBehavior;
  111354. private _pointerObserver;
  111355. /**
  111356. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  111357. */
  111358. snapDistance: number;
  111359. /**
  111360. * Event that fires each time the gizmo snaps to a new location.
  111361. * * snapDistance is the the change in distance
  111362. */
  111363. onSnapObservable: Observable<{
  111364. snapDistance: number;
  111365. }>;
  111366. private _plane;
  111367. private _coloredMaterial;
  111368. private _hoverMaterial;
  111369. private _isEnabled;
  111370. private _parent;
  111371. /** @hidden */
  111372. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  111373. /** @hidden */
  111374. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  111375. /**
  111376. * Creates a PlaneDragGizmo
  111377. * @param gizmoLayer The utility layer the gizmo will be added to
  111378. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  111379. * @param color The color of the gizmo
  111380. */
  111381. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  111382. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  111383. /**
  111384. * If the gizmo is enabled
  111385. */
  111386. isEnabled: boolean;
  111387. /**
  111388. * Disposes of the gizmo
  111389. */
  111390. dispose(): void;
  111391. }
  111392. }
  111393. declare module BABYLON {
  111394. /**
  111395. * Gizmo that enables dragging a mesh along 3 axis
  111396. */
  111397. export class PositionGizmo extends Gizmo {
  111398. /**
  111399. * Internal gizmo used for interactions on the x axis
  111400. */
  111401. xGizmo: AxisDragGizmo;
  111402. /**
  111403. * Internal gizmo used for interactions on the y axis
  111404. */
  111405. yGizmo: AxisDragGizmo;
  111406. /**
  111407. * Internal gizmo used for interactions on the z axis
  111408. */
  111409. zGizmo: AxisDragGizmo;
  111410. /**
  111411. * Internal gizmo used for interactions on the yz plane
  111412. */
  111413. xPlaneGizmo: PlaneDragGizmo;
  111414. /**
  111415. * Internal gizmo used for interactions on the xz plane
  111416. */
  111417. yPlaneGizmo: PlaneDragGizmo;
  111418. /**
  111419. * Internal gizmo used for interactions on the xy plane
  111420. */
  111421. zPlaneGizmo: PlaneDragGizmo;
  111422. /**
  111423. * private variables
  111424. */
  111425. private _meshAttached;
  111426. private _updateGizmoRotationToMatchAttachedMesh;
  111427. private _snapDistance;
  111428. private _scaleRatio;
  111429. /** Fires an event when any of it's sub gizmos are dragged */
  111430. onDragStartObservable: Observable<unknown>;
  111431. /** Fires an event when any of it's sub gizmos are released from dragging */
  111432. onDragEndObservable: Observable<unknown>;
  111433. /**
  111434. * If set to true, planar drag is enabled
  111435. */
  111436. private _planarGizmoEnabled;
  111437. attachedMesh: Nullable<AbstractMesh>;
  111438. /**
  111439. * Creates a PositionGizmo
  111440. * @param gizmoLayer The utility layer the gizmo will be added to
  111441. */
  111442. constructor(gizmoLayer?: UtilityLayerRenderer);
  111443. /**
  111444. * If the planar drag gizmo is enabled
  111445. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  111446. */
  111447. planarGizmoEnabled: boolean;
  111448. updateGizmoRotationToMatchAttachedMesh: boolean;
  111449. /**
  111450. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  111451. */
  111452. snapDistance: number;
  111453. /**
  111454. * Ratio for the scale of the gizmo (Default: 1)
  111455. */
  111456. scaleRatio: number;
  111457. /**
  111458. * Disposes of the gizmo
  111459. */
  111460. dispose(): void;
  111461. /**
  111462. * CustomMeshes are not supported by this gizmo
  111463. * @param mesh The mesh to replace the default mesh of the gizmo
  111464. */
  111465. setCustomMesh(mesh: Mesh): void;
  111466. }
  111467. }
  111468. declare module BABYLON {
  111469. /**
  111470. * Single axis drag gizmo
  111471. */
  111472. export class AxisDragGizmo extends Gizmo {
  111473. /**
  111474. * Drag behavior responsible for the gizmos dragging interactions
  111475. */
  111476. dragBehavior: PointerDragBehavior;
  111477. private _pointerObserver;
  111478. /**
  111479. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  111480. */
  111481. snapDistance: number;
  111482. /**
  111483. * Event that fires each time the gizmo snaps to a new location.
  111484. * * snapDistance is the the change in distance
  111485. */
  111486. onSnapObservable: Observable<{
  111487. snapDistance: number;
  111488. }>;
  111489. private _isEnabled;
  111490. private _parent;
  111491. private _arrow;
  111492. private _coloredMaterial;
  111493. private _hoverMaterial;
  111494. /** @hidden */
  111495. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  111496. /** @hidden */
  111497. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  111498. /**
  111499. * Creates an AxisDragGizmo
  111500. * @param gizmoLayer The utility layer the gizmo will be added to
  111501. * @param dragAxis The axis which the gizmo will be able to drag on
  111502. * @param color The color of the gizmo
  111503. */
  111504. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  111505. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  111506. /**
  111507. * If the gizmo is enabled
  111508. */
  111509. isEnabled: boolean;
  111510. /**
  111511. * Disposes of the gizmo
  111512. */
  111513. dispose(): void;
  111514. }
  111515. }
  111516. declare module BABYLON.Debug {
  111517. /**
  111518. * The Axes viewer will show 3 axes in a specific point in space
  111519. */
  111520. export class AxesViewer {
  111521. private _xAxis;
  111522. private _yAxis;
  111523. private _zAxis;
  111524. private _scaleLinesFactor;
  111525. private _instanced;
  111526. /**
  111527. * Gets the hosting scene
  111528. */
  111529. scene: Scene;
  111530. /**
  111531. * Gets or sets a number used to scale line length
  111532. */
  111533. scaleLines: number;
  111534. /** Gets the node hierarchy used to render x-axis */
  111535. readonly xAxis: TransformNode;
  111536. /** Gets the node hierarchy used to render y-axis */
  111537. readonly yAxis: TransformNode;
  111538. /** Gets the node hierarchy used to render z-axis */
  111539. readonly zAxis: TransformNode;
  111540. /**
  111541. * Creates a new AxesViewer
  111542. * @param scene defines the hosting scene
  111543. * @param scaleLines defines a number used to scale line length (1 by default)
  111544. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  111545. * @param xAxis defines the node hierarchy used to render the x-axis
  111546. * @param yAxis defines the node hierarchy used to render the y-axis
  111547. * @param zAxis defines the node hierarchy used to render the z-axis
  111548. */
  111549. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  111550. /**
  111551. * Force the viewer to update
  111552. * @param position defines the position of the viewer
  111553. * @param xaxis defines the x axis of the viewer
  111554. * @param yaxis defines the y axis of the viewer
  111555. * @param zaxis defines the z axis of the viewer
  111556. */
  111557. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  111558. /**
  111559. * Creates an instance of this axes viewer.
  111560. * @returns a new axes viewer with instanced meshes
  111561. */
  111562. createInstance(): AxesViewer;
  111563. /** Releases resources */
  111564. dispose(): void;
  111565. private static _SetRenderingGroupId;
  111566. }
  111567. }
  111568. declare module BABYLON.Debug {
  111569. /**
  111570. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  111571. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  111572. */
  111573. export class BoneAxesViewer extends AxesViewer {
  111574. /**
  111575. * Gets or sets the target mesh where to display the axes viewer
  111576. */
  111577. mesh: Nullable<Mesh>;
  111578. /**
  111579. * Gets or sets the target bone where to display the axes viewer
  111580. */
  111581. bone: Nullable<Bone>;
  111582. /** Gets current position */
  111583. pos: Vector3;
  111584. /** Gets direction of X axis */
  111585. xaxis: Vector3;
  111586. /** Gets direction of Y axis */
  111587. yaxis: Vector3;
  111588. /** Gets direction of Z axis */
  111589. zaxis: Vector3;
  111590. /**
  111591. * Creates a new BoneAxesViewer
  111592. * @param scene defines the hosting scene
  111593. * @param bone defines the target bone
  111594. * @param mesh defines the target mesh
  111595. * @param scaleLines defines a scaling factor for line length (1 by default)
  111596. */
  111597. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  111598. /**
  111599. * Force the viewer to update
  111600. */
  111601. update(): void;
  111602. /** Releases resources */
  111603. dispose(): void;
  111604. }
  111605. }
  111606. declare module BABYLON {
  111607. /**
  111608. * Interface used to define scene explorer extensibility option
  111609. */
  111610. export interface IExplorerExtensibilityOption {
  111611. /**
  111612. * Define the option label
  111613. */
  111614. label: string;
  111615. /**
  111616. * Defines the action to execute on click
  111617. */
  111618. action: (entity: any) => void;
  111619. }
  111620. /**
  111621. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  111622. */
  111623. export interface IExplorerExtensibilityGroup {
  111624. /**
  111625. * Defines a predicate to test if a given type mut be extended
  111626. */
  111627. predicate: (entity: any) => boolean;
  111628. /**
  111629. * Gets the list of options added to a type
  111630. */
  111631. entries: IExplorerExtensibilityOption[];
  111632. }
  111633. /**
  111634. * Interface used to define the options to use to create the Inspector
  111635. */
  111636. export interface IInspectorOptions {
  111637. /**
  111638. * Display in overlay mode (default: false)
  111639. */
  111640. overlay?: boolean;
  111641. /**
  111642. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  111643. */
  111644. globalRoot?: HTMLElement;
  111645. /**
  111646. * Display the Scene explorer
  111647. */
  111648. showExplorer?: boolean;
  111649. /**
  111650. * Display the property inspector
  111651. */
  111652. showInspector?: boolean;
  111653. /**
  111654. * Display in embed mode (both panes on the right)
  111655. */
  111656. embedMode?: boolean;
  111657. /**
  111658. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  111659. */
  111660. handleResize?: boolean;
  111661. /**
  111662. * Allow the panes to popup (default: true)
  111663. */
  111664. enablePopup?: boolean;
  111665. /**
  111666. * Allow the panes to be closed by users (default: true)
  111667. */
  111668. enableClose?: boolean;
  111669. /**
  111670. * Optional list of extensibility entries
  111671. */
  111672. explorerExtensibility?: IExplorerExtensibilityGroup[];
  111673. /**
  111674. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  111675. */
  111676. inspectorURL?: string;
  111677. }
  111678. interface Scene {
  111679. /**
  111680. * @hidden
  111681. * Backing field
  111682. */
  111683. _debugLayer: DebugLayer;
  111684. /**
  111685. * Gets the debug layer (aka Inspector) associated with the scene
  111686. * @see http://doc.babylonjs.com/features/playground_debuglayer
  111687. */
  111688. debugLayer: DebugLayer;
  111689. }
  111690. /**
  111691. * The debug layer (aka Inspector) is the go to tool in order to better understand
  111692. * what is happening in your scene
  111693. * @see http://doc.babylonjs.com/features/playground_debuglayer
  111694. */
  111695. export class DebugLayer {
  111696. /**
  111697. * Define the url to get the inspector script from.
  111698. * By default it uses the babylonjs CDN.
  111699. * @ignoreNaming
  111700. */
  111701. static InspectorURL: string;
  111702. private _scene;
  111703. private BJSINSPECTOR;
  111704. private _onPropertyChangedObservable?;
  111705. /**
  111706. * Observable triggered when a property is changed through the inspector.
  111707. */
  111708. readonly onPropertyChangedObservable: any;
  111709. /**
  111710. * Instantiates a new debug layer.
  111711. * The debug layer (aka Inspector) is the go to tool in order to better understand
  111712. * what is happening in your scene
  111713. * @see http://doc.babylonjs.com/features/playground_debuglayer
  111714. * @param scene Defines the scene to inspect
  111715. */
  111716. constructor(scene: Scene);
  111717. /** Creates the inspector window. */
  111718. private _createInspector;
  111719. /**
  111720. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  111721. * @param entity defines the entity to select
  111722. * @param lineContainerTitle defines the specific block to highlight
  111723. */
  111724. select(entity: any, lineContainerTitle?: string): void;
  111725. /** Get the inspector from bundle or global */
  111726. private _getGlobalInspector;
  111727. /**
  111728. * Get if the inspector is visible or not.
  111729. * @returns true if visible otherwise, false
  111730. */
  111731. isVisible(): boolean;
  111732. /**
  111733. * Hide the inspector and close its window.
  111734. */
  111735. hide(): void;
  111736. /**
  111737. * Launch the debugLayer.
  111738. * @param config Define the configuration of the inspector
  111739. * @return a promise fulfilled when the debug layer is visible
  111740. */
  111741. show(config?: IInspectorOptions): Promise<DebugLayer>;
  111742. }
  111743. }
  111744. declare module BABYLON {
  111745. /**
  111746. * Class containing static functions to help procedurally build meshes
  111747. */
  111748. export class BoxBuilder {
  111749. /**
  111750. * Creates a box mesh
  111751. * * The parameter `size` sets the size (float) of each box side (default 1)
  111752. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  111753. * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of 6 Color3 elements) and `faceUV` (an array of 6 Vector4 elements)
  111754. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  111755. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  111756. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  111757. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111758. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  111759. * @param name defines the name of the mesh
  111760. * @param options defines the options used to create the mesh
  111761. * @param scene defines the hosting scene
  111762. * @returns the box mesh
  111763. */
  111764. static CreateBox(name: string, options: {
  111765. size?: number;
  111766. width?: number;
  111767. height?: number;
  111768. depth?: number;
  111769. faceUV?: Vector4[];
  111770. faceColors?: Color4[];
  111771. sideOrientation?: number;
  111772. frontUVs?: Vector4;
  111773. backUVs?: Vector4;
  111774. wrap?: boolean;
  111775. topBaseAt?: number;
  111776. bottomBaseAt?: number;
  111777. updatable?: boolean;
  111778. }, scene?: Nullable<Scene>): Mesh;
  111779. }
  111780. }
  111781. declare module BABYLON {
  111782. /**
  111783. * Class containing static functions to help procedurally build meshes
  111784. */
  111785. export class SphereBuilder {
  111786. /**
  111787. * Creates a sphere mesh
  111788. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  111789. * * You can set some different sphere dimensions, for instance to build an ellipsoid, by using the parameters `diameterX`, `diameterY` and `diameterZ` (all by default have the same value of `diameter`)
  111790. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  111791. * * You can create an unclosed sphere with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference (latitude) : 2 x PI x ratio
  111792. * * You can create an unclosed sphere on its height with the parameter `slice` (positive float, default1), valued between 0 and 1, what is the height ratio (longitude)
  111793. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  111794. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  111795. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111796. * @param name defines the name of the mesh
  111797. * @param options defines the options used to create the mesh
  111798. * @param scene defines the hosting scene
  111799. * @returns the sphere mesh
  111800. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  111801. */
  111802. static CreateSphere(name: string, options: {
  111803. segments?: number;
  111804. diameter?: number;
  111805. diameterX?: number;
  111806. diameterY?: number;
  111807. diameterZ?: number;
  111808. arc?: number;
  111809. slice?: number;
  111810. sideOrientation?: number;
  111811. frontUVs?: Vector4;
  111812. backUVs?: Vector4;
  111813. updatable?: boolean;
  111814. }, scene?: Nullable<Scene>): Mesh;
  111815. }
  111816. }
  111817. declare module BABYLON.Debug {
  111818. /**
  111819. * Used to show the physics impostor around the specific mesh
  111820. */
  111821. export class PhysicsViewer {
  111822. /** @hidden */
  111823. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  111824. /** @hidden */
  111825. protected _meshes: Array<Nullable<AbstractMesh>>;
  111826. /** @hidden */
  111827. protected _scene: Nullable<Scene>;
  111828. /** @hidden */
  111829. protected _numMeshes: number;
  111830. /** @hidden */
  111831. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  111832. private _renderFunction;
  111833. private _utilityLayer;
  111834. private _debugBoxMesh;
  111835. private _debugSphereMesh;
  111836. private _debugCylinderMesh;
  111837. private _debugMaterial;
  111838. private _debugMeshMeshes;
  111839. /**
  111840. * Creates a new PhysicsViewer
  111841. * @param scene defines the hosting scene
  111842. */
  111843. constructor(scene: Scene);
  111844. /** @hidden */
  111845. protected _updateDebugMeshes(): void;
  111846. /**
  111847. * Renders a specified physic impostor
  111848. * @param impostor defines the impostor to render
  111849. * @param targetMesh defines the mesh represented by the impostor
  111850. * @returns the new debug mesh used to render the impostor
  111851. */
  111852. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  111853. /**
  111854. * Hides a specified physic impostor
  111855. * @param impostor defines the impostor to hide
  111856. */
  111857. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  111858. private _getDebugMaterial;
  111859. private _getDebugBoxMesh;
  111860. private _getDebugSphereMesh;
  111861. private _getDebugCylinderMesh;
  111862. private _getDebugMeshMesh;
  111863. private _getDebugMesh;
  111864. /** Releases all resources */
  111865. dispose(): void;
  111866. }
  111867. }
  111868. declare module BABYLON {
  111869. /**
  111870. * Class containing static functions to help procedurally build meshes
  111871. */
  111872. export class LinesBuilder {
  111873. /**
  111874. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  111875. * * A line system mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of lines as an input parameter
  111876. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  111877. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  111878. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  111879. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  111880. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  111881. * * Updating a simple Line mesh, you just need to update every line in the `lines` array : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  111882. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  111883. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111884. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  111885. * @param name defines the name of the new line system
  111886. * @param options defines the options used to create the line system
  111887. * @param scene defines the hosting scene
  111888. * @returns a new line system mesh
  111889. */
  111890. static CreateLineSystem(name: string, options: {
  111891. lines: Vector3[][];
  111892. updatable?: boolean;
  111893. instance?: Nullable<LinesMesh>;
  111894. colors?: Nullable<Color4[][]>;
  111895. useVertexAlpha?: boolean;
  111896. }, scene: Nullable<Scene>): LinesMesh;
  111897. /**
  111898. * Creates a line mesh
  111899. * A line mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of points as an input parameter
  111900. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  111901. * * The parameter `points` is an array successive Vector3
  111902. * * The optional parameter `instance` is an instance of an existing LineMesh object to be updated with the passed `points` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  111903. * * The optional parameter `colors` is an array of successive Color4, one per line point
  111904. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  111905. * * When updating an instance, remember that only point positions can change, not the number of points
  111906. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111907. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  111908. * @param name defines the name of the new line system
  111909. * @param options defines the options used to create the line system
  111910. * @param scene defines the hosting scene
  111911. * @returns a new line mesh
  111912. */
  111913. static CreateLines(name: string, options: {
  111914. points: Vector3[];
  111915. updatable?: boolean;
  111916. instance?: Nullable<LinesMesh>;
  111917. colors?: Color4[];
  111918. useVertexAlpha?: boolean;
  111919. }, scene?: Nullable<Scene>): LinesMesh;
  111920. /**
  111921. * Creates a dashed line mesh
  111922. * * A dashed line mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of points as an input parameter
  111923. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  111924. * * The parameter `points` is an array successive Vector3
  111925. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  111926. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  111927. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  111928. * * The optional parameter `instance` is an instance of an existing LineMesh object to be updated with the passed `points` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  111929. * * When updating an instance, remember that only point positions can change, not the number of points
  111930. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  111931. * @param name defines the name of the mesh
  111932. * @param options defines the options used to create the mesh
  111933. * @param scene defines the hosting scene
  111934. * @returns the dashed line mesh
  111935. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  111936. */
  111937. static CreateDashedLines(name: string, options: {
  111938. points: Vector3[];
  111939. dashSize?: number;
  111940. gapSize?: number;
  111941. dashNb?: number;
  111942. updatable?: boolean;
  111943. instance?: LinesMesh;
  111944. }, scene?: Nullable<Scene>): LinesMesh;
  111945. }
  111946. }
  111947. declare module BABYLON {
  111948. /**
  111949. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  111950. * in order to better appreciate the issue one might have.
  111951. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  111952. */
  111953. export class RayHelper {
  111954. /**
  111955. * Defines the ray we are currently tryin to visualize.
  111956. */
  111957. ray: Nullable<Ray>;
  111958. private _renderPoints;
  111959. private _renderLine;
  111960. private _renderFunction;
  111961. private _scene;
  111962. private _updateToMeshFunction;
  111963. private _attachedToMesh;
  111964. private _meshSpaceDirection;
  111965. private _meshSpaceOrigin;
  111966. /**
  111967. * Helper function to create a colored helper in a scene in one line.
  111968. * @param ray Defines the ray we are currently tryin to visualize
  111969. * @param scene Defines the scene the ray is used in
  111970. * @param color Defines the color we want to see the ray in
  111971. * @returns The newly created ray helper.
  111972. */
  111973. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  111974. /**
  111975. * Instantiate a new ray helper.
  111976. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  111977. * in order to better appreciate the issue one might have.
  111978. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  111979. * @param ray Defines the ray we are currently tryin to visualize
  111980. */
  111981. constructor(ray: Ray);
  111982. /**
  111983. * Shows the ray we are willing to debug.
  111984. * @param scene Defines the scene the ray needs to be rendered in
  111985. * @param color Defines the color the ray needs to be rendered in
  111986. */
  111987. show(scene: Scene, color?: Color3): void;
  111988. /**
  111989. * Hides the ray we are debugging.
  111990. */
  111991. hide(): void;
  111992. private _render;
  111993. /**
  111994. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  111995. * @param mesh Defines the mesh we want the helper attached to
  111996. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  111997. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  111998. * @param length Defines the length of the ray
  111999. */
  112000. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  112001. /**
  112002. * Detach the ray helper from the mesh it has previously been attached to.
  112003. */
  112004. detachFromMesh(): void;
  112005. private _updateToMesh;
  112006. /**
  112007. * Dispose the helper and release its associated resources.
  112008. */
  112009. dispose(): void;
  112010. }
  112011. }
  112012. declare module BABYLON.Debug {
  112013. /**
  112014. * Class used to render a debug view of a given skeleton
  112015. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  112016. */
  112017. export class SkeletonViewer {
  112018. /** defines the skeleton to render */
  112019. skeleton: Skeleton;
  112020. /** defines the mesh attached to the skeleton */
  112021. mesh: AbstractMesh;
  112022. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  112023. autoUpdateBonesMatrices: boolean;
  112024. /** defines the rendering group id to use with the viewer */
  112025. renderingGroupId: number;
  112026. /** Gets or sets the color used to render the skeleton */
  112027. color: Color3;
  112028. private _scene;
  112029. private _debugLines;
  112030. private _debugMesh;
  112031. private _isEnabled;
  112032. private _renderFunction;
  112033. private _utilityLayer;
  112034. /**
  112035. * Returns the mesh used to render the bones
  112036. */
  112037. readonly debugMesh: Nullable<LinesMesh>;
  112038. /**
  112039. * Creates a new SkeletonViewer
  112040. * @param skeleton defines the skeleton to render
  112041. * @param mesh defines the mesh attached to the skeleton
  112042. * @param scene defines the hosting scene
  112043. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  112044. * @param renderingGroupId defines the rendering group id to use with the viewer
  112045. */
  112046. constructor(
  112047. /** defines the skeleton to render */
  112048. skeleton: Skeleton,
  112049. /** defines the mesh attached to the skeleton */
  112050. mesh: AbstractMesh, scene: Scene,
  112051. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  112052. autoUpdateBonesMatrices?: boolean,
  112053. /** defines the rendering group id to use with the viewer */
  112054. renderingGroupId?: number);
  112055. /** Gets or sets a boolean indicating if the viewer is enabled */
  112056. isEnabled: boolean;
  112057. private _getBonePosition;
  112058. private _getLinesForBonesWithLength;
  112059. private _getLinesForBonesNoLength;
  112060. /** Update the viewer to sync with current skeleton state */
  112061. update(): void;
  112062. /** Release associated resources */
  112063. dispose(): void;
  112064. }
  112065. }
  112066. declare module BABYLON {
  112067. /**
  112068. * Options to create the null engine
  112069. */
  112070. export class NullEngineOptions {
  112071. /**
  112072. * Render width (Default: 512)
  112073. */
  112074. renderWidth: number;
  112075. /**
  112076. * Render height (Default: 256)
  112077. */
  112078. renderHeight: number;
  112079. /**
  112080. * Texture size (Default: 512)
  112081. */
  112082. textureSize: number;
  112083. /**
  112084. * If delta time between frames should be constant
  112085. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112086. */
  112087. deterministicLockstep: boolean;
  112088. /**
  112089. * Maximum about of steps between frames (Default: 4)
  112090. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112091. */
  112092. lockstepMaxSteps: number;
  112093. }
  112094. /**
  112095. * The null engine class provides support for headless version of babylon.js.
  112096. * This can be used in server side scenario or for testing purposes
  112097. */
  112098. export class NullEngine extends Engine {
  112099. private _options;
  112100. /**
  112101. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  112102. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112103. * @returns true if engine is in deterministic lock step mode
  112104. */
  112105. isDeterministicLockStep(): boolean;
  112106. /**
  112107. * Gets the max steps when engine is running in deterministic lock step
  112108. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112109. * @returns the max steps
  112110. */
  112111. getLockstepMaxSteps(): number;
  112112. /**
  112113. * Gets the current hardware scaling level.
  112114. * By default the hardware scaling level is computed from the window device ratio.
  112115. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  112116. * @returns a number indicating the current hardware scaling level
  112117. */
  112118. getHardwareScalingLevel(): number;
  112119. constructor(options?: NullEngineOptions);
  112120. /**
  112121. * Creates a vertex buffer
  112122. * @param vertices the data for the vertex buffer
  112123. * @returns the new WebGL static buffer
  112124. */
  112125. createVertexBuffer(vertices: FloatArray): DataBuffer;
  112126. /**
  112127. * Creates a new index buffer
  112128. * @param indices defines the content of the index buffer
  112129. * @param updatable defines if the index buffer must be updatable
  112130. * @returns a new webGL buffer
  112131. */
  112132. createIndexBuffer(indices: IndicesArray): DataBuffer;
  112133. /**
  112134. * Clear the current render buffer or the current render target (if any is set up)
  112135. * @param color defines the color to use
  112136. * @param backBuffer defines if the back buffer must be cleared
  112137. * @param depth defines if the depth buffer must be cleared
  112138. * @param stencil defines if the stencil buffer must be cleared
  112139. */
  112140. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  112141. /**
  112142. * Gets the current render width
  112143. * @param useScreen defines if screen size must be used (or the current render target if any)
  112144. * @returns a number defining the current render width
  112145. */
  112146. getRenderWidth(useScreen?: boolean): number;
  112147. /**
  112148. * Gets the current render height
  112149. * @param useScreen defines if screen size must be used (or the current render target if any)
  112150. * @returns a number defining the current render height
  112151. */
  112152. getRenderHeight(useScreen?: boolean): number;
  112153. /**
  112154. * Set the WebGL's viewport
  112155. * @param viewport defines the viewport element to be used
  112156. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  112157. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  112158. */
  112159. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  112160. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  112161. /**
  112162. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  112163. * @param pipelineContext defines the pipeline context to use
  112164. * @param uniformsNames defines the list of uniform names
  112165. * @returns an array of webGL uniform locations
  112166. */
  112167. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  112168. /**
  112169. * Gets the lsit of active attributes for a given webGL program
  112170. * @param pipelineContext defines the pipeline context to use
  112171. * @param attributesNames defines the list of attribute names to get
  112172. * @returns an array of indices indicating the offset of each attribute
  112173. */
  112174. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  112175. /**
  112176. * Binds an effect to the webGL context
  112177. * @param effect defines the effect to bind
  112178. */
  112179. bindSamplers(effect: Effect): void;
  112180. /**
  112181. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  112182. * @param effect defines the effect to activate
  112183. */
  112184. enableEffect(effect: Effect): void;
  112185. /**
  112186. * Set various states to the webGL context
  112187. * @param culling defines backface culling state
  112188. * @param zOffset defines the value to apply to zOffset (0 by default)
  112189. * @param force defines if states must be applied even if cache is up to date
  112190. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  112191. */
  112192. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  112193. /**
  112194. * Set the value of an uniform to an array of int32
  112195. * @param uniform defines the webGL uniform location where to store the value
  112196. * @param array defines the array of int32 to store
  112197. */
  112198. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  112199. /**
  112200. * Set the value of an uniform to an array of int32 (stored as vec2)
  112201. * @param uniform defines the webGL uniform location where to store the value
  112202. * @param array defines the array of int32 to store
  112203. */
  112204. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  112205. /**
  112206. * Set the value of an uniform to an array of int32 (stored as vec3)
  112207. * @param uniform defines the webGL uniform location where to store the value
  112208. * @param array defines the array of int32 to store
  112209. */
  112210. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  112211. /**
  112212. * Set the value of an uniform to an array of int32 (stored as vec4)
  112213. * @param uniform defines the webGL uniform location where to store the value
  112214. * @param array defines the array of int32 to store
  112215. */
  112216. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  112217. /**
  112218. * Set the value of an uniform to an array of float32
  112219. * @param uniform defines the webGL uniform location where to store the value
  112220. * @param array defines the array of float32 to store
  112221. */
  112222. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  112223. /**
  112224. * Set the value of an uniform to an array of float32 (stored as vec2)
  112225. * @param uniform defines the webGL uniform location where to store the value
  112226. * @param array defines the array of float32 to store
  112227. */
  112228. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  112229. /**
  112230. * Set the value of an uniform to an array of float32 (stored as vec3)
  112231. * @param uniform defines the webGL uniform location where to store the value
  112232. * @param array defines the array of float32 to store
  112233. */
  112234. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  112235. /**
  112236. * Set the value of an uniform to an array of float32 (stored as vec4)
  112237. * @param uniform defines the webGL uniform location where to store the value
  112238. * @param array defines the array of float32 to store
  112239. */
  112240. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  112241. /**
  112242. * Set the value of an uniform to an array of number
  112243. * @param uniform defines the webGL uniform location where to store the value
  112244. * @param array defines the array of number to store
  112245. */
  112246. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  112247. /**
  112248. * Set the value of an uniform to an array of number (stored as vec2)
  112249. * @param uniform defines the webGL uniform location where to store the value
  112250. * @param array defines the array of number to store
  112251. */
  112252. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  112253. /**
  112254. * Set the value of an uniform to an array of number (stored as vec3)
  112255. * @param uniform defines the webGL uniform location where to store the value
  112256. * @param array defines the array of number to store
  112257. */
  112258. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  112259. /**
  112260. * Set the value of an uniform to an array of number (stored as vec4)
  112261. * @param uniform defines the webGL uniform location where to store the value
  112262. * @param array defines the array of number to store
  112263. */
  112264. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  112265. /**
  112266. * Set the value of an uniform to an array of float32 (stored as matrices)
  112267. * @param uniform defines the webGL uniform location where to store the value
  112268. * @param matrices defines the array of float32 to store
  112269. */
  112270. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  112271. /**
  112272. * Set the value of an uniform to a matrix (3x3)
  112273. * @param uniform defines the webGL uniform location where to store the value
  112274. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  112275. */
  112276. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  112277. /**
  112278. * Set the value of an uniform to a matrix (2x2)
  112279. * @param uniform defines the webGL uniform location where to store the value
  112280. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  112281. */
  112282. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  112283. /**
  112284. * Set the value of an uniform to a number (float)
  112285. * @param uniform defines the webGL uniform location where to store the value
  112286. * @param value defines the float number to store
  112287. */
  112288. setFloat(uniform: WebGLUniformLocation, value: number): void;
  112289. /**
  112290. * Set the value of an uniform to a vec2
  112291. * @param uniform defines the webGL uniform location where to store the value
  112292. * @param x defines the 1st component of the value
  112293. * @param y defines the 2nd component of the value
  112294. */
  112295. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  112296. /**
  112297. * Set the value of an uniform to a vec3
  112298. * @param uniform defines the webGL uniform location where to store the value
  112299. * @param x defines the 1st component of the value
  112300. * @param y defines the 2nd component of the value
  112301. * @param z defines the 3rd component of the value
  112302. */
  112303. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  112304. /**
  112305. * Set the value of an uniform to a boolean
  112306. * @param uniform defines the webGL uniform location where to store the value
  112307. * @param bool defines the boolean to store
  112308. */
  112309. setBool(uniform: WebGLUniformLocation, bool: number): void;
  112310. /**
  112311. * Set the value of an uniform to a vec4
  112312. * @param uniform defines the webGL uniform location where to store the value
  112313. * @param x defines the 1st component of the value
  112314. * @param y defines the 2nd component of the value
  112315. * @param z defines the 3rd component of the value
  112316. * @param w defines the 4th component of the value
  112317. */
  112318. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  112319. /**
  112320. * Sets the current alpha mode
  112321. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  112322. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  112323. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  112324. */
  112325. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  112326. /**
  112327. * Bind webGl buffers directly to the webGL context
  112328. * @param vertexBuffers defines the vertex buffer to bind
  112329. * @param indexBuffer defines the index buffer to bind
  112330. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  112331. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  112332. * @param effect defines the effect associated with the vertex buffer
  112333. */
  112334. bindBuffers(vertexBuffers: {
  112335. [key: string]: VertexBuffer;
  112336. }, indexBuffer: DataBuffer, effect: Effect): void;
  112337. /**
  112338. * Force the entire cache to be cleared
  112339. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  112340. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  112341. */
  112342. wipeCaches(bruteForce?: boolean): void;
  112343. /**
  112344. * Send a draw order
  112345. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  112346. * @param indexStart defines the starting index
  112347. * @param indexCount defines the number of index to draw
  112348. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112349. */
  112350. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  112351. /**
  112352. * Draw a list of indexed primitives
  112353. * @param fillMode defines the primitive to use
  112354. * @param indexStart defines the starting index
  112355. * @param indexCount defines the number of index to draw
  112356. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112357. */
  112358. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  112359. /**
  112360. * Draw a list of unindexed primitives
  112361. * @param fillMode defines the primitive to use
  112362. * @param verticesStart defines the index of first vertex to draw
  112363. * @param verticesCount defines the count of vertices to draw
  112364. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112365. */
  112366. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  112367. /** @hidden */
  112368. _createTexture(): WebGLTexture;
  112369. /** @hidden */
  112370. _releaseTexture(texture: InternalTexture): void;
  112371. /**
  112372. * Usually called from Texture.ts.
  112373. * Passed information to create a WebGLTexture
  112374. * @param urlArg defines a value which contains one of the following:
  112375. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  112376. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  112377. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  112378. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  112379. * @param invertY when true, image is flipped when loaded. You probably want true. Certain compressed textures may invert this if their default is inverted (eg. ktx)
  112380. * @param scene needed for loading to the correct scene
  112381. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  112382. * @param onLoad optional callback to be called upon successful completion
  112383. * @param onError optional callback to be called upon failure
  112384. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), HTMLImageElement (image format), or a Blob
  112385. * @param fallBack an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  112386. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  112387. * @param forcedExtension defines the extension to use to pick the right loader
  112388. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  112389. * @returns a InternalTexture for assignment back into BABYLON.Texture
  112390. */
  112391. createTexture(urlArg: string, noMipmap: boolean, invertY: boolean, scene: Scene, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<ArrayBuffer | HTMLImageElement>, fallBack?: InternalTexture, format?: number): InternalTexture;
  112392. /**
  112393. * Creates a new render target texture
  112394. * @param size defines the size of the texture
  112395. * @param options defines the options used to create the texture
  112396. * @returns a new render target texture stored in an InternalTexture
  112397. */
  112398. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  112399. /**
  112400. * Update the sampling mode of a given texture
  112401. * @param samplingMode defines the required sampling mode
  112402. * @param texture defines the texture to update
  112403. */
  112404. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  112405. /**
  112406. * Binds the frame buffer to the specified texture.
  112407. * @param texture The texture to render to or null for the default canvas
  112408. * @param faceIndex The face of the texture to render to in case of cube texture
  112409. * @param requiredWidth The width of the target to render to
  112410. * @param requiredHeight The height of the target to render to
  112411. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  112412. * @param depthStencilTexture The depth stencil texture to use to render
  112413. * @param lodLevel defines le lod level to bind to the frame buffer
  112414. */
  112415. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  112416. /**
  112417. * Unbind the current render target texture from the webGL context
  112418. * @param texture defines the render target texture to unbind
  112419. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  112420. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  112421. */
  112422. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  112423. /**
  112424. * Creates a dynamic vertex buffer
  112425. * @param vertices the data for the dynamic vertex buffer
  112426. * @returns the new WebGL dynamic buffer
  112427. */
  112428. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  112429. /**
  112430. * Update the content of a dynamic texture
  112431. * @param texture defines the texture to update
  112432. * @param canvas defines the canvas containing the source
  112433. * @param invertY defines if data must be stored with Y axis inverted
  112434. * @param premulAlpha defines if alpha is stored as premultiplied
  112435. * @param format defines the format of the data
  112436. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  112437. */
  112438. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  112439. /**
  112440. * Gets a boolean indicating if all created effects are ready
  112441. * @returns true if all effects are ready
  112442. */
  112443. areAllEffectsReady(): boolean;
  112444. /**
  112445. * @hidden
  112446. * Get the current error code of the webGL context
  112447. * @returns the error code
  112448. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  112449. */
  112450. getError(): number;
  112451. /** @hidden */
  112452. _getUnpackAlignement(): number;
  112453. /** @hidden */
  112454. _unpackFlipY(value: boolean): void;
  112455. /**
  112456. * Update a dynamic index buffer
  112457. * @param indexBuffer defines the target index buffer
  112458. * @param indices defines the data to update
  112459. * @param offset defines the offset in the target index buffer where update should start
  112460. */
  112461. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  112462. /**
  112463. * Updates a dynamic vertex buffer.
  112464. * @param vertexBuffer the vertex buffer to update
  112465. * @param vertices the data used to update the vertex buffer
  112466. * @param byteOffset the byte offset of the data (optional)
  112467. * @param byteLength the byte length of the data (optional)
  112468. */
  112469. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  112470. /** @hidden */
  112471. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  112472. /** @hidden */
  112473. _bindTexture(channel: number, texture: InternalTexture): void;
  112474. protected _deleteBuffer(buffer: WebGLBuffer): void;
  112475. /**
  112476. * Force the engine to release all cached effects. This means that next effect compilation will have to be done completely even if a similar effect was already compiled
  112477. */
  112478. releaseEffects(): void;
  112479. displayLoadingUI(): void;
  112480. hideLoadingUI(): void;
  112481. /** @hidden */
  112482. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112483. /** @hidden */
  112484. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112485. /** @hidden */
  112486. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112487. /** @hidden */
  112488. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  112489. }
  112490. }
  112491. declare module BABYLON {
  112492. /** @hidden */
  112493. export class _OcclusionDataStorage {
  112494. /** @hidden */
  112495. occlusionInternalRetryCounter: number;
  112496. /** @hidden */
  112497. isOcclusionQueryInProgress: boolean;
  112498. /** @hidden */
  112499. isOccluded: boolean;
  112500. /** @hidden */
  112501. occlusionRetryCount: number;
  112502. /** @hidden */
  112503. occlusionType: number;
  112504. /** @hidden */
  112505. occlusionQueryAlgorithmType: number;
  112506. }
  112507. interface Engine {
  112508. /**
  112509. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  112510. * @return the new query
  112511. */
  112512. createQuery(): WebGLQuery;
  112513. /**
  112514. * Delete and release a webGL query
  112515. * @param query defines the query to delete
  112516. * @return the current engine
  112517. */
  112518. deleteQuery(query: WebGLQuery): Engine;
  112519. /**
  112520. * Check if a given query has resolved and got its value
  112521. * @param query defines the query to check
  112522. * @returns true if the query got its value
  112523. */
  112524. isQueryResultAvailable(query: WebGLQuery): boolean;
  112525. /**
  112526. * Gets the value of a given query
  112527. * @param query defines the query to check
  112528. * @returns the value of the query
  112529. */
  112530. getQueryResult(query: WebGLQuery): number;
  112531. /**
  112532. * Initiates an occlusion query
  112533. * @param algorithmType defines the algorithm to use
  112534. * @param query defines the query to use
  112535. * @returns the current engine
  112536. * @see http://doc.babylonjs.com/features/occlusionquery
  112537. */
  112538. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  112539. /**
  112540. * Ends an occlusion query
  112541. * @see http://doc.babylonjs.com/features/occlusionquery
  112542. * @param algorithmType defines the algorithm to use
  112543. * @returns the current engine
  112544. */
  112545. endOcclusionQuery(algorithmType: number): Engine;
  112546. /**
  112547. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  112548. * Please note that only one query can be issued at a time
  112549. * @returns a time token used to track the time span
  112550. */
  112551. startTimeQuery(): Nullable<_TimeToken>;
  112552. /**
  112553. * Ends a time query
  112554. * @param token defines the token used to measure the time span
  112555. * @returns the time spent (in ns)
  112556. */
  112557. endTimeQuery(token: _TimeToken): int;
  112558. /** @hidden */
  112559. _currentNonTimestampToken: Nullable<_TimeToken>;
  112560. /** @hidden */
  112561. _createTimeQuery(): WebGLQuery;
  112562. /** @hidden */
  112563. _deleteTimeQuery(query: WebGLQuery): void;
  112564. /** @hidden */
  112565. _getGlAlgorithmType(algorithmType: number): number;
  112566. /** @hidden */
  112567. _getTimeQueryResult(query: WebGLQuery): any;
  112568. /** @hidden */
  112569. _getTimeQueryAvailability(query: WebGLQuery): any;
  112570. }
  112571. interface AbstractMesh {
  112572. /**
  112573. * Backing filed
  112574. * @hidden
  112575. */
  112576. __occlusionDataStorage: _OcclusionDataStorage;
  112577. /**
  112578. * Access property
  112579. * @hidden
  112580. */
  112581. _occlusionDataStorage: _OcclusionDataStorage;
  112582. /**
  112583. * This number indicates the number of allowed retries before stop the occlusion query, this is useful if the occlusion query is taking long time before to the query result is retireved, the query result indicates if the object is visible within the scene or not and based on that Babylon.Js engine decideds to show or hide the object.
  112584. * The default value is -1 which means don't break the query and wait till the result
  112585. * @see http://doc.babylonjs.com/features/occlusionquery
  112586. */
  112587. occlusionRetryCount: number;
  112588. /**
  112589. * This property is responsible for starting the occlusion query within the Mesh or not, this property is also used to determine what should happen when the occlusionRetryCount is reached. It has supports 3 values:
  112590. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  112591. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  112592. * * OCCLUSION_TYPE_STRICT: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken restore the last state of the mesh occlusion if the mesh was visible then show the mesh if was hidden then hide don't show.
  112593. * @see http://doc.babylonjs.com/features/occlusionquery
  112594. */
  112595. occlusionType: number;
  112596. /**
  112597. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  112598. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  112599. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE (Default Value) which is mapped to GL_ANY_SAMPLES_PASSED_CONSERVATIVE which is a false positive algorithm that is faster than GL_ANY_SAMPLES_PASSED but less accurate.
  112600. * @see http://doc.babylonjs.com/features/occlusionquery
  112601. */
  112602. occlusionQueryAlgorithmType: number;
  112603. /**
  112604. * Gets or sets whether the mesh is occluded or not, it is used also to set the intial state of the mesh to be occluded or not
  112605. * @see http://doc.babylonjs.com/features/occlusionquery
  112606. */
  112607. isOccluded: boolean;
  112608. /**
  112609. * Flag to check the progress status of the query
  112610. * @see http://doc.babylonjs.com/features/occlusionquery
  112611. */
  112612. isOcclusionQueryInProgress: boolean;
  112613. }
  112614. }
  112615. declare module BABYLON {
  112616. /** @hidden */
  112617. export var _forceTransformFeedbackToBundle: boolean;
  112618. interface Engine {
  112619. /**
  112620. * Creates a webGL transform feedback object
  112621. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  112622. * @returns the webGL transform feedback object
  112623. */
  112624. createTransformFeedback(): WebGLTransformFeedback;
  112625. /**
  112626. * Delete a webGL transform feedback object
  112627. * @param value defines the webGL transform feedback object to delete
  112628. */
  112629. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  112630. /**
  112631. * Bind a webGL transform feedback object to the webgl context
  112632. * @param value defines the webGL transform feedback object to bind
  112633. */
  112634. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  112635. /**
  112636. * Begins a transform feedback operation
  112637. * @param usePoints defines if points or triangles must be used
  112638. */
  112639. beginTransformFeedback(usePoints: boolean): void;
  112640. /**
  112641. * Ends a transform feedback operation
  112642. */
  112643. endTransformFeedback(): void;
  112644. /**
  112645. * Specify the varyings to use with transform feedback
  112646. * @param program defines the associated webGL program
  112647. * @param value defines the list of strings representing the varying names
  112648. */
  112649. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  112650. /**
  112651. * Bind a webGL buffer for a transform feedback operation
  112652. * @param value defines the webGL buffer to bind
  112653. */
  112654. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  112655. }
  112656. }
  112657. declare module BABYLON {
  112658. /**
  112659. * Creation options of the multi render target texture.
  112660. */
  112661. export interface IMultiRenderTargetOptions {
  112662. /**
  112663. * Define if the texture needs to create mip maps after render.
  112664. */
  112665. generateMipMaps?: boolean;
  112666. /**
  112667. * Define the types of all the draw buffers we want to create
  112668. */
  112669. types?: number[];
  112670. /**
  112671. * Define the sampling modes of all the draw buffers we want to create
  112672. */
  112673. samplingModes?: number[];
  112674. /**
  112675. * Define if a depth buffer is required
  112676. */
  112677. generateDepthBuffer?: boolean;
  112678. /**
  112679. * Define if a stencil buffer is required
  112680. */
  112681. generateStencilBuffer?: boolean;
  112682. /**
  112683. * Define if a depth texture is required instead of a depth buffer
  112684. */
  112685. generateDepthTexture?: boolean;
  112686. /**
  112687. * Define the number of desired draw buffers
  112688. */
  112689. textureCount?: number;
  112690. /**
  112691. * Define if aspect ratio should be adapted to the texture or stay the scene one
  112692. */
  112693. doNotChangeAspectRatio?: boolean;
  112694. /**
  112695. * Define the default type of the buffers we are creating
  112696. */
  112697. defaultType?: number;
  112698. }
  112699. /**
  112700. * A multi render target, like a render target provides the ability to render to a texture.
  112701. * Unlike the render target, it can render to several draw buffers in one draw.
  112702. * This is specially interesting in deferred rendering or for any effects requiring more than
  112703. * just one color from a single pass.
  112704. */
  112705. export class MultiRenderTarget extends RenderTargetTexture {
  112706. private _internalTextures;
  112707. private _textures;
  112708. private _multiRenderTargetOptions;
  112709. /**
  112710. * Get if draw buffers are currently supported by the used hardware and browser.
  112711. */
  112712. readonly isSupported: boolean;
  112713. /**
  112714. * Get the list of textures generated by the multi render target.
  112715. */
  112716. readonly textures: Texture[];
  112717. /**
  112718. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  112719. */
  112720. readonly depthTexture: Texture;
  112721. /**
  112722. * Set the wrapping mode on U of all the textures we are rendering to.
  112723. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  112724. */
  112725. wrapU: number;
  112726. /**
  112727. * Set the wrapping mode on V of all the textures we are rendering to.
  112728. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  112729. */
  112730. wrapV: number;
  112731. /**
  112732. * Instantiate a new multi render target texture.
  112733. * A multi render target, like a render target provides the ability to render to a texture.
  112734. * Unlike the render target, it can render to several draw buffers in one draw.
  112735. * This is specially interesting in deferred rendering or for any effects requiring more than
  112736. * just one color from a single pass.
  112737. * @param name Define the name of the texture
  112738. * @param size Define the size of the buffers to render to
  112739. * @param count Define the number of target we are rendering into
  112740. * @param scene Define the scene the texture belongs to
  112741. * @param options Define the options used to create the multi render target
  112742. */
  112743. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  112744. /** @hidden */
  112745. _rebuild(): void;
  112746. private _createInternalTextures;
  112747. private _createTextures;
  112748. /**
  112749. * Define the number of samples used if MSAA is enabled.
  112750. */
  112751. samples: number;
  112752. /**
  112753. * Resize all the textures in the multi render target.
  112754. * Be carrefull as it will recreate all the data in the new texture.
  112755. * @param size Define the new size
  112756. */
  112757. resize(size: any): void;
  112758. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  112759. /**
  112760. * Dispose the render targets and their associated resources
  112761. */
  112762. dispose(): void;
  112763. /**
  112764. * Release all the underlying texture used as draw buffers.
  112765. */
  112766. releaseInternalTextures(): void;
  112767. }
  112768. }
  112769. declare module BABYLON {
  112770. interface ThinEngine {
  112771. /**
  112772. * Unbind a list of render target textures from the webGL context
  112773. * This is used only when drawBuffer extension or webGL2 are active
  112774. * @param textures defines the render target textures to unbind
  112775. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  112776. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  112777. */
  112778. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  112779. /**
  112780. * Create a multi render target texture
  112781. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  112782. * @param size defines the size of the texture
  112783. * @param options defines the creation options
  112784. * @returns the cube texture as an InternalTexture
  112785. */
  112786. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  112787. /**
  112788. * Update the sample count for a given multiple render target texture
  112789. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  112790. * @param textures defines the textures to update
  112791. * @param samples defines the sample count to set
  112792. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  112793. */
  112794. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  112795. }
  112796. }
  112797. declare module BABYLON {
  112798. /**
  112799. * Class used to define an additional view for the engine
  112800. * @see https://doc.babylonjs.com/how_to/multi_canvases
  112801. */
  112802. export class EngineView {
  112803. /** Defines the canvas where to render the view */
  112804. target: HTMLCanvasElement;
  112805. /** Defines an optional camera used to render the view (will use active camera else) */
  112806. camera?: Camera;
  112807. }
  112808. interface Engine {
  112809. /**
  112810. * Gets or sets the HTML element to use for attaching events
  112811. */
  112812. inputElement: Nullable<HTMLElement>;
  112813. /**
  112814. * Gets the current engine view
  112815. * @see https://doc.babylonjs.com/how_to/multi_canvases
  112816. */
  112817. activeView: Nullable<EngineView>;
  112818. /** Gets or sets the list of views */
  112819. views: EngineView[];
  112820. /**
  112821. * Register a new child canvas
  112822. * @param canvas defines the canvas to register
  112823. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  112824. * @returns the associated view
  112825. */
  112826. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  112827. /**
  112828. * Remove a registered child canvas
  112829. * @param canvas defines the canvas to remove
  112830. * @returns the current engine
  112831. */
  112832. unRegisterView(canvas: HTMLCanvasElement): Engine;
  112833. }
  112834. }
  112835. declare module BABYLON {
  112836. /**
  112837. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  112838. */
  112839. export interface CubeMapInfo {
  112840. /**
  112841. * The pixel array for the front face.
  112842. * This is stored in format, left to right, up to down format.
  112843. */
  112844. front: Nullable<ArrayBufferView>;
  112845. /**
  112846. * The pixel array for the back face.
  112847. * This is stored in format, left to right, up to down format.
  112848. */
  112849. back: Nullable<ArrayBufferView>;
  112850. /**
  112851. * The pixel array for the left face.
  112852. * This is stored in format, left to right, up to down format.
  112853. */
  112854. left: Nullable<ArrayBufferView>;
  112855. /**
  112856. * The pixel array for the right face.
  112857. * This is stored in format, left to right, up to down format.
  112858. */
  112859. right: Nullable<ArrayBufferView>;
  112860. /**
  112861. * The pixel array for the up face.
  112862. * This is stored in format, left to right, up to down format.
  112863. */
  112864. up: Nullable<ArrayBufferView>;
  112865. /**
  112866. * The pixel array for the down face.
  112867. * This is stored in format, left to right, up to down format.
  112868. */
  112869. down: Nullable<ArrayBufferView>;
  112870. /**
  112871. * The size of the cubemap stored.
  112872. *
  112873. * Each faces will be size * size pixels.
  112874. */
  112875. size: number;
  112876. /**
  112877. * The format of the texture.
  112878. *
  112879. * RGBA, RGB.
  112880. */
  112881. format: number;
  112882. /**
  112883. * The type of the texture data.
  112884. *
  112885. * UNSIGNED_INT, FLOAT.
  112886. */
  112887. type: number;
  112888. /**
  112889. * Specifies whether the texture is in gamma space.
  112890. */
  112891. gammaSpace: boolean;
  112892. }
  112893. /**
  112894. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  112895. */
  112896. export class PanoramaToCubeMapTools {
  112897. private static FACE_FRONT;
  112898. private static FACE_BACK;
  112899. private static FACE_RIGHT;
  112900. private static FACE_LEFT;
  112901. private static FACE_DOWN;
  112902. private static FACE_UP;
  112903. /**
  112904. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  112905. *
  112906. * @param float32Array The source data.
  112907. * @param inputWidth The width of the input panorama.
  112908. * @param inputHeight The height of the input panorama.
  112909. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  112910. * @return The cubemap data
  112911. */
  112912. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  112913. private static CreateCubemapTexture;
  112914. private static CalcProjectionSpherical;
  112915. }
  112916. }
  112917. declare module BABYLON {
  112918. /**
  112919. * Helper class dealing with the extraction of spherical polynomial dataArray
  112920. * from a cube map.
  112921. */
  112922. export class CubeMapToSphericalPolynomialTools {
  112923. private static FileFaces;
  112924. /**
  112925. * Converts a texture to the according Spherical Polynomial data.
  112926. * This extracts the first 3 orders only as they are the only one used in the lighting.
  112927. *
  112928. * @param texture The texture to extract the information from.
  112929. * @return The Spherical Polynomial data.
  112930. */
  112931. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  112932. /**
  112933. * Converts a cubemap to the according Spherical Polynomial data.
  112934. * This extracts the first 3 orders only as they are the only one used in the lighting.
  112935. *
  112936. * @param cubeInfo The Cube map to extract the information from.
  112937. * @return The Spherical Polynomial data.
  112938. */
  112939. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  112940. }
  112941. }
  112942. declare module BABYLON {
  112943. interface BaseTexture {
  112944. /**
  112945. * Get the polynomial representation of the texture data.
  112946. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  112947. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  112948. */
  112949. sphericalPolynomial: Nullable<SphericalPolynomial>;
  112950. }
  112951. }
  112952. declare module BABYLON {
  112953. /** @hidden */
  112954. export var rgbdEncodePixelShader: {
  112955. name: string;
  112956. shader: string;
  112957. };
  112958. }
  112959. declare module BABYLON {
  112960. /** @hidden */
  112961. export var rgbdDecodePixelShader: {
  112962. name: string;
  112963. shader: string;
  112964. };
  112965. }
  112966. declare module BABYLON {
  112967. /**
  112968. * Raw texture data and descriptor sufficient for WebGL texture upload
  112969. */
  112970. export interface EnvironmentTextureInfo {
  112971. /**
  112972. * Version of the environment map
  112973. */
  112974. version: number;
  112975. /**
  112976. * Width of image
  112977. */
  112978. width: number;
  112979. /**
  112980. * Irradiance information stored in the file.
  112981. */
  112982. irradiance: any;
  112983. /**
  112984. * Specular information stored in the file.
  112985. */
  112986. specular: any;
  112987. }
  112988. /**
  112989. * Defines One Image in the file. It requires only the position in the file
  112990. * as well as the length.
  112991. */
  112992. interface BufferImageData {
  112993. /**
  112994. * Length of the image data.
  112995. */
  112996. length: number;
  112997. /**
  112998. * Position of the data from the null terminator delimiting the end of the JSON.
  112999. */
  113000. position: number;
  113001. }
  113002. /**
  113003. * Defines the specular data enclosed in the file.
  113004. * This corresponds to the version 1 of the data.
  113005. */
  113006. export interface EnvironmentTextureSpecularInfoV1 {
  113007. /**
  113008. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  113009. */
  113010. specularDataPosition?: number;
  113011. /**
  113012. * This contains all the images data needed to reconstruct the cubemap.
  113013. */
  113014. mipmaps: Array<BufferImageData>;
  113015. /**
  113016. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  113017. */
  113018. lodGenerationScale: number;
  113019. }
  113020. /**
  113021. * Sets of helpers addressing the serialization and deserialization of environment texture
  113022. * stored in a BabylonJS env file.
  113023. * Those files are usually stored as .env files.
  113024. */
  113025. export class EnvironmentTextureTools {
  113026. /**
  113027. * Magic number identifying the env file.
  113028. */
  113029. private static _MagicBytes;
  113030. /**
  113031. * Gets the environment info from an env file.
  113032. * @param data The array buffer containing the .env bytes.
  113033. * @returns the environment file info (the json header) if successfully parsed.
  113034. */
  113035. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  113036. /**
  113037. * Creates an environment texture from a loaded cube texture.
  113038. * @param texture defines the cube texture to convert in env file
  113039. * @return a promise containing the environment data if succesfull.
  113040. */
  113041. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  113042. /**
  113043. * Creates a JSON representation of the spherical data.
  113044. * @param texture defines the texture containing the polynomials
  113045. * @return the JSON representation of the spherical info
  113046. */
  113047. private static _CreateEnvTextureIrradiance;
  113048. /**
  113049. * Creates the ArrayBufferViews used for initializing environment texture image data.
  113050. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  113051. * @param info parameters that determine what views will be created for accessing the underlying buffer
  113052. * @return the views described by info providing access to the underlying buffer
  113053. */
  113054. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  113055. /**
  113056. * Uploads the texture info contained in the env file to the GPU.
  113057. * @param texture defines the internal texture to upload to
  113058. * @param arrayBuffer defines the buffer cotaining the data to load
  113059. * @param info defines the texture info retrieved through the GetEnvInfo method
  113060. * @returns a promise
  113061. */
  113062. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  113063. private static _OnImageReadyAsync;
  113064. /**
  113065. * Uploads the levels of image data to the GPU.
  113066. * @param texture defines the internal texture to upload to
  113067. * @param imageData defines the array buffer views of image data [mipmap][face]
  113068. * @returns a promise
  113069. */
  113070. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  113071. /**
  113072. * Uploads spherical polynomials information to the texture.
  113073. * @param texture defines the texture we are trying to upload the information to
  113074. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  113075. */
  113076. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  113077. /** @hidden */
  113078. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  113079. }
  113080. }
  113081. declare module BABYLON {
  113082. /**
  113083. * Contains position and normal vectors for a vertex
  113084. */
  113085. export class PositionNormalVertex {
  113086. /** the position of the vertex (defaut: 0,0,0) */
  113087. position: Vector3;
  113088. /** the normal of the vertex (defaut: 0,1,0) */
  113089. normal: Vector3;
  113090. /**
  113091. * Creates a PositionNormalVertex
  113092. * @param position the position of the vertex (defaut: 0,0,0)
  113093. * @param normal the normal of the vertex (defaut: 0,1,0)
  113094. */
  113095. constructor(
  113096. /** the position of the vertex (defaut: 0,0,0) */
  113097. position?: Vector3,
  113098. /** the normal of the vertex (defaut: 0,1,0) */
  113099. normal?: Vector3);
  113100. /**
  113101. * Clones the PositionNormalVertex
  113102. * @returns the cloned PositionNormalVertex
  113103. */
  113104. clone(): PositionNormalVertex;
  113105. }
  113106. /**
  113107. * Contains position, normal and uv vectors for a vertex
  113108. */
  113109. export class PositionNormalTextureVertex {
  113110. /** the position of the vertex (defaut: 0,0,0) */
  113111. position: Vector3;
  113112. /** the normal of the vertex (defaut: 0,1,0) */
  113113. normal: Vector3;
  113114. /** the uv of the vertex (default: 0,0) */
  113115. uv: Vector2;
  113116. /**
  113117. * Creates a PositionNormalTextureVertex
  113118. * @param position the position of the vertex (defaut: 0,0,0)
  113119. * @param normal the normal of the vertex (defaut: 0,1,0)
  113120. * @param uv the uv of the vertex (default: 0,0)
  113121. */
  113122. constructor(
  113123. /** the position of the vertex (defaut: 0,0,0) */
  113124. position?: Vector3,
  113125. /** the normal of the vertex (defaut: 0,1,0) */
  113126. normal?: Vector3,
  113127. /** the uv of the vertex (default: 0,0) */
  113128. uv?: Vector2);
  113129. /**
  113130. * Clones the PositionNormalTextureVertex
  113131. * @returns the cloned PositionNormalTextureVertex
  113132. */
  113133. clone(): PositionNormalTextureVertex;
  113134. }
  113135. }
  113136. declare module BABYLON {
  113137. /** @hidden */
  113138. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  113139. private _genericAttributeLocation;
  113140. private _varyingLocationCount;
  113141. private _varyingLocationMap;
  113142. private _replacements;
  113143. private _textureCount;
  113144. private _uniforms;
  113145. lineProcessor(line: string): string;
  113146. attributeProcessor(attribute: string): string;
  113147. varyingProcessor(varying: string, isFragment: boolean): string;
  113148. uniformProcessor(uniform: string): string;
  113149. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  113150. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  113151. }
  113152. }
  113153. declare module BABYLON {
  113154. /**
  113155. * Container for accessors for natively-stored mesh data buffers.
  113156. */
  113157. class NativeDataBuffer extends DataBuffer {
  113158. /**
  113159. * Accessor value used to identify/retrieve a natively-stored index buffer.
  113160. */
  113161. nativeIndexBuffer?: any;
  113162. /**
  113163. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  113164. */
  113165. nativeVertexBuffer?: any;
  113166. }
  113167. /** @hidden */
  113168. class NativeTexture extends InternalTexture {
  113169. getInternalTexture(): InternalTexture;
  113170. getViewCount(): number;
  113171. }
  113172. /** @hidden */
  113173. export class NativeEngine extends Engine {
  113174. private readonly _native;
  113175. getHardwareScalingLevel(): number;
  113176. constructor();
  113177. /**
  113178. * Can be used to override the current requestAnimationFrame requester.
  113179. * @hidden
  113180. */
  113181. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  113182. /**
  113183. * Override default engine behavior.
  113184. * @param color
  113185. * @param backBuffer
  113186. * @param depth
  113187. * @param stencil
  113188. */
  113189. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  113190. clear(color: Color4, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  113191. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  113192. createVertexBuffer(data: DataArray): NativeDataBuffer;
  113193. recordVertexArrayObject(vertexBuffers: {
  113194. [key: string]: VertexBuffer;
  113195. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  113196. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  113197. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  113198. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  113199. /**
  113200. * Draw a list of indexed primitives
  113201. * @param fillMode defines the primitive to use
  113202. * @param indexStart defines the starting index
  113203. * @param indexCount defines the number of index to draw
  113204. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  113205. */
  113206. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  113207. /**
  113208. * Draw a list of unindexed primitives
  113209. * @param fillMode defines the primitive to use
  113210. * @param verticesStart defines the index of first vertex to draw
  113211. * @param verticesCount defines the count of vertices to draw
  113212. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  113213. */
  113214. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  113215. createPipelineContext(): IPipelineContext;
  113216. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  113217. /** @hidden */
  113218. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  113219. /** @hidden */
  113220. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  113221. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  113222. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  113223. protected _setProgram(program: WebGLProgram): void;
  113224. _releaseEffect(effect: Effect): void;
  113225. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  113226. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  113227. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  113228. bindSamplers(effect: Effect): void;
  113229. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  113230. getRenderWidth(useScreen?: boolean): number;
  113231. getRenderHeight(useScreen?: boolean): number;
  113232. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  113233. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  113234. /**
  113235. * Set the z offset to apply to current rendering
  113236. * @param value defines the offset to apply
  113237. */
  113238. setZOffset(value: number): void;
  113239. /**
  113240. * Gets the current value of the zOffset
  113241. * @returns the current zOffset state
  113242. */
  113243. getZOffset(): number;
  113244. /**
  113245. * Enable or disable depth buffering
  113246. * @param enable defines the state to set
  113247. */
  113248. setDepthBuffer(enable: boolean): void;
  113249. /**
  113250. * Gets a boolean indicating if depth writing is enabled
  113251. * @returns the current depth writing state
  113252. */
  113253. getDepthWrite(): boolean;
  113254. /**
  113255. * Enable or disable depth writing
  113256. * @param enable defines the state to set
  113257. */
  113258. setDepthWrite(enable: boolean): void;
  113259. /**
  113260. * Enable or disable color writing
  113261. * @param enable defines the state to set
  113262. */
  113263. setColorWrite(enable: boolean): void;
  113264. /**
  113265. * Gets a boolean indicating if color writing is enabled
  113266. * @returns the current color writing state
  113267. */
  113268. getColorWrite(): boolean;
  113269. /**
  113270. * Sets alpha constants used by some alpha blending modes
  113271. * @param r defines the red component
  113272. * @param g defines the green component
  113273. * @param b defines the blue component
  113274. * @param a defines the alpha component
  113275. */
  113276. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  113277. /**
  113278. * Sets the current alpha mode
  113279. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  113280. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  113281. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  113282. */
  113283. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  113284. /**
  113285. * Gets the current alpha mode
  113286. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  113287. * @returns the current alpha mode
  113288. */
  113289. getAlphaMode(): number;
  113290. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  113291. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  113292. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  113293. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  113294. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  113295. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  113296. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  113297. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  113298. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  113299. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  113300. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  113301. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  113302. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  113303. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  113304. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  113305. setFloat(uniform: WebGLUniformLocation, value: number): void;
  113306. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  113307. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  113308. setBool(uniform: WebGLUniformLocation, bool: number): void;
  113309. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  113310. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  113311. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  113312. wipeCaches(bruteForce?: boolean): void;
  113313. _createTexture(): WebGLTexture;
  113314. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  113315. /**
  113316. * Usually called from BABYLON.Texture.ts.
  113317. * Passed information to create a WebGLTexture
  113318. * @param urlArg defines a value which contains one of the following:
  113319. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  113320. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  113321. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  113322. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  113323. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  113324. * @param scene needed for loading to the correct scene
  113325. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  113326. * @param onLoad optional callback to be called upon successful completion
  113327. * @param onError optional callback to be called upon failure
  113328. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  113329. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  113330. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  113331. * @param forcedExtension defines the extension to use to pick the right loader
  113332. * @returns a InternalTexture for assignment back into BABYLON.Texture
  113333. */
  113334. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<Scene>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>): InternalTexture;
  113335. /**
  113336. * Creates a cube texture
  113337. * @param rootUrl defines the url where the files to load is located
  113338. * @param scene defines the current scene
  113339. * @param files defines the list of files to load (1 per face)
  113340. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  113341. * @param onLoad defines an optional callback raised when the texture is loaded
  113342. * @param onError defines an optional callback raised if there is an issue to load the texture
  113343. * @param format defines the format of the data
  113344. * @param forcedExtension defines the extension to use to pick the right loader
  113345. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  113346. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  113347. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  113348. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  113349. * @returns the cube texture as an InternalTexture
  113350. */
  113351. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap?: boolean, onLoad?: Nullable<(data?: any) => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number, fallback?: Nullable<InternalTexture>): InternalTexture;
  113352. private _getSamplingFilter;
  113353. private static _GetNativeTextureFormat;
  113354. createRenderTargetTexture(size: number | {
  113355. width: number;
  113356. height: number;
  113357. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  113358. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  113359. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  113360. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  113361. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  113362. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  113363. /**
  113364. * Updates a dynamic vertex buffer.
  113365. * @param vertexBuffer the vertex buffer to update
  113366. * @param data the data used to update the vertex buffer
  113367. * @param byteOffset the byte offset of the data (optional)
  113368. * @param byteLength the byte length of the data (optional)
  113369. */
  113370. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  113371. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  113372. private _updateAnisotropicLevel;
  113373. private _getAddressMode;
  113374. /** @hidden */
  113375. _bindTexture(channel: number, texture: InternalTexture): void;
  113376. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  113377. releaseEffects(): void;
  113378. /** @hidden */
  113379. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113380. /** @hidden */
  113381. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113382. /** @hidden */
  113383. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113384. /** @hidden */
  113385. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  113386. }
  113387. }
  113388. declare module BABYLON {
  113389. /**
  113390. * Gather the list of clipboard event types as constants.
  113391. */
  113392. export class ClipboardEventTypes {
  113393. /**
  113394. * The clipboard event is fired when a copy command is active (pressed).
  113395. */
  113396. static readonly COPY: number;
  113397. /**
  113398. * The clipboard event is fired when a cut command is active (pressed).
  113399. */
  113400. static readonly CUT: number;
  113401. /**
  113402. * The clipboard event is fired when a paste command is active (pressed).
  113403. */
  113404. static readonly PASTE: number;
  113405. }
  113406. /**
  113407. * This class is used to store clipboard related info for the onClipboardObservable event.
  113408. */
  113409. export class ClipboardInfo {
  113410. /**
  113411. * Defines the type of event (BABYLON.ClipboardEventTypes)
  113412. */
  113413. type: number;
  113414. /**
  113415. * Defines the related dom event
  113416. */
  113417. event: ClipboardEvent;
  113418. /**
  113419. *Creates an instance of ClipboardInfo.
  113420. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  113421. * @param event Defines the related dom event
  113422. */
  113423. constructor(
  113424. /**
  113425. * Defines the type of event (BABYLON.ClipboardEventTypes)
  113426. */
  113427. type: number,
  113428. /**
  113429. * Defines the related dom event
  113430. */
  113431. event: ClipboardEvent);
  113432. /**
  113433. * Get the clipboard event's type from the keycode.
  113434. * @param keyCode Defines the keyCode for the current keyboard event.
  113435. * @return {number}
  113436. */
  113437. static GetTypeFromCharacter(keyCode: number): number;
  113438. }
  113439. }
  113440. declare module BABYLON {
  113441. /**
  113442. * Google Daydream controller
  113443. */
  113444. export class DaydreamController extends WebVRController {
  113445. /**
  113446. * Base Url for the controller model.
  113447. */
  113448. static MODEL_BASE_URL: string;
  113449. /**
  113450. * File name for the controller model.
  113451. */
  113452. static MODEL_FILENAME: string;
  113453. /**
  113454. * Gamepad Id prefix used to identify Daydream Controller.
  113455. */
  113456. static readonly GAMEPAD_ID_PREFIX: string;
  113457. /**
  113458. * Creates a new DaydreamController from a gamepad
  113459. * @param vrGamepad the gamepad that the controller should be created from
  113460. */
  113461. constructor(vrGamepad: any);
  113462. /**
  113463. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  113464. * @param scene scene in which to add meshes
  113465. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  113466. */
  113467. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  113468. /**
  113469. * Called once for each button that changed state since the last frame
  113470. * @param buttonIdx Which button index changed
  113471. * @param state New state of the button
  113472. * @param changes Which properties on the state changed since last frame
  113473. */
  113474. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  113475. }
  113476. }
  113477. declare module BABYLON {
  113478. /**
  113479. * Gear VR Controller
  113480. */
  113481. export class GearVRController extends WebVRController {
  113482. /**
  113483. * Base Url for the controller model.
  113484. */
  113485. static MODEL_BASE_URL: string;
  113486. /**
  113487. * File name for the controller model.
  113488. */
  113489. static MODEL_FILENAME: string;
  113490. /**
  113491. * Gamepad Id prefix used to identify this controller.
  113492. */
  113493. static readonly GAMEPAD_ID_PREFIX: string;
  113494. private readonly _buttonIndexToObservableNameMap;
  113495. /**
  113496. * Creates a new GearVRController from a gamepad
  113497. * @param vrGamepad the gamepad that the controller should be created from
  113498. */
  113499. constructor(vrGamepad: any);
  113500. /**
  113501. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  113502. * @param scene scene in which to add meshes
  113503. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  113504. */
  113505. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  113506. /**
  113507. * Called once for each button that changed state since the last frame
  113508. * @param buttonIdx Which button index changed
  113509. * @param state New state of the button
  113510. * @param changes Which properties on the state changed since last frame
  113511. */
  113512. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  113513. }
  113514. }
  113515. declare module BABYLON {
  113516. /**
  113517. * Class containing static functions to help procedurally build meshes
  113518. */
  113519. export class PolyhedronBuilder {
  113520. /**
  113521. * Creates a polyhedron mesh
  113522. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  113523. * * The parameter `size` (positive float, default 1) sets the polygon size
  113524. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  113525. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  113526. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  113527. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  113528. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  113529. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  113530. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  113531. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  113532. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  113533. * @param name defines the name of the mesh
  113534. * @param options defines the options used to create the mesh
  113535. * @param scene defines the hosting scene
  113536. * @returns the polyhedron mesh
  113537. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  113538. */
  113539. static CreatePolyhedron(name: string, options: {
  113540. type?: number;
  113541. size?: number;
  113542. sizeX?: number;
  113543. sizeY?: number;
  113544. sizeZ?: number;
  113545. custom?: any;
  113546. faceUV?: Vector4[];
  113547. faceColors?: Color4[];
  113548. flat?: boolean;
  113549. updatable?: boolean;
  113550. sideOrientation?: number;
  113551. frontUVs?: Vector4;
  113552. backUVs?: Vector4;
  113553. }, scene?: Nullable<Scene>): Mesh;
  113554. }
  113555. }
  113556. declare module BABYLON {
  113557. /**
  113558. * Gizmo that enables scaling a mesh along 3 axis
  113559. */
  113560. export class ScaleGizmo extends Gizmo {
  113561. /**
  113562. * Internal gizmo used for interactions on the x axis
  113563. */
  113564. xGizmo: AxisScaleGizmo;
  113565. /**
  113566. * Internal gizmo used for interactions on the y axis
  113567. */
  113568. yGizmo: AxisScaleGizmo;
  113569. /**
  113570. * Internal gizmo used for interactions on the z axis
  113571. */
  113572. zGizmo: AxisScaleGizmo;
  113573. /**
  113574. * Internal gizmo used to scale all axis equally
  113575. */
  113576. uniformScaleGizmo: AxisScaleGizmo;
  113577. private _meshAttached;
  113578. private _updateGizmoRotationToMatchAttachedMesh;
  113579. private _snapDistance;
  113580. private _scaleRatio;
  113581. private _uniformScalingMesh;
  113582. private _octahedron;
  113583. /** Fires an event when any of it's sub gizmos are dragged */
  113584. onDragStartObservable: Observable<unknown>;
  113585. /** Fires an event when any of it's sub gizmos are released from dragging */
  113586. onDragEndObservable: Observable<unknown>;
  113587. attachedMesh: Nullable<AbstractMesh>;
  113588. /**
  113589. * Creates a ScaleGizmo
  113590. * @param gizmoLayer The utility layer the gizmo will be added to
  113591. */
  113592. constructor(gizmoLayer?: UtilityLayerRenderer);
  113593. updateGizmoRotationToMatchAttachedMesh: boolean;
  113594. /**
  113595. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  113596. */
  113597. snapDistance: number;
  113598. /**
  113599. * Ratio for the scale of the gizmo (Default: 1)
  113600. */
  113601. scaleRatio: number;
  113602. /**
  113603. * Disposes of the gizmo
  113604. */
  113605. dispose(): void;
  113606. }
  113607. }
  113608. declare module BABYLON {
  113609. /**
  113610. * Single axis scale gizmo
  113611. */
  113612. export class AxisScaleGizmo extends Gizmo {
  113613. /**
  113614. * Drag behavior responsible for the gizmos dragging interactions
  113615. */
  113616. dragBehavior: PointerDragBehavior;
  113617. private _pointerObserver;
  113618. /**
  113619. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  113620. */
  113621. snapDistance: number;
  113622. /**
  113623. * Event that fires each time the gizmo snaps to a new location.
  113624. * * snapDistance is the the change in distance
  113625. */
  113626. onSnapObservable: Observable<{
  113627. snapDistance: number;
  113628. }>;
  113629. /**
  113630. * If the scaling operation should be done on all axis (default: false)
  113631. */
  113632. uniformScaling: boolean;
  113633. private _isEnabled;
  113634. private _parent;
  113635. private _arrow;
  113636. private _coloredMaterial;
  113637. private _hoverMaterial;
  113638. /**
  113639. * Creates an AxisScaleGizmo
  113640. * @param gizmoLayer The utility layer the gizmo will be added to
  113641. * @param dragAxis The axis which the gizmo will be able to scale on
  113642. * @param color The color of the gizmo
  113643. */
  113644. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  113645. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  113646. /**
  113647. * If the gizmo is enabled
  113648. */
  113649. isEnabled: boolean;
  113650. /**
  113651. * Disposes of the gizmo
  113652. */
  113653. dispose(): void;
  113654. /**
  113655. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  113656. * @param mesh The mesh to replace the default mesh of the gizmo
  113657. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  113658. */
  113659. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  113660. }
  113661. }
  113662. declare module BABYLON {
  113663. /**
  113664. * Bounding box gizmo
  113665. */
  113666. export class BoundingBoxGizmo extends Gizmo {
  113667. private _lineBoundingBox;
  113668. private _rotateSpheresParent;
  113669. private _scaleBoxesParent;
  113670. private _boundingDimensions;
  113671. private _renderObserver;
  113672. private _pointerObserver;
  113673. private _scaleDragSpeed;
  113674. private _tmpQuaternion;
  113675. private _tmpVector;
  113676. private _tmpRotationMatrix;
  113677. /**
  113678. * If child meshes should be ignored when calculating the boudning box. This should be set to true to avoid perf hits with heavily nested meshes (Default: false)
  113679. */
  113680. ignoreChildren: boolean;
  113681. /**
  113682. * Returns true if a descendant should be included when computing the bounding box. When null, all descendants are included. If ignoreChildren is set this will be ignored. (Default: null)
  113683. */
  113684. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  113685. /**
  113686. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  113687. */
  113688. rotationSphereSize: number;
  113689. /**
  113690. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  113691. */
  113692. scaleBoxSize: number;
  113693. /**
  113694. * If set, the rotation spheres and scale boxes will increase in size based on the distance away from the camera to have a consistent screen size (Default: false)
  113695. */
  113696. fixedDragMeshScreenSize: boolean;
  113697. /**
  113698. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  113699. */
  113700. fixedDragMeshScreenSizeDistanceFactor: number;
  113701. /**
  113702. * Fired when a rotation sphere or scale box is dragged
  113703. */
  113704. onDragStartObservable: Observable<{}>;
  113705. /**
  113706. * Fired when a scale box is dragged
  113707. */
  113708. onScaleBoxDragObservable: Observable<{}>;
  113709. /**
  113710. * Fired when a scale box drag is ended
  113711. */
  113712. onScaleBoxDragEndObservable: Observable<{}>;
  113713. /**
  113714. * Fired when a rotation sphere is dragged
  113715. */
  113716. onRotationSphereDragObservable: Observable<{}>;
  113717. /**
  113718. * Fired when a rotation sphere drag is ended
  113719. */
  113720. onRotationSphereDragEndObservable: Observable<{}>;
  113721. /**
  113722. * Relative bounding box pivot used when scaling the attached mesh. When null object with scale from the opposite corner. 0.5,0.5,0.5 for center and 0.5,0,0.5 for bottom (Default: null)
  113723. */
  113724. scalePivot: Nullable<Vector3>;
  113725. /**
  113726. * Mesh used as a pivot to rotate the attached mesh
  113727. */
  113728. private _anchorMesh;
  113729. private _existingMeshScale;
  113730. private _dragMesh;
  113731. private pointerDragBehavior;
  113732. private coloredMaterial;
  113733. private hoverColoredMaterial;
  113734. /**
  113735. * Sets the color of the bounding box gizmo
  113736. * @param color the color to set
  113737. */
  113738. setColor(color: Color3): void;
  113739. /**
  113740. * Creates an BoundingBoxGizmo
  113741. * @param gizmoLayer The utility layer the gizmo will be added to
  113742. * @param color The color of the gizmo
  113743. */
  113744. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  113745. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  113746. private _selectNode;
  113747. /**
  113748. * Updates the bounding box information for the Gizmo
  113749. */
  113750. updateBoundingBox(): void;
  113751. private _updateRotationSpheres;
  113752. private _updateScaleBoxes;
  113753. /**
  113754. * Enables rotation on the specified axis and disables rotation on the others
  113755. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  113756. */
  113757. setEnabledRotationAxis(axis: string): void;
  113758. /**
  113759. * Enables/disables scaling
  113760. * @param enable if scaling should be enabled
  113761. */
  113762. setEnabledScaling(enable: boolean): void;
  113763. private _updateDummy;
  113764. /**
  113765. * Enables a pointer drag behavior on the bounding box of the gizmo
  113766. */
  113767. enableDragBehavior(): void;
  113768. /**
  113769. * Disposes of the gizmo
  113770. */
  113771. dispose(): void;
  113772. /**
  113773. * Makes a mesh not pickable and wraps the mesh inside of a bounding box mesh that is pickable. (This is useful to avoid picking within complex geometry)
  113774. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  113775. * @returns the bounding box mesh with the passed in mesh as a child
  113776. */
  113777. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  113778. /**
  113779. * CustomMeshes are not supported by this gizmo
  113780. * @param mesh The mesh to replace the default mesh of the gizmo
  113781. */
  113782. setCustomMesh(mesh: Mesh): void;
  113783. }
  113784. }
  113785. declare module BABYLON {
  113786. /**
  113787. * Single plane rotation gizmo
  113788. */
  113789. export class PlaneRotationGizmo extends Gizmo {
  113790. /**
  113791. * Drag behavior responsible for the gizmos dragging interactions
  113792. */
  113793. dragBehavior: PointerDragBehavior;
  113794. private _pointerObserver;
  113795. /**
  113796. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  113797. */
  113798. snapDistance: number;
  113799. /**
  113800. * Event that fires each time the gizmo snaps to a new location.
  113801. * * snapDistance is the the change in distance
  113802. */
  113803. onSnapObservable: Observable<{
  113804. snapDistance: number;
  113805. }>;
  113806. private _isEnabled;
  113807. private _parent;
  113808. /**
  113809. * Creates a PlaneRotationGizmo
  113810. * @param gizmoLayer The utility layer the gizmo will be added to
  113811. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  113812. * @param color The color of the gizmo
  113813. * @param tessellation Amount of tessellation to be used when creating rotation circles
  113814. * @param useEulerRotation Use and update Euler angle instead of quaternion
  113815. */
  113816. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  113817. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  113818. /**
  113819. * If the gizmo is enabled
  113820. */
  113821. isEnabled: boolean;
  113822. /**
  113823. * Disposes of the gizmo
  113824. */
  113825. dispose(): void;
  113826. }
  113827. }
  113828. declare module BABYLON {
  113829. /**
  113830. * Gizmo that enables rotating a mesh along 3 axis
  113831. */
  113832. export class RotationGizmo extends Gizmo {
  113833. /**
  113834. * Internal gizmo used for interactions on the x axis
  113835. */
  113836. xGizmo: PlaneRotationGizmo;
  113837. /**
  113838. * Internal gizmo used for interactions on the y axis
  113839. */
  113840. yGizmo: PlaneRotationGizmo;
  113841. /**
  113842. * Internal gizmo used for interactions on the z axis
  113843. */
  113844. zGizmo: PlaneRotationGizmo;
  113845. /** Fires an event when any of it's sub gizmos are dragged */
  113846. onDragStartObservable: Observable<unknown>;
  113847. /** Fires an event when any of it's sub gizmos are released from dragging */
  113848. onDragEndObservable: Observable<unknown>;
  113849. private _meshAttached;
  113850. attachedMesh: Nullable<AbstractMesh>;
  113851. /**
  113852. * Creates a RotationGizmo
  113853. * @param gizmoLayer The utility layer the gizmo will be added to
  113854. * @param tessellation Amount of tessellation to be used when creating rotation circles
  113855. * @param useEulerRotation Use and update Euler angle instead of quaternion
  113856. */
  113857. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  113858. updateGizmoRotationToMatchAttachedMesh: boolean;
  113859. /**
  113860. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  113861. */
  113862. snapDistance: number;
  113863. /**
  113864. * Ratio for the scale of the gizmo (Default: 1)
  113865. */
  113866. scaleRatio: number;
  113867. /**
  113868. * Disposes of the gizmo
  113869. */
  113870. dispose(): void;
  113871. /**
  113872. * CustomMeshes are not supported by this gizmo
  113873. * @param mesh The mesh to replace the default mesh of the gizmo
  113874. */
  113875. setCustomMesh(mesh: Mesh): void;
  113876. }
  113877. }
  113878. declare module BABYLON {
  113879. /**
  113880. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  113881. */
  113882. export class GizmoManager implements IDisposable {
  113883. private scene;
  113884. /**
  113885. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  113886. */
  113887. gizmos: {
  113888. positionGizmo: Nullable<PositionGizmo>;
  113889. rotationGizmo: Nullable<RotationGizmo>;
  113890. scaleGizmo: Nullable<ScaleGizmo>;
  113891. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  113892. };
  113893. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  113894. clearGizmoOnEmptyPointerEvent: boolean;
  113895. /** Fires an event when the manager is attached to a mesh */
  113896. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  113897. private _gizmosEnabled;
  113898. private _pointerObserver;
  113899. private _attachedMesh;
  113900. private _boundingBoxColor;
  113901. private _defaultUtilityLayer;
  113902. private _defaultKeepDepthUtilityLayer;
  113903. /**
  113904. * When bounding box gizmo is enabled, this can be used to track drag/end events
  113905. */
  113906. boundingBoxDragBehavior: SixDofDragBehavior;
  113907. /**
  113908. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  113909. */
  113910. attachableMeshes: Nullable<Array<AbstractMesh>>;
  113911. /**
  113912. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  113913. */
  113914. usePointerToAttachGizmos: boolean;
  113915. /**
  113916. * Utility layer that the bounding box gizmo belongs to
  113917. */
  113918. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  113919. /**
  113920. * Utility layer that all gizmos besides bounding box belong to
  113921. */
  113922. readonly utilityLayer: UtilityLayerRenderer;
  113923. /**
  113924. * Instatiates a gizmo manager
  113925. * @param scene the scene to overlay the gizmos on top of
  113926. */
  113927. constructor(scene: Scene);
  113928. /**
  113929. * Attaches a set of gizmos to the specified mesh
  113930. * @param mesh The mesh the gizmo's should be attached to
  113931. */
  113932. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  113933. /**
  113934. * If the position gizmo is enabled
  113935. */
  113936. positionGizmoEnabled: boolean;
  113937. /**
  113938. * If the rotation gizmo is enabled
  113939. */
  113940. rotationGizmoEnabled: boolean;
  113941. /**
  113942. * If the scale gizmo is enabled
  113943. */
  113944. scaleGizmoEnabled: boolean;
  113945. /**
  113946. * If the boundingBox gizmo is enabled
  113947. */
  113948. boundingBoxGizmoEnabled: boolean;
  113949. /**
  113950. * Disposes of the gizmo manager
  113951. */
  113952. dispose(): void;
  113953. }
  113954. }
  113955. declare module BABYLON {
  113956. /**
  113957. * A directional light is defined by a direction (what a surprise!).
  113958. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  113959. * An example of a directional light is when a distance planet is lit by the apparently parallel lines of light from its sun. Light in a downward direction will light the top of an object.
  113960. * Documentation: https://doc.babylonjs.com/babylon101/lights
  113961. */
  113962. export class DirectionalLight extends ShadowLight {
  113963. private _shadowFrustumSize;
  113964. /**
  113965. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  113966. */
  113967. /**
  113968. * Specifies a fix frustum size for the shadow generation.
  113969. */
  113970. shadowFrustumSize: number;
  113971. private _shadowOrthoScale;
  113972. /**
  113973. * Gets the shadow projection scale against the optimal computed one.
  113974. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  113975. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  113976. */
  113977. /**
  113978. * Sets the shadow projection scale against the optimal computed one.
  113979. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  113980. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  113981. */
  113982. shadowOrthoScale: number;
  113983. /**
  113984. * Automatically compute the projection matrix to best fit (including all the casters)
  113985. * on each frame.
  113986. */
  113987. autoUpdateExtends: boolean;
  113988. private _orthoLeft;
  113989. private _orthoRight;
  113990. private _orthoTop;
  113991. private _orthoBottom;
  113992. /**
  113993. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  113994. * The directional light is emitted from everywhere in the given direction.
  113995. * It can cast shadows.
  113996. * Documentation : https://doc.babylonjs.com/babylon101/lights
  113997. * @param name The friendly name of the light
  113998. * @param direction The direction of the light
  113999. * @param scene The scene the light belongs to
  114000. */
  114001. constructor(name: string, direction: Vector3, scene: Scene);
  114002. /**
  114003. * Returns the string "DirectionalLight".
  114004. * @return The class name
  114005. */
  114006. getClassName(): string;
  114007. /**
  114008. * Returns the integer 1.
  114009. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  114010. */
  114011. getTypeID(): number;
  114012. /**
  114013. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  114014. * Returns the DirectionalLight Shadow projection matrix.
  114015. */
  114016. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  114017. /**
  114018. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  114019. * Returns the DirectionalLight Shadow projection matrix.
  114020. */
  114021. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  114022. /**
  114023. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  114024. * Returns the DirectionalLight Shadow projection matrix.
  114025. */
  114026. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  114027. protected _buildUniformLayout(): void;
  114028. /**
  114029. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  114030. * @param effect The effect to update
  114031. * @param lightIndex The index of the light in the effect to update
  114032. * @returns The directional light
  114033. */
  114034. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  114035. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  114036. /**
  114037. * Gets the minZ used for shadow according to both the scene and the light.
  114038. *
  114039. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  114040. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  114041. * @param activeCamera The camera we are returning the min for
  114042. * @returns the depth min z
  114043. */
  114044. getDepthMinZ(activeCamera: Camera): number;
  114045. /**
  114046. * Gets the maxZ used for shadow according to both the scene and the light.
  114047. *
  114048. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  114049. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  114050. * @param activeCamera The camera we are returning the max for
  114051. * @returns the depth max z
  114052. */
  114053. getDepthMaxZ(activeCamera: Camera): number;
  114054. /**
  114055. * Prepares the list of defines specific to the light type.
  114056. * @param defines the list of defines
  114057. * @param lightIndex defines the index of the light for the effect
  114058. */
  114059. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  114060. }
  114061. }
  114062. declare module BABYLON {
  114063. /**
  114064. * Class containing static functions to help procedurally build meshes
  114065. */
  114066. export class HemisphereBuilder {
  114067. /**
  114068. * Creates a hemisphere mesh
  114069. * @param name defines the name of the mesh
  114070. * @param options defines the options used to create the mesh
  114071. * @param scene defines the hosting scene
  114072. * @returns the hemisphere mesh
  114073. */
  114074. static CreateHemisphere(name: string, options: {
  114075. segments?: number;
  114076. diameter?: number;
  114077. sideOrientation?: number;
  114078. }, scene: any): Mesh;
  114079. }
  114080. }
  114081. declare module BABYLON {
  114082. /**
  114083. * A spot light is defined by a position, a direction, an angle, and an exponent.
  114084. * These values define a cone of light starting from the position, emitting toward the direction.
  114085. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  114086. * and the exponent defines the speed of the decay of the light with distance (reach).
  114087. * Documentation: https://doc.babylonjs.com/babylon101/lights
  114088. */
  114089. export class SpotLight extends ShadowLight {
  114090. private _angle;
  114091. private _innerAngle;
  114092. private _cosHalfAngle;
  114093. private _lightAngleScale;
  114094. private _lightAngleOffset;
  114095. /**
  114096. * Gets the cone angle of the spot light in Radians.
  114097. */
  114098. /**
  114099. * Sets the cone angle of the spot light in Radians.
  114100. */
  114101. angle: number;
  114102. /**
  114103. * Only used in gltf falloff mode, this defines the angle where
  114104. * the directional falloff will start before cutting at angle which could be seen
  114105. * as outer angle.
  114106. */
  114107. /**
  114108. * Only used in gltf falloff mode, this defines the angle where
  114109. * the directional falloff will start before cutting at angle which could be seen
  114110. * as outer angle.
  114111. */
  114112. innerAngle: number;
  114113. private _shadowAngleScale;
  114114. /**
  114115. * Allows scaling the angle of the light for shadow generation only.
  114116. */
  114117. /**
  114118. * Allows scaling the angle of the light for shadow generation only.
  114119. */
  114120. shadowAngleScale: number;
  114121. /**
  114122. * The light decay speed with the distance from the emission spot.
  114123. */
  114124. exponent: number;
  114125. private _projectionTextureMatrix;
  114126. /**
  114127. * Allows reading the projecton texture
  114128. */
  114129. readonly projectionTextureMatrix: Matrix;
  114130. protected _projectionTextureLightNear: number;
  114131. /**
  114132. * Gets the near clip of the Spotlight for texture projection.
  114133. */
  114134. /**
  114135. * Sets the near clip of the Spotlight for texture projection.
  114136. */
  114137. projectionTextureLightNear: number;
  114138. protected _projectionTextureLightFar: number;
  114139. /**
  114140. * Gets the far clip of the Spotlight for texture projection.
  114141. */
  114142. /**
  114143. * Sets the far clip of the Spotlight for texture projection.
  114144. */
  114145. projectionTextureLightFar: number;
  114146. protected _projectionTextureUpDirection: Vector3;
  114147. /**
  114148. * Gets the Up vector of the Spotlight for texture projection.
  114149. */
  114150. /**
  114151. * Sets the Up vector of the Spotlight for texture projection.
  114152. */
  114153. projectionTextureUpDirection: Vector3;
  114154. private _projectionTexture;
  114155. /**
  114156. * Gets the projection texture of the light.
  114157. */
  114158. /**
  114159. * Sets the projection texture of the light.
  114160. */
  114161. projectionTexture: Nullable<BaseTexture>;
  114162. private _projectionTextureViewLightDirty;
  114163. private _projectionTextureProjectionLightDirty;
  114164. private _projectionTextureDirty;
  114165. private _projectionTextureViewTargetVector;
  114166. private _projectionTextureViewLightMatrix;
  114167. private _projectionTextureProjectionLightMatrix;
  114168. private _projectionTextureScalingMatrix;
  114169. /**
  114170. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  114171. * It can cast shadows.
  114172. * Documentation : https://doc.babylonjs.com/babylon101/lights
  114173. * @param name The light friendly name
  114174. * @param position The position of the spot light in the scene
  114175. * @param direction The direction of the light in the scene
  114176. * @param angle The cone angle of the light in Radians
  114177. * @param exponent The light decay speed with the distance from the emission spot
  114178. * @param scene The scene the lights belongs to
  114179. */
  114180. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  114181. /**
  114182. * Returns the string "SpotLight".
  114183. * @returns the class name
  114184. */
  114185. getClassName(): string;
  114186. /**
  114187. * Returns the integer 2.
  114188. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  114189. */
  114190. getTypeID(): number;
  114191. /**
  114192. * Overrides the direction setter to recompute the projection texture view light Matrix.
  114193. */
  114194. protected _setDirection(value: Vector3): void;
  114195. /**
  114196. * Overrides the position setter to recompute the projection texture view light Matrix.
  114197. */
  114198. protected _setPosition(value: Vector3): void;
  114199. /**
  114200. * Sets the passed matrix "matrix" as perspective projection matrix for the shadows and the passed view matrix with the fov equal to the SpotLight angle and and aspect ratio of 1.0.
  114201. * Returns the SpotLight.
  114202. */
  114203. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  114204. protected _computeProjectionTextureViewLightMatrix(): void;
  114205. protected _computeProjectionTextureProjectionLightMatrix(): void;
  114206. /**
  114207. * Main function for light texture projection matrix computing.
  114208. */
  114209. protected _computeProjectionTextureMatrix(): void;
  114210. protected _buildUniformLayout(): void;
  114211. private _computeAngleValues;
  114212. /**
  114213. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  114214. * @param effect The effect to update
  114215. * @param lightIndex The index of the light in the effect to update
  114216. * @returns The spot light
  114217. */
  114218. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  114219. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  114220. /**
  114221. * Disposes the light and the associated resources.
  114222. */
  114223. dispose(): void;
  114224. /**
  114225. * Prepares the list of defines specific to the light type.
  114226. * @param defines the list of defines
  114227. * @param lightIndex defines the index of the light for the effect
  114228. */
  114229. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  114230. }
  114231. }
  114232. declare module BABYLON {
  114233. /**
  114234. * Gizmo that enables viewing a light
  114235. */
  114236. export class LightGizmo extends Gizmo {
  114237. private _lightMesh;
  114238. private _material;
  114239. private cachedPosition;
  114240. private cachedForward;
  114241. /**
  114242. * Creates a LightGizmo
  114243. * @param gizmoLayer The utility layer the gizmo will be added to
  114244. */
  114245. constructor(gizmoLayer?: UtilityLayerRenderer);
  114246. private _light;
  114247. /**
  114248. * The light that the gizmo is attached to
  114249. */
  114250. light: Nullable<Light>;
  114251. /**
  114252. * Gets the material used to render the light gizmo
  114253. */
  114254. readonly material: StandardMaterial;
  114255. /**
  114256. * @hidden
  114257. * Updates the gizmo to match the attached mesh's position/rotation
  114258. */
  114259. protected _update(): void;
  114260. private static _Scale;
  114261. /**
  114262. * Creates the lines for a light mesh
  114263. */
  114264. private static _createLightLines;
  114265. /**
  114266. * Disposes of the light gizmo
  114267. */
  114268. dispose(): void;
  114269. private static _CreateHemisphericLightMesh;
  114270. private static _CreatePointLightMesh;
  114271. private static _CreateSpotLightMesh;
  114272. private static _CreateDirectionalLightMesh;
  114273. }
  114274. }
  114275. declare module BABYLON {
  114276. /** @hidden */
  114277. export var backgroundFragmentDeclaration: {
  114278. name: string;
  114279. shader: string;
  114280. };
  114281. }
  114282. declare module BABYLON {
  114283. /** @hidden */
  114284. export var backgroundUboDeclaration: {
  114285. name: string;
  114286. shader: string;
  114287. };
  114288. }
  114289. declare module BABYLON {
  114290. /** @hidden */
  114291. export var backgroundPixelShader: {
  114292. name: string;
  114293. shader: string;
  114294. };
  114295. }
  114296. declare module BABYLON {
  114297. /** @hidden */
  114298. export var backgroundVertexDeclaration: {
  114299. name: string;
  114300. shader: string;
  114301. };
  114302. }
  114303. declare module BABYLON {
  114304. /** @hidden */
  114305. export var backgroundVertexShader: {
  114306. name: string;
  114307. shader: string;
  114308. };
  114309. }
  114310. declare module BABYLON {
  114311. /**
  114312. * Background material used to create an efficient environement around your scene.
  114313. */
  114314. export class BackgroundMaterial extends PushMaterial {
  114315. /**
  114316. * Standard reflectance value at parallel view angle.
  114317. */
  114318. static StandardReflectance0: number;
  114319. /**
  114320. * Standard reflectance value at grazing angle.
  114321. */
  114322. static StandardReflectance90: number;
  114323. protected _primaryColor: Color3;
  114324. /**
  114325. * Key light Color (multiply against the environement texture)
  114326. */
  114327. primaryColor: Color3;
  114328. protected __perceptualColor: Nullable<Color3>;
  114329. /**
  114330. * Experimental Internal Use Only.
  114331. *
  114332. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  114333. * This acts as a helper to set the primary color to a more "human friendly" value.
  114334. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  114335. * output color as close as possible from the chosen value.
  114336. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  114337. * part of lighting setup.)
  114338. */
  114339. _perceptualColor: Nullable<Color3>;
  114340. protected _primaryColorShadowLevel: float;
  114341. /**
  114342. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  114343. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  114344. */
  114345. primaryColorShadowLevel: float;
  114346. protected _primaryColorHighlightLevel: float;
  114347. /**
  114348. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  114349. * The primary color is used at the level chosen to define what the white area would look.
  114350. */
  114351. primaryColorHighlightLevel: float;
  114352. protected _reflectionTexture: Nullable<BaseTexture>;
  114353. /**
  114354. * Reflection Texture used in the material.
  114355. * Should be author in a specific way for the best result (refer to the documentation).
  114356. */
  114357. reflectionTexture: Nullable<BaseTexture>;
  114358. protected _reflectionBlur: float;
  114359. /**
  114360. * Reflection Texture level of blur.
  114361. *
  114362. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  114363. * texture twice.
  114364. */
  114365. reflectionBlur: float;
  114366. protected _diffuseTexture: Nullable<BaseTexture>;
  114367. /**
  114368. * Diffuse Texture used in the material.
  114369. * Should be author in a specific way for the best result (refer to the documentation).
  114370. */
  114371. diffuseTexture: Nullable<BaseTexture>;
  114372. protected _shadowLights: Nullable<IShadowLight[]>;
  114373. /**
  114374. * Specify the list of lights casting shadow on the material.
  114375. * All scene shadow lights will be included if null.
  114376. */
  114377. shadowLights: Nullable<IShadowLight[]>;
  114378. protected _shadowLevel: float;
  114379. /**
  114380. * Helps adjusting the shadow to a softer level if required.
  114381. * 0 means black shadows and 1 means no shadows.
  114382. */
  114383. shadowLevel: float;
  114384. protected _sceneCenter: Vector3;
  114385. /**
  114386. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  114387. * It is usually zero but might be interesting to modify according to your setup.
  114388. */
  114389. sceneCenter: Vector3;
  114390. protected _opacityFresnel: boolean;
  114391. /**
  114392. * This helps specifying that the material is falling off to the sky box at grazing angle.
  114393. * This helps ensuring a nice transition when the camera goes under the ground.
  114394. */
  114395. opacityFresnel: boolean;
  114396. protected _reflectionFresnel: boolean;
  114397. /**
  114398. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  114399. * This helps adding a mirror texture on the ground.
  114400. */
  114401. reflectionFresnel: boolean;
  114402. protected _reflectionFalloffDistance: number;
  114403. /**
  114404. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  114405. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  114406. */
  114407. reflectionFalloffDistance: number;
  114408. protected _reflectionAmount: number;
  114409. /**
  114410. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  114411. */
  114412. reflectionAmount: number;
  114413. protected _reflectionReflectance0: number;
  114414. /**
  114415. * This specifies the weight of the reflection at grazing angle.
  114416. */
  114417. reflectionReflectance0: number;
  114418. protected _reflectionReflectance90: number;
  114419. /**
  114420. * This specifies the weight of the reflection at a perpendicular point of view.
  114421. */
  114422. reflectionReflectance90: number;
  114423. /**
  114424. * Sets the reflection reflectance fresnel values according to the default standard
  114425. * empirically know to work well :-)
  114426. */
  114427. reflectionStandardFresnelWeight: number;
  114428. protected _useRGBColor: boolean;
  114429. /**
  114430. * Helps to directly use the maps channels instead of their level.
  114431. */
  114432. useRGBColor: boolean;
  114433. protected _enableNoise: boolean;
  114434. /**
  114435. * This helps reducing the banding effect that could occur on the background.
  114436. */
  114437. enableNoise: boolean;
  114438. /**
  114439. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  114440. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  114441. * Recommended to be keep at 1.0 except for special cases.
  114442. */
  114443. fovMultiplier: number;
  114444. private _fovMultiplier;
  114445. /**
  114446. * Enable the FOV adjustment feature controlled by fovMultiplier.
  114447. */
  114448. useEquirectangularFOV: boolean;
  114449. private _maxSimultaneousLights;
  114450. /**
  114451. * Number of Simultaneous lights allowed on the material.
  114452. */
  114453. maxSimultaneousLights: int;
  114454. /**
  114455. * Default configuration related to image processing available in the Background Material.
  114456. */
  114457. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  114458. /**
  114459. * Keep track of the image processing observer to allow dispose and replace.
  114460. */
  114461. private _imageProcessingObserver;
  114462. /**
  114463. * Attaches a new image processing configuration to the PBR Material.
  114464. * @param configuration (if null the scene configuration will be use)
  114465. */
  114466. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  114467. /**
  114468. * Gets the image processing configuration used either in this material.
  114469. */
  114470. /**
  114471. * Sets the Default image processing configuration used either in the this material.
  114472. *
  114473. * If sets to null, the scene one is in use.
  114474. */
  114475. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  114476. /**
  114477. * Gets wether the color curves effect is enabled.
  114478. */
  114479. /**
  114480. * Sets wether the color curves effect is enabled.
  114481. */
  114482. cameraColorCurvesEnabled: boolean;
  114483. /**
  114484. * Gets wether the color grading effect is enabled.
  114485. */
  114486. /**
  114487. * Gets wether the color grading effect is enabled.
  114488. */
  114489. cameraColorGradingEnabled: boolean;
  114490. /**
  114491. * Gets wether tonemapping is enabled or not.
  114492. */
  114493. /**
  114494. * Sets wether tonemapping is enabled or not
  114495. */
  114496. cameraToneMappingEnabled: boolean;
  114497. /**
  114498. * The camera exposure used on this material.
  114499. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  114500. * This corresponds to a photographic exposure.
  114501. */
  114502. /**
  114503. * The camera exposure used on this material.
  114504. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  114505. * This corresponds to a photographic exposure.
  114506. */
  114507. cameraExposure: float;
  114508. /**
  114509. * Gets The camera contrast used on this material.
  114510. */
  114511. /**
  114512. * Sets The camera contrast used on this material.
  114513. */
  114514. cameraContrast: float;
  114515. /**
  114516. * Gets the Color Grading 2D Lookup Texture.
  114517. */
  114518. /**
  114519. * Sets the Color Grading 2D Lookup Texture.
  114520. */
  114521. cameraColorGradingTexture: Nullable<BaseTexture>;
  114522. /**
  114523. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  114524. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  114525. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  114526. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  114527. */
  114528. /**
  114529. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  114530. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  114531. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  114532. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  114533. */
  114534. cameraColorCurves: Nullable<ColorCurves>;
  114535. /**
  114536. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  114537. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  114538. */
  114539. switchToBGR: boolean;
  114540. private _renderTargets;
  114541. private _reflectionControls;
  114542. private _white;
  114543. private _primaryShadowColor;
  114544. private _primaryHighlightColor;
  114545. /**
  114546. * Instantiates a Background Material in the given scene
  114547. * @param name The friendly name of the material
  114548. * @param scene The scene to add the material to
  114549. */
  114550. constructor(name: string, scene: Scene);
  114551. /**
  114552. * Gets a boolean indicating that current material needs to register RTT
  114553. */
  114554. readonly hasRenderTargetTextures: boolean;
  114555. /**
  114556. * The entire material has been created in order to prevent overdraw.
  114557. * @returns false
  114558. */
  114559. needAlphaTesting(): boolean;
  114560. /**
  114561. * The entire material has been created in order to prevent overdraw.
  114562. * @returns true if blending is enable
  114563. */
  114564. needAlphaBlending(): boolean;
  114565. /**
  114566. * Checks wether the material is ready to be rendered for a given mesh.
  114567. * @param mesh The mesh to render
  114568. * @param subMesh The submesh to check against
  114569. * @param useInstances Specify wether or not the material is used with instances
  114570. * @returns true if all the dependencies are ready (Textures, Effects...)
  114571. */
  114572. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  114573. /**
  114574. * Compute the primary color according to the chosen perceptual color.
  114575. */
  114576. private _computePrimaryColorFromPerceptualColor;
  114577. /**
  114578. * Compute the highlights and shadow colors according to their chosen levels.
  114579. */
  114580. private _computePrimaryColors;
  114581. /**
  114582. * Build the uniform buffer used in the material.
  114583. */
  114584. buildUniformLayout(): void;
  114585. /**
  114586. * Unbind the material.
  114587. */
  114588. unbind(): void;
  114589. /**
  114590. * Bind only the world matrix to the material.
  114591. * @param world The world matrix to bind.
  114592. */
  114593. bindOnlyWorldMatrix(world: Matrix): void;
  114594. /**
  114595. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  114596. * @param world The world matrix to bind.
  114597. * @param subMesh The submesh to bind for.
  114598. */
  114599. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  114600. /**
  114601. * Checks to see if a texture is used in the material.
  114602. * @param texture - Base texture to use.
  114603. * @returns - Boolean specifying if a texture is used in the material.
  114604. */
  114605. hasTexture(texture: BaseTexture): boolean;
  114606. /**
  114607. * Dispose the material.
  114608. * @param forceDisposeEffect Force disposal of the associated effect.
  114609. * @param forceDisposeTextures Force disposal of the associated textures.
  114610. */
  114611. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  114612. /**
  114613. * Clones the material.
  114614. * @param name The cloned name.
  114615. * @returns The cloned material.
  114616. */
  114617. clone(name: string): BackgroundMaterial;
  114618. /**
  114619. * Serializes the current material to its JSON representation.
  114620. * @returns The JSON representation.
  114621. */
  114622. serialize(): any;
  114623. /**
  114624. * Gets the class name of the material
  114625. * @returns "BackgroundMaterial"
  114626. */
  114627. getClassName(): string;
  114628. /**
  114629. * Parse a JSON input to create back a background material.
  114630. * @param source The JSON data to parse
  114631. * @param scene The scene to create the parsed material in
  114632. * @param rootUrl The root url of the assets the material depends upon
  114633. * @returns the instantiated BackgroundMaterial.
  114634. */
  114635. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  114636. }
  114637. }
  114638. declare module BABYLON {
  114639. /**
  114640. * Represents the different options available during the creation of
  114641. * a Environment helper.
  114642. *
  114643. * This can control the default ground, skybox and image processing setup of your scene.
  114644. */
  114645. export interface IEnvironmentHelperOptions {
  114646. /**
  114647. * Specifies wether or not to create a ground.
  114648. * True by default.
  114649. */
  114650. createGround: boolean;
  114651. /**
  114652. * Specifies the ground size.
  114653. * 15 by default.
  114654. */
  114655. groundSize: number;
  114656. /**
  114657. * The texture used on the ground for the main color.
  114658. * Comes from the BabylonJS CDN by default.
  114659. *
  114660. * Remarks: Can be either a texture or a url.
  114661. */
  114662. groundTexture: string | BaseTexture;
  114663. /**
  114664. * The color mixed in the ground texture by default.
  114665. * BabylonJS clearColor by default.
  114666. */
  114667. groundColor: Color3;
  114668. /**
  114669. * Specifies the ground opacity.
  114670. * 1 by default.
  114671. */
  114672. groundOpacity: number;
  114673. /**
  114674. * Enables the ground to receive shadows.
  114675. * True by default.
  114676. */
  114677. enableGroundShadow: boolean;
  114678. /**
  114679. * Helps preventing the shadow to be fully black on the ground.
  114680. * 0.5 by default.
  114681. */
  114682. groundShadowLevel: number;
  114683. /**
  114684. * Creates a mirror texture attach to the ground.
  114685. * false by default.
  114686. */
  114687. enableGroundMirror: boolean;
  114688. /**
  114689. * Specifies the ground mirror size ratio.
  114690. * 0.3 by default as the default kernel is 64.
  114691. */
  114692. groundMirrorSizeRatio: number;
  114693. /**
  114694. * Specifies the ground mirror blur kernel size.
  114695. * 64 by default.
  114696. */
  114697. groundMirrorBlurKernel: number;
  114698. /**
  114699. * Specifies the ground mirror visibility amount.
  114700. * 1 by default
  114701. */
  114702. groundMirrorAmount: number;
  114703. /**
  114704. * Specifies the ground mirror reflectance weight.
  114705. * This uses the standard weight of the background material to setup the fresnel effect
  114706. * of the mirror.
  114707. * 1 by default.
  114708. */
  114709. groundMirrorFresnelWeight: number;
  114710. /**
  114711. * Specifies the ground mirror Falloff distance.
  114712. * This can helps reducing the size of the reflection.
  114713. * 0 by Default.
  114714. */
  114715. groundMirrorFallOffDistance: number;
  114716. /**
  114717. * Specifies the ground mirror texture type.
  114718. * Unsigned Int by Default.
  114719. */
  114720. groundMirrorTextureType: number;
  114721. /**
  114722. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  114723. * the shown objects.
  114724. */
  114725. groundYBias: number;
  114726. /**
  114727. * Specifies wether or not to create a skybox.
  114728. * True by default.
  114729. */
  114730. createSkybox: boolean;
  114731. /**
  114732. * Specifies the skybox size.
  114733. * 20 by default.
  114734. */
  114735. skyboxSize: number;
  114736. /**
  114737. * The texture used on the skybox for the main color.
  114738. * Comes from the BabylonJS CDN by default.
  114739. *
  114740. * Remarks: Can be either a texture or a url.
  114741. */
  114742. skyboxTexture: string | BaseTexture;
  114743. /**
  114744. * The color mixed in the skybox texture by default.
  114745. * BabylonJS clearColor by default.
  114746. */
  114747. skyboxColor: Color3;
  114748. /**
  114749. * The background rotation around the Y axis of the scene.
  114750. * This helps aligning the key lights of your scene with the background.
  114751. * 0 by default.
  114752. */
  114753. backgroundYRotation: number;
  114754. /**
  114755. * Compute automatically the size of the elements to best fit with the scene.
  114756. */
  114757. sizeAuto: boolean;
  114758. /**
  114759. * Default position of the rootMesh if autoSize is not true.
  114760. */
  114761. rootPosition: Vector3;
  114762. /**
  114763. * Sets up the image processing in the scene.
  114764. * true by default.
  114765. */
  114766. setupImageProcessing: boolean;
  114767. /**
  114768. * The texture used as your environment texture in the scene.
  114769. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  114770. *
  114771. * Remarks: Can be either a texture or a url.
  114772. */
  114773. environmentTexture: string | BaseTexture;
  114774. /**
  114775. * The value of the exposure to apply to the scene.
  114776. * 0.6 by default if setupImageProcessing is true.
  114777. */
  114778. cameraExposure: number;
  114779. /**
  114780. * The value of the contrast to apply to the scene.
  114781. * 1.6 by default if setupImageProcessing is true.
  114782. */
  114783. cameraContrast: number;
  114784. /**
  114785. * Specifies wether or not tonemapping should be enabled in the scene.
  114786. * true by default if setupImageProcessing is true.
  114787. */
  114788. toneMappingEnabled: boolean;
  114789. }
  114790. /**
  114791. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  114792. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  114793. * It also helps with the default setup of your imageProcessing configuration.
  114794. */
  114795. export class EnvironmentHelper {
  114796. /**
  114797. * Default ground texture URL.
  114798. */
  114799. private static _groundTextureCDNUrl;
  114800. /**
  114801. * Default skybox texture URL.
  114802. */
  114803. private static _skyboxTextureCDNUrl;
  114804. /**
  114805. * Default environment texture URL.
  114806. */
  114807. private static _environmentTextureCDNUrl;
  114808. /**
  114809. * Creates the default options for the helper.
  114810. */
  114811. private static _getDefaultOptions;
  114812. private _rootMesh;
  114813. /**
  114814. * Gets the root mesh created by the helper.
  114815. */
  114816. readonly rootMesh: Mesh;
  114817. private _skybox;
  114818. /**
  114819. * Gets the skybox created by the helper.
  114820. */
  114821. readonly skybox: Nullable<Mesh>;
  114822. private _skyboxTexture;
  114823. /**
  114824. * Gets the skybox texture created by the helper.
  114825. */
  114826. readonly skyboxTexture: Nullable<BaseTexture>;
  114827. private _skyboxMaterial;
  114828. /**
  114829. * Gets the skybox material created by the helper.
  114830. */
  114831. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  114832. private _ground;
  114833. /**
  114834. * Gets the ground mesh created by the helper.
  114835. */
  114836. readonly ground: Nullable<Mesh>;
  114837. private _groundTexture;
  114838. /**
  114839. * Gets the ground texture created by the helper.
  114840. */
  114841. readonly groundTexture: Nullable<BaseTexture>;
  114842. private _groundMirror;
  114843. /**
  114844. * Gets the ground mirror created by the helper.
  114845. */
  114846. readonly groundMirror: Nullable<MirrorTexture>;
  114847. /**
  114848. * Gets the ground mirror render list to helps pushing the meshes
  114849. * you wish in the ground reflection.
  114850. */
  114851. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  114852. private _groundMaterial;
  114853. /**
  114854. * Gets the ground material created by the helper.
  114855. */
  114856. readonly groundMaterial: Nullable<BackgroundMaterial>;
  114857. /**
  114858. * Stores the creation options.
  114859. */
  114860. private readonly _scene;
  114861. private _options;
  114862. /**
  114863. * This observable will be notified with any error during the creation of the environment,
  114864. * mainly texture creation errors.
  114865. */
  114866. onErrorObservable: Observable<{
  114867. message?: string;
  114868. exception?: any;
  114869. }>;
  114870. /**
  114871. * constructor
  114872. * @param options Defines the options we want to customize the helper
  114873. * @param scene The scene to add the material to
  114874. */
  114875. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  114876. /**
  114877. * Updates the background according to the new options
  114878. * @param options
  114879. */
  114880. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  114881. /**
  114882. * Sets the primary color of all the available elements.
  114883. * @param color the main color to affect to the ground and the background
  114884. */
  114885. setMainColor(color: Color3): void;
  114886. /**
  114887. * Setup the image processing according to the specified options.
  114888. */
  114889. private _setupImageProcessing;
  114890. /**
  114891. * Setup the environment texture according to the specified options.
  114892. */
  114893. private _setupEnvironmentTexture;
  114894. /**
  114895. * Setup the background according to the specified options.
  114896. */
  114897. private _setupBackground;
  114898. /**
  114899. * Get the scene sizes according to the setup.
  114900. */
  114901. private _getSceneSize;
  114902. /**
  114903. * Setup the ground according to the specified options.
  114904. */
  114905. private _setupGround;
  114906. /**
  114907. * Setup the ground material according to the specified options.
  114908. */
  114909. private _setupGroundMaterial;
  114910. /**
  114911. * Setup the ground diffuse texture according to the specified options.
  114912. */
  114913. private _setupGroundDiffuseTexture;
  114914. /**
  114915. * Setup the ground mirror texture according to the specified options.
  114916. */
  114917. private _setupGroundMirrorTexture;
  114918. /**
  114919. * Setup the ground to receive the mirror texture.
  114920. */
  114921. private _setupMirrorInGroundMaterial;
  114922. /**
  114923. * Setup the skybox according to the specified options.
  114924. */
  114925. private _setupSkybox;
  114926. /**
  114927. * Setup the skybox material according to the specified options.
  114928. */
  114929. private _setupSkyboxMaterial;
  114930. /**
  114931. * Setup the skybox reflection texture according to the specified options.
  114932. */
  114933. private _setupSkyboxReflectionTexture;
  114934. private _errorHandler;
  114935. /**
  114936. * Dispose all the elements created by the Helper.
  114937. */
  114938. dispose(): void;
  114939. }
  114940. }
  114941. declare module BABYLON {
  114942. /**
  114943. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  114944. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  114945. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  114946. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  114947. */
  114948. export class PhotoDome extends TransformNode {
  114949. /**
  114950. * Define the image as a Monoscopic panoramic 360 image.
  114951. */
  114952. static readonly MODE_MONOSCOPIC: number;
  114953. /**
  114954. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  114955. */
  114956. static readonly MODE_TOPBOTTOM: number;
  114957. /**
  114958. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  114959. */
  114960. static readonly MODE_SIDEBYSIDE: number;
  114961. private _useDirectMapping;
  114962. /**
  114963. * The texture being displayed on the sphere
  114964. */
  114965. protected _photoTexture: Texture;
  114966. /**
  114967. * Gets or sets the texture being displayed on the sphere
  114968. */
  114969. photoTexture: Texture;
  114970. /**
  114971. * Observable raised when an error occured while loading the 360 image
  114972. */
  114973. onLoadErrorObservable: Observable<string>;
  114974. /**
  114975. * The skybox material
  114976. */
  114977. protected _material: BackgroundMaterial;
  114978. /**
  114979. * The surface used for the skybox
  114980. */
  114981. protected _mesh: Mesh;
  114982. /**
  114983. * Gets the mesh used for the skybox.
  114984. */
  114985. readonly mesh: Mesh;
  114986. /**
  114987. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  114988. * Also see the options.resolution property.
  114989. */
  114990. fovMultiplier: number;
  114991. private _imageMode;
  114992. /**
  114993. * Gets or set the current video mode for the video. It can be:
  114994. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  114995. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  114996. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  114997. */
  114998. imageMode: number;
  114999. /**
  115000. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  115001. * @param name Element's name, child elements will append suffixes for their own names.
  115002. * @param urlsOfPhoto defines the url of the photo to display
  115003. * @param options defines an object containing optional or exposed sub element properties
  115004. * @param onError defines a callback called when an error occured while loading the texture
  115005. */
  115006. constructor(name: string, urlOfPhoto: string, options: {
  115007. resolution?: number;
  115008. size?: number;
  115009. useDirectMapping?: boolean;
  115010. faceForward?: boolean;
  115011. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  115012. private _onBeforeCameraRenderObserver;
  115013. private _changeImageMode;
  115014. /**
  115015. * Releases resources associated with this node.
  115016. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  115017. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  115018. */
  115019. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  115020. }
  115021. }
  115022. declare module BABYLON {
  115023. /**
  115024. * Class used to host RGBD texture specific utilities
  115025. */
  115026. export class RGBDTextureTools {
  115027. /**
  115028. * Expand the RGBD Texture from RGBD to Half Float if possible.
  115029. * @param texture the texture to expand.
  115030. */
  115031. static ExpandRGBDTexture(texture: Texture): void;
  115032. }
  115033. }
  115034. declare module BABYLON {
  115035. /**
  115036. * Class used to host texture specific utilities
  115037. */
  115038. export class BRDFTextureTools {
  115039. /**
  115040. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  115041. * @param scene defines the hosting scene
  115042. * @returns the environment BRDF texture
  115043. */
  115044. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  115045. private static _environmentBRDFBase64Texture;
  115046. }
  115047. }
  115048. declare module BABYLON {
  115049. /**
  115050. * @hidden
  115051. */
  115052. export interface IMaterialClearCoatDefines {
  115053. CLEARCOAT: boolean;
  115054. CLEARCOAT_DEFAULTIOR: boolean;
  115055. CLEARCOAT_TEXTURE: boolean;
  115056. CLEARCOAT_TEXTUREDIRECTUV: number;
  115057. CLEARCOAT_BUMP: boolean;
  115058. CLEARCOAT_BUMPDIRECTUV: number;
  115059. CLEARCOAT_TINT: boolean;
  115060. CLEARCOAT_TINT_TEXTURE: boolean;
  115061. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  115062. /** @hidden */
  115063. _areTexturesDirty: boolean;
  115064. }
  115065. /**
  115066. * Define the code related to the clear coat parameters of the pbr material.
  115067. */
  115068. export class PBRClearCoatConfiguration {
  115069. /**
  115070. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  115071. * The default fits with a polyurethane material.
  115072. */
  115073. private static readonly _DefaultIndexOfRefraction;
  115074. private _isEnabled;
  115075. /**
  115076. * Defines if the clear coat is enabled in the material.
  115077. */
  115078. isEnabled: boolean;
  115079. /**
  115080. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  115081. */
  115082. intensity: number;
  115083. /**
  115084. * Defines the clear coat layer roughness.
  115085. */
  115086. roughness: number;
  115087. private _indexOfRefraction;
  115088. /**
  115089. * Defines the index of refraction of the clear coat.
  115090. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  115091. * The default fits with a polyurethane material.
  115092. * Changing the default value is more performance intensive.
  115093. */
  115094. indexOfRefraction: number;
  115095. private _texture;
  115096. /**
  115097. * Stores the clear coat values in a texture.
  115098. */
  115099. texture: Nullable<BaseTexture>;
  115100. private _bumpTexture;
  115101. /**
  115102. * Define the clear coat specific bump texture.
  115103. */
  115104. bumpTexture: Nullable<BaseTexture>;
  115105. private _isTintEnabled;
  115106. /**
  115107. * Defines if the clear coat tint is enabled in the material.
  115108. */
  115109. isTintEnabled: boolean;
  115110. /**
  115111. * Defines the clear coat tint of the material.
  115112. * This is only use if tint is enabled
  115113. */
  115114. tintColor: Color3;
  115115. /**
  115116. * Defines the distance at which the tint color should be found in the
  115117. * clear coat media.
  115118. * This is only use if tint is enabled
  115119. */
  115120. tintColorAtDistance: number;
  115121. /**
  115122. * Defines the clear coat layer thickness.
  115123. * This is only use if tint is enabled
  115124. */
  115125. tintThickness: number;
  115126. private _tintTexture;
  115127. /**
  115128. * Stores the clear tint values in a texture.
  115129. * rgb is tint
  115130. * a is a thickness factor
  115131. */
  115132. tintTexture: Nullable<BaseTexture>;
  115133. /** @hidden */
  115134. private _internalMarkAllSubMeshesAsTexturesDirty;
  115135. /** @hidden */
  115136. _markAllSubMeshesAsTexturesDirty(): void;
  115137. /**
  115138. * Instantiate a new istance of clear coat configuration.
  115139. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115140. */
  115141. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115142. /**
  115143. * Gets wehter the submesh is ready to be used or not.
  115144. * @param defines the list of "defines" to update.
  115145. * @param scene defines the scene the material belongs to.
  115146. * @param engine defines the engine the material belongs to.
  115147. * @param disableBumpMap defines wether the material disables bump or not.
  115148. * @returns - boolean indicating that the submesh is ready or not.
  115149. */
  115150. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  115151. /**
  115152. * Checks to see if a texture is used in the material.
  115153. * @param defines the list of "defines" to update.
  115154. * @param scene defines the scene to the material belongs to.
  115155. */
  115156. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  115157. /**
  115158. * Binds the material data.
  115159. * @param uniformBuffer defines the Uniform buffer to fill in.
  115160. * @param scene defines the scene the material belongs to.
  115161. * @param engine defines the engine the material belongs to.
  115162. * @param disableBumpMap defines wether the material disables bump or not.
  115163. * @param isFrozen defines wether the material is frozen or not.
  115164. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  115165. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  115166. */
  115167. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  115168. /**
  115169. * Checks to see if a texture is used in the material.
  115170. * @param texture - Base texture to use.
  115171. * @returns - Boolean specifying if a texture is used in the material.
  115172. */
  115173. hasTexture(texture: BaseTexture): boolean;
  115174. /**
  115175. * Returns an array of the actively used textures.
  115176. * @param activeTextures Array of BaseTextures
  115177. */
  115178. getActiveTextures(activeTextures: BaseTexture[]): void;
  115179. /**
  115180. * Returns the animatable textures.
  115181. * @param animatables Array of animatable textures.
  115182. */
  115183. getAnimatables(animatables: IAnimatable[]): void;
  115184. /**
  115185. * Disposes the resources of the material.
  115186. * @param forceDisposeTextures - Forces the disposal of all textures.
  115187. */
  115188. dispose(forceDisposeTextures?: boolean): void;
  115189. /**
  115190. * Get the current class name of the texture useful for serialization or dynamic coding.
  115191. * @returns "PBRClearCoatConfiguration"
  115192. */
  115193. getClassName(): string;
  115194. /**
  115195. * Add fallbacks to the effect fallbacks list.
  115196. * @param defines defines the Base texture to use.
  115197. * @param fallbacks defines the current fallback list.
  115198. * @param currentRank defines the current fallback rank.
  115199. * @returns the new fallback rank.
  115200. */
  115201. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115202. /**
  115203. * Add the required uniforms to the current list.
  115204. * @param uniforms defines the current uniform list.
  115205. */
  115206. static AddUniforms(uniforms: string[]): void;
  115207. /**
  115208. * Add the required samplers to the current list.
  115209. * @param samplers defines the current sampler list.
  115210. */
  115211. static AddSamplers(samplers: string[]): void;
  115212. /**
  115213. * Add the required uniforms to the current buffer.
  115214. * @param uniformBuffer defines the current uniform buffer.
  115215. */
  115216. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115217. /**
  115218. * Makes a duplicate of the current configuration into another one.
  115219. * @param clearCoatConfiguration define the config where to copy the info
  115220. */
  115221. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  115222. /**
  115223. * Serializes this clear coat configuration.
  115224. * @returns - An object with the serialized config.
  115225. */
  115226. serialize(): any;
  115227. /**
  115228. * Parses a anisotropy Configuration from a serialized object.
  115229. * @param source - Serialized object.
  115230. * @param scene Defines the scene we are parsing for
  115231. * @param rootUrl Defines the rootUrl to load from
  115232. */
  115233. parse(source: any, scene: Scene, rootUrl: string): void;
  115234. }
  115235. }
  115236. declare module BABYLON {
  115237. /**
  115238. * @hidden
  115239. */
  115240. export interface IMaterialAnisotropicDefines {
  115241. ANISOTROPIC: boolean;
  115242. ANISOTROPIC_TEXTURE: boolean;
  115243. ANISOTROPIC_TEXTUREDIRECTUV: number;
  115244. MAINUV1: boolean;
  115245. _areTexturesDirty: boolean;
  115246. _needUVs: boolean;
  115247. }
  115248. /**
  115249. * Define the code related to the anisotropic parameters of the pbr material.
  115250. */
  115251. export class PBRAnisotropicConfiguration {
  115252. private _isEnabled;
  115253. /**
  115254. * Defines if the anisotropy is enabled in the material.
  115255. */
  115256. isEnabled: boolean;
  115257. /**
  115258. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  115259. */
  115260. intensity: number;
  115261. /**
  115262. * Defines if the effect is along the tangents, bitangents or in between.
  115263. * By default, the effect is "strectching" the highlights along the tangents.
  115264. */
  115265. direction: Vector2;
  115266. private _texture;
  115267. /**
  115268. * Stores the anisotropy values in a texture.
  115269. * rg is direction (like normal from -1 to 1)
  115270. * b is a intensity
  115271. */
  115272. texture: Nullable<BaseTexture>;
  115273. /** @hidden */
  115274. private _internalMarkAllSubMeshesAsTexturesDirty;
  115275. /** @hidden */
  115276. _markAllSubMeshesAsTexturesDirty(): void;
  115277. /**
  115278. * Instantiate a new istance of anisotropy configuration.
  115279. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115280. */
  115281. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115282. /**
  115283. * Specifies that the submesh is ready to be used.
  115284. * @param defines the list of "defines" to update.
  115285. * @param scene defines the scene the material belongs to.
  115286. * @returns - boolean indicating that the submesh is ready or not.
  115287. */
  115288. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  115289. /**
  115290. * Checks to see if a texture is used in the material.
  115291. * @param defines the list of "defines" to update.
  115292. * @param mesh the mesh we are preparing the defines for.
  115293. * @param scene defines the scene the material belongs to.
  115294. */
  115295. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  115296. /**
  115297. * Binds the material data.
  115298. * @param uniformBuffer defines the Uniform buffer to fill in.
  115299. * @param scene defines the scene the material belongs to.
  115300. * @param isFrozen defines wether the material is frozen or not.
  115301. */
  115302. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  115303. /**
  115304. * Checks to see if a texture is used in the material.
  115305. * @param texture - Base texture to use.
  115306. * @returns - Boolean specifying if a texture is used in the material.
  115307. */
  115308. hasTexture(texture: BaseTexture): boolean;
  115309. /**
  115310. * Returns an array of the actively used textures.
  115311. * @param activeTextures Array of BaseTextures
  115312. */
  115313. getActiveTextures(activeTextures: BaseTexture[]): void;
  115314. /**
  115315. * Returns the animatable textures.
  115316. * @param animatables Array of animatable textures.
  115317. */
  115318. getAnimatables(animatables: IAnimatable[]): void;
  115319. /**
  115320. * Disposes the resources of the material.
  115321. * @param forceDisposeTextures - Forces the disposal of all textures.
  115322. */
  115323. dispose(forceDisposeTextures?: boolean): void;
  115324. /**
  115325. * Get the current class name of the texture useful for serialization or dynamic coding.
  115326. * @returns "PBRAnisotropicConfiguration"
  115327. */
  115328. getClassName(): string;
  115329. /**
  115330. * Add fallbacks to the effect fallbacks list.
  115331. * @param defines defines the Base texture to use.
  115332. * @param fallbacks defines the current fallback list.
  115333. * @param currentRank defines the current fallback rank.
  115334. * @returns the new fallback rank.
  115335. */
  115336. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115337. /**
  115338. * Add the required uniforms to the current list.
  115339. * @param uniforms defines the current uniform list.
  115340. */
  115341. static AddUniforms(uniforms: string[]): void;
  115342. /**
  115343. * Add the required uniforms to the current buffer.
  115344. * @param uniformBuffer defines the current uniform buffer.
  115345. */
  115346. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115347. /**
  115348. * Add the required samplers to the current list.
  115349. * @param samplers defines the current sampler list.
  115350. */
  115351. static AddSamplers(samplers: string[]): void;
  115352. /**
  115353. * Makes a duplicate of the current configuration into another one.
  115354. * @param anisotropicConfiguration define the config where to copy the info
  115355. */
  115356. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  115357. /**
  115358. * Serializes this anisotropy configuration.
  115359. * @returns - An object with the serialized config.
  115360. */
  115361. serialize(): any;
  115362. /**
  115363. * Parses a anisotropy Configuration from a serialized object.
  115364. * @param source - Serialized object.
  115365. * @param scene Defines the scene we are parsing for
  115366. * @param rootUrl Defines the rootUrl to load from
  115367. */
  115368. parse(source: any, scene: Scene, rootUrl: string): void;
  115369. }
  115370. }
  115371. declare module BABYLON {
  115372. /**
  115373. * @hidden
  115374. */
  115375. export interface IMaterialBRDFDefines {
  115376. BRDF_V_HEIGHT_CORRELATED: boolean;
  115377. MS_BRDF_ENERGY_CONSERVATION: boolean;
  115378. SPHERICAL_HARMONICS: boolean;
  115379. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  115380. /** @hidden */
  115381. _areMiscDirty: boolean;
  115382. }
  115383. /**
  115384. * Define the code related to the BRDF parameters of the pbr material.
  115385. */
  115386. export class PBRBRDFConfiguration {
  115387. /**
  115388. * Default value used for the energy conservation.
  115389. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  115390. */
  115391. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  115392. /**
  115393. * Default value used for the Smith Visibility Height Correlated mode.
  115394. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  115395. */
  115396. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  115397. /**
  115398. * Default value used for the IBL diffuse part.
  115399. * This can help switching back to the polynomials mode globally which is a tiny bit
  115400. * less GPU intensive at the drawback of a lower quality.
  115401. */
  115402. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  115403. /**
  115404. * Default value used for activating energy conservation for the specular workflow.
  115405. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  115406. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  115407. */
  115408. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  115409. private _useEnergyConservation;
  115410. /**
  115411. * Defines if the material uses energy conservation.
  115412. */
  115413. useEnergyConservation: boolean;
  115414. private _useSmithVisibilityHeightCorrelated;
  115415. /**
  115416. * LEGACY Mode set to false
  115417. * Defines if the material uses height smith correlated visibility term.
  115418. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  115419. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  115420. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  115421. * Not relying on height correlated will also disable energy conservation.
  115422. */
  115423. useSmithVisibilityHeightCorrelated: boolean;
  115424. private _useSphericalHarmonics;
  115425. /**
  115426. * LEGACY Mode set to false
  115427. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  115428. * diffuse part of the IBL.
  115429. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  115430. * to the ground truth.
  115431. */
  115432. useSphericalHarmonics: boolean;
  115433. private _useSpecularGlossinessInputEnergyConservation;
  115434. /**
  115435. * Defines if the material uses energy conservation, when the specular workflow is active.
  115436. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  115437. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  115438. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  115439. */
  115440. useSpecularGlossinessInputEnergyConservation: boolean;
  115441. /** @hidden */
  115442. private _internalMarkAllSubMeshesAsMiscDirty;
  115443. /** @hidden */
  115444. _markAllSubMeshesAsMiscDirty(): void;
  115445. /**
  115446. * Instantiate a new istance of clear coat configuration.
  115447. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  115448. */
  115449. constructor(markAllSubMeshesAsMiscDirty: () => void);
  115450. /**
  115451. * Checks to see if a texture is used in the material.
  115452. * @param defines the list of "defines" to update.
  115453. */
  115454. prepareDefines(defines: IMaterialBRDFDefines): void;
  115455. /**
  115456. * Get the current class name of the texture useful for serialization or dynamic coding.
  115457. * @returns "PBRClearCoatConfiguration"
  115458. */
  115459. getClassName(): string;
  115460. /**
  115461. * Makes a duplicate of the current configuration into another one.
  115462. * @param brdfConfiguration define the config where to copy the info
  115463. */
  115464. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  115465. /**
  115466. * Serializes this BRDF configuration.
  115467. * @returns - An object with the serialized config.
  115468. */
  115469. serialize(): any;
  115470. /**
  115471. * Parses a anisotropy Configuration from a serialized object.
  115472. * @param source - Serialized object.
  115473. * @param scene Defines the scene we are parsing for
  115474. * @param rootUrl Defines the rootUrl to load from
  115475. */
  115476. parse(source: any, scene: Scene, rootUrl: string): void;
  115477. }
  115478. }
  115479. declare module BABYLON {
  115480. /**
  115481. * @hidden
  115482. */
  115483. export interface IMaterialSheenDefines {
  115484. SHEEN: boolean;
  115485. SHEEN_TEXTURE: boolean;
  115486. SHEEN_TEXTUREDIRECTUV: number;
  115487. SHEEN_LINKWITHALBEDO: boolean;
  115488. /** @hidden */
  115489. _areTexturesDirty: boolean;
  115490. }
  115491. /**
  115492. * Define the code related to the Sheen parameters of the pbr material.
  115493. */
  115494. export class PBRSheenConfiguration {
  115495. private _isEnabled;
  115496. /**
  115497. * Defines if the material uses sheen.
  115498. */
  115499. isEnabled: boolean;
  115500. private _linkSheenWithAlbedo;
  115501. /**
  115502. * Defines if the sheen is linked to the sheen color.
  115503. */
  115504. linkSheenWithAlbedo: boolean;
  115505. /**
  115506. * Defines the sheen intensity.
  115507. */
  115508. intensity: number;
  115509. /**
  115510. * Defines the sheen color.
  115511. */
  115512. color: Color3;
  115513. private _texture;
  115514. /**
  115515. * Stores the sheen tint values in a texture.
  115516. * rgb is tint
  115517. * a is a intensity
  115518. */
  115519. texture: Nullable<BaseTexture>;
  115520. /** @hidden */
  115521. private _internalMarkAllSubMeshesAsTexturesDirty;
  115522. /** @hidden */
  115523. _markAllSubMeshesAsTexturesDirty(): void;
  115524. /**
  115525. * Instantiate a new istance of clear coat configuration.
  115526. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115527. */
  115528. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115529. /**
  115530. * Specifies that the submesh is ready to be used.
  115531. * @param defines the list of "defines" to update.
  115532. * @param scene defines the scene the material belongs to.
  115533. * @returns - boolean indicating that the submesh is ready or not.
  115534. */
  115535. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  115536. /**
  115537. * Checks to see if a texture is used in the material.
  115538. * @param defines the list of "defines" to update.
  115539. * @param scene defines the scene the material belongs to.
  115540. */
  115541. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  115542. /**
  115543. * Binds the material data.
  115544. * @param uniformBuffer defines the Uniform buffer to fill in.
  115545. * @param scene defines the scene the material belongs to.
  115546. * @param isFrozen defines wether the material is frozen or not.
  115547. */
  115548. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  115549. /**
  115550. * Checks to see if a texture is used in the material.
  115551. * @param texture - Base texture to use.
  115552. * @returns - Boolean specifying if a texture is used in the material.
  115553. */
  115554. hasTexture(texture: BaseTexture): boolean;
  115555. /**
  115556. * Returns an array of the actively used textures.
  115557. * @param activeTextures Array of BaseTextures
  115558. */
  115559. getActiveTextures(activeTextures: BaseTexture[]): void;
  115560. /**
  115561. * Returns the animatable textures.
  115562. * @param animatables Array of animatable textures.
  115563. */
  115564. getAnimatables(animatables: IAnimatable[]): void;
  115565. /**
  115566. * Disposes the resources of the material.
  115567. * @param forceDisposeTextures - Forces the disposal of all textures.
  115568. */
  115569. dispose(forceDisposeTextures?: boolean): void;
  115570. /**
  115571. * Get the current class name of the texture useful for serialization or dynamic coding.
  115572. * @returns "PBRSheenConfiguration"
  115573. */
  115574. getClassName(): string;
  115575. /**
  115576. * Add fallbacks to the effect fallbacks list.
  115577. * @param defines defines the Base texture to use.
  115578. * @param fallbacks defines the current fallback list.
  115579. * @param currentRank defines the current fallback rank.
  115580. * @returns the new fallback rank.
  115581. */
  115582. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115583. /**
  115584. * Add the required uniforms to the current list.
  115585. * @param uniforms defines the current uniform list.
  115586. */
  115587. static AddUniforms(uniforms: string[]): void;
  115588. /**
  115589. * Add the required uniforms to the current buffer.
  115590. * @param uniformBuffer defines the current uniform buffer.
  115591. */
  115592. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115593. /**
  115594. * Add the required samplers to the current list.
  115595. * @param samplers defines the current sampler list.
  115596. */
  115597. static AddSamplers(samplers: string[]): void;
  115598. /**
  115599. * Makes a duplicate of the current configuration into another one.
  115600. * @param sheenConfiguration define the config where to copy the info
  115601. */
  115602. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  115603. /**
  115604. * Serializes this BRDF configuration.
  115605. * @returns - An object with the serialized config.
  115606. */
  115607. serialize(): any;
  115608. /**
  115609. * Parses a anisotropy Configuration from a serialized object.
  115610. * @param source - Serialized object.
  115611. * @param scene Defines the scene we are parsing for
  115612. * @param rootUrl Defines the rootUrl to load from
  115613. */
  115614. parse(source: any, scene: Scene, rootUrl: string): void;
  115615. }
  115616. }
  115617. declare module BABYLON {
  115618. /**
  115619. * @hidden
  115620. */
  115621. export interface IMaterialSubSurfaceDefines {
  115622. SUBSURFACE: boolean;
  115623. SS_REFRACTION: boolean;
  115624. SS_TRANSLUCENCY: boolean;
  115625. SS_SCATERRING: boolean;
  115626. SS_THICKNESSANDMASK_TEXTURE: boolean;
  115627. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  115628. SS_REFRACTIONMAP_3D: boolean;
  115629. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  115630. SS_LODINREFRACTIONALPHA: boolean;
  115631. SS_GAMMAREFRACTION: boolean;
  115632. SS_RGBDREFRACTION: boolean;
  115633. SS_LINEARSPECULARREFRACTION: boolean;
  115634. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  115635. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  115636. /** @hidden */
  115637. _areTexturesDirty: boolean;
  115638. }
  115639. /**
  115640. * Define the code related to the sub surface parameters of the pbr material.
  115641. */
  115642. export class PBRSubSurfaceConfiguration {
  115643. private _isRefractionEnabled;
  115644. /**
  115645. * Defines if the refraction is enabled in the material.
  115646. */
  115647. isRefractionEnabled: boolean;
  115648. private _isTranslucencyEnabled;
  115649. /**
  115650. * Defines if the translucency is enabled in the material.
  115651. */
  115652. isTranslucencyEnabled: boolean;
  115653. private _isScatteringEnabled;
  115654. /**
  115655. * Defines the refraction intensity of the material.
  115656. * The refraction when enabled replaces the Diffuse part of the material.
  115657. * The intensity helps transitionning between diffuse and refraction.
  115658. */
  115659. refractionIntensity: number;
  115660. /**
  115661. * Defines the translucency intensity of the material.
  115662. * When translucency has been enabled, this defines how much of the "translucency"
  115663. * is addded to the diffuse part of the material.
  115664. */
  115665. translucencyIntensity: number;
  115666. /**
  115667. * Defines the scattering intensity of the material.
  115668. * When scattering has been enabled, this defines how much of the "scattered light"
  115669. * is addded to the diffuse part of the material.
  115670. */
  115671. scatteringIntensity: number;
  115672. private _thicknessTexture;
  115673. /**
  115674. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  115675. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  115676. * 0 would mean minimumThickness
  115677. * 1 would mean maximumThickness
  115678. * The other channels might be use as a mask to vary the different effects intensity.
  115679. */
  115680. thicknessTexture: Nullable<BaseTexture>;
  115681. private _refractionTexture;
  115682. /**
  115683. * Defines the texture to use for refraction.
  115684. */
  115685. refractionTexture: Nullable<BaseTexture>;
  115686. private _indexOfRefraction;
  115687. /**
  115688. * Defines the index of refraction used in the material.
  115689. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  115690. */
  115691. indexOfRefraction: number;
  115692. private _invertRefractionY;
  115693. /**
  115694. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  115695. */
  115696. invertRefractionY: boolean;
  115697. private _linkRefractionWithTransparency;
  115698. /**
  115699. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  115700. * Materials half opaque for instance using refraction could benefit from this control.
  115701. */
  115702. linkRefractionWithTransparency: boolean;
  115703. /**
  115704. * Defines the minimum thickness stored in the thickness map.
  115705. * If no thickness map is defined, this value will be used to simulate thickness.
  115706. */
  115707. minimumThickness: number;
  115708. /**
  115709. * Defines the maximum thickness stored in the thickness map.
  115710. */
  115711. maximumThickness: number;
  115712. /**
  115713. * Defines the volume tint of the material.
  115714. * This is used for both translucency and scattering.
  115715. */
  115716. tintColor: Color3;
  115717. /**
  115718. * Defines the distance at which the tint color should be found in the media.
  115719. * This is used for refraction only.
  115720. */
  115721. tintColorAtDistance: number;
  115722. /**
  115723. * Defines how far each channel transmit through the media.
  115724. * It is defined as a color to simplify it selection.
  115725. */
  115726. diffusionDistance: Color3;
  115727. private _useMaskFromThicknessTexture;
  115728. /**
  115729. * Stores the intensity of the different subsurface effects in the thickness texture.
  115730. * * the green channel is the translucency intensity.
  115731. * * the blue channel is the scattering intensity.
  115732. * * the alpha channel is the refraction intensity.
  115733. */
  115734. useMaskFromThicknessTexture: boolean;
  115735. /** @hidden */
  115736. private _internalMarkAllSubMeshesAsTexturesDirty;
  115737. /** @hidden */
  115738. _markAllSubMeshesAsTexturesDirty(): void;
  115739. /**
  115740. * Instantiate a new istance of sub surface configuration.
  115741. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115742. */
  115743. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115744. /**
  115745. * Gets wehter the submesh is ready to be used or not.
  115746. * @param defines the list of "defines" to update.
  115747. * @param scene defines the scene the material belongs to.
  115748. * @returns - boolean indicating that the submesh is ready or not.
  115749. */
  115750. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  115751. /**
  115752. * Checks to see if a texture is used in the material.
  115753. * @param defines the list of "defines" to update.
  115754. * @param scene defines the scene to the material belongs to.
  115755. */
  115756. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  115757. /**
  115758. * Binds the material data.
  115759. * @param uniformBuffer defines the Uniform buffer to fill in.
  115760. * @param scene defines the scene the material belongs to.
  115761. * @param engine defines the engine the material belongs to.
  115762. * @param isFrozen defines wether the material is frozen or not.
  115763. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  115764. */
  115765. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  115766. /**
  115767. * Unbinds the material from the mesh.
  115768. * @param activeEffect defines the effect that should be unbound from.
  115769. * @returns true if unbound, otherwise false
  115770. */
  115771. unbind(activeEffect: Effect): boolean;
  115772. /**
  115773. * Returns the texture used for refraction or null if none is used.
  115774. * @param scene defines the scene the material belongs to.
  115775. * @returns - Refraction texture if present. If no refraction texture and refraction
  115776. * is linked with transparency, returns environment texture. Otherwise, returns null.
  115777. */
  115778. private _getRefractionTexture;
  115779. /**
  115780. * Returns true if alpha blending should be disabled.
  115781. */
  115782. readonly disableAlphaBlending: boolean;
  115783. /**
  115784. * Fills the list of render target textures.
  115785. * @param renderTargets the list of render targets to update
  115786. */
  115787. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  115788. /**
  115789. * Checks to see if a texture is used in the material.
  115790. * @param texture - Base texture to use.
  115791. * @returns - Boolean specifying if a texture is used in the material.
  115792. */
  115793. hasTexture(texture: BaseTexture): boolean;
  115794. /**
  115795. * Gets a boolean indicating that current material needs to register RTT
  115796. * @returns true if this uses a render target otherwise false.
  115797. */
  115798. hasRenderTargetTextures(): boolean;
  115799. /**
  115800. * Returns an array of the actively used textures.
  115801. * @param activeTextures Array of BaseTextures
  115802. */
  115803. getActiveTextures(activeTextures: BaseTexture[]): void;
  115804. /**
  115805. * Returns the animatable textures.
  115806. * @param animatables Array of animatable textures.
  115807. */
  115808. getAnimatables(animatables: IAnimatable[]): void;
  115809. /**
  115810. * Disposes the resources of the material.
  115811. * @param forceDisposeTextures - Forces the disposal of all textures.
  115812. */
  115813. dispose(forceDisposeTextures?: boolean): void;
  115814. /**
  115815. * Get the current class name of the texture useful for serialization or dynamic coding.
  115816. * @returns "PBRSubSurfaceConfiguration"
  115817. */
  115818. getClassName(): string;
  115819. /**
  115820. * Add fallbacks to the effect fallbacks list.
  115821. * @param defines defines the Base texture to use.
  115822. * @param fallbacks defines the current fallback list.
  115823. * @param currentRank defines the current fallback rank.
  115824. * @returns the new fallback rank.
  115825. */
  115826. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115827. /**
  115828. * Add the required uniforms to the current list.
  115829. * @param uniforms defines the current uniform list.
  115830. */
  115831. static AddUniforms(uniforms: string[]): void;
  115832. /**
  115833. * Add the required samplers to the current list.
  115834. * @param samplers defines the current sampler list.
  115835. */
  115836. static AddSamplers(samplers: string[]): void;
  115837. /**
  115838. * Add the required uniforms to the current buffer.
  115839. * @param uniformBuffer defines the current uniform buffer.
  115840. */
  115841. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115842. /**
  115843. * Makes a duplicate of the current configuration into another one.
  115844. * @param configuration define the config where to copy the info
  115845. */
  115846. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  115847. /**
  115848. * Serializes this Sub Surface configuration.
  115849. * @returns - An object with the serialized config.
  115850. */
  115851. serialize(): any;
  115852. /**
  115853. * Parses a anisotropy Configuration from a serialized object.
  115854. * @param source - Serialized object.
  115855. * @param scene Defines the scene we are parsing for
  115856. * @param rootUrl Defines the rootUrl to load from
  115857. */
  115858. parse(source: any, scene: Scene, rootUrl: string): void;
  115859. }
  115860. }
  115861. declare module BABYLON {
  115862. /** @hidden */
  115863. export var pbrFragmentDeclaration: {
  115864. name: string;
  115865. shader: string;
  115866. };
  115867. }
  115868. declare module BABYLON {
  115869. /** @hidden */
  115870. export var pbrUboDeclaration: {
  115871. name: string;
  115872. shader: string;
  115873. };
  115874. }
  115875. declare module BABYLON {
  115876. /** @hidden */
  115877. export var pbrFragmentExtraDeclaration: {
  115878. name: string;
  115879. shader: string;
  115880. };
  115881. }
  115882. declare module BABYLON {
  115883. /** @hidden */
  115884. export var pbrFragmentSamplersDeclaration: {
  115885. name: string;
  115886. shader: string;
  115887. };
  115888. }
  115889. declare module BABYLON {
  115890. /** @hidden */
  115891. export var pbrHelperFunctions: {
  115892. name: string;
  115893. shader: string;
  115894. };
  115895. }
  115896. declare module BABYLON {
  115897. /** @hidden */
  115898. export var harmonicsFunctions: {
  115899. name: string;
  115900. shader: string;
  115901. };
  115902. }
  115903. declare module BABYLON {
  115904. /** @hidden */
  115905. export var pbrDirectLightingSetupFunctions: {
  115906. name: string;
  115907. shader: string;
  115908. };
  115909. }
  115910. declare module BABYLON {
  115911. /** @hidden */
  115912. export var pbrDirectLightingFalloffFunctions: {
  115913. name: string;
  115914. shader: string;
  115915. };
  115916. }
  115917. declare module BABYLON {
  115918. /** @hidden */
  115919. export var pbrBRDFFunctions: {
  115920. name: string;
  115921. shader: string;
  115922. };
  115923. }
  115924. declare module BABYLON {
  115925. /** @hidden */
  115926. export var pbrDirectLightingFunctions: {
  115927. name: string;
  115928. shader: string;
  115929. };
  115930. }
  115931. declare module BABYLON {
  115932. /** @hidden */
  115933. export var pbrIBLFunctions: {
  115934. name: string;
  115935. shader: string;
  115936. };
  115937. }
  115938. declare module BABYLON {
  115939. /** @hidden */
  115940. export var pbrDebug: {
  115941. name: string;
  115942. shader: string;
  115943. };
  115944. }
  115945. declare module BABYLON {
  115946. /** @hidden */
  115947. export var pbrPixelShader: {
  115948. name: string;
  115949. shader: string;
  115950. };
  115951. }
  115952. declare module BABYLON {
  115953. /** @hidden */
  115954. export var pbrVertexDeclaration: {
  115955. name: string;
  115956. shader: string;
  115957. };
  115958. }
  115959. declare module BABYLON {
  115960. /** @hidden */
  115961. export var pbrVertexShader: {
  115962. name: string;
  115963. shader: string;
  115964. };
  115965. }
  115966. declare module BABYLON {
  115967. /**
  115968. * Manages the defines for the PBR Material.
  115969. * @hidden
  115970. */
  115971. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  115972. PBR: boolean;
  115973. MAINUV1: boolean;
  115974. MAINUV2: boolean;
  115975. UV1: boolean;
  115976. UV2: boolean;
  115977. ALBEDO: boolean;
  115978. ALBEDODIRECTUV: number;
  115979. VERTEXCOLOR: boolean;
  115980. AMBIENT: boolean;
  115981. AMBIENTDIRECTUV: number;
  115982. AMBIENTINGRAYSCALE: boolean;
  115983. OPACITY: boolean;
  115984. VERTEXALPHA: boolean;
  115985. OPACITYDIRECTUV: number;
  115986. OPACITYRGB: boolean;
  115987. ALPHATEST: boolean;
  115988. DEPTHPREPASS: boolean;
  115989. ALPHABLEND: boolean;
  115990. ALPHAFROMALBEDO: boolean;
  115991. ALPHATESTVALUE: string;
  115992. SPECULAROVERALPHA: boolean;
  115993. RADIANCEOVERALPHA: boolean;
  115994. ALPHAFRESNEL: boolean;
  115995. LINEARALPHAFRESNEL: boolean;
  115996. PREMULTIPLYALPHA: boolean;
  115997. EMISSIVE: boolean;
  115998. EMISSIVEDIRECTUV: number;
  115999. REFLECTIVITY: boolean;
  116000. REFLECTIVITYDIRECTUV: number;
  116001. SPECULARTERM: boolean;
  116002. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  116003. MICROSURFACEAUTOMATIC: boolean;
  116004. LODBASEDMICROSFURACE: boolean;
  116005. MICROSURFACEMAP: boolean;
  116006. MICROSURFACEMAPDIRECTUV: number;
  116007. METALLICWORKFLOW: boolean;
  116008. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  116009. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  116010. METALLNESSSTOREINMETALMAPBLUE: boolean;
  116011. AOSTOREINMETALMAPRED: boolean;
  116012. METALLICF0FACTORFROMMETALLICMAP: boolean;
  116013. ENVIRONMENTBRDF: boolean;
  116014. ENVIRONMENTBRDF_RGBD: boolean;
  116015. NORMAL: boolean;
  116016. TANGENT: boolean;
  116017. BUMP: boolean;
  116018. BUMPDIRECTUV: number;
  116019. OBJECTSPACE_NORMALMAP: boolean;
  116020. PARALLAX: boolean;
  116021. PARALLAXOCCLUSION: boolean;
  116022. NORMALXYSCALE: boolean;
  116023. LIGHTMAP: boolean;
  116024. LIGHTMAPDIRECTUV: number;
  116025. USELIGHTMAPASSHADOWMAP: boolean;
  116026. GAMMALIGHTMAP: boolean;
  116027. RGBDLIGHTMAP: boolean;
  116028. REFLECTION: boolean;
  116029. REFLECTIONMAP_3D: boolean;
  116030. REFLECTIONMAP_SPHERICAL: boolean;
  116031. REFLECTIONMAP_PLANAR: boolean;
  116032. REFLECTIONMAP_CUBIC: boolean;
  116033. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  116034. REFLECTIONMAP_PROJECTION: boolean;
  116035. REFLECTIONMAP_SKYBOX: boolean;
  116036. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  116037. REFLECTIONMAP_EXPLICIT: boolean;
  116038. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  116039. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  116040. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  116041. INVERTCUBICMAP: boolean;
  116042. USESPHERICALFROMREFLECTIONMAP: boolean;
  116043. USEIRRADIANCEMAP: boolean;
  116044. SPHERICAL_HARMONICS: boolean;
  116045. USESPHERICALINVERTEX: boolean;
  116046. REFLECTIONMAP_OPPOSITEZ: boolean;
  116047. LODINREFLECTIONALPHA: boolean;
  116048. GAMMAREFLECTION: boolean;
  116049. RGBDREFLECTION: boolean;
  116050. LINEARSPECULARREFLECTION: boolean;
  116051. RADIANCEOCCLUSION: boolean;
  116052. HORIZONOCCLUSION: boolean;
  116053. INSTANCES: boolean;
  116054. NUM_BONE_INFLUENCERS: number;
  116055. BonesPerMesh: number;
  116056. BONETEXTURE: boolean;
  116057. NONUNIFORMSCALING: boolean;
  116058. MORPHTARGETS: boolean;
  116059. MORPHTARGETS_NORMAL: boolean;
  116060. MORPHTARGETS_TANGENT: boolean;
  116061. MORPHTARGETS_UV: boolean;
  116062. NUM_MORPH_INFLUENCERS: number;
  116063. IMAGEPROCESSING: boolean;
  116064. VIGNETTE: boolean;
  116065. VIGNETTEBLENDMODEMULTIPLY: boolean;
  116066. VIGNETTEBLENDMODEOPAQUE: boolean;
  116067. TONEMAPPING: boolean;
  116068. TONEMAPPING_ACES: boolean;
  116069. CONTRAST: boolean;
  116070. COLORCURVES: boolean;
  116071. COLORGRADING: boolean;
  116072. COLORGRADING3D: boolean;
  116073. SAMPLER3DGREENDEPTH: boolean;
  116074. SAMPLER3DBGRMAP: boolean;
  116075. IMAGEPROCESSINGPOSTPROCESS: boolean;
  116076. EXPOSURE: boolean;
  116077. MULTIVIEW: boolean;
  116078. USEPHYSICALLIGHTFALLOFF: boolean;
  116079. USEGLTFLIGHTFALLOFF: boolean;
  116080. TWOSIDEDLIGHTING: boolean;
  116081. SHADOWFLOAT: boolean;
  116082. CLIPPLANE: boolean;
  116083. CLIPPLANE2: boolean;
  116084. CLIPPLANE3: boolean;
  116085. CLIPPLANE4: boolean;
  116086. POINTSIZE: boolean;
  116087. FOG: boolean;
  116088. LOGARITHMICDEPTH: boolean;
  116089. FORCENORMALFORWARD: boolean;
  116090. SPECULARAA: boolean;
  116091. CLEARCOAT: boolean;
  116092. CLEARCOAT_DEFAULTIOR: boolean;
  116093. CLEARCOAT_TEXTURE: boolean;
  116094. CLEARCOAT_TEXTUREDIRECTUV: number;
  116095. CLEARCOAT_BUMP: boolean;
  116096. CLEARCOAT_BUMPDIRECTUV: number;
  116097. CLEARCOAT_TINT: boolean;
  116098. CLEARCOAT_TINT_TEXTURE: boolean;
  116099. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  116100. ANISOTROPIC: boolean;
  116101. ANISOTROPIC_TEXTURE: boolean;
  116102. ANISOTROPIC_TEXTUREDIRECTUV: number;
  116103. BRDF_V_HEIGHT_CORRELATED: boolean;
  116104. MS_BRDF_ENERGY_CONSERVATION: boolean;
  116105. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  116106. SHEEN: boolean;
  116107. SHEEN_TEXTURE: boolean;
  116108. SHEEN_TEXTUREDIRECTUV: number;
  116109. SHEEN_LINKWITHALBEDO: boolean;
  116110. SUBSURFACE: boolean;
  116111. SS_REFRACTION: boolean;
  116112. SS_TRANSLUCENCY: boolean;
  116113. SS_SCATERRING: boolean;
  116114. SS_THICKNESSANDMASK_TEXTURE: boolean;
  116115. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  116116. SS_REFRACTIONMAP_3D: boolean;
  116117. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  116118. SS_LODINREFRACTIONALPHA: boolean;
  116119. SS_GAMMAREFRACTION: boolean;
  116120. SS_RGBDREFRACTION: boolean;
  116121. SS_LINEARSPECULARREFRACTION: boolean;
  116122. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  116123. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  116124. UNLIT: boolean;
  116125. DEBUGMODE: number;
  116126. /**
  116127. * Initializes the PBR Material defines.
  116128. */
  116129. constructor();
  116130. /**
  116131. * Resets the PBR Material defines.
  116132. */
  116133. reset(): void;
  116134. }
  116135. /**
  116136. * The Physically based material base class of BJS.
  116137. *
  116138. * This offers the main features of a standard PBR material.
  116139. * For more information, please refer to the documentation :
  116140. * https://doc.babylonjs.com/how_to/physically_based_rendering
  116141. */
  116142. export abstract class PBRBaseMaterial extends PushMaterial {
  116143. /**
  116144. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  116145. */
  116146. static readonly PBRMATERIAL_OPAQUE: number;
  116147. /**
  116148. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  116149. */
  116150. static readonly PBRMATERIAL_ALPHATEST: number;
  116151. /**
  116152. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116153. */
  116154. static readonly PBRMATERIAL_ALPHABLEND: number;
  116155. /**
  116156. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116157. * They are also discarded below the alpha cutoff threshold to improve performances.
  116158. */
  116159. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  116160. /**
  116161. * Defines the default value of how much AO map is occluding the analytical lights
  116162. * (point spot...).
  116163. */
  116164. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  116165. /**
  116166. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  116167. */
  116168. static readonly LIGHTFALLOFF_PHYSICAL: number;
  116169. /**
  116170. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  116171. * to enhance interoperability with other engines.
  116172. */
  116173. static readonly LIGHTFALLOFF_GLTF: number;
  116174. /**
  116175. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  116176. * to enhance interoperability with other materials.
  116177. */
  116178. static readonly LIGHTFALLOFF_STANDARD: number;
  116179. /**
  116180. * Intensity of the direct lights e.g. the four lights available in your scene.
  116181. * This impacts both the direct diffuse and specular highlights.
  116182. */
  116183. protected _directIntensity: number;
  116184. /**
  116185. * Intensity of the emissive part of the material.
  116186. * This helps controlling the emissive effect without modifying the emissive color.
  116187. */
  116188. protected _emissiveIntensity: number;
  116189. /**
  116190. * Intensity of the environment e.g. how much the environment will light the object
  116191. * either through harmonics for rough material or through the refelction for shiny ones.
  116192. */
  116193. protected _environmentIntensity: number;
  116194. /**
  116195. * This is a special control allowing the reduction of the specular highlights coming from the
  116196. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  116197. */
  116198. protected _specularIntensity: number;
  116199. /**
  116200. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  116201. */
  116202. private _lightingInfos;
  116203. /**
  116204. * Debug Control allowing disabling the bump map on this material.
  116205. */
  116206. protected _disableBumpMap: boolean;
  116207. /**
  116208. * AKA Diffuse Texture in standard nomenclature.
  116209. */
  116210. protected _albedoTexture: Nullable<BaseTexture>;
  116211. /**
  116212. * AKA Occlusion Texture in other nomenclature.
  116213. */
  116214. protected _ambientTexture: Nullable<BaseTexture>;
  116215. /**
  116216. * AKA Occlusion Texture Intensity in other nomenclature.
  116217. */
  116218. protected _ambientTextureStrength: number;
  116219. /**
  116220. * Defines how much the AO map is occluding the analytical lights (point spot...).
  116221. * 1 means it completely occludes it
  116222. * 0 mean it has no impact
  116223. */
  116224. protected _ambientTextureImpactOnAnalyticalLights: number;
  116225. /**
  116226. * Stores the alpha values in a texture.
  116227. */
  116228. protected _opacityTexture: Nullable<BaseTexture>;
  116229. /**
  116230. * Stores the reflection values in a texture.
  116231. */
  116232. protected _reflectionTexture: Nullable<BaseTexture>;
  116233. /**
  116234. * Stores the emissive values in a texture.
  116235. */
  116236. protected _emissiveTexture: Nullable<BaseTexture>;
  116237. /**
  116238. * AKA Specular texture in other nomenclature.
  116239. */
  116240. protected _reflectivityTexture: Nullable<BaseTexture>;
  116241. /**
  116242. * Used to switch from specular/glossiness to metallic/roughness workflow.
  116243. */
  116244. protected _metallicTexture: Nullable<BaseTexture>;
  116245. /**
  116246. * Specifies the metallic scalar of the metallic/roughness workflow.
  116247. * Can also be used to scale the metalness values of the metallic texture.
  116248. */
  116249. protected _metallic: Nullable<number>;
  116250. /**
  116251. * Specifies the roughness scalar of the metallic/roughness workflow.
  116252. * Can also be used to scale the roughness values of the metallic texture.
  116253. */
  116254. protected _roughness: Nullable<number>;
  116255. /**
  116256. * Specifies the an F0 factor to help configuring the material F0.
  116257. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  116258. * to 0.5 the previously hard coded value stays the same.
  116259. * Can also be used to scale the F0 values of the metallic texture.
  116260. */
  116261. protected _metallicF0Factor: number;
  116262. /**
  116263. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  116264. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  116265. * your expectation as it multiplies with the texture data.
  116266. */
  116267. protected _useMetallicF0FactorFromMetallicTexture: boolean;
  116268. /**
  116269. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  116270. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  116271. */
  116272. protected _microSurfaceTexture: Nullable<BaseTexture>;
  116273. /**
  116274. * Stores surface normal data used to displace a mesh in a texture.
  116275. */
  116276. protected _bumpTexture: Nullable<BaseTexture>;
  116277. /**
  116278. * Stores the pre-calculated light information of a mesh in a texture.
  116279. */
  116280. protected _lightmapTexture: Nullable<BaseTexture>;
  116281. /**
  116282. * The color of a material in ambient lighting.
  116283. */
  116284. protected _ambientColor: Color3;
  116285. /**
  116286. * AKA Diffuse Color in other nomenclature.
  116287. */
  116288. protected _albedoColor: Color3;
  116289. /**
  116290. * AKA Specular Color in other nomenclature.
  116291. */
  116292. protected _reflectivityColor: Color3;
  116293. /**
  116294. * The color applied when light is reflected from a material.
  116295. */
  116296. protected _reflectionColor: Color3;
  116297. /**
  116298. * The color applied when light is emitted from a material.
  116299. */
  116300. protected _emissiveColor: Color3;
  116301. /**
  116302. * AKA Glossiness in other nomenclature.
  116303. */
  116304. protected _microSurface: number;
  116305. /**
  116306. * Specifies that the material will use the light map as a show map.
  116307. */
  116308. protected _useLightmapAsShadowmap: boolean;
  116309. /**
  116310. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  116311. * makes the reflect vector face the model (under horizon).
  116312. */
  116313. protected _useHorizonOcclusion: boolean;
  116314. /**
  116315. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  116316. * too much the area relying on ambient texture to define their ambient occlusion.
  116317. */
  116318. protected _useRadianceOcclusion: boolean;
  116319. /**
  116320. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  116321. */
  116322. protected _useAlphaFromAlbedoTexture: boolean;
  116323. /**
  116324. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  116325. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  116326. */
  116327. protected _useSpecularOverAlpha: boolean;
  116328. /**
  116329. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  116330. */
  116331. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  116332. /**
  116333. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  116334. */
  116335. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  116336. /**
  116337. * Specifies if the metallic texture contains the roughness information in its green channel.
  116338. */
  116339. protected _useRoughnessFromMetallicTextureGreen: boolean;
  116340. /**
  116341. * Specifies if the metallic texture contains the metallness information in its blue channel.
  116342. */
  116343. protected _useMetallnessFromMetallicTextureBlue: boolean;
  116344. /**
  116345. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  116346. */
  116347. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  116348. /**
  116349. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  116350. */
  116351. protected _useAmbientInGrayScale: boolean;
  116352. /**
  116353. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  116354. * The material will try to infer what glossiness each pixel should be.
  116355. */
  116356. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  116357. /**
  116358. * Defines the falloff type used in this material.
  116359. * It by default is Physical.
  116360. */
  116361. protected _lightFalloff: number;
  116362. /**
  116363. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  116364. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  116365. */
  116366. protected _useRadianceOverAlpha: boolean;
  116367. /**
  116368. * Allows using an object space normal map (instead of tangent space).
  116369. */
  116370. protected _useObjectSpaceNormalMap: boolean;
  116371. /**
  116372. * Allows using the bump map in parallax mode.
  116373. */
  116374. protected _useParallax: boolean;
  116375. /**
  116376. * Allows using the bump map in parallax occlusion mode.
  116377. */
  116378. protected _useParallaxOcclusion: boolean;
  116379. /**
  116380. * Controls the scale bias of the parallax mode.
  116381. */
  116382. protected _parallaxScaleBias: number;
  116383. /**
  116384. * If sets to true, disables all the lights affecting the material.
  116385. */
  116386. protected _disableLighting: boolean;
  116387. /**
  116388. * Number of Simultaneous lights allowed on the material.
  116389. */
  116390. protected _maxSimultaneousLights: number;
  116391. /**
  116392. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  116393. */
  116394. protected _invertNormalMapX: boolean;
  116395. /**
  116396. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  116397. */
  116398. protected _invertNormalMapY: boolean;
  116399. /**
  116400. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  116401. */
  116402. protected _twoSidedLighting: boolean;
  116403. /**
  116404. * Defines the alpha limits in alpha test mode.
  116405. */
  116406. protected _alphaCutOff: number;
  116407. /**
  116408. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  116409. */
  116410. protected _forceAlphaTest: boolean;
  116411. /**
  116412. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  116413. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  116414. */
  116415. protected _useAlphaFresnel: boolean;
  116416. /**
  116417. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  116418. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  116419. */
  116420. protected _useLinearAlphaFresnel: boolean;
  116421. /**
  116422. * The transparency mode of the material.
  116423. */
  116424. protected _transparencyMode: Nullable<number>;
  116425. /**
  116426. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  116427. * from cos thetav and roughness:
  116428. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  116429. */
  116430. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  116431. /**
  116432. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  116433. */
  116434. protected _forceIrradianceInFragment: boolean;
  116435. /**
  116436. * Force normal to face away from face.
  116437. */
  116438. protected _forceNormalForward: boolean;
  116439. /**
  116440. * Enables specular anti aliasing in the PBR shader.
  116441. * It will both interacts on the Geometry for analytical and IBL lighting.
  116442. * It also prefilter the roughness map based on the bump values.
  116443. */
  116444. protected _enableSpecularAntiAliasing: boolean;
  116445. /**
  116446. * Default configuration related to image processing available in the PBR Material.
  116447. */
  116448. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  116449. /**
  116450. * Keep track of the image processing observer to allow dispose and replace.
  116451. */
  116452. private _imageProcessingObserver;
  116453. /**
  116454. * Attaches a new image processing configuration to the PBR Material.
  116455. * @param configuration
  116456. */
  116457. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  116458. /**
  116459. * Stores the available render targets.
  116460. */
  116461. private _renderTargets;
  116462. /**
  116463. * Sets the global ambient color for the material used in lighting calculations.
  116464. */
  116465. private _globalAmbientColor;
  116466. /**
  116467. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  116468. */
  116469. private _useLogarithmicDepth;
  116470. /**
  116471. * If set to true, no lighting calculations will be applied.
  116472. */
  116473. private _unlit;
  116474. private _debugMode;
  116475. /**
  116476. * @hidden
  116477. * This is reserved for the inspector.
  116478. * Defines the material debug mode.
  116479. * It helps seeing only some components of the material while troubleshooting.
  116480. */
  116481. debugMode: number;
  116482. /**
  116483. * @hidden
  116484. * This is reserved for the inspector.
  116485. * Specify from where on screen the debug mode should start.
  116486. * The value goes from -1 (full screen) to 1 (not visible)
  116487. * It helps with side by side comparison against the final render
  116488. * This defaults to -1
  116489. */
  116490. private debugLimit;
  116491. /**
  116492. * @hidden
  116493. * This is reserved for the inspector.
  116494. * As the default viewing range might not be enough (if the ambient is really small for instance)
  116495. * You can use the factor to better multiply the final value.
  116496. */
  116497. private debugFactor;
  116498. /**
  116499. * Defines the clear coat layer parameters for the material.
  116500. */
  116501. readonly clearCoat: PBRClearCoatConfiguration;
  116502. /**
  116503. * Defines the anisotropic parameters for the material.
  116504. */
  116505. readonly anisotropy: PBRAnisotropicConfiguration;
  116506. /**
  116507. * Defines the BRDF parameters for the material.
  116508. */
  116509. readonly brdf: PBRBRDFConfiguration;
  116510. /**
  116511. * Defines the Sheen parameters for the material.
  116512. */
  116513. readonly sheen: PBRSheenConfiguration;
  116514. /**
  116515. * Defines the SubSurface parameters for the material.
  116516. */
  116517. readonly subSurface: PBRSubSurfaceConfiguration;
  116518. /**
  116519. * Custom callback helping to override the default shader used in the material.
  116520. */
  116521. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  116522. protected _rebuildInParallel: boolean;
  116523. /**
  116524. * Instantiates a new PBRMaterial instance.
  116525. *
  116526. * @param name The material name
  116527. * @param scene The scene the material will be use in.
  116528. */
  116529. constructor(name: string, scene: Scene);
  116530. /**
  116531. * Gets a boolean indicating that current material needs to register RTT
  116532. */
  116533. readonly hasRenderTargetTextures: boolean;
  116534. /**
  116535. * Gets the name of the material class.
  116536. */
  116537. getClassName(): string;
  116538. /**
  116539. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  116540. */
  116541. /**
  116542. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  116543. */
  116544. useLogarithmicDepth: boolean;
  116545. /**
  116546. * Gets the current transparency mode.
  116547. */
  116548. /**
  116549. * Sets the transparency mode of the material.
  116550. *
  116551. * | Value | Type | Description |
  116552. * | ----- | ----------------------------------- | ----------- |
  116553. * | 0 | OPAQUE | |
  116554. * | 1 | ALPHATEST | |
  116555. * | 2 | ALPHABLEND | |
  116556. * | 3 | ALPHATESTANDBLEND | |
  116557. *
  116558. */
  116559. transparencyMode: Nullable<number>;
  116560. /**
  116561. * Returns true if alpha blending should be disabled.
  116562. */
  116563. private readonly _disableAlphaBlending;
  116564. /**
  116565. * Specifies whether or not this material should be rendered in alpha blend mode.
  116566. */
  116567. needAlphaBlending(): boolean;
  116568. /**
  116569. * Specifies if the mesh will require alpha blending.
  116570. * @param mesh - BJS mesh.
  116571. */
  116572. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  116573. /**
  116574. * Specifies whether or not this material should be rendered in alpha test mode.
  116575. */
  116576. needAlphaTesting(): boolean;
  116577. /**
  116578. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  116579. */
  116580. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  116581. /**
  116582. * Gets the texture used for the alpha test.
  116583. */
  116584. getAlphaTestTexture(): Nullable<BaseTexture>;
  116585. /**
  116586. * Specifies that the submesh is ready to be used.
  116587. * @param mesh - BJS mesh.
  116588. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  116589. * @param useInstances - Specifies that instances should be used.
  116590. * @returns - boolean indicating that the submesh is ready or not.
  116591. */
  116592. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  116593. /**
  116594. * Specifies if the material uses metallic roughness workflow.
  116595. * @returns boolean specifiying if the material uses metallic roughness workflow.
  116596. */
  116597. isMetallicWorkflow(): boolean;
  116598. private _prepareEffect;
  116599. private _prepareDefines;
  116600. /**
  116601. * Force shader compilation
  116602. */
  116603. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  116604. /**
  116605. * Initializes the uniform buffer layout for the shader.
  116606. */
  116607. buildUniformLayout(): void;
  116608. /**
  116609. * Unbinds the material from the mesh
  116610. */
  116611. unbind(): void;
  116612. /**
  116613. * Binds the submesh data.
  116614. * @param world - The world matrix.
  116615. * @param mesh - The BJS mesh.
  116616. * @param subMesh - A submesh of the BJS mesh.
  116617. */
  116618. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  116619. /**
  116620. * Returns the animatable textures.
  116621. * @returns - Array of animatable textures.
  116622. */
  116623. getAnimatables(): IAnimatable[];
  116624. /**
  116625. * Returns the texture used for reflections.
  116626. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  116627. */
  116628. private _getReflectionTexture;
  116629. /**
  116630. * Returns an array of the actively used textures.
  116631. * @returns - Array of BaseTextures
  116632. */
  116633. getActiveTextures(): BaseTexture[];
  116634. /**
  116635. * Checks to see if a texture is used in the material.
  116636. * @param texture - Base texture to use.
  116637. * @returns - Boolean specifying if a texture is used in the material.
  116638. */
  116639. hasTexture(texture: BaseTexture): boolean;
  116640. /**
  116641. * Disposes the resources of the material.
  116642. * @param forceDisposeEffect - Forces the disposal of effects.
  116643. * @param forceDisposeTextures - Forces the disposal of all textures.
  116644. */
  116645. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  116646. }
  116647. }
  116648. declare module BABYLON {
  116649. /**
  116650. * The Physically based material of BJS.
  116651. *
  116652. * This offers the main features of a standard PBR material.
  116653. * For more information, please refer to the documentation :
  116654. * https://doc.babylonjs.com/how_to/physically_based_rendering
  116655. */
  116656. export class PBRMaterial extends PBRBaseMaterial {
  116657. /**
  116658. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  116659. */
  116660. static readonly PBRMATERIAL_OPAQUE: number;
  116661. /**
  116662. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  116663. */
  116664. static readonly PBRMATERIAL_ALPHATEST: number;
  116665. /**
  116666. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116667. */
  116668. static readonly PBRMATERIAL_ALPHABLEND: number;
  116669. /**
  116670. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116671. * They are also discarded below the alpha cutoff threshold to improve performances.
  116672. */
  116673. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  116674. /**
  116675. * Defines the default value of how much AO map is occluding the analytical lights
  116676. * (point spot...).
  116677. */
  116678. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  116679. /**
  116680. * Intensity of the direct lights e.g. the four lights available in your scene.
  116681. * This impacts both the direct diffuse and specular highlights.
  116682. */
  116683. directIntensity: number;
  116684. /**
  116685. * Intensity of the emissive part of the material.
  116686. * This helps controlling the emissive effect without modifying the emissive color.
  116687. */
  116688. emissiveIntensity: number;
  116689. /**
  116690. * Intensity of the environment e.g. how much the environment will light the object
  116691. * either through harmonics for rough material or through the refelction for shiny ones.
  116692. */
  116693. environmentIntensity: number;
  116694. /**
  116695. * This is a special control allowing the reduction of the specular highlights coming from the
  116696. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  116697. */
  116698. specularIntensity: number;
  116699. /**
  116700. * Debug Control allowing disabling the bump map on this material.
  116701. */
  116702. disableBumpMap: boolean;
  116703. /**
  116704. * AKA Diffuse Texture in standard nomenclature.
  116705. */
  116706. albedoTexture: BaseTexture;
  116707. /**
  116708. * AKA Occlusion Texture in other nomenclature.
  116709. */
  116710. ambientTexture: BaseTexture;
  116711. /**
  116712. * AKA Occlusion Texture Intensity in other nomenclature.
  116713. */
  116714. ambientTextureStrength: number;
  116715. /**
  116716. * Defines how much the AO map is occluding the analytical lights (point spot...).
  116717. * 1 means it completely occludes it
  116718. * 0 mean it has no impact
  116719. */
  116720. ambientTextureImpactOnAnalyticalLights: number;
  116721. /**
  116722. * Stores the alpha values in a texture.
  116723. */
  116724. opacityTexture: BaseTexture;
  116725. /**
  116726. * Stores the reflection values in a texture.
  116727. */
  116728. reflectionTexture: Nullable<BaseTexture>;
  116729. /**
  116730. * Stores the emissive values in a texture.
  116731. */
  116732. emissiveTexture: BaseTexture;
  116733. /**
  116734. * AKA Specular texture in other nomenclature.
  116735. */
  116736. reflectivityTexture: BaseTexture;
  116737. /**
  116738. * Used to switch from specular/glossiness to metallic/roughness workflow.
  116739. */
  116740. metallicTexture: BaseTexture;
  116741. /**
  116742. * Specifies the metallic scalar of the metallic/roughness workflow.
  116743. * Can also be used to scale the metalness values of the metallic texture.
  116744. */
  116745. metallic: Nullable<number>;
  116746. /**
  116747. * Specifies the roughness scalar of the metallic/roughness workflow.
  116748. * Can also be used to scale the roughness values of the metallic texture.
  116749. */
  116750. roughness: Nullable<number>;
  116751. /**
  116752. * Specifies the an F0 factor to help configuring the material F0.
  116753. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  116754. * to 0.5 the previously hard coded value stays the same.
  116755. * Can also be used to scale the F0 values of the metallic texture.
  116756. */
  116757. metallicF0Factor: number;
  116758. /**
  116759. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  116760. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  116761. * your expectation as it multiplies with the texture data.
  116762. */
  116763. useMetallicF0FactorFromMetallicTexture: boolean;
  116764. /**
  116765. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  116766. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  116767. */
  116768. microSurfaceTexture: BaseTexture;
  116769. /**
  116770. * Stores surface normal data used to displace a mesh in a texture.
  116771. */
  116772. bumpTexture: BaseTexture;
  116773. /**
  116774. * Stores the pre-calculated light information of a mesh in a texture.
  116775. */
  116776. lightmapTexture: BaseTexture;
  116777. /**
  116778. * Stores the refracted light information in a texture.
  116779. */
  116780. refractionTexture: Nullable<BaseTexture>;
  116781. /**
  116782. * The color of a material in ambient lighting.
  116783. */
  116784. ambientColor: Color3;
  116785. /**
  116786. * AKA Diffuse Color in other nomenclature.
  116787. */
  116788. albedoColor: Color3;
  116789. /**
  116790. * AKA Specular Color in other nomenclature.
  116791. */
  116792. reflectivityColor: Color3;
  116793. /**
  116794. * The color reflected from the material.
  116795. */
  116796. reflectionColor: Color3;
  116797. /**
  116798. * The color emitted from the material.
  116799. */
  116800. emissiveColor: Color3;
  116801. /**
  116802. * AKA Glossiness in other nomenclature.
  116803. */
  116804. microSurface: number;
  116805. /**
  116806. * source material index of refraction (IOR)' / 'destination material IOR.
  116807. */
  116808. indexOfRefraction: number;
  116809. /**
  116810. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  116811. */
  116812. invertRefractionY: boolean;
  116813. /**
  116814. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  116815. * Materials half opaque for instance using refraction could benefit from this control.
  116816. */
  116817. linkRefractionWithTransparency: boolean;
  116818. /**
  116819. * If true, the light map contains occlusion information instead of lighting info.
  116820. */
  116821. useLightmapAsShadowmap: boolean;
  116822. /**
  116823. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  116824. */
  116825. useAlphaFromAlbedoTexture: boolean;
  116826. /**
  116827. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  116828. */
  116829. forceAlphaTest: boolean;
  116830. /**
  116831. * Defines the alpha limits in alpha test mode.
  116832. */
  116833. alphaCutOff: number;
  116834. /**
  116835. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  116836. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  116837. */
  116838. useSpecularOverAlpha: boolean;
  116839. /**
  116840. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  116841. */
  116842. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  116843. /**
  116844. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  116845. */
  116846. useRoughnessFromMetallicTextureAlpha: boolean;
  116847. /**
  116848. * Specifies if the metallic texture contains the roughness information in its green channel.
  116849. */
  116850. useRoughnessFromMetallicTextureGreen: boolean;
  116851. /**
  116852. * Specifies if the metallic texture contains the metallness information in its blue channel.
  116853. */
  116854. useMetallnessFromMetallicTextureBlue: boolean;
  116855. /**
  116856. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  116857. */
  116858. useAmbientOcclusionFromMetallicTextureRed: boolean;
  116859. /**
  116860. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  116861. */
  116862. useAmbientInGrayScale: boolean;
  116863. /**
  116864. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  116865. * The material will try to infer what glossiness each pixel should be.
  116866. */
  116867. useAutoMicroSurfaceFromReflectivityMap: boolean;
  116868. /**
  116869. * BJS is using an harcoded light falloff based on a manually sets up range.
  116870. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  116871. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  116872. */
  116873. /**
  116874. * BJS is using an harcoded light falloff based on a manually sets up range.
  116875. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  116876. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  116877. */
  116878. usePhysicalLightFalloff: boolean;
  116879. /**
  116880. * In order to support the falloff compatibility with gltf, a special mode has been added
  116881. * to reproduce the gltf light falloff.
  116882. */
  116883. /**
  116884. * In order to support the falloff compatibility with gltf, a special mode has been added
  116885. * to reproduce the gltf light falloff.
  116886. */
  116887. useGLTFLightFalloff: boolean;
  116888. /**
  116889. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  116890. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  116891. */
  116892. useRadianceOverAlpha: boolean;
  116893. /**
  116894. * Allows using an object space normal map (instead of tangent space).
  116895. */
  116896. useObjectSpaceNormalMap: boolean;
  116897. /**
  116898. * Allows using the bump map in parallax mode.
  116899. */
  116900. useParallax: boolean;
  116901. /**
  116902. * Allows using the bump map in parallax occlusion mode.
  116903. */
  116904. useParallaxOcclusion: boolean;
  116905. /**
  116906. * Controls the scale bias of the parallax mode.
  116907. */
  116908. parallaxScaleBias: number;
  116909. /**
  116910. * If sets to true, disables all the lights affecting the material.
  116911. */
  116912. disableLighting: boolean;
  116913. /**
  116914. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  116915. */
  116916. forceIrradianceInFragment: boolean;
  116917. /**
  116918. * Number of Simultaneous lights allowed on the material.
  116919. */
  116920. maxSimultaneousLights: number;
  116921. /**
  116922. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  116923. */
  116924. invertNormalMapX: boolean;
  116925. /**
  116926. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  116927. */
  116928. invertNormalMapY: boolean;
  116929. /**
  116930. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  116931. */
  116932. twoSidedLighting: boolean;
  116933. /**
  116934. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  116935. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  116936. */
  116937. useAlphaFresnel: boolean;
  116938. /**
  116939. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  116940. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  116941. */
  116942. useLinearAlphaFresnel: boolean;
  116943. /**
  116944. * Let user defines the brdf lookup texture used for IBL.
  116945. * A default 8bit version is embedded but you could point at :
  116946. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  116947. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  116948. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  116949. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  116950. */
  116951. environmentBRDFTexture: Nullable<BaseTexture>;
  116952. /**
  116953. * Force normal to face away from face.
  116954. */
  116955. forceNormalForward: boolean;
  116956. /**
  116957. * Enables specular anti aliasing in the PBR shader.
  116958. * It will both interacts on the Geometry for analytical and IBL lighting.
  116959. * It also prefilter the roughness map based on the bump values.
  116960. */
  116961. enableSpecularAntiAliasing: boolean;
  116962. /**
  116963. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  116964. * makes the reflect vector face the model (under horizon).
  116965. */
  116966. useHorizonOcclusion: boolean;
  116967. /**
  116968. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  116969. * too much the area relying on ambient texture to define their ambient occlusion.
  116970. */
  116971. useRadianceOcclusion: boolean;
  116972. /**
  116973. * If set to true, no lighting calculations will be applied.
  116974. */
  116975. unlit: boolean;
  116976. /**
  116977. * Gets the image processing configuration used either in this material.
  116978. */
  116979. /**
  116980. * Sets the Default image processing configuration used either in the this material.
  116981. *
  116982. * If sets to null, the scene one is in use.
  116983. */
  116984. imageProcessingConfiguration: ImageProcessingConfiguration;
  116985. /**
  116986. * Gets wether the color curves effect is enabled.
  116987. */
  116988. /**
  116989. * Sets wether the color curves effect is enabled.
  116990. */
  116991. cameraColorCurvesEnabled: boolean;
  116992. /**
  116993. * Gets wether the color grading effect is enabled.
  116994. */
  116995. /**
  116996. * Gets wether the color grading effect is enabled.
  116997. */
  116998. cameraColorGradingEnabled: boolean;
  116999. /**
  117000. * Gets wether tonemapping is enabled or not.
  117001. */
  117002. /**
  117003. * Sets wether tonemapping is enabled or not
  117004. */
  117005. cameraToneMappingEnabled: boolean;
  117006. /**
  117007. * The camera exposure used on this material.
  117008. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  117009. * This corresponds to a photographic exposure.
  117010. */
  117011. /**
  117012. * The camera exposure used on this material.
  117013. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  117014. * This corresponds to a photographic exposure.
  117015. */
  117016. cameraExposure: number;
  117017. /**
  117018. * Gets The camera contrast used on this material.
  117019. */
  117020. /**
  117021. * Sets The camera contrast used on this material.
  117022. */
  117023. cameraContrast: number;
  117024. /**
  117025. * Gets the Color Grading 2D Lookup Texture.
  117026. */
  117027. /**
  117028. * Sets the Color Grading 2D Lookup Texture.
  117029. */
  117030. cameraColorGradingTexture: Nullable<BaseTexture>;
  117031. /**
  117032. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  117033. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  117034. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  117035. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  117036. */
  117037. /**
  117038. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  117039. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  117040. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  117041. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  117042. */
  117043. cameraColorCurves: Nullable<ColorCurves>;
  117044. /**
  117045. * Instantiates a new PBRMaterial instance.
  117046. *
  117047. * @param name The material name
  117048. * @param scene The scene the material will be use in.
  117049. */
  117050. constructor(name: string, scene: Scene);
  117051. /**
  117052. * Returns the name of this material class.
  117053. */
  117054. getClassName(): string;
  117055. /**
  117056. * Makes a duplicate of the current material.
  117057. * @param name - name to use for the new material.
  117058. */
  117059. clone(name: string): PBRMaterial;
  117060. /**
  117061. * Serializes this PBR Material.
  117062. * @returns - An object with the serialized material.
  117063. */
  117064. serialize(): any;
  117065. /**
  117066. * Parses a PBR Material from a serialized object.
  117067. * @param source - Serialized object.
  117068. * @param scene - BJS scene instance.
  117069. * @param rootUrl - url for the scene object
  117070. * @returns - PBRMaterial
  117071. */
  117072. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  117073. }
  117074. }
  117075. declare module BABYLON {
  117076. /**
  117077. * Direct draw surface info
  117078. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  117079. */
  117080. export interface DDSInfo {
  117081. /**
  117082. * Width of the texture
  117083. */
  117084. width: number;
  117085. /**
  117086. * Width of the texture
  117087. */
  117088. height: number;
  117089. /**
  117090. * Number of Mipmaps for the texture
  117091. * @see https://en.wikipedia.org/wiki/Mipmap
  117092. */
  117093. mipmapCount: number;
  117094. /**
  117095. * If the textures format is a known fourCC format
  117096. * @see https://www.fourcc.org/
  117097. */
  117098. isFourCC: boolean;
  117099. /**
  117100. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  117101. */
  117102. isRGB: boolean;
  117103. /**
  117104. * If the texture is a lumincance format
  117105. */
  117106. isLuminance: boolean;
  117107. /**
  117108. * If this is a cube texture
  117109. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  117110. */
  117111. isCube: boolean;
  117112. /**
  117113. * If the texture is a compressed format eg. FOURCC_DXT1
  117114. */
  117115. isCompressed: boolean;
  117116. /**
  117117. * The dxgiFormat of the texture
  117118. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  117119. */
  117120. dxgiFormat: number;
  117121. /**
  117122. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  117123. */
  117124. textureType: number;
  117125. /**
  117126. * Sphericle polynomial created for the dds texture
  117127. */
  117128. sphericalPolynomial?: SphericalPolynomial;
  117129. }
  117130. /**
  117131. * Class used to provide DDS decompression tools
  117132. */
  117133. export class DDSTools {
  117134. /**
  117135. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  117136. */
  117137. static StoreLODInAlphaChannel: boolean;
  117138. /**
  117139. * Gets DDS information from an array buffer
  117140. * @param arrayBuffer defines the array buffer to read data from
  117141. * @returns the DDS information
  117142. */
  117143. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  117144. private static _FloatView;
  117145. private static _Int32View;
  117146. private static _ToHalfFloat;
  117147. private static _FromHalfFloat;
  117148. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  117149. private static _GetHalfFloatRGBAArrayBuffer;
  117150. private static _GetFloatRGBAArrayBuffer;
  117151. private static _GetFloatAsUIntRGBAArrayBuffer;
  117152. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  117153. private static _GetRGBAArrayBuffer;
  117154. private static _ExtractLongWordOrder;
  117155. private static _GetRGBArrayBuffer;
  117156. private static _GetLuminanceArrayBuffer;
  117157. /**
  117158. * Uploads DDS Levels to a Babylon Texture
  117159. * @hidden
  117160. */
  117161. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  117162. }
  117163. interface ThinEngine {
  117164. /**
  117165. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  117166. * @param rootUrl defines the url where the file to load is located
  117167. * @param scene defines the current scene
  117168. * @param lodScale defines scale to apply to the mip map selection
  117169. * @param lodOffset defines offset to apply to the mip map selection
  117170. * @param onLoad defines an optional callback raised when the texture is loaded
  117171. * @param onError defines an optional callback raised if there is an issue to load the texture
  117172. * @param format defines the format of the data
  117173. * @param forcedExtension defines the extension to use to pick the right loader
  117174. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  117175. * @returns the cube texture as an InternalTexture
  117176. */
  117177. createPrefilteredCubeTexture(rootUrl: string, scene: Nullable<Scene>, lodScale: number, lodOffset: number, onLoad?: Nullable<(internalTexture: Nullable<InternalTexture>) => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, forcedExtension?: any, createPolynomials?: boolean): InternalTexture;
  117178. }
  117179. }
  117180. declare module BABYLON {
  117181. /**
  117182. * Implementation of the DDS Texture Loader.
  117183. * @hidden
  117184. */
  117185. export class _DDSTextureLoader implements IInternalTextureLoader {
  117186. /**
  117187. * Defines wether the loader supports cascade loading the different faces.
  117188. */
  117189. readonly supportCascades: boolean;
  117190. /**
  117191. * This returns if the loader support the current file information.
  117192. * @param extension defines the file extension of the file being loaded
  117193. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117194. * @param fallback defines the fallback internal texture if any
  117195. * @param isBase64 defines whether the texture is encoded as a base64
  117196. * @param isBuffer defines whether the texture data are stored as a buffer
  117197. * @returns true if the loader can load the specified file
  117198. */
  117199. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117200. /**
  117201. * Transform the url before loading if required.
  117202. * @param rootUrl the url of the texture
  117203. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117204. * @returns the transformed texture
  117205. */
  117206. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117207. /**
  117208. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117209. * @param rootUrl the url of the texture
  117210. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117211. * @returns the fallback texture
  117212. */
  117213. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117214. /**
  117215. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  117216. * @param data contains the texture data
  117217. * @param texture defines the BabylonJS internal texture
  117218. * @param createPolynomials will be true if polynomials have been requested
  117219. * @param onLoad defines the callback to trigger once the texture is ready
  117220. * @param onError defines the callback to trigger in case of error
  117221. */
  117222. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  117223. /**
  117224. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  117225. * @param data contains the texture data
  117226. * @param texture defines the BabylonJS internal texture
  117227. * @param callback defines the method to call once ready to upload
  117228. */
  117229. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  117230. }
  117231. }
  117232. declare module BABYLON {
  117233. /**
  117234. * Implementation of the ENV Texture Loader.
  117235. * @hidden
  117236. */
  117237. export class _ENVTextureLoader implements IInternalTextureLoader {
  117238. /**
  117239. * Defines wether the loader supports cascade loading the different faces.
  117240. */
  117241. readonly supportCascades: boolean;
  117242. /**
  117243. * This returns if the loader support the current file information.
  117244. * @param extension defines the file extension of the file being loaded
  117245. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117246. * @param fallback defines the fallback internal texture if any
  117247. * @param isBase64 defines whether the texture is encoded as a base64
  117248. * @param isBuffer defines whether the texture data are stored as a buffer
  117249. * @returns true if the loader can load the specified file
  117250. */
  117251. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117252. /**
  117253. * Transform the url before loading if required.
  117254. * @param rootUrl the url of the texture
  117255. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117256. * @returns the transformed texture
  117257. */
  117258. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117259. /**
  117260. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117261. * @param rootUrl the url of the texture
  117262. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117263. * @returns the fallback texture
  117264. */
  117265. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117266. /**
  117267. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  117268. * @param data contains the texture data
  117269. * @param texture defines the BabylonJS internal texture
  117270. * @param createPolynomials will be true if polynomials have been requested
  117271. * @param onLoad defines the callback to trigger once the texture is ready
  117272. * @param onError defines the callback to trigger in case of error
  117273. */
  117274. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  117275. /**
  117276. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  117277. * @param data contains the texture data
  117278. * @param texture defines the BabylonJS internal texture
  117279. * @param callback defines the method to call once ready to upload
  117280. */
  117281. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  117282. }
  117283. }
  117284. declare module BABYLON {
  117285. /**
  117286. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  117287. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  117288. */
  117289. export class KhronosTextureContainer {
  117290. /** contents of the KTX container file */
  117291. arrayBuffer: any;
  117292. private static HEADER_LEN;
  117293. private static COMPRESSED_2D;
  117294. private static COMPRESSED_3D;
  117295. private static TEX_2D;
  117296. private static TEX_3D;
  117297. /**
  117298. * Gets the openGL type
  117299. */
  117300. glType: number;
  117301. /**
  117302. * Gets the openGL type size
  117303. */
  117304. glTypeSize: number;
  117305. /**
  117306. * Gets the openGL format
  117307. */
  117308. glFormat: number;
  117309. /**
  117310. * Gets the openGL internal format
  117311. */
  117312. glInternalFormat: number;
  117313. /**
  117314. * Gets the base internal format
  117315. */
  117316. glBaseInternalFormat: number;
  117317. /**
  117318. * Gets image width in pixel
  117319. */
  117320. pixelWidth: number;
  117321. /**
  117322. * Gets image height in pixel
  117323. */
  117324. pixelHeight: number;
  117325. /**
  117326. * Gets image depth in pixels
  117327. */
  117328. pixelDepth: number;
  117329. /**
  117330. * Gets the number of array elements
  117331. */
  117332. numberOfArrayElements: number;
  117333. /**
  117334. * Gets the number of faces
  117335. */
  117336. numberOfFaces: number;
  117337. /**
  117338. * Gets the number of mipmap levels
  117339. */
  117340. numberOfMipmapLevels: number;
  117341. /**
  117342. * Gets the bytes of key value data
  117343. */
  117344. bytesOfKeyValueData: number;
  117345. /**
  117346. * Gets the load type
  117347. */
  117348. loadType: number;
  117349. /**
  117350. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  117351. */
  117352. isInvalid: boolean;
  117353. /**
  117354. * Creates a new KhronosTextureContainer
  117355. * @param arrayBuffer contents of the KTX container file
  117356. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  117357. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  117358. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  117359. */
  117360. constructor(
  117361. /** contents of the KTX container file */
  117362. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  117363. /**
  117364. * Uploads KTX content to a Babylon Texture.
  117365. * It is assumed that the texture has already been created & is currently bound
  117366. * @hidden
  117367. */
  117368. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  117369. private _upload2DCompressedLevels;
  117370. }
  117371. }
  117372. declare module BABYLON {
  117373. /**
  117374. * Implementation of the KTX Texture Loader.
  117375. * @hidden
  117376. */
  117377. export class _KTXTextureLoader implements IInternalTextureLoader {
  117378. /**
  117379. * Defines wether the loader supports cascade loading the different faces.
  117380. */
  117381. readonly supportCascades: boolean;
  117382. /**
  117383. * This returns if the loader support the current file information.
  117384. * @param extension defines the file extension of the file being loaded
  117385. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117386. * @param fallback defines the fallback internal texture if any
  117387. * @param isBase64 defines whether the texture is encoded as a base64
  117388. * @param isBuffer defines whether the texture data are stored as a buffer
  117389. * @returns true if the loader can load the specified file
  117390. */
  117391. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117392. /**
  117393. * Transform the url before loading if required.
  117394. * @param rootUrl the url of the texture
  117395. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117396. * @returns the transformed texture
  117397. */
  117398. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117399. /**
  117400. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117401. * @param rootUrl the url of the texture
  117402. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117403. * @returns the fallback texture
  117404. */
  117405. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117406. /**
  117407. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  117408. * @param data contains the texture data
  117409. * @param texture defines the BabylonJS internal texture
  117410. * @param createPolynomials will be true if polynomials have been requested
  117411. * @param onLoad defines the callback to trigger once the texture is ready
  117412. * @param onError defines the callback to trigger in case of error
  117413. */
  117414. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  117415. /**
  117416. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  117417. * @param data contains the texture data
  117418. * @param texture defines the BabylonJS internal texture
  117419. * @param callback defines the method to call once ready to upload
  117420. */
  117421. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  117422. }
  117423. }
  117424. declare module BABYLON {
  117425. /**
  117426. * Options for the default xr helper
  117427. */
  117428. export class WebXRDefaultExperienceOptions {
  117429. /**
  117430. * Floor meshes that should be used for teleporting
  117431. */
  117432. floorMeshes: Array<AbstractMesh>;
  117433. /**
  117434. * Enable or disable default UI to enter XR
  117435. */
  117436. disableDefaultUI: boolean;
  117437. }
  117438. /**
  117439. * Default experience which provides a similar setup to the previous webVRExperience
  117440. */
  117441. export class WebXRDefaultExperience {
  117442. /**
  117443. * Base experience
  117444. */
  117445. baseExperience: WebXRExperienceHelper;
  117446. /**
  117447. * Input experience extension
  117448. */
  117449. input: WebXRInput;
  117450. /**
  117451. * Loads the controller models
  117452. */
  117453. controllerModelLoader: WebXRControllerModelLoader;
  117454. /**
  117455. * Enables laser pointer and selection
  117456. */
  117457. pointerSelection: WebXRControllerPointerSelection;
  117458. /**
  117459. * Enables teleportation
  117460. */
  117461. teleportation: WebXRControllerTeleportation;
  117462. /**
  117463. * Enables ui for enetering/exiting xr
  117464. */
  117465. enterExitUI: WebXREnterExitUI;
  117466. /**
  117467. * Default target xr should render to
  117468. */
  117469. renderTarget: WebXRRenderTarget;
  117470. /**
  117471. * Creates the default xr experience
  117472. * @param scene scene
  117473. * @param options options for basic configuration
  117474. * @returns resulting WebXRDefaultExperience
  117475. */
  117476. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  117477. private constructor();
  117478. /**
  117479. * DIsposes of the experience helper
  117480. */
  117481. dispose(): void;
  117482. }
  117483. }
  117484. declare module BABYLON {
  117485. /** @hidden */
  117486. export var _forceSceneHelpersToBundle: boolean;
  117487. interface Scene {
  117488. /**
  117489. * Creates a default light for the scene.
  117490. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  117491. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  117492. */
  117493. createDefaultLight(replace?: boolean): void;
  117494. /**
  117495. * Creates a default camera for the scene.
  117496. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  117497. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  117498. * @param replace has default false, when true replaces the active camera in the scene
  117499. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  117500. */
  117501. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  117502. /**
  117503. * Creates a default camera and a default light.
  117504. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  117505. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  117506. * @param replace has the default false, when true replaces the active camera/light in the scene
  117507. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  117508. */
  117509. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  117510. /**
  117511. * Creates a new sky box
  117512. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  117513. * @param environmentTexture defines the texture to use as environment texture
  117514. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  117515. * @param scale defines the overall scale of the skybox
  117516. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  117517. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  117518. * @returns a new mesh holding the sky box
  117519. */
  117520. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  117521. /**
  117522. * Creates a new environment
  117523. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  117524. * @param options defines the options you can use to configure the environment
  117525. * @returns the new EnvironmentHelper
  117526. */
  117527. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  117528. /**
  117529. * Creates a new VREXperienceHelper
  117530. * @see http://doc.babylonjs.com/how_to/webvr_helper
  117531. * @param webVROptions defines the options used to create the new VREXperienceHelper
  117532. * @returns a new VREXperienceHelper
  117533. */
  117534. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  117535. /**
  117536. * Creates a new WebXRDefaultExperience
  117537. * @see http://doc.babylonjs.com/how_to/webxr
  117538. * @param options experience options
  117539. * @returns a promise for a new WebXRDefaultExperience
  117540. */
  117541. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  117542. }
  117543. }
  117544. declare module BABYLON {
  117545. /**
  117546. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  117547. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  117548. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  117549. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  117550. */
  117551. export class VideoDome extends TransformNode {
  117552. /**
  117553. * Define the video source as a Monoscopic panoramic 360 video.
  117554. */
  117555. static readonly MODE_MONOSCOPIC: number;
  117556. /**
  117557. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  117558. */
  117559. static readonly MODE_TOPBOTTOM: number;
  117560. /**
  117561. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  117562. */
  117563. static readonly MODE_SIDEBYSIDE: number;
  117564. private _halfDome;
  117565. private _useDirectMapping;
  117566. /**
  117567. * The video texture being displayed on the sphere
  117568. */
  117569. protected _videoTexture: VideoTexture;
  117570. /**
  117571. * Gets the video texture being displayed on the sphere
  117572. */
  117573. readonly videoTexture: VideoTexture;
  117574. /**
  117575. * The skybox material
  117576. */
  117577. protected _material: BackgroundMaterial;
  117578. /**
  117579. * The surface used for the skybox
  117580. */
  117581. protected _mesh: Mesh;
  117582. /**
  117583. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  117584. */
  117585. private _halfDomeMask;
  117586. /**
  117587. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  117588. * Also see the options.resolution property.
  117589. */
  117590. fovMultiplier: number;
  117591. private _videoMode;
  117592. /**
  117593. * Gets or set the current video mode for the video. It can be:
  117594. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  117595. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  117596. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  117597. */
  117598. videoMode: number;
  117599. /**
  117600. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  117601. *
  117602. */
  117603. /**
  117604. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  117605. */
  117606. halfDome: boolean;
  117607. /**
  117608. * Oberserver used in Stereoscopic VR Mode.
  117609. */
  117610. private _onBeforeCameraRenderObserver;
  117611. /**
  117612. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  117613. * @param name Element's name, child elements will append suffixes for their own names.
  117614. * @param urlsOrVideo defines the url(s) or the video element to use
  117615. * @param options An object containing optional or exposed sub element properties
  117616. */
  117617. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  117618. resolution?: number;
  117619. clickToPlay?: boolean;
  117620. autoPlay?: boolean;
  117621. loop?: boolean;
  117622. size?: number;
  117623. poster?: string;
  117624. faceForward?: boolean;
  117625. useDirectMapping?: boolean;
  117626. halfDomeMode?: boolean;
  117627. }, scene: Scene);
  117628. private _changeVideoMode;
  117629. /**
  117630. * Releases resources associated with this node.
  117631. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  117632. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  117633. */
  117634. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  117635. }
  117636. }
  117637. declare module BABYLON {
  117638. /**
  117639. * This class can be used to get instrumentation data from a Babylon engine
  117640. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117641. */
  117642. export class EngineInstrumentation implements IDisposable {
  117643. /**
  117644. * Define the instrumented engine.
  117645. */
  117646. engine: Engine;
  117647. private _captureGPUFrameTime;
  117648. private _gpuFrameTimeToken;
  117649. private _gpuFrameTime;
  117650. private _captureShaderCompilationTime;
  117651. private _shaderCompilationTime;
  117652. private _onBeginFrameObserver;
  117653. private _onEndFrameObserver;
  117654. private _onBeforeShaderCompilationObserver;
  117655. private _onAfterShaderCompilationObserver;
  117656. /**
  117657. * Gets the perf counter used for GPU frame time
  117658. */
  117659. readonly gpuFrameTimeCounter: PerfCounter;
  117660. /**
  117661. * Gets the GPU frame time capture status
  117662. */
  117663. /**
  117664. * Enable or disable the GPU frame time capture
  117665. */
  117666. captureGPUFrameTime: boolean;
  117667. /**
  117668. * Gets the perf counter used for shader compilation time
  117669. */
  117670. readonly shaderCompilationTimeCounter: PerfCounter;
  117671. /**
  117672. * Gets the shader compilation time capture status
  117673. */
  117674. /**
  117675. * Enable or disable the shader compilation time capture
  117676. */
  117677. captureShaderCompilationTime: boolean;
  117678. /**
  117679. * Instantiates a new engine instrumentation.
  117680. * This class can be used to get instrumentation data from a Babylon engine
  117681. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117682. * @param engine Defines the engine to instrument
  117683. */
  117684. constructor(
  117685. /**
  117686. * Define the instrumented engine.
  117687. */
  117688. engine: Engine);
  117689. /**
  117690. * Dispose and release associated resources.
  117691. */
  117692. dispose(): void;
  117693. }
  117694. }
  117695. declare module BABYLON {
  117696. /**
  117697. * This class can be used to get instrumentation data from a Babylon engine
  117698. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  117699. */
  117700. export class SceneInstrumentation implements IDisposable {
  117701. /**
  117702. * Defines the scene to instrument
  117703. */
  117704. scene: Scene;
  117705. private _captureActiveMeshesEvaluationTime;
  117706. private _activeMeshesEvaluationTime;
  117707. private _captureRenderTargetsRenderTime;
  117708. private _renderTargetsRenderTime;
  117709. private _captureFrameTime;
  117710. private _frameTime;
  117711. private _captureRenderTime;
  117712. private _renderTime;
  117713. private _captureInterFrameTime;
  117714. private _interFrameTime;
  117715. private _captureParticlesRenderTime;
  117716. private _particlesRenderTime;
  117717. private _captureSpritesRenderTime;
  117718. private _spritesRenderTime;
  117719. private _capturePhysicsTime;
  117720. private _physicsTime;
  117721. private _captureAnimationsTime;
  117722. private _animationsTime;
  117723. private _captureCameraRenderTime;
  117724. private _cameraRenderTime;
  117725. private _onBeforeActiveMeshesEvaluationObserver;
  117726. private _onAfterActiveMeshesEvaluationObserver;
  117727. private _onBeforeRenderTargetsRenderObserver;
  117728. private _onAfterRenderTargetsRenderObserver;
  117729. private _onAfterRenderObserver;
  117730. private _onBeforeDrawPhaseObserver;
  117731. private _onAfterDrawPhaseObserver;
  117732. private _onBeforeAnimationsObserver;
  117733. private _onBeforeParticlesRenderingObserver;
  117734. private _onAfterParticlesRenderingObserver;
  117735. private _onBeforeSpritesRenderingObserver;
  117736. private _onAfterSpritesRenderingObserver;
  117737. private _onBeforePhysicsObserver;
  117738. private _onAfterPhysicsObserver;
  117739. private _onAfterAnimationsObserver;
  117740. private _onBeforeCameraRenderObserver;
  117741. private _onAfterCameraRenderObserver;
  117742. /**
  117743. * Gets the perf counter used for active meshes evaluation time
  117744. */
  117745. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  117746. /**
  117747. * Gets the active meshes evaluation time capture status
  117748. */
  117749. /**
  117750. * Enable or disable the active meshes evaluation time capture
  117751. */
  117752. captureActiveMeshesEvaluationTime: boolean;
  117753. /**
  117754. * Gets the perf counter used for render targets render time
  117755. */
  117756. readonly renderTargetsRenderTimeCounter: PerfCounter;
  117757. /**
  117758. * Gets the render targets render time capture status
  117759. */
  117760. /**
  117761. * Enable or disable the render targets render time capture
  117762. */
  117763. captureRenderTargetsRenderTime: boolean;
  117764. /**
  117765. * Gets the perf counter used for particles render time
  117766. */
  117767. readonly particlesRenderTimeCounter: PerfCounter;
  117768. /**
  117769. * Gets the particles render time capture status
  117770. */
  117771. /**
  117772. * Enable or disable the particles render time capture
  117773. */
  117774. captureParticlesRenderTime: boolean;
  117775. /**
  117776. * Gets the perf counter used for sprites render time
  117777. */
  117778. readonly spritesRenderTimeCounter: PerfCounter;
  117779. /**
  117780. * Gets the sprites render time capture status
  117781. */
  117782. /**
  117783. * Enable or disable the sprites render time capture
  117784. */
  117785. captureSpritesRenderTime: boolean;
  117786. /**
  117787. * Gets the perf counter used for physics time
  117788. */
  117789. readonly physicsTimeCounter: PerfCounter;
  117790. /**
  117791. * Gets the physics time capture status
  117792. */
  117793. /**
  117794. * Enable or disable the physics time capture
  117795. */
  117796. capturePhysicsTime: boolean;
  117797. /**
  117798. * Gets the perf counter used for animations time
  117799. */
  117800. readonly animationsTimeCounter: PerfCounter;
  117801. /**
  117802. * Gets the animations time capture status
  117803. */
  117804. /**
  117805. * Enable or disable the animations time capture
  117806. */
  117807. captureAnimationsTime: boolean;
  117808. /**
  117809. * Gets the perf counter used for frame time capture
  117810. */
  117811. readonly frameTimeCounter: PerfCounter;
  117812. /**
  117813. * Gets the frame time capture status
  117814. */
  117815. /**
  117816. * Enable or disable the frame time capture
  117817. */
  117818. captureFrameTime: boolean;
  117819. /**
  117820. * Gets the perf counter used for inter-frames time capture
  117821. */
  117822. readonly interFrameTimeCounter: PerfCounter;
  117823. /**
  117824. * Gets the inter-frames time capture status
  117825. */
  117826. /**
  117827. * Enable or disable the inter-frames time capture
  117828. */
  117829. captureInterFrameTime: boolean;
  117830. /**
  117831. * Gets the perf counter used for render time capture
  117832. */
  117833. readonly renderTimeCounter: PerfCounter;
  117834. /**
  117835. * Gets the render time capture status
  117836. */
  117837. /**
  117838. * Enable or disable the render time capture
  117839. */
  117840. captureRenderTime: boolean;
  117841. /**
  117842. * Gets the perf counter used for camera render time capture
  117843. */
  117844. readonly cameraRenderTimeCounter: PerfCounter;
  117845. /**
  117846. * Gets the camera render time capture status
  117847. */
  117848. /**
  117849. * Enable or disable the camera render time capture
  117850. */
  117851. captureCameraRenderTime: boolean;
  117852. /**
  117853. * Gets the perf counter used for draw calls
  117854. */
  117855. readonly drawCallsCounter: PerfCounter;
  117856. /**
  117857. * Instantiates a new scene instrumentation.
  117858. * This class can be used to get instrumentation data from a Babylon engine
  117859. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  117860. * @param scene Defines the scene to instrument
  117861. */
  117862. constructor(
  117863. /**
  117864. * Defines the scene to instrument
  117865. */
  117866. scene: Scene);
  117867. /**
  117868. * Dispose and release associated resources.
  117869. */
  117870. dispose(): void;
  117871. }
  117872. }
  117873. declare module BABYLON {
  117874. /** @hidden */
  117875. export var glowMapGenerationPixelShader: {
  117876. name: string;
  117877. shader: string;
  117878. };
  117879. }
  117880. declare module BABYLON {
  117881. /** @hidden */
  117882. export var glowMapGenerationVertexShader: {
  117883. name: string;
  117884. shader: string;
  117885. };
  117886. }
  117887. declare module BABYLON {
  117888. /**
  117889. * Effect layer options. This helps customizing the behaviour
  117890. * of the effect layer.
  117891. */
  117892. export interface IEffectLayerOptions {
  117893. /**
  117894. * Multiplication factor apply to the canvas size to compute the render target size
  117895. * used to generated the objects (the smaller the faster).
  117896. */
  117897. mainTextureRatio: number;
  117898. /**
  117899. * Enforces a fixed size texture to ensure effect stability across devices.
  117900. */
  117901. mainTextureFixedSize?: number;
  117902. /**
  117903. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  117904. */
  117905. alphaBlendingMode: number;
  117906. /**
  117907. * The camera attached to the layer.
  117908. */
  117909. camera: Nullable<Camera>;
  117910. /**
  117911. * The rendering group to draw the layer in.
  117912. */
  117913. renderingGroupId: number;
  117914. }
  117915. /**
  117916. * The effect layer Helps adding post process effect blended with the main pass.
  117917. *
  117918. * This can be for instance use to generate glow or higlight effects on the scene.
  117919. *
  117920. * The effect layer class can not be used directly and is intented to inherited from to be
  117921. * customized per effects.
  117922. */
  117923. export abstract class EffectLayer {
  117924. private _vertexBuffers;
  117925. private _indexBuffer;
  117926. private _cachedDefines;
  117927. private _effectLayerMapGenerationEffect;
  117928. private _effectLayerOptions;
  117929. private _mergeEffect;
  117930. protected _scene: Scene;
  117931. protected _engine: Engine;
  117932. protected _maxSize: number;
  117933. protected _mainTextureDesiredSize: ISize;
  117934. protected _mainTexture: RenderTargetTexture;
  117935. protected _shouldRender: boolean;
  117936. protected _postProcesses: PostProcess[];
  117937. protected _textures: BaseTexture[];
  117938. protected _emissiveTextureAndColor: {
  117939. texture: Nullable<BaseTexture>;
  117940. color: Color4;
  117941. };
  117942. /**
  117943. * The name of the layer
  117944. */
  117945. name: string;
  117946. /**
  117947. * The clear color of the texture used to generate the glow map.
  117948. */
  117949. neutralColor: Color4;
  117950. /**
  117951. * Specifies wether the highlight layer is enabled or not.
  117952. */
  117953. isEnabled: boolean;
  117954. /**
  117955. * Gets the camera attached to the layer.
  117956. */
  117957. readonly camera: Nullable<Camera>;
  117958. /**
  117959. * Gets the rendering group id the layer should render in.
  117960. */
  117961. renderingGroupId: number;
  117962. /**
  117963. * An event triggered when the effect layer has been disposed.
  117964. */
  117965. onDisposeObservable: Observable<EffectLayer>;
  117966. /**
  117967. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  117968. */
  117969. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  117970. /**
  117971. * An event triggered when the generated texture is being merged in the scene.
  117972. */
  117973. onBeforeComposeObservable: Observable<EffectLayer>;
  117974. /**
  117975. * An event triggered when the mesh is rendered into the effect render target.
  117976. */
  117977. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  117978. /**
  117979. * An event triggered after the mesh has been rendered into the effect render target.
  117980. */
  117981. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  117982. /**
  117983. * An event triggered when the generated texture has been merged in the scene.
  117984. */
  117985. onAfterComposeObservable: Observable<EffectLayer>;
  117986. /**
  117987. * An event triggered when the efffect layer changes its size.
  117988. */
  117989. onSizeChangedObservable: Observable<EffectLayer>;
  117990. /** @hidden */
  117991. static _SceneComponentInitialization: (scene: Scene) => void;
  117992. /**
  117993. * Instantiates a new effect Layer and references it in the scene.
  117994. * @param name The name of the layer
  117995. * @param scene The scene to use the layer in
  117996. */
  117997. constructor(
  117998. /** The Friendly of the effect in the scene */
  117999. name: string, scene: Scene);
  118000. /**
  118001. * Get the effect name of the layer.
  118002. * @return The effect name
  118003. */
  118004. abstract getEffectName(): string;
  118005. /**
  118006. * Checks for the readiness of the element composing the layer.
  118007. * @param subMesh the mesh to check for
  118008. * @param useInstances specify wether or not to use instances to render the mesh
  118009. * @return true if ready otherwise, false
  118010. */
  118011. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  118012. /**
  118013. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  118014. * @returns true if the effect requires stencil during the main canvas render pass.
  118015. */
  118016. abstract needStencil(): boolean;
  118017. /**
  118018. * Create the merge effect. This is the shader use to blit the information back
  118019. * to the main canvas at the end of the scene rendering.
  118020. * @returns The effect containing the shader used to merge the effect on the main canvas
  118021. */
  118022. protected abstract _createMergeEffect(): Effect;
  118023. /**
  118024. * Creates the render target textures and post processes used in the effect layer.
  118025. */
  118026. protected abstract _createTextureAndPostProcesses(): void;
  118027. /**
  118028. * Implementation specific of rendering the generating effect on the main canvas.
  118029. * @param effect The effect used to render through
  118030. */
  118031. protected abstract _internalRender(effect: Effect): void;
  118032. /**
  118033. * Sets the required values for both the emissive texture and and the main color.
  118034. */
  118035. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  118036. /**
  118037. * Free any resources and references associated to a mesh.
  118038. * Internal use
  118039. * @param mesh The mesh to free.
  118040. */
  118041. abstract _disposeMesh(mesh: Mesh): void;
  118042. /**
  118043. * Serializes this layer (Glow or Highlight for example)
  118044. * @returns a serialized layer object
  118045. */
  118046. abstract serialize?(): any;
  118047. /**
  118048. * Initializes the effect layer with the required options.
  118049. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  118050. */
  118051. protected _init(options: Partial<IEffectLayerOptions>): void;
  118052. /**
  118053. * Generates the index buffer of the full screen quad blending to the main canvas.
  118054. */
  118055. private _generateIndexBuffer;
  118056. /**
  118057. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  118058. */
  118059. private _generateVertexBuffer;
  118060. /**
  118061. * Sets the main texture desired size which is the closest power of two
  118062. * of the engine canvas size.
  118063. */
  118064. private _setMainTextureSize;
  118065. /**
  118066. * Creates the main texture for the effect layer.
  118067. */
  118068. protected _createMainTexture(): void;
  118069. /**
  118070. * Adds specific effects defines.
  118071. * @param defines The defines to add specifics to.
  118072. */
  118073. protected _addCustomEffectDefines(defines: string[]): void;
  118074. /**
  118075. * Checks for the readiness of the element composing the layer.
  118076. * @param subMesh the mesh to check for
  118077. * @param useInstances specify wether or not to use instances to render the mesh
  118078. * @param emissiveTexture the associated emissive texture used to generate the glow
  118079. * @return true if ready otherwise, false
  118080. */
  118081. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  118082. /**
  118083. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  118084. */
  118085. render(): void;
  118086. /**
  118087. * Determine if a given mesh will be used in the current effect.
  118088. * @param mesh mesh to test
  118089. * @returns true if the mesh will be used
  118090. */
  118091. hasMesh(mesh: AbstractMesh): boolean;
  118092. /**
  118093. * Returns true if the layer contains information to display, otherwise false.
  118094. * @returns true if the glow layer should be rendered
  118095. */
  118096. shouldRender(): boolean;
  118097. /**
  118098. * Returns true if the mesh should render, otherwise false.
  118099. * @param mesh The mesh to render
  118100. * @returns true if it should render otherwise false
  118101. */
  118102. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  118103. /**
  118104. * Returns true if the mesh can be rendered, otherwise false.
  118105. * @param mesh The mesh to render
  118106. * @param material The material used on the mesh
  118107. * @returns true if it can be rendered otherwise false
  118108. */
  118109. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  118110. /**
  118111. * Returns true if the mesh should render, otherwise false.
  118112. * @param mesh The mesh to render
  118113. * @returns true if it should render otherwise false
  118114. */
  118115. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  118116. /**
  118117. * Renders the submesh passed in parameter to the generation map.
  118118. */
  118119. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  118120. /**
  118121. * Defines wether the current material of the mesh should be use to render the effect.
  118122. * @param mesh defines the current mesh to render
  118123. */
  118124. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  118125. /**
  118126. * Rebuild the required buffers.
  118127. * @hidden Internal use only.
  118128. */
  118129. _rebuild(): void;
  118130. /**
  118131. * Dispose only the render target textures and post process.
  118132. */
  118133. private _disposeTextureAndPostProcesses;
  118134. /**
  118135. * Dispose the highlight layer and free resources.
  118136. */
  118137. dispose(): void;
  118138. /**
  118139. * Gets the class name of the effect layer
  118140. * @returns the string with the class name of the effect layer
  118141. */
  118142. getClassName(): string;
  118143. /**
  118144. * Creates an effect layer from parsed effect layer data
  118145. * @param parsedEffectLayer defines effect layer data
  118146. * @param scene defines the current scene
  118147. * @param rootUrl defines the root URL containing the effect layer information
  118148. * @returns a parsed effect Layer
  118149. */
  118150. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  118151. }
  118152. }
  118153. declare module BABYLON {
  118154. interface AbstractScene {
  118155. /**
  118156. * The list of effect layers (highlights/glow) added to the scene
  118157. * @see http://doc.babylonjs.com/how_to/highlight_layer
  118158. * @see http://doc.babylonjs.com/how_to/glow_layer
  118159. */
  118160. effectLayers: Array<EffectLayer>;
  118161. /**
  118162. * Removes the given effect layer from this scene.
  118163. * @param toRemove defines the effect layer to remove
  118164. * @returns the index of the removed effect layer
  118165. */
  118166. removeEffectLayer(toRemove: EffectLayer): number;
  118167. /**
  118168. * Adds the given effect layer to this scene
  118169. * @param newEffectLayer defines the effect layer to add
  118170. */
  118171. addEffectLayer(newEffectLayer: EffectLayer): void;
  118172. }
  118173. /**
  118174. * Defines the layer scene component responsible to manage any effect layers
  118175. * in a given scene.
  118176. */
  118177. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  118178. /**
  118179. * The component name helpfull to identify the component in the list of scene components.
  118180. */
  118181. readonly name: string;
  118182. /**
  118183. * The scene the component belongs to.
  118184. */
  118185. scene: Scene;
  118186. private _engine;
  118187. private _renderEffects;
  118188. private _needStencil;
  118189. private _previousStencilState;
  118190. /**
  118191. * Creates a new instance of the component for the given scene
  118192. * @param scene Defines the scene to register the component in
  118193. */
  118194. constructor(scene: Scene);
  118195. /**
  118196. * Registers the component in a given scene
  118197. */
  118198. register(): void;
  118199. /**
  118200. * Rebuilds the elements related to this component in case of
  118201. * context lost for instance.
  118202. */
  118203. rebuild(): void;
  118204. /**
  118205. * Serializes the component data to the specified json object
  118206. * @param serializationObject The object to serialize to
  118207. */
  118208. serialize(serializationObject: any): void;
  118209. /**
  118210. * Adds all the elements from the container to the scene
  118211. * @param container the container holding the elements
  118212. */
  118213. addFromContainer(container: AbstractScene): void;
  118214. /**
  118215. * Removes all the elements in the container from the scene
  118216. * @param container contains the elements to remove
  118217. * @param dispose if the removed element should be disposed (default: false)
  118218. */
  118219. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118220. /**
  118221. * Disposes the component and the associated ressources.
  118222. */
  118223. dispose(): void;
  118224. private _isReadyForMesh;
  118225. private _renderMainTexture;
  118226. private _setStencil;
  118227. private _setStencilBack;
  118228. private _draw;
  118229. private _drawCamera;
  118230. private _drawRenderingGroup;
  118231. }
  118232. }
  118233. declare module BABYLON {
  118234. /** @hidden */
  118235. export var glowMapMergePixelShader: {
  118236. name: string;
  118237. shader: string;
  118238. };
  118239. }
  118240. declare module BABYLON {
  118241. /** @hidden */
  118242. export var glowMapMergeVertexShader: {
  118243. name: string;
  118244. shader: string;
  118245. };
  118246. }
  118247. declare module BABYLON {
  118248. interface AbstractScene {
  118249. /**
  118250. * Return a the first highlight layer of the scene with a given name.
  118251. * @param name The name of the highlight layer to look for.
  118252. * @return The highlight layer if found otherwise null.
  118253. */
  118254. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  118255. }
  118256. /**
  118257. * Glow layer options. This helps customizing the behaviour
  118258. * of the glow layer.
  118259. */
  118260. export interface IGlowLayerOptions {
  118261. /**
  118262. * Multiplication factor apply to the canvas size to compute the render target size
  118263. * used to generated the glowing objects (the smaller the faster).
  118264. */
  118265. mainTextureRatio: number;
  118266. /**
  118267. * Enforces a fixed size texture to ensure resize independant blur.
  118268. */
  118269. mainTextureFixedSize?: number;
  118270. /**
  118271. * How big is the kernel of the blur texture.
  118272. */
  118273. blurKernelSize: number;
  118274. /**
  118275. * The camera attached to the layer.
  118276. */
  118277. camera: Nullable<Camera>;
  118278. /**
  118279. * Enable MSAA by chosing the number of samples.
  118280. */
  118281. mainTextureSamples?: number;
  118282. /**
  118283. * The rendering group to draw the layer in.
  118284. */
  118285. renderingGroupId: number;
  118286. }
  118287. /**
  118288. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  118289. *
  118290. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  118291. *
  118292. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  118293. */
  118294. export class GlowLayer extends EffectLayer {
  118295. /**
  118296. * Effect Name of the layer.
  118297. */
  118298. static readonly EffectName: string;
  118299. /**
  118300. * The default blur kernel size used for the glow.
  118301. */
  118302. static DefaultBlurKernelSize: number;
  118303. /**
  118304. * The default texture size ratio used for the glow.
  118305. */
  118306. static DefaultTextureRatio: number;
  118307. /**
  118308. * Sets the kernel size of the blur.
  118309. */
  118310. /**
  118311. * Gets the kernel size of the blur.
  118312. */
  118313. blurKernelSize: number;
  118314. /**
  118315. * Sets the glow intensity.
  118316. */
  118317. /**
  118318. * Gets the glow intensity.
  118319. */
  118320. intensity: number;
  118321. private _options;
  118322. private _intensity;
  118323. private _horizontalBlurPostprocess1;
  118324. private _verticalBlurPostprocess1;
  118325. private _horizontalBlurPostprocess2;
  118326. private _verticalBlurPostprocess2;
  118327. private _blurTexture1;
  118328. private _blurTexture2;
  118329. private _postProcesses1;
  118330. private _postProcesses2;
  118331. private _includedOnlyMeshes;
  118332. private _excludedMeshes;
  118333. private _meshesUsingTheirOwnMaterials;
  118334. /**
  118335. * Callback used to let the user override the color selection on a per mesh basis
  118336. */
  118337. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  118338. /**
  118339. * Callback used to let the user override the texture selection on a per mesh basis
  118340. */
  118341. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  118342. /**
  118343. * Instantiates a new glow Layer and references it to the scene.
  118344. * @param name The name of the layer
  118345. * @param scene The scene to use the layer in
  118346. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  118347. */
  118348. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  118349. /**
  118350. * Get the effect name of the layer.
  118351. * @return The effect name
  118352. */
  118353. getEffectName(): string;
  118354. /**
  118355. * Create the merge effect. This is the shader use to blit the information back
  118356. * to the main canvas at the end of the scene rendering.
  118357. */
  118358. protected _createMergeEffect(): Effect;
  118359. /**
  118360. * Creates the render target textures and post processes used in the glow layer.
  118361. */
  118362. protected _createTextureAndPostProcesses(): void;
  118363. /**
  118364. * Checks for the readiness of the element composing the layer.
  118365. * @param subMesh the mesh to check for
  118366. * @param useInstances specify wether or not to use instances to render the mesh
  118367. * @param emissiveTexture the associated emissive texture used to generate the glow
  118368. * @return true if ready otherwise, false
  118369. */
  118370. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  118371. /**
  118372. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  118373. */
  118374. needStencil(): boolean;
  118375. /**
  118376. * Returns true if the mesh can be rendered, otherwise false.
  118377. * @param mesh The mesh to render
  118378. * @param material The material used on the mesh
  118379. * @returns true if it can be rendered otherwise false
  118380. */
  118381. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  118382. /**
  118383. * Implementation specific of rendering the generating effect on the main canvas.
  118384. * @param effect The effect used to render through
  118385. */
  118386. protected _internalRender(effect: Effect): void;
  118387. /**
  118388. * Sets the required values for both the emissive texture and and the main color.
  118389. */
  118390. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  118391. /**
  118392. * Returns true if the mesh should render, otherwise false.
  118393. * @param mesh The mesh to render
  118394. * @returns true if it should render otherwise false
  118395. */
  118396. protected _shouldRenderMesh(mesh: Mesh): boolean;
  118397. /**
  118398. * Adds specific effects defines.
  118399. * @param defines The defines to add specifics to.
  118400. */
  118401. protected _addCustomEffectDefines(defines: string[]): void;
  118402. /**
  118403. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  118404. * @param mesh The mesh to exclude from the glow layer
  118405. */
  118406. addExcludedMesh(mesh: Mesh): void;
  118407. /**
  118408. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  118409. * @param mesh The mesh to remove
  118410. */
  118411. removeExcludedMesh(mesh: Mesh): void;
  118412. /**
  118413. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  118414. * @param mesh The mesh to include in the glow layer
  118415. */
  118416. addIncludedOnlyMesh(mesh: Mesh): void;
  118417. /**
  118418. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  118419. * @param mesh The mesh to remove
  118420. */
  118421. removeIncludedOnlyMesh(mesh: Mesh): void;
  118422. /**
  118423. * Determine if a given mesh will be used in the glow layer
  118424. * @param mesh The mesh to test
  118425. * @returns true if the mesh will be highlighted by the current glow layer
  118426. */
  118427. hasMesh(mesh: AbstractMesh): boolean;
  118428. /**
  118429. * Defines wether the current material of the mesh should be use to render the effect.
  118430. * @param mesh defines the current mesh to render
  118431. */
  118432. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  118433. /**
  118434. * Add a mesh to be rendered through its own material and not with emissive only.
  118435. * @param mesh The mesh for which we need to use its material
  118436. */
  118437. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  118438. /**
  118439. * Remove a mesh from being rendered through its own material and not with emissive only.
  118440. * @param mesh The mesh for which we need to not use its material
  118441. */
  118442. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  118443. /**
  118444. * Free any resources and references associated to a mesh.
  118445. * Internal use
  118446. * @param mesh The mesh to free.
  118447. * @hidden
  118448. */
  118449. _disposeMesh(mesh: Mesh): void;
  118450. /**
  118451. * Gets the class name of the effect layer
  118452. * @returns the string with the class name of the effect layer
  118453. */
  118454. getClassName(): string;
  118455. /**
  118456. * Serializes this glow layer
  118457. * @returns a serialized glow layer object
  118458. */
  118459. serialize(): any;
  118460. /**
  118461. * Creates a Glow Layer from parsed glow layer data
  118462. * @param parsedGlowLayer defines glow layer data
  118463. * @param scene defines the current scene
  118464. * @param rootUrl defines the root URL containing the glow layer information
  118465. * @returns a parsed Glow Layer
  118466. */
  118467. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  118468. }
  118469. }
  118470. declare module BABYLON {
  118471. /** @hidden */
  118472. export var glowBlurPostProcessPixelShader: {
  118473. name: string;
  118474. shader: string;
  118475. };
  118476. }
  118477. declare module BABYLON {
  118478. interface AbstractScene {
  118479. /**
  118480. * Return a the first highlight layer of the scene with a given name.
  118481. * @param name The name of the highlight layer to look for.
  118482. * @return The highlight layer if found otherwise null.
  118483. */
  118484. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  118485. }
  118486. /**
  118487. * Highlight layer options. This helps customizing the behaviour
  118488. * of the highlight layer.
  118489. */
  118490. export interface IHighlightLayerOptions {
  118491. /**
  118492. * Multiplication factor apply to the canvas size to compute the render target size
  118493. * used to generated the glowing objects (the smaller the faster).
  118494. */
  118495. mainTextureRatio: number;
  118496. /**
  118497. * Enforces a fixed size texture to ensure resize independant blur.
  118498. */
  118499. mainTextureFixedSize?: number;
  118500. /**
  118501. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  118502. * of the picture to blur (the smaller the faster).
  118503. */
  118504. blurTextureSizeRatio: number;
  118505. /**
  118506. * How big in texel of the blur texture is the vertical blur.
  118507. */
  118508. blurVerticalSize: number;
  118509. /**
  118510. * How big in texel of the blur texture is the horizontal blur.
  118511. */
  118512. blurHorizontalSize: number;
  118513. /**
  118514. * Alpha blending mode used to apply the blur. Default is combine.
  118515. */
  118516. alphaBlendingMode: number;
  118517. /**
  118518. * The camera attached to the layer.
  118519. */
  118520. camera: Nullable<Camera>;
  118521. /**
  118522. * Should we display highlight as a solid stroke?
  118523. */
  118524. isStroke?: boolean;
  118525. /**
  118526. * The rendering group to draw the layer in.
  118527. */
  118528. renderingGroupId: number;
  118529. }
  118530. /**
  118531. * The highlight layer Helps adding a glow effect around a mesh.
  118532. *
  118533. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  118534. * glowy meshes to your scene.
  118535. *
  118536. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  118537. */
  118538. export class HighlightLayer extends EffectLayer {
  118539. name: string;
  118540. /**
  118541. * Effect Name of the highlight layer.
  118542. */
  118543. static readonly EffectName: string;
  118544. /**
  118545. * The neutral color used during the preparation of the glow effect.
  118546. * This is black by default as the blend operation is a blend operation.
  118547. */
  118548. static NeutralColor: Color4;
  118549. /**
  118550. * Stencil value used for glowing meshes.
  118551. */
  118552. static GlowingMeshStencilReference: number;
  118553. /**
  118554. * Stencil value used for the other meshes in the scene.
  118555. */
  118556. static NormalMeshStencilReference: number;
  118557. /**
  118558. * Specifies whether or not the inner glow is ACTIVE in the layer.
  118559. */
  118560. innerGlow: boolean;
  118561. /**
  118562. * Specifies whether or not the outer glow is ACTIVE in the layer.
  118563. */
  118564. outerGlow: boolean;
  118565. /**
  118566. * Specifies the horizontal size of the blur.
  118567. */
  118568. /**
  118569. * Gets the horizontal size of the blur.
  118570. */
  118571. blurHorizontalSize: number;
  118572. /**
  118573. * Specifies the vertical size of the blur.
  118574. */
  118575. /**
  118576. * Gets the vertical size of the blur.
  118577. */
  118578. blurVerticalSize: number;
  118579. /**
  118580. * An event triggered when the highlight layer is being blurred.
  118581. */
  118582. onBeforeBlurObservable: Observable<HighlightLayer>;
  118583. /**
  118584. * An event triggered when the highlight layer has been blurred.
  118585. */
  118586. onAfterBlurObservable: Observable<HighlightLayer>;
  118587. private _instanceGlowingMeshStencilReference;
  118588. private _options;
  118589. private _downSamplePostprocess;
  118590. private _horizontalBlurPostprocess;
  118591. private _verticalBlurPostprocess;
  118592. private _blurTexture;
  118593. private _meshes;
  118594. private _excludedMeshes;
  118595. /**
  118596. * Instantiates a new highlight Layer and references it to the scene..
  118597. * @param name The name of the layer
  118598. * @param scene The scene to use the layer in
  118599. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  118600. */
  118601. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  118602. /**
  118603. * Get the effect name of the layer.
  118604. * @return The effect name
  118605. */
  118606. getEffectName(): string;
  118607. /**
  118608. * Create the merge effect. This is the shader use to blit the information back
  118609. * to the main canvas at the end of the scene rendering.
  118610. */
  118611. protected _createMergeEffect(): Effect;
  118612. /**
  118613. * Creates the render target textures and post processes used in the highlight layer.
  118614. */
  118615. protected _createTextureAndPostProcesses(): void;
  118616. /**
  118617. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  118618. */
  118619. needStencil(): boolean;
  118620. /**
  118621. * Checks for the readiness of the element composing the layer.
  118622. * @param subMesh the mesh to check for
  118623. * @param useInstances specify wether or not to use instances to render the mesh
  118624. * @param emissiveTexture the associated emissive texture used to generate the glow
  118625. * @return true if ready otherwise, false
  118626. */
  118627. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  118628. /**
  118629. * Implementation specific of rendering the generating effect on the main canvas.
  118630. * @param effect The effect used to render through
  118631. */
  118632. protected _internalRender(effect: Effect): void;
  118633. /**
  118634. * Returns true if the layer contains information to display, otherwise false.
  118635. */
  118636. shouldRender(): boolean;
  118637. /**
  118638. * Returns true if the mesh should render, otherwise false.
  118639. * @param mesh The mesh to render
  118640. * @returns true if it should render otherwise false
  118641. */
  118642. protected _shouldRenderMesh(mesh: Mesh): boolean;
  118643. /**
  118644. * Sets the required values for both the emissive texture and and the main color.
  118645. */
  118646. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  118647. /**
  118648. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  118649. * @param mesh The mesh to exclude from the highlight layer
  118650. */
  118651. addExcludedMesh(mesh: Mesh): void;
  118652. /**
  118653. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  118654. * @param mesh The mesh to highlight
  118655. */
  118656. removeExcludedMesh(mesh: Mesh): void;
  118657. /**
  118658. * Determine if a given mesh will be highlighted by the current HighlightLayer
  118659. * @param mesh mesh to test
  118660. * @returns true if the mesh will be highlighted by the current HighlightLayer
  118661. */
  118662. hasMesh(mesh: AbstractMesh): boolean;
  118663. /**
  118664. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  118665. * @param mesh The mesh to highlight
  118666. * @param color The color of the highlight
  118667. * @param glowEmissiveOnly Extract the glow from the emissive texture
  118668. */
  118669. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  118670. /**
  118671. * Remove a mesh from the highlight layer in order to make it stop glowing.
  118672. * @param mesh The mesh to highlight
  118673. */
  118674. removeMesh(mesh: Mesh): void;
  118675. /**
  118676. * Force the stencil to the normal expected value for none glowing parts
  118677. */
  118678. private _defaultStencilReference;
  118679. /**
  118680. * Free any resources and references associated to a mesh.
  118681. * Internal use
  118682. * @param mesh The mesh to free.
  118683. * @hidden
  118684. */
  118685. _disposeMesh(mesh: Mesh): void;
  118686. /**
  118687. * Dispose the highlight layer and free resources.
  118688. */
  118689. dispose(): void;
  118690. /**
  118691. * Gets the class name of the effect layer
  118692. * @returns the string with the class name of the effect layer
  118693. */
  118694. getClassName(): string;
  118695. /**
  118696. * Serializes this Highlight layer
  118697. * @returns a serialized Highlight layer object
  118698. */
  118699. serialize(): any;
  118700. /**
  118701. * Creates a Highlight layer from parsed Highlight layer data
  118702. * @param parsedHightlightLayer defines the Highlight layer data
  118703. * @param scene defines the current scene
  118704. * @param rootUrl defines the root URL containing the Highlight layer information
  118705. * @returns a parsed Highlight layer
  118706. */
  118707. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  118708. }
  118709. }
  118710. declare module BABYLON {
  118711. interface AbstractScene {
  118712. /**
  118713. * The list of layers (background and foreground) of the scene
  118714. */
  118715. layers: Array<Layer>;
  118716. }
  118717. /**
  118718. * Defines the layer scene component responsible to manage any layers
  118719. * in a given scene.
  118720. */
  118721. export class LayerSceneComponent implements ISceneComponent {
  118722. /**
  118723. * The component name helpfull to identify the component in the list of scene components.
  118724. */
  118725. readonly name: string;
  118726. /**
  118727. * The scene the component belongs to.
  118728. */
  118729. scene: Scene;
  118730. private _engine;
  118731. /**
  118732. * Creates a new instance of the component for the given scene
  118733. * @param scene Defines the scene to register the component in
  118734. */
  118735. constructor(scene: Scene);
  118736. /**
  118737. * Registers the component in a given scene
  118738. */
  118739. register(): void;
  118740. /**
  118741. * Rebuilds the elements related to this component in case of
  118742. * context lost for instance.
  118743. */
  118744. rebuild(): void;
  118745. /**
  118746. * Disposes the component and the associated ressources.
  118747. */
  118748. dispose(): void;
  118749. private _draw;
  118750. private _drawCameraPredicate;
  118751. private _drawCameraBackground;
  118752. private _drawCameraForeground;
  118753. private _drawRenderTargetPredicate;
  118754. private _drawRenderTargetBackground;
  118755. private _drawRenderTargetForeground;
  118756. /**
  118757. * Adds all the elements from the container to the scene
  118758. * @param container the container holding the elements
  118759. */
  118760. addFromContainer(container: AbstractScene): void;
  118761. /**
  118762. * Removes all the elements in the container from the scene
  118763. * @param container contains the elements to remove
  118764. * @param dispose if the removed element should be disposed (default: false)
  118765. */
  118766. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118767. }
  118768. }
  118769. declare module BABYLON {
  118770. /** @hidden */
  118771. export var layerPixelShader: {
  118772. name: string;
  118773. shader: string;
  118774. };
  118775. }
  118776. declare module BABYLON {
  118777. /** @hidden */
  118778. export var layerVertexShader: {
  118779. name: string;
  118780. shader: string;
  118781. };
  118782. }
  118783. declare module BABYLON {
  118784. /**
  118785. * This represents a full screen 2d layer.
  118786. * This can be useful to display a picture in the background of your scene for instance.
  118787. * @see https://www.babylonjs-playground.com/#08A2BS#1
  118788. */
  118789. export class Layer {
  118790. /**
  118791. * Define the name of the layer.
  118792. */
  118793. name: string;
  118794. /**
  118795. * Define the texture the layer should display.
  118796. */
  118797. texture: Nullable<Texture>;
  118798. /**
  118799. * Is the layer in background or foreground.
  118800. */
  118801. isBackground: boolean;
  118802. /**
  118803. * Define the color of the layer (instead of texture).
  118804. */
  118805. color: Color4;
  118806. /**
  118807. * Define the scale of the layer in order to zoom in out of the texture.
  118808. */
  118809. scale: Vector2;
  118810. /**
  118811. * Define an offset for the layer in order to shift the texture.
  118812. */
  118813. offset: Vector2;
  118814. /**
  118815. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  118816. */
  118817. alphaBlendingMode: number;
  118818. /**
  118819. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  118820. * Alpha test will not mix with the background color in case of transparency.
  118821. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  118822. */
  118823. alphaTest: boolean;
  118824. /**
  118825. * Define a mask to restrict the layer to only some of the scene cameras.
  118826. */
  118827. layerMask: number;
  118828. /**
  118829. * Define the list of render target the layer is visible into.
  118830. */
  118831. renderTargetTextures: RenderTargetTexture[];
  118832. /**
  118833. * Define if the layer is only used in renderTarget or if it also
  118834. * renders in the main frame buffer of the canvas.
  118835. */
  118836. renderOnlyInRenderTargetTextures: boolean;
  118837. private _scene;
  118838. private _vertexBuffers;
  118839. private _indexBuffer;
  118840. private _effect;
  118841. private _alphaTestEffect;
  118842. /**
  118843. * An event triggered when the layer is disposed.
  118844. */
  118845. onDisposeObservable: Observable<Layer>;
  118846. private _onDisposeObserver;
  118847. /**
  118848. * Back compatibility with callback before the onDisposeObservable existed.
  118849. * The set callback will be triggered when the layer has been disposed.
  118850. */
  118851. onDispose: () => void;
  118852. /**
  118853. * An event triggered before rendering the scene
  118854. */
  118855. onBeforeRenderObservable: Observable<Layer>;
  118856. private _onBeforeRenderObserver;
  118857. /**
  118858. * Back compatibility with callback before the onBeforeRenderObservable existed.
  118859. * The set callback will be triggered just before rendering the layer.
  118860. */
  118861. onBeforeRender: () => void;
  118862. /**
  118863. * An event triggered after rendering the scene
  118864. */
  118865. onAfterRenderObservable: Observable<Layer>;
  118866. private _onAfterRenderObserver;
  118867. /**
  118868. * Back compatibility with callback before the onAfterRenderObservable existed.
  118869. * The set callback will be triggered just after rendering the layer.
  118870. */
  118871. onAfterRender: () => void;
  118872. /**
  118873. * Instantiates a new layer.
  118874. * This represents a full screen 2d layer.
  118875. * This can be useful to display a picture in the background of your scene for instance.
  118876. * @see https://www.babylonjs-playground.com/#08A2BS#1
  118877. * @param name Define the name of the layer in the scene
  118878. * @param imgUrl Define the url of the texture to display in the layer
  118879. * @param scene Define the scene the layer belongs to
  118880. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  118881. * @param color Defines a color for the layer
  118882. */
  118883. constructor(
  118884. /**
  118885. * Define the name of the layer.
  118886. */
  118887. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  118888. private _createIndexBuffer;
  118889. /** @hidden */
  118890. _rebuild(): void;
  118891. /**
  118892. * Renders the layer in the scene.
  118893. */
  118894. render(): void;
  118895. /**
  118896. * Disposes and releases the associated ressources.
  118897. */
  118898. dispose(): void;
  118899. }
  118900. }
  118901. declare module BABYLON {
  118902. /** @hidden */
  118903. export var lensFlarePixelShader: {
  118904. name: string;
  118905. shader: string;
  118906. };
  118907. }
  118908. declare module BABYLON {
  118909. /** @hidden */
  118910. export var lensFlareVertexShader: {
  118911. name: string;
  118912. shader: string;
  118913. };
  118914. }
  118915. declare module BABYLON {
  118916. /**
  118917. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  118918. * It is usually composed of several `lensFlare`.
  118919. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118920. */
  118921. export class LensFlareSystem {
  118922. /**
  118923. * Define the name of the lens flare system
  118924. */
  118925. name: string;
  118926. /**
  118927. * List of lens flares used in this system.
  118928. */
  118929. lensFlares: LensFlare[];
  118930. /**
  118931. * Define a limit from the border the lens flare can be visible.
  118932. */
  118933. borderLimit: number;
  118934. /**
  118935. * Define a viewport border we do not want to see the lens flare in.
  118936. */
  118937. viewportBorder: number;
  118938. /**
  118939. * Define a predicate which could limit the list of meshes able to occlude the effect.
  118940. */
  118941. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  118942. /**
  118943. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  118944. */
  118945. layerMask: number;
  118946. /**
  118947. * Define the id of the lens flare system in the scene.
  118948. * (equal to name by default)
  118949. */
  118950. id: string;
  118951. private _scene;
  118952. private _emitter;
  118953. private _vertexBuffers;
  118954. private _indexBuffer;
  118955. private _effect;
  118956. private _positionX;
  118957. private _positionY;
  118958. private _isEnabled;
  118959. /** @hidden */
  118960. static _SceneComponentInitialization: (scene: Scene) => void;
  118961. /**
  118962. * Instantiates a lens flare system.
  118963. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  118964. * It is usually composed of several `lensFlare`.
  118965. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  118966. * @param name Define the name of the lens flare system in the scene
  118967. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  118968. * @param scene Define the scene the lens flare system belongs to
  118969. */
  118970. constructor(
  118971. /**
  118972. * Define the name of the lens flare system
  118973. */
  118974. name: string, emitter: any, scene: Scene);
  118975. /**
  118976. * Define if the lens flare system is enabled.
  118977. */
  118978. isEnabled: boolean;
  118979. /**
  118980. * Get the scene the effects belongs to.
  118981. * @returns the scene holding the lens flare system
  118982. */
  118983. getScene(): Scene;
  118984. /**
  118985. * Get the emitter of the lens flare system.
  118986. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  118987. * @returns the emitter of the lens flare system
  118988. */
  118989. getEmitter(): any;
  118990. /**
  118991. * Set the emitter of the lens flare system.
  118992. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  118993. * @param newEmitter Define the new emitter of the system
  118994. */
  118995. setEmitter(newEmitter: any): void;
  118996. /**
  118997. * Get the lens flare system emitter position.
  118998. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  118999. * @returns the position
  119000. */
  119001. getEmitterPosition(): Vector3;
  119002. /**
  119003. * @hidden
  119004. */
  119005. computeEffectivePosition(globalViewport: Viewport): boolean;
  119006. /** @hidden */
  119007. _isVisible(): boolean;
  119008. /**
  119009. * @hidden
  119010. */
  119011. render(): boolean;
  119012. /**
  119013. * Dispose and release the lens flare with its associated resources.
  119014. */
  119015. dispose(): void;
  119016. /**
  119017. * Parse a lens flare system from a JSON repressentation
  119018. * @param parsedLensFlareSystem Define the JSON to parse
  119019. * @param scene Define the scene the parsed system should be instantiated in
  119020. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  119021. * @returns the parsed system
  119022. */
  119023. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  119024. /**
  119025. * Serialize the current Lens Flare System into a JSON representation.
  119026. * @returns the serialized JSON
  119027. */
  119028. serialize(): any;
  119029. }
  119030. }
  119031. declare module BABYLON {
  119032. /**
  119033. * This represents one of the lens effect in a `lensFlareSystem`.
  119034. * It controls one of the indiviual texture used in the effect.
  119035. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119036. */
  119037. export class LensFlare {
  119038. /**
  119039. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  119040. */
  119041. size: number;
  119042. /**
  119043. * Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
  119044. */
  119045. position: number;
  119046. /**
  119047. * Define the lens color.
  119048. */
  119049. color: Color3;
  119050. /**
  119051. * Define the lens texture.
  119052. */
  119053. texture: Nullable<Texture>;
  119054. /**
  119055. * Define the alpha mode to render this particular lens.
  119056. */
  119057. alphaMode: number;
  119058. private _system;
  119059. /**
  119060. * Creates a new Lens Flare.
  119061. * This represents one of the lens effect in a `lensFlareSystem`.
  119062. * It controls one of the indiviual texture used in the effect.
  119063. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119064. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  119065. * @param position Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
  119066. * @param color Define the lens color
  119067. * @param imgUrl Define the lens texture url
  119068. * @param system Define the `lensFlareSystem` this flare is part of
  119069. * @returns The newly created Lens Flare
  119070. */
  119071. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  119072. /**
  119073. * Instantiates a new Lens Flare.
  119074. * This represents one of the lens effect in a `lensFlareSystem`.
  119075. * It controls one of the indiviual texture used in the effect.
  119076. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119077. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  119078. * @param position Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
  119079. * @param color Define the lens color
  119080. * @param imgUrl Define the lens texture url
  119081. * @param system Define the `lensFlareSystem` this flare is part of
  119082. */
  119083. constructor(
  119084. /**
  119085. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  119086. */
  119087. size: number,
  119088. /**
  119089. * Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
  119090. */
  119091. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  119092. /**
  119093. * Dispose and release the lens flare with its associated resources.
  119094. */
  119095. dispose(): void;
  119096. }
  119097. }
  119098. declare module BABYLON {
  119099. interface AbstractScene {
  119100. /**
  119101. * The list of lens flare system added to the scene
  119102. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119103. */
  119104. lensFlareSystems: Array<LensFlareSystem>;
  119105. /**
  119106. * Removes the given lens flare system from this scene.
  119107. * @param toRemove The lens flare system to remove
  119108. * @returns The index of the removed lens flare system
  119109. */
  119110. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  119111. /**
  119112. * Adds the given lens flare system to this scene
  119113. * @param newLensFlareSystem The lens flare system to add
  119114. */
  119115. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  119116. /**
  119117. * Gets a lens flare system using its name
  119118. * @param name defines the name to look for
  119119. * @returns the lens flare system or null if not found
  119120. */
  119121. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  119122. /**
  119123. * Gets a lens flare system using its id
  119124. * @param id defines the id to look for
  119125. * @returns the lens flare system or null if not found
  119126. */
  119127. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  119128. }
  119129. /**
  119130. * Defines the lens flare scene component responsible to manage any lens flares
  119131. * in a given scene.
  119132. */
  119133. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  119134. /**
  119135. * The component name helpfull to identify the component in the list of scene components.
  119136. */
  119137. readonly name: string;
  119138. /**
  119139. * The scene the component belongs to.
  119140. */
  119141. scene: Scene;
  119142. /**
  119143. * Creates a new instance of the component for the given scene
  119144. * @param scene Defines the scene to register the component in
  119145. */
  119146. constructor(scene: Scene);
  119147. /**
  119148. * Registers the component in a given scene
  119149. */
  119150. register(): void;
  119151. /**
  119152. * Rebuilds the elements related to this component in case of
  119153. * context lost for instance.
  119154. */
  119155. rebuild(): void;
  119156. /**
  119157. * Adds all the elements from the container to the scene
  119158. * @param container the container holding the elements
  119159. */
  119160. addFromContainer(container: AbstractScene): void;
  119161. /**
  119162. * Removes all the elements in the container from the scene
  119163. * @param container contains the elements to remove
  119164. * @param dispose if the removed element should be disposed (default: false)
  119165. */
  119166. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  119167. /**
  119168. * Serializes the component data to the specified json object
  119169. * @param serializationObject The object to serialize to
  119170. */
  119171. serialize(serializationObject: any): void;
  119172. /**
  119173. * Disposes the component and the associated ressources.
  119174. */
  119175. dispose(): void;
  119176. private _draw;
  119177. }
  119178. }
  119179. declare module BABYLON {
  119180. /**
  119181. * Defines the shadow generator component responsible to manage any shadow generators
  119182. * in a given scene.
  119183. */
  119184. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  119185. /**
  119186. * The component name helpfull to identify the component in the list of scene components.
  119187. */
  119188. readonly name: string;
  119189. /**
  119190. * The scene the component belongs to.
  119191. */
  119192. scene: Scene;
  119193. /**
  119194. * Creates a new instance of the component for the given scene
  119195. * @param scene Defines the scene to register the component in
  119196. */
  119197. constructor(scene: Scene);
  119198. /**
  119199. * Registers the component in a given scene
  119200. */
  119201. register(): void;
  119202. /**
  119203. * Rebuilds the elements related to this component in case of
  119204. * context lost for instance.
  119205. */
  119206. rebuild(): void;
  119207. /**
  119208. * Serializes the component data to the specified json object
  119209. * @param serializationObject The object to serialize to
  119210. */
  119211. serialize(serializationObject: any): void;
  119212. /**
  119213. * Adds all the elements from the container to the scene
  119214. * @param container the container holding the elements
  119215. */
  119216. addFromContainer(container: AbstractScene): void;
  119217. /**
  119218. * Removes all the elements in the container from the scene
  119219. * @param container contains the elements to remove
  119220. * @param dispose if the removed element should be disposed (default: false)
  119221. */
  119222. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  119223. /**
  119224. * Rebuilds the elements related to this component in case of
  119225. * context lost for instance.
  119226. */
  119227. dispose(): void;
  119228. private _gatherRenderTargets;
  119229. }
  119230. }
  119231. declare module BABYLON {
  119232. /**
  119233. * A point light is a light defined by an unique point in world space.
  119234. * The light is emitted in every direction from this point.
  119235. * A good example of a point light is a standard light bulb.
  119236. * Documentation: https://doc.babylonjs.com/babylon101/lights
  119237. */
  119238. export class PointLight extends ShadowLight {
  119239. private _shadowAngle;
  119240. /**
  119241. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119242. * This specifies what angle the shadow will use to be created.
  119243. *
  119244. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  119245. */
  119246. /**
  119247. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119248. * This specifies what angle the shadow will use to be created.
  119249. *
  119250. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  119251. */
  119252. shadowAngle: number;
  119253. /**
  119254. * Gets the direction if it has been set.
  119255. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119256. */
  119257. /**
  119258. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119259. */
  119260. direction: Vector3;
  119261. /**
  119262. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  119263. * A PointLight emits the light in every direction.
  119264. * It can cast shadows.
  119265. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  119266. * ```javascript
  119267. * var pointLight = new PointLight("pl", camera.position, scene);
  119268. * ```
  119269. * Documentation : https://doc.babylonjs.com/babylon101/lights
  119270. * @param name The light friendly name
  119271. * @param position The position of the point light in the scene
  119272. * @param scene The scene the lights belongs to
  119273. */
  119274. constructor(name: string, position: Vector3, scene: Scene);
  119275. /**
  119276. * Returns the string "PointLight"
  119277. * @returns the class name
  119278. */
  119279. getClassName(): string;
  119280. /**
  119281. * Returns the integer 0.
  119282. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  119283. */
  119284. getTypeID(): number;
  119285. /**
  119286. * Specifies wether or not the shadowmap should be a cube texture.
  119287. * @returns true if the shadowmap needs to be a cube texture.
  119288. */
  119289. needCube(): boolean;
  119290. /**
  119291. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  119292. * @param faceIndex The index of the face we are computed the direction to generate shadow
  119293. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  119294. */
  119295. getShadowDirection(faceIndex?: number): Vector3;
  119296. /**
  119297. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  119298. * - fov = PI / 2
  119299. * - aspect ratio : 1.0
  119300. * - z-near and far equal to the active camera minZ and maxZ.
  119301. * Returns the PointLight.
  119302. */
  119303. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  119304. protected _buildUniformLayout(): void;
  119305. /**
  119306. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  119307. * @param effect The effect to update
  119308. * @param lightIndex The index of the light in the effect to update
  119309. * @returns The point light
  119310. */
  119311. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  119312. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  119313. /**
  119314. * Prepares the list of defines specific to the light type.
  119315. * @param defines the list of defines
  119316. * @param lightIndex defines the index of the light for the effect
  119317. */
  119318. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  119319. }
  119320. }
  119321. declare module BABYLON {
  119322. /**
  119323. * Header information of HDR texture files.
  119324. */
  119325. export interface HDRInfo {
  119326. /**
  119327. * The height of the texture in pixels.
  119328. */
  119329. height: number;
  119330. /**
  119331. * The width of the texture in pixels.
  119332. */
  119333. width: number;
  119334. /**
  119335. * The index of the beginning of the data in the binary file.
  119336. */
  119337. dataPosition: number;
  119338. }
  119339. /**
  119340. * This groups tools to convert HDR texture to native colors array.
  119341. */
  119342. export class HDRTools {
  119343. private static Ldexp;
  119344. private static Rgbe2float;
  119345. private static readStringLine;
  119346. /**
  119347. * Reads header information from an RGBE texture stored in a native array.
  119348. * More information on this format are available here:
  119349. * https://en.wikipedia.org/wiki/RGBE_image_format
  119350. *
  119351. * @param uint8array The binary file stored in native array.
  119352. * @return The header information.
  119353. */
  119354. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  119355. /**
  119356. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  119357. * This RGBE texture needs to store the information as a panorama.
  119358. *
  119359. * More information on this format are available here:
  119360. * https://en.wikipedia.org/wiki/RGBE_image_format
  119361. *
  119362. * @param buffer The binary file stored in an array buffer.
  119363. * @param size The expected size of the extracted cubemap.
  119364. * @return The Cube Map information.
  119365. */
  119366. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  119367. /**
  119368. * Returns the pixels data extracted from an RGBE texture.
  119369. * This pixels will be stored left to right up to down in the R G B order in one array.
  119370. *
  119371. * More information on this format are available here:
  119372. * https://en.wikipedia.org/wiki/RGBE_image_format
  119373. *
  119374. * @param uint8array The binary file stored in an array buffer.
  119375. * @param hdrInfo The header information of the file.
  119376. * @return The pixels data in RGB right to left up to down order.
  119377. */
  119378. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  119379. private static RGBE_ReadPixels_RLE;
  119380. }
  119381. }
  119382. declare module BABYLON {
  119383. /**
  119384. * This represents a texture coming from an HDR input.
  119385. *
  119386. * The only supported format is currently panorama picture stored in RGBE format.
  119387. * Example of such files can be found on HDRLib: http://hdrlib.com/
  119388. */
  119389. export class HDRCubeTexture extends BaseTexture {
  119390. private static _facesMapping;
  119391. private _generateHarmonics;
  119392. private _noMipmap;
  119393. private _textureMatrix;
  119394. private _size;
  119395. private _onLoad;
  119396. private _onError;
  119397. /**
  119398. * The texture URL.
  119399. */
  119400. url: string;
  119401. /**
  119402. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  119403. */
  119404. coordinatesMode: number;
  119405. protected _isBlocking: boolean;
  119406. /**
  119407. * Sets wether or not the texture is blocking during loading.
  119408. */
  119409. /**
  119410. * Gets wether or not the texture is blocking during loading.
  119411. */
  119412. isBlocking: boolean;
  119413. protected _rotationY: number;
  119414. /**
  119415. * Sets texture matrix rotation angle around Y axis in radians.
  119416. */
  119417. /**
  119418. * Gets texture matrix rotation angle around Y axis radians.
  119419. */
  119420. rotationY: number;
  119421. /**
  119422. * Gets or sets the center of the bounding box associated with the cube texture
  119423. * It must define where the camera used to render the texture was set
  119424. */
  119425. boundingBoxPosition: Vector3;
  119426. private _boundingBoxSize;
  119427. /**
  119428. * Gets or sets the size of the bounding box associated with the cube texture
  119429. * When defined, the cubemap will switch to local mode
  119430. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  119431. * @example https://www.babylonjs-playground.com/#RNASML
  119432. */
  119433. boundingBoxSize: Vector3;
  119434. /**
  119435. * Instantiates an HDRTexture from the following parameters.
  119436. *
  119437. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  119438. * @param scene The scene the texture will be used in
  119439. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  119440. * @param noMipmap Forces to not generate the mipmap if true
  119441. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  119442. * @param gammaSpace Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  119443. * @param reserved Reserved flag for internal use.
  119444. */
  119445. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  119446. /**
  119447. * Get the current class name of the texture useful for serialization or dynamic coding.
  119448. * @returns "HDRCubeTexture"
  119449. */
  119450. getClassName(): string;
  119451. /**
  119452. * Occurs when the file is raw .hdr file.
  119453. */
  119454. private loadTexture;
  119455. clone(): HDRCubeTexture;
  119456. delayLoad(): void;
  119457. /**
  119458. * Get the texture reflection matrix used to rotate/transform the reflection.
  119459. * @returns the reflection matrix
  119460. */
  119461. getReflectionTextureMatrix(): Matrix;
  119462. /**
  119463. * Set the texture reflection matrix used to rotate/transform the reflection.
  119464. * @param value Define the reflection matrix to set
  119465. */
  119466. setReflectionTextureMatrix(value: Matrix): void;
  119467. /**
  119468. * Parses a JSON representation of an HDR Texture in order to create the texture
  119469. * @param parsedTexture Define the JSON representation
  119470. * @param scene Define the scene the texture should be created in
  119471. * @param rootUrl Define the root url in case we need to load relative dependencies
  119472. * @returns the newly created texture after parsing
  119473. */
  119474. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  119475. serialize(): any;
  119476. }
  119477. }
  119478. declare module BABYLON {
  119479. /**
  119480. * Class used to control physics engine
  119481. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  119482. */
  119483. export class PhysicsEngine implements IPhysicsEngine {
  119484. private _physicsPlugin;
  119485. /**
  119486. * Global value used to control the smallest number supported by the simulation
  119487. */
  119488. static Epsilon: number;
  119489. private _impostors;
  119490. private _joints;
  119491. /**
  119492. * Gets the gravity vector used by the simulation
  119493. */
  119494. gravity: Vector3;
  119495. /**
  119496. * Factory used to create the default physics plugin.
  119497. * @returns The default physics plugin
  119498. */
  119499. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  119500. /**
  119501. * Creates a new Physics Engine
  119502. * @param gravity defines the gravity vector used by the simulation
  119503. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  119504. */
  119505. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  119506. /**
  119507. * Sets the gravity vector used by the simulation
  119508. * @param gravity defines the gravity vector to use
  119509. */
  119510. setGravity(gravity: Vector3): void;
  119511. /**
  119512. * Set the time step of the physics engine.
  119513. * Default is 1/60.
  119514. * To slow it down, enter 1/600 for example.
  119515. * To speed it up, 1/30
  119516. * @param newTimeStep defines the new timestep to apply to this world.
  119517. */
  119518. setTimeStep(newTimeStep?: number): void;
  119519. /**
  119520. * Get the time step of the physics engine.
  119521. * @returns the current time step
  119522. */
  119523. getTimeStep(): number;
  119524. /**
  119525. * Release all resources
  119526. */
  119527. dispose(): void;
  119528. /**
  119529. * Gets the name of the current physics plugin
  119530. * @returns the name of the plugin
  119531. */
  119532. getPhysicsPluginName(): string;
  119533. /**
  119534. * Adding a new impostor for the impostor tracking.
  119535. * This will be done by the impostor itself.
  119536. * @param impostor the impostor to add
  119537. */
  119538. addImpostor(impostor: PhysicsImpostor): void;
  119539. /**
  119540. * Remove an impostor from the engine.
  119541. * This impostor and its mesh will not longer be updated by the physics engine.
  119542. * @param impostor the impostor to remove
  119543. */
  119544. removeImpostor(impostor: PhysicsImpostor): void;
  119545. /**
  119546. * Add a joint to the physics engine
  119547. * @param mainImpostor defines the main impostor to which the joint is added.
  119548. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  119549. * @param joint defines the joint that will connect both impostors.
  119550. */
  119551. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  119552. /**
  119553. * Removes a joint from the simulation
  119554. * @param mainImpostor defines the impostor used with the joint
  119555. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  119556. * @param joint defines the joint to remove
  119557. */
  119558. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  119559. /**
  119560. * Called by the scene. No need to call it.
  119561. * @param delta defines the timespam between frames
  119562. */
  119563. _step(delta: number): void;
  119564. /**
  119565. * Gets the current plugin used to run the simulation
  119566. * @returns current plugin
  119567. */
  119568. getPhysicsPlugin(): IPhysicsEnginePlugin;
  119569. /**
  119570. * Gets the list of physic impostors
  119571. * @returns an array of PhysicsImpostor
  119572. */
  119573. getImpostors(): Array<PhysicsImpostor>;
  119574. /**
  119575. * Gets the impostor for a physics enabled object
  119576. * @param object defines the object impersonated by the impostor
  119577. * @returns the PhysicsImpostor or null if not found
  119578. */
  119579. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  119580. /**
  119581. * Gets the impostor for a physics body object
  119582. * @param body defines physics body used by the impostor
  119583. * @returns the PhysicsImpostor or null if not found
  119584. */
  119585. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  119586. /**
  119587. * Does a raycast in the physics world
  119588. * @param from when should the ray start?
  119589. * @param to when should the ray end?
  119590. * @returns PhysicsRaycastResult
  119591. */
  119592. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  119593. }
  119594. }
  119595. declare module BABYLON {
  119596. /** @hidden */
  119597. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  119598. private _useDeltaForWorldStep;
  119599. world: any;
  119600. name: string;
  119601. private _physicsMaterials;
  119602. private _fixedTimeStep;
  119603. private _cannonRaycastResult;
  119604. private _raycastResult;
  119605. private _physicsBodysToRemoveAfterStep;
  119606. BJSCANNON: any;
  119607. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  119608. setGravity(gravity: Vector3): void;
  119609. setTimeStep(timeStep: number): void;
  119610. getTimeStep(): number;
  119611. executeStep(delta: number): void;
  119612. private _removeMarkedPhysicsBodiesFromWorld;
  119613. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119614. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119615. generatePhysicsBody(impostor: PhysicsImpostor): void;
  119616. private _processChildMeshes;
  119617. removePhysicsBody(impostor: PhysicsImpostor): void;
  119618. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  119619. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  119620. private _addMaterial;
  119621. private _checkWithEpsilon;
  119622. private _createShape;
  119623. private _createHeightmap;
  119624. private _minus90X;
  119625. private _plus90X;
  119626. private _tmpPosition;
  119627. private _tmpDeltaPosition;
  119628. private _tmpUnityRotation;
  119629. private _updatePhysicsBodyTransformation;
  119630. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  119631. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  119632. isSupported(): boolean;
  119633. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119634. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119635. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119636. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119637. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  119638. getBodyMass(impostor: PhysicsImpostor): number;
  119639. getBodyFriction(impostor: PhysicsImpostor): number;
  119640. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  119641. getBodyRestitution(impostor: PhysicsImpostor): number;
  119642. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  119643. sleepBody(impostor: PhysicsImpostor): void;
  119644. wakeUpBody(impostor: PhysicsImpostor): void;
  119645. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  119646. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  119647. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  119648. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  119649. getRadius(impostor: PhysicsImpostor): number;
  119650. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  119651. dispose(): void;
  119652. private _extendNamespace;
  119653. /**
  119654. * Does a raycast in the physics world
  119655. * @param from when should the ray start?
  119656. * @param to when should the ray end?
  119657. * @returns PhysicsRaycastResult
  119658. */
  119659. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  119660. }
  119661. }
  119662. declare module BABYLON {
  119663. /** @hidden */
  119664. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  119665. world: any;
  119666. name: string;
  119667. BJSOIMO: any;
  119668. private _raycastResult;
  119669. constructor(iterations?: number, oimoInjection?: any);
  119670. setGravity(gravity: Vector3): void;
  119671. setTimeStep(timeStep: number): void;
  119672. getTimeStep(): number;
  119673. private _tmpImpostorsArray;
  119674. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  119675. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119676. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119677. generatePhysicsBody(impostor: PhysicsImpostor): void;
  119678. private _tmpPositionVector;
  119679. removePhysicsBody(impostor: PhysicsImpostor): void;
  119680. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  119681. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  119682. isSupported(): boolean;
  119683. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  119684. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  119685. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119686. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  119687. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119688. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  119689. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  119690. getBodyMass(impostor: PhysicsImpostor): number;
  119691. getBodyFriction(impostor: PhysicsImpostor): number;
  119692. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  119693. getBodyRestitution(impostor: PhysicsImpostor): number;
  119694. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  119695. sleepBody(impostor: PhysicsImpostor): void;
  119696. wakeUpBody(impostor: PhysicsImpostor): void;
  119697. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  119698. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  119699. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  119700. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  119701. getRadius(impostor: PhysicsImpostor): number;
  119702. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  119703. dispose(): void;
  119704. /**
  119705. * Does a raycast in the physics world
  119706. * @param from when should the ray start?
  119707. * @param to when should the ray end?
  119708. * @returns PhysicsRaycastResult
  119709. */
  119710. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  119711. }
  119712. }
  119713. declare module BABYLON {
  119714. /**
  119715. * Class containing static functions to help procedurally build meshes
  119716. */
  119717. export class RibbonBuilder {
  119718. /**
  119719. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  119720. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  119721. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  119722. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  119723. * * The parameter `offset` (positive integer, default : rounded half size of the pathArray length), is taken in account only if the `pathArray` is containing a single path
  119724. * * It's the offset to join the points from the same path. Ex : offset = 10 means the point 1 is joined to the point 11
  119725. * * The optional parameter `instance` is an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#ribbon
  119726. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  119727. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  119728. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  119729. * * The parameter `uvs` is an optional flat array of `Vector2` to update/set each ribbon vertex with its own custom UV values instead of the computed ones
  119730. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  119731. * * Note that if you use the parameters `uvs` or `colors`, the passed arrays must be populated with the right number of elements, it is to say the number of ribbon vertices. Remember that if you set `closePath` to `true`, there's one extra vertex per path in the geometry
  119732. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  119733. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  119734. * @param name defines the name of the mesh
  119735. * @param options defines the options used to create the mesh
  119736. * @param scene defines the hosting scene
  119737. * @returns the ribbon mesh
  119738. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  119739. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  119740. */
  119741. static CreateRibbon(name: string, options: {
  119742. pathArray: Vector3[][];
  119743. closeArray?: boolean;
  119744. closePath?: boolean;
  119745. offset?: number;
  119746. updatable?: boolean;
  119747. sideOrientation?: number;
  119748. frontUVs?: Vector4;
  119749. backUVs?: Vector4;
  119750. instance?: Mesh;
  119751. invertUV?: boolean;
  119752. uvs?: Vector2[];
  119753. colors?: Color4[];
  119754. }, scene?: Nullable<Scene>): Mesh;
  119755. }
  119756. }
  119757. declare module BABYLON {
  119758. /**
  119759. * Class containing static functions to help procedurally build meshes
  119760. */
  119761. export class ShapeBuilder {
  119762. /**
  119763. * Creates an extruded shape mesh. The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  119764. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis.
  119765. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  119766. * * The parameter `rotation` (float, default 0 radians) is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve.
  119767. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  119768. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  119769. * * The optional parameter `instance` is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape
  119770. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  119771. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  119772. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  119773. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  119774. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  119775. * @param name defines the name of the mesh
  119776. * @param options defines the options used to create the mesh
  119777. * @param scene defines the hosting scene
  119778. * @returns the extruded shape mesh
  119779. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  119780. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  119781. */
  119782. static ExtrudeShape(name: string, options: {
  119783. shape: Vector3[];
  119784. path: Vector3[];
  119785. scale?: number;
  119786. rotation?: number;
  119787. cap?: number;
  119788. updatable?: boolean;
  119789. sideOrientation?: number;
  119790. frontUVs?: Vector4;
  119791. backUVs?: Vector4;
  119792. instance?: Mesh;
  119793. invertUV?: boolean;
  119794. }, scene?: Nullable<Scene>): Mesh;
  119795. /**
  119796. * Creates an custom extruded shape mesh.
  119797. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  119798. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis.
  119799. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  119800. * * The parameter `rotationFunction` (JS function) is a custom Javascript function called on each path point. This function is passed the position i of the point in the path and the distance of this point from the begining of the path
  119801. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  119802. * * The parameter `scaleFunction` (JS function) is a custom Javascript function called on each path point. This function is passed the position i of the point in the path and the distance of this point from the begining of the path
  119803. * * It must returns a float value that will be the scale value applied to the shape on each path point
  119804. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  119805. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  119806. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  119807. * * The optional parameter `instance` is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape
  119808. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  119809. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  119810. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  119811. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  119812. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  119813. * @param name defines the name of the mesh
  119814. * @param options defines the options used to create the mesh
  119815. * @param scene defines the hosting scene
  119816. * @returns the custom extruded shape mesh
  119817. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  119818. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  119819. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  119820. */
  119821. static ExtrudeShapeCustom(name: string, options: {
  119822. shape: Vector3[];
  119823. path: Vector3[];
  119824. scaleFunction?: any;
  119825. rotationFunction?: any;
  119826. ribbonCloseArray?: boolean;
  119827. ribbonClosePath?: boolean;
  119828. cap?: number;
  119829. updatable?: boolean;
  119830. sideOrientation?: number;
  119831. frontUVs?: Vector4;
  119832. backUVs?: Vector4;
  119833. instance?: Mesh;
  119834. invertUV?: boolean;
  119835. }, scene?: Nullable<Scene>): Mesh;
  119836. private static _ExtrudeShapeGeneric;
  119837. }
  119838. }
  119839. declare module BABYLON {
  119840. /**
  119841. * AmmoJS Physics plugin
  119842. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  119843. * @see https://github.com/kripken/ammo.js/
  119844. */
  119845. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  119846. private _useDeltaForWorldStep;
  119847. /**
  119848. * Reference to the Ammo library
  119849. */
  119850. bjsAMMO: any;
  119851. /**
  119852. * Created ammoJS world which physics bodies are added to
  119853. */
  119854. world: any;
  119855. /**
  119856. * Name of the plugin
  119857. */
  119858. name: string;
  119859. private _timeStep;
  119860. private _fixedTimeStep;
  119861. private _maxSteps;
  119862. private _tmpQuaternion;
  119863. private _tmpAmmoTransform;
  119864. private _tmpAmmoQuaternion;
  119865. private _tmpAmmoConcreteContactResultCallback;
  119866. private _collisionConfiguration;
  119867. private _dispatcher;
  119868. private _overlappingPairCache;
  119869. private _solver;
  119870. private _softBodySolver;
  119871. private _tmpAmmoVectorA;
  119872. private _tmpAmmoVectorB;
  119873. private _tmpAmmoVectorC;
  119874. private _tmpAmmoVectorD;
  119875. private _tmpContactCallbackResult;
  119876. private _tmpAmmoVectorRCA;
  119877. private _tmpAmmoVectorRCB;
  119878. private _raycastResult;
  119879. private static readonly DISABLE_COLLISION_FLAG;
  119880. private static readonly KINEMATIC_FLAG;
  119881. private static readonly DISABLE_DEACTIVATION_FLAG;
  119882. /**
  119883. * Initializes the ammoJS plugin
  119884. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  119885. * @param ammoInjection can be used to inject your own ammo reference
  119886. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  119887. */
  119888. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  119889. /**
  119890. * Sets the gravity of the physics world (m/(s^2))
  119891. * @param gravity Gravity to set
  119892. */
  119893. setGravity(gravity: Vector3): void;
  119894. /**
  119895. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  119896. * @param timeStep timestep to use in seconds
  119897. */
  119898. setTimeStep(timeStep: number): void;
  119899. /**
  119900. * Increment to step forward in the physics engine (If timeStep is set to 1/60 and fixedTimeStep is set to 1/120 the physics engine should run 2 steps per frame) (Default: 1/60)
  119901. * @param fixedTimeStep fixedTimeStep to use in seconds
  119902. */
  119903. setFixedTimeStep(fixedTimeStep: number): void;
  119904. /**
  119905. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  119906. * @param maxSteps the maximum number of steps by the physics engine per frame
  119907. */
  119908. setMaxSteps(maxSteps: number): void;
  119909. /**
  119910. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  119911. * @returns the current timestep in seconds
  119912. */
  119913. getTimeStep(): number;
  119914. private _isImpostorInContact;
  119915. private _isImpostorPairInContact;
  119916. private _stepSimulation;
  119917. /**
  119918. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  119919. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  119920. * After the step the babylon meshes are set to the position of the physics imposters
  119921. * @param delta amount of time to step forward
  119922. * @param impostors array of imposters to update before/after the step
  119923. */
  119924. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  119925. /**
  119926. * Update babylon mesh to match physics world object
  119927. * @param impostor imposter to match
  119928. */
  119929. private _afterSoftStep;
  119930. /**
  119931. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  119932. * @param impostor imposter to match
  119933. */
  119934. private _ropeStep;
  119935. /**
  119936. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  119937. * @param impostor imposter to match
  119938. */
  119939. private _softbodyOrClothStep;
  119940. private _tmpVector;
  119941. private _tmpMatrix;
  119942. /**
  119943. * Applies an impulse on the imposter
  119944. * @param impostor imposter to apply impulse to
  119945. * @param force amount of force to be applied to the imposter
  119946. * @param contactPoint the location to apply the impulse on the imposter
  119947. */
  119948. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119949. /**
  119950. * Applies a force on the imposter
  119951. * @param impostor imposter to apply force
  119952. * @param force amount of force to be applied to the imposter
  119953. * @param contactPoint the location to apply the force on the imposter
  119954. */
  119955. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  119956. /**
  119957. * Creates a physics body using the plugin
  119958. * @param impostor the imposter to create the physics body on
  119959. */
  119960. generatePhysicsBody(impostor: PhysicsImpostor): void;
  119961. /**
  119962. * Removes the physics body from the imposter and disposes of the body's memory
  119963. * @param impostor imposter to remove the physics body from
  119964. */
  119965. removePhysicsBody(impostor: PhysicsImpostor): void;
  119966. /**
  119967. * Generates a joint
  119968. * @param impostorJoint the imposter joint to create the joint with
  119969. */
  119970. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  119971. /**
  119972. * Removes a joint
  119973. * @param impostorJoint the imposter joint to remove the joint from
  119974. */
  119975. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  119976. private _addMeshVerts;
  119977. /**
  119978. * Initialise the soft body vertices to match its object's (mesh) vertices
  119979. * Softbody vertices (nodes) are in world space and to match this
  119980. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  119981. * @param impostor to create the softbody for
  119982. */
  119983. private _softVertexData;
  119984. /**
  119985. * Create an impostor's soft body
  119986. * @param impostor to create the softbody for
  119987. */
  119988. private _createSoftbody;
  119989. /**
  119990. * Create cloth for an impostor
  119991. * @param impostor to create the softbody for
  119992. */
  119993. private _createCloth;
  119994. /**
  119995. * Create rope for an impostor
  119996. * @param impostor to create the softbody for
  119997. */
  119998. private _createRope;
  119999. private _addHullVerts;
  120000. private _createShape;
  120001. /**
  120002. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  120003. * @param impostor imposter containing the physics body and babylon object
  120004. */
  120005. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  120006. /**
  120007. * Sets the babylon object's position/rotation from the physics body's position/rotation
  120008. * @param impostor imposter containing the physics body and babylon object
  120009. * @param newPosition new position
  120010. * @param newRotation new rotation
  120011. */
  120012. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  120013. /**
  120014. * If this plugin is supported
  120015. * @returns true if its supported
  120016. */
  120017. isSupported(): boolean;
  120018. /**
  120019. * Sets the linear velocity of the physics body
  120020. * @param impostor imposter to set the velocity on
  120021. * @param velocity velocity to set
  120022. */
  120023. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120024. /**
  120025. * Sets the angular velocity of the physics body
  120026. * @param impostor imposter to set the velocity on
  120027. * @param velocity velocity to set
  120028. */
  120029. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120030. /**
  120031. * gets the linear velocity
  120032. * @param impostor imposter to get linear velocity from
  120033. * @returns linear velocity
  120034. */
  120035. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120036. /**
  120037. * gets the angular velocity
  120038. * @param impostor imposter to get angular velocity from
  120039. * @returns angular velocity
  120040. */
  120041. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120042. /**
  120043. * Sets the mass of physics body
  120044. * @param impostor imposter to set the mass on
  120045. * @param mass mass to set
  120046. */
  120047. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  120048. /**
  120049. * Gets the mass of the physics body
  120050. * @param impostor imposter to get the mass from
  120051. * @returns mass
  120052. */
  120053. getBodyMass(impostor: PhysicsImpostor): number;
  120054. /**
  120055. * Gets friction of the impostor
  120056. * @param impostor impostor to get friction from
  120057. * @returns friction value
  120058. */
  120059. getBodyFriction(impostor: PhysicsImpostor): number;
  120060. /**
  120061. * Sets friction of the impostor
  120062. * @param impostor impostor to set friction on
  120063. * @param friction friction value
  120064. */
  120065. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  120066. /**
  120067. * Gets restitution of the impostor
  120068. * @param impostor impostor to get restitution from
  120069. * @returns restitution value
  120070. */
  120071. getBodyRestitution(impostor: PhysicsImpostor): number;
  120072. /**
  120073. * Sets resitution of the impostor
  120074. * @param impostor impostor to set resitution on
  120075. * @param restitution resitution value
  120076. */
  120077. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  120078. /**
  120079. * Gets pressure inside the impostor
  120080. * @param impostor impostor to get pressure from
  120081. * @returns pressure value
  120082. */
  120083. getBodyPressure(impostor: PhysicsImpostor): number;
  120084. /**
  120085. * Sets pressure inside a soft body impostor
  120086. * Cloth and rope must remain 0 pressure
  120087. * @param impostor impostor to set pressure on
  120088. * @param pressure pressure value
  120089. */
  120090. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  120091. /**
  120092. * Gets stiffness of the impostor
  120093. * @param impostor impostor to get stiffness from
  120094. * @returns pressure value
  120095. */
  120096. getBodyStiffness(impostor: PhysicsImpostor): number;
  120097. /**
  120098. * Sets stiffness of the impostor
  120099. * @param impostor impostor to set stiffness on
  120100. * @param stiffness stiffness value from 0 to 1
  120101. */
  120102. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  120103. /**
  120104. * Gets velocityIterations of the impostor
  120105. * @param impostor impostor to get velocity iterations from
  120106. * @returns velocityIterations value
  120107. */
  120108. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  120109. /**
  120110. * Sets velocityIterations of the impostor
  120111. * @param impostor impostor to set velocity iterations on
  120112. * @param velocityIterations velocityIterations value
  120113. */
  120114. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  120115. /**
  120116. * Gets positionIterations of the impostor
  120117. * @param impostor impostor to get position iterations from
  120118. * @returns positionIterations value
  120119. */
  120120. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  120121. /**
  120122. * Sets positionIterations of the impostor
  120123. * @param impostor impostor to set position on
  120124. * @param positionIterations positionIterations value
  120125. */
  120126. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  120127. /**
  120128. * Append an anchor to a cloth object
  120129. * @param impostor is the cloth impostor to add anchor to
  120130. * @param otherImpostor is the rigid impostor to anchor to
  120131. * @param width ratio across width from 0 to 1
  120132. * @param height ratio up height from 0 to 1
  120133. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  120134. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  120135. */
  120136. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  120137. /**
  120138. * Append an hook to a rope object
  120139. * @param impostor is the rope impostor to add hook to
  120140. * @param otherImpostor is the rigid impostor to hook to
  120141. * @param length ratio along the rope from 0 to 1
  120142. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  120143. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  120144. */
  120145. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  120146. /**
  120147. * Sleeps the physics body and stops it from being active
  120148. * @param impostor impostor to sleep
  120149. */
  120150. sleepBody(impostor: PhysicsImpostor): void;
  120151. /**
  120152. * Activates the physics body
  120153. * @param impostor impostor to activate
  120154. */
  120155. wakeUpBody(impostor: PhysicsImpostor): void;
  120156. /**
  120157. * Updates the distance parameters of the joint
  120158. * @param joint joint to update
  120159. * @param maxDistance maximum distance of the joint
  120160. * @param minDistance minimum distance of the joint
  120161. */
  120162. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  120163. /**
  120164. * Sets a motor on the joint
  120165. * @param joint joint to set motor on
  120166. * @param speed speed of the motor
  120167. * @param maxForce maximum force of the motor
  120168. * @param motorIndex index of the motor
  120169. */
  120170. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  120171. /**
  120172. * Sets the motors limit
  120173. * @param joint joint to set limit on
  120174. * @param upperLimit upper limit
  120175. * @param lowerLimit lower limit
  120176. */
  120177. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  120178. /**
  120179. * Syncs the position and rotation of a mesh with the impostor
  120180. * @param mesh mesh to sync
  120181. * @param impostor impostor to update the mesh with
  120182. */
  120183. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  120184. /**
  120185. * Gets the radius of the impostor
  120186. * @param impostor impostor to get radius from
  120187. * @returns the radius
  120188. */
  120189. getRadius(impostor: PhysicsImpostor): number;
  120190. /**
  120191. * Gets the box size of the impostor
  120192. * @param impostor impostor to get box size from
  120193. * @param result the resulting box size
  120194. */
  120195. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  120196. /**
  120197. * Disposes of the impostor
  120198. */
  120199. dispose(): void;
  120200. /**
  120201. * Does a raycast in the physics world
  120202. * @param from when should the ray start?
  120203. * @param to when should the ray end?
  120204. * @returns PhysicsRaycastResult
  120205. */
  120206. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  120207. }
  120208. }
  120209. declare module BABYLON {
  120210. interface AbstractScene {
  120211. /**
  120212. * The list of reflection probes added to the scene
  120213. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  120214. */
  120215. reflectionProbes: Array<ReflectionProbe>;
  120216. /**
  120217. * Removes the given reflection probe from this scene.
  120218. * @param toRemove The reflection probe to remove
  120219. * @returns The index of the removed reflection probe
  120220. */
  120221. removeReflectionProbe(toRemove: ReflectionProbe): number;
  120222. /**
  120223. * Adds the given reflection probe to this scene.
  120224. * @param newReflectionProbe The reflection probe to add
  120225. */
  120226. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  120227. }
  120228. /**
  120229. * Class used to generate realtime reflection / refraction cube textures
  120230. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  120231. */
  120232. export class ReflectionProbe {
  120233. /** defines the name of the probe */
  120234. name: string;
  120235. private _scene;
  120236. private _renderTargetTexture;
  120237. private _projectionMatrix;
  120238. private _viewMatrix;
  120239. private _target;
  120240. private _add;
  120241. private _attachedMesh;
  120242. private _invertYAxis;
  120243. /** Gets or sets probe position (center of the cube map) */
  120244. position: Vector3;
  120245. /**
  120246. * Creates a new reflection probe
  120247. * @param name defines the name of the probe
  120248. * @param size defines the texture resolution (for each face)
  120249. * @param scene defines the hosting scene
  120250. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  120251. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  120252. */
  120253. constructor(
  120254. /** defines the name of the probe */
  120255. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  120256. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  120257. samples: number;
  120258. /** Gets or sets the refresh rate to use (on every frame by default) */
  120259. refreshRate: number;
  120260. /**
  120261. * Gets the hosting scene
  120262. * @returns a Scene
  120263. */
  120264. getScene(): Scene;
  120265. /** Gets the internal CubeTexture used to render to */
  120266. readonly cubeTexture: RenderTargetTexture;
  120267. /** Gets the list of meshes to render */
  120268. readonly renderList: Nullable<AbstractMesh[]>;
  120269. /**
  120270. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  120271. * @param mesh defines the mesh to attach to
  120272. */
  120273. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  120274. /**
  120275. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  120276. * @param renderingGroupId The rendering group id corresponding to its index
  120277. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120278. */
  120279. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  120280. /**
  120281. * Clean all associated resources
  120282. */
  120283. dispose(): void;
  120284. /**
  120285. * Converts the reflection probe information to a readable string for debug purpose.
  120286. * @param fullDetails Supports for multiple levels of logging within scene loading
  120287. * @returns the human readable reflection probe info
  120288. */
  120289. toString(fullDetails?: boolean): string;
  120290. /**
  120291. * Get the class name of the relfection probe.
  120292. * @returns "ReflectionProbe"
  120293. */
  120294. getClassName(): string;
  120295. /**
  120296. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  120297. * @returns The JSON representation of the texture
  120298. */
  120299. serialize(): any;
  120300. /**
  120301. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  120302. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  120303. * @param scene Define the scene the parsed reflection probe should be instantiated in
  120304. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  120305. * @returns The parsed reflection probe if successful
  120306. */
  120307. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  120308. }
  120309. }
  120310. declare module BABYLON {
  120311. /** @hidden */
  120312. export var _BabylonLoaderRegistered: boolean;
  120313. /**
  120314. * Helps setting up some configuration for the babylon file loader.
  120315. */
  120316. export class BabylonFileLoaderConfiguration {
  120317. /**
  120318. * The loader does not allow injecting custom physix engine into the plugins.
  120319. * Unfortunately in ES6, we need to manually inject them into the plugin.
  120320. * So you could set this variable to your engine import to make it work.
  120321. */
  120322. static LoaderInjectedPhysicsEngine: any;
  120323. }
  120324. }
  120325. declare module BABYLON {
  120326. /**
  120327. * The Physically based simple base material of BJS.
  120328. *
  120329. * This enables better naming and convention enforcements on top of the pbrMaterial.
  120330. * It is used as the base class for both the specGloss and metalRough conventions.
  120331. */
  120332. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  120333. /**
  120334. * Number of Simultaneous lights allowed on the material.
  120335. */
  120336. maxSimultaneousLights: number;
  120337. /**
  120338. * If sets to true, disables all the lights affecting the material.
  120339. */
  120340. disableLighting: boolean;
  120341. /**
  120342. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  120343. */
  120344. environmentTexture: BaseTexture;
  120345. /**
  120346. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  120347. */
  120348. invertNormalMapX: boolean;
  120349. /**
  120350. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  120351. */
  120352. invertNormalMapY: boolean;
  120353. /**
  120354. * Normal map used in the model.
  120355. */
  120356. normalTexture: BaseTexture;
  120357. /**
  120358. * Emissivie color used to self-illuminate the model.
  120359. */
  120360. emissiveColor: Color3;
  120361. /**
  120362. * Emissivie texture used to self-illuminate the model.
  120363. */
  120364. emissiveTexture: BaseTexture;
  120365. /**
  120366. * Occlusion Channel Strenght.
  120367. */
  120368. occlusionStrength: number;
  120369. /**
  120370. * Occlusion Texture of the material (adding extra occlusion effects).
  120371. */
  120372. occlusionTexture: BaseTexture;
  120373. /**
  120374. * Defines the alpha limits in alpha test mode.
  120375. */
  120376. alphaCutOff: number;
  120377. /**
  120378. * Gets the current double sided mode.
  120379. */
  120380. /**
  120381. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  120382. */
  120383. doubleSided: boolean;
  120384. /**
  120385. * Stores the pre-calculated light information of a mesh in a texture.
  120386. */
  120387. lightmapTexture: BaseTexture;
  120388. /**
  120389. * If true, the light map contains occlusion information instead of lighting info.
  120390. */
  120391. useLightmapAsShadowmap: boolean;
  120392. /**
  120393. * Instantiates a new PBRMaterial instance.
  120394. *
  120395. * @param name The material name
  120396. * @param scene The scene the material will be use in.
  120397. */
  120398. constructor(name: string, scene: Scene);
  120399. getClassName(): string;
  120400. }
  120401. }
  120402. declare module BABYLON {
  120403. /**
  120404. * The PBR material of BJS following the metal roughness convention.
  120405. *
  120406. * This fits to the PBR convention in the GLTF definition:
  120407. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  120408. */
  120409. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  120410. /**
  120411. * The base color has two different interpretations depending on the value of metalness.
  120412. * When the material is a metal, the base color is the specific measured reflectance value
  120413. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  120414. * of the material.
  120415. */
  120416. baseColor: Color3;
  120417. /**
  120418. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  120419. * well as opacity information in the alpha channel.
  120420. */
  120421. baseTexture: BaseTexture;
  120422. /**
  120423. * Specifies the metallic scalar value of the material.
  120424. * Can also be used to scale the metalness values of the metallic texture.
  120425. */
  120426. metallic: number;
  120427. /**
  120428. * Specifies the roughness scalar value of the material.
  120429. * Can also be used to scale the roughness values of the metallic texture.
  120430. */
  120431. roughness: number;
  120432. /**
  120433. * Texture containing both the metallic value in the B channel and the
  120434. * roughness value in the G channel to keep better precision.
  120435. */
  120436. metallicRoughnessTexture: BaseTexture;
  120437. /**
  120438. * Instantiates a new PBRMetalRoughnessMaterial instance.
  120439. *
  120440. * @param name The material name
  120441. * @param scene The scene the material will be use in.
  120442. */
  120443. constructor(name: string, scene: Scene);
  120444. /**
  120445. * Return the currrent class name of the material.
  120446. */
  120447. getClassName(): string;
  120448. /**
  120449. * Makes a duplicate of the current material.
  120450. * @param name - name to use for the new material.
  120451. */
  120452. clone(name: string): PBRMetallicRoughnessMaterial;
  120453. /**
  120454. * Serialize the material to a parsable JSON object.
  120455. */
  120456. serialize(): any;
  120457. /**
  120458. * Parses a JSON object correponding to the serialize function.
  120459. */
  120460. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  120461. }
  120462. }
  120463. declare module BABYLON {
  120464. /**
  120465. * The PBR material of BJS following the specular glossiness convention.
  120466. *
  120467. * This fits to the PBR convention in the GLTF definition:
  120468. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  120469. */
  120470. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  120471. /**
  120472. * Specifies the diffuse color of the material.
  120473. */
  120474. diffuseColor: Color3;
  120475. /**
  120476. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  120477. * channel.
  120478. */
  120479. diffuseTexture: BaseTexture;
  120480. /**
  120481. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  120482. */
  120483. specularColor: Color3;
  120484. /**
  120485. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  120486. */
  120487. glossiness: number;
  120488. /**
  120489. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  120490. */
  120491. specularGlossinessTexture: BaseTexture;
  120492. /**
  120493. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  120494. *
  120495. * @param name The material name
  120496. * @param scene The scene the material will be use in.
  120497. */
  120498. constructor(name: string, scene: Scene);
  120499. /**
  120500. * Return the currrent class name of the material.
  120501. */
  120502. getClassName(): string;
  120503. /**
  120504. * Makes a duplicate of the current material.
  120505. * @param name - name to use for the new material.
  120506. */
  120507. clone(name: string): PBRSpecularGlossinessMaterial;
  120508. /**
  120509. * Serialize the material to a parsable JSON object.
  120510. */
  120511. serialize(): any;
  120512. /**
  120513. * Parses a JSON object correponding to the serialize function.
  120514. */
  120515. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  120516. }
  120517. }
  120518. declare module BABYLON {
  120519. /**
  120520. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  120521. * It can help converting any input color in a desired output one. This can then be used to create effects
  120522. * from sepia, black and white to sixties or futuristic rendering...
  120523. *
  120524. * The only supported format is currently 3dl.
  120525. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  120526. */
  120527. export class ColorGradingTexture extends BaseTexture {
  120528. /**
  120529. * The current texture matrix. (will always be identity in color grading texture)
  120530. */
  120531. private _textureMatrix;
  120532. /**
  120533. * The texture URL.
  120534. */
  120535. url: string;
  120536. /**
  120537. * Empty line regex stored for GC.
  120538. */
  120539. private static _noneEmptyLineRegex;
  120540. private _engine;
  120541. /**
  120542. * Instantiates a ColorGradingTexture from the following parameters.
  120543. *
  120544. * @param url The location of the color gradind data (currently only supporting 3dl)
  120545. * @param scene The scene the texture will be used in
  120546. */
  120547. constructor(url: string, scene: Scene);
  120548. /**
  120549. * Returns the texture matrix used in most of the material.
  120550. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  120551. */
  120552. getTextureMatrix(): Matrix;
  120553. /**
  120554. * Occurs when the file being loaded is a .3dl LUT file.
  120555. */
  120556. private load3dlTexture;
  120557. /**
  120558. * Starts the loading process of the texture.
  120559. */
  120560. private loadTexture;
  120561. /**
  120562. * Clones the color gradind texture.
  120563. */
  120564. clone(): ColorGradingTexture;
  120565. /**
  120566. * Called during delayed load for textures.
  120567. */
  120568. delayLoad(): void;
  120569. /**
  120570. * Parses a color grading texture serialized by Babylon.
  120571. * @param parsedTexture The texture information being parsedTexture
  120572. * @param scene The scene to load the texture in
  120573. * @param rootUrl The root url of the data assets to load
  120574. * @return A color gradind texture
  120575. */
  120576. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  120577. /**
  120578. * Serializes the LUT texture to json format.
  120579. */
  120580. serialize(): any;
  120581. }
  120582. }
  120583. declare module BABYLON {
  120584. /**
  120585. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  120586. */
  120587. export class EquiRectangularCubeTexture extends BaseTexture {
  120588. /** The six faces of the cube. */
  120589. private static _FacesMapping;
  120590. private _noMipmap;
  120591. private _onLoad;
  120592. private _onError;
  120593. /** The size of the cubemap. */
  120594. private _size;
  120595. /** The buffer of the image. */
  120596. private _buffer;
  120597. /** The width of the input image. */
  120598. private _width;
  120599. /** The height of the input image. */
  120600. private _height;
  120601. /** The URL to the image. */
  120602. url: string;
  120603. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  120604. coordinatesMode: number;
  120605. /**
  120606. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  120607. * @param url The location of the image
  120608. * @param scene The scene the texture will be used in
  120609. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  120610. * @param noMipmap Forces to not generate the mipmap if true
  120611. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  120612. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  120613. * @param onLoad — defines a callback called when texture is loaded
  120614. * @param onError — defines a callback called if there is an error
  120615. */
  120616. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  120617. /**
  120618. * Load the image data, by putting the image on a canvas and extracting its buffer.
  120619. */
  120620. private loadImage;
  120621. /**
  120622. * Convert the image buffer into a cubemap and create a CubeTexture.
  120623. */
  120624. private loadTexture;
  120625. /**
  120626. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  120627. * @param buffer The ArrayBuffer that should be converted.
  120628. * @returns The buffer as Float32Array.
  120629. */
  120630. private getFloat32ArrayFromArrayBuffer;
  120631. /**
  120632. * Get the current class name of the texture useful for serialization or dynamic coding.
  120633. * @returns "EquiRectangularCubeTexture"
  120634. */
  120635. getClassName(): string;
  120636. /**
  120637. * Create a clone of the current EquiRectangularCubeTexture and return it.
  120638. * @returns A clone of the current EquiRectangularCubeTexture.
  120639. */
  120640. clone(): EquiRectangularCubeTexture;
  120641. }
  120642. }
  120643. declare module BABYLON {
  120644. /**
  120645. * Based on jsTGALoader - Javascript loader for TGA file
  120646. * By Vincent Thibault
  120647. * @see http://blog.robrowser.com/javascript-tga-loader.html
  120648. */
  120649. export class TGATools {
  120650. private static _TYPE_INDEXED;
  120651. private static _TYPE_RGB;
  120652. private static _TYPE_GREY;
  120653. private static _TYPE_RLE_INDEXED;
  120654. private static _TYPE_RLE_RGB;
  120655. private static _TYPE_RLE_GREY;
  120656. private static _ORIGIN_MASK;
  120657. private static _ORIGIN_SHIFT;
  120658. private static _ORIGIN_BL;
  120659. private static _ORIGIN_BR;
  120660. private static _ORIGIN_UL;
  120661. private static _ORIGIN_UR;
  120662. /**
  120663. * Gets the header of a TGA file
  120664. * @param data defines the TGA data
  120665. * @returns the header
  120666. */
  120667. static GetTGAHeader(data: Uint8Array): any;
  120668. /**
  120669. * Uploads TGA content to a Babylon Texture
  120670. * @hidden
  120671. */
  120672. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  120673. /** @hidden */
  120674. static _getImageData8bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  120675. /** @hidden */
  120676. static _getImageData16bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  120677. /** @hidden */
  120678. static _getImageData24bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  120679. /** @hidden */
  120680. static _getImageData32bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  120681. /** @hidden */
  120682. static _getImageDataGrey8bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  120683. /** @hidden */
  120684. static _getImageDataGrey16bits(header: any, palettes: Uint8Array, pixel_data: Uint8Array, y_start: number, y_step: number, y_end: number, x_start: number, x_step: number, x_end: number): Uint8Array;
  120685. }
  120686. }
  120687. declare module BABYLON {
  120688. /**
  120689. * Implementation of the TGA Texture Loader.
  120690. * @hidden
  120691. */
  120692. export class _TGATextureLoader implements IInternalTextureLoader {
  120693. /**
  120694. * Defines wether the loader supports cascade loading the different faces.
  120695. */
  120696. readonly supportCascades: boolean;
  120697. /**
  120698. * This returns if the loader support the current file information.
  120699. * @param extension defines the file extension of the file being loaded
  120700. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120701. * @param fallback defines the fallback internal texture if any
  120702. * @param isBase64 defines whether the texture is encoded as a base64
  120703. * @param isBuffer defines whether the texture data are stored as a buffer
  120704. * @returns true if the loader can load the specified file
  120705. */
  120706. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  120707. /**
  120708. * Transform the url before loading if required.
  120709. * @param rootUrl the url of the texture
  120710. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120711. * @returns the transformed texture
  120712. */
  120713. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  120714. /**
  120715. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  120716. * @param rootUrl the url of the texture
  120717. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120718. * @returns the fallback texture
  120719. */
  120720. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  120721. /**
  120722. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  120723. * @param data contains the texture data
  120724. * @param texture defines the BabylonJS internal texture
  120725. * @param createPolynomials will be true if polynomials have been requested
  120726. * @param onLoad defines the callback to trigger once the texture is ready
  120727. * @param onError defines the callback to trigger in case of error
  120728. */
  120729. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  120730. /**
  120731. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  120732. * @param data contains the texture data
  120733. * @param texture defines the BabylonJS internal texture
  120734. * @param callback defines the method to call once ready to upload
  120735. */
  120736. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  120737. }
  120738. }
  120739. declare module BABYLON {
  120740. /**
  120741. * Info about the .basis files
  120742. */
  120743. class BasisFileInfo {
  120744. /**
  120745. * If the file has alpha
  120746. */
  120747. hasAlpha: boolean;
  120748. /**
  120749. * Info about each image of the basis file
  120750. */
  120751. images: Array<{
  120752. levels: Array<{
  120753. width: number;
  120754. height: number;
  120755. transcodedPixels: ArrayBufferView;
  120756. }>;
  120757. }>;
  120758. }
  120759. /**
  120760. * Result of transcoding a basis file
  120761. */
  120762. class TranscodeResult {
  120763. /**
  120764. * Info about the .basis file
  120765. */
  120766. fileInfo: BasisFileInfo;
  120767. /**
  120768. * Format to use when loading the file
  120769. */
  120770. format: number;
  120771. }
  120772. /**
  120773. * Configuration options for the Basis transcoder
  120774. */
  120775. export class BasisTranscodeConfiguration {
  120776. /**
  120777. * Supported compression formats used to determine the supported output format of the transcoder
  120778. */
  120779. supportedCompressionFormats?: {
  120780. /**
  120781. * etc1 compression format
  120782. */
  120783. etc1?: boolean;
  120784. /**
  120785. * s3tc compression format
  120786. */
  120787. s3tc?: boolean;
  120788. /**
  120789. * pvrtc compression format
  120790. */
  120791. pvrtc?: boolean;
  120792. /**
  120793. * etc2 compression format
  120794. */
  120795. etc2?: boolean;
  120796. };
  120797. /**
  120798. * If mipmap levels should be loaded for transcoded images (Default: true)
  120799. */
  120800. loadMipmapLevels?: boolean;
  120801. /**
  120802. * Index of a single image to load (Default: all images)
  120803. */
  120804. loadSingleImage?: number;
  120805. }
  120806. /**
  120807. * Used to load .Basis files
  120808. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  120809. */
  120810. export class BasisTools {
  120811. private static _IgnoreSupportedFormats;
  120812. /**
  120813. * URL to use when loading the basis transcoder
  120814. */
  120815. static JSModuleURL: string;
  120816. /**
  120817. * URL to use when loading the wasm module for the transcoder
  120818. */
  120819. static WasmModuleURL: string;
  120820. /**
  120821. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  120822. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  120823. * @returns internal format corresponding to the Basis format
  120824. */
  120825. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  120826. private static _WorkerPromise;
  120827. private static _Worker;
  120828. private static _actionId;
  120829. private static _CreateWorkerAsync;
  120830. /**
  120831. * Transcodes a loaded image file to compressed pixel data
  120832. * @param imageData image data to transcode
  120833. * @param config configuration options for the transcoding
  120834. * @returns a promise resulting in the transcoded image
  120835. */
  120836. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  120837. /**
  120838. * Loads a texture from the transcode result
  120839. * @param texture texture load to
  120840. * @param transcodeResult the result of transcoding the basis file to load from
  120841. */
  120842. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  120843. }
  120844. }
  120845. declare module BABYLON {
  120846. /**
  120847. * Loader for .basis file format
  120848. */
  120849. export class _BasisTextureLoader implements IInternalTextureLoader {
  120850. /**
  120851. * Defines whether the loader supports cascade loading the different faces.
  120852. */
  120853. readonly supportCascades: boolean;
  120854. /**
  120855. * This returns if the loader support the current file information.
  120856. * @param extension defines the file extension of the file being loaded
  120857. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120858. * @param fallback defines the fallback internal texture if any
  120859. * @param isBase64 defines whether the texture is encoded as a base64
  120860. * @param isBuffer defines whether the texture data are stored as a buffer
  120861. * @returns true if the loader can load the specified file
  120862. */
  120863. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  120864. /**
  120865. * Transform the url before loading if required.
  120866. * @param rootUrl the url of the texture
  120867. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120868. * @returns the transformed texture
  120869. */
  120870. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  120871. /**
  120872. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  120873. * @param rootUrl the url of the texture
  120874. * @param textureFormatInUse defines the current compressed format in use iun the engine
  120875. * @returns the fallback texture
  120876. */
  120877. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  120878. /**
  120879. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  120880. * @param data contains the texture data
  120881. * @param texture defines the BabylonJS internal texture
  120882. * @param createPolynomials will be true if polynomials have been requested
  120883. * @param onLoad defines the callback to trigger once the texture is ready
  120884. * @param onError defines the callback to trigger in case of error
  120885. */
  120886. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  120887. /**
  120888. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  120889. * @param data contains the texture data
  120890. * @param texture defines the BabylonJS internal texture
  120891. * @param callback defines the method to call once ready to upload
  120892. */
  120893. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  120894. }
  120895. }
  120896. declare module BABYLON {
  120897. /**
  120898. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  120899. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  120900. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  120901. */
  120902. export class CustomProceduralTexture extends ProceduralTexture {
  120903. private _animate;
  120904. private _time;
  120905. private _config;
  120906. private _texturePath;
  120907. /**
  120908. * Instantiates a new Custom Procedural Texture.
  120909. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  120910. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  120911. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  120912. * @param name Define the name of the texture
  120913. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  120914. * @param size Define the size of the texture to create
  120915. * @param scene Define the scene the texture belongs to
  120916. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  120917. * @param generateMipMaps Define if the texture should creates mip maps or not
  120918. */
  120919. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  120920. private _loadJson;
  120921. /**
  120922. * Is the texture ready to be used ? (rendered at least once)
  120923. * @returns true if ready, otherwise, false.
  120924. */
  120925. isReady(): boolean;
  120926. /**
  120927. * Render the texture to its associated render target.
  120928. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  120929. */
  120930. render(useCameraPostProcess?: boolean): void;
  120931. /**
  120932. * Update the list of dependant textures samplers in the shader.
  120933. */
  120934. updateTextures(): void;
  120935. /**
  120936. * Update the uniform values of the procedural texture in the shader.
  120937. */
  120938. updateShaderUniforms(): void;
  120939. /**
  120940. * Define if the texture animates or not.
  120941. */
  120942. animate: boolean;
  120943. }
  120944. }
  120945. declare module BABYLON {
  120946. /** @hidden */
  120947. export var noisePixelShader: {
  120948. name: string;
  120949. shader: string;
  120950. };
  120951. }
  120952. declare module BABYLON {
  120953. /**
  120954. * Class used to generate noise procedural textures
  120955. */
  120956. export class NoiseProceduralTexture extends ProceduralTexture {
  120957. private _time;
  120958. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  120959. brightness: number;
  120960. /** Defines the number of octaves to process */
  120961. octaves: number;
  120962. /** Defines the level of persistence (0.8 by default) */
  120963. persistence: number;
  120964. /** Gets or sets animation speed factor (default is 1) */
  120965. animationSpeedFactor: number;
  120966. /**
  120967. * Creates a new NoiseProceduralTexture
  120968. * @param name defines the name fo the texture
  120969. * @param size defines the size of the texture (default is 256)
  120970. * @param scene defines the hosting scene
  120971. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  120972. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  120973. */
  120974. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  120975. private _updateShaderUniforms;
  120976. protected _getDefines(): string;
  120977. /** Generate the current state of the procedural texture */
  120978. render(useCameraPostProcess?: boolean): void;
  120979. /**
  120980. * Serializes this noise procedural texture
  120981. * @returns a serialized noise procedural texture object
  120982. */
  120983. serialize(): any;
  120984. /**
  120985. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  120986. * @param parsedTexture defines parsed texture data
  120987. * @param scene defines the current scene
  120988. * @param rootUrl defines the root URL containing noise procedural texture information
  120989. * @returns a parsed NoiseProceduralTexture
  120990. */
  120991. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  120992. }
  120993. }
  120994. declare module BABYLON {
  120995. /**
  120996. * Raw cube texture where the raw buffers are passed in
  120997. */
  120998. export class RawCubeTexture extends CubeTexture {
  120999. /**
  121000. * Creates a cube texture where the raw buffers are passed in.
  121001. * @param scene defines the scene the texture is attached to
  121002. * @param data defines the array of data to use to create each face
  121003. * @param size defines the size of the textures
  121004. * @param format defines the format of the data
  121005. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  121006. * @param generateMipMaps defines if the engine should generate the mip levels
  121007. * @param invertY defines if data must be stored with Y axis inverted
  121008. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  121009. * @param compression defines the compression used (null by default)
  121010. */
  121011. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  121012. /**
  121013. * Updates the raw cube texture.
  121014. * @param data defines the data to store
  121015. * @param format defines the data format
  121016. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  121017. * @param invertY defines if data must be stored with Y axis inverted
  121018. * @param compression defines the compression used (null by default)
  121019. * @param level defines which level of the texture to update
  121020. */
  121021. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  121022. /**
  121023. * Updates a raw cube texture with RGBD encoded data.
  121024. * @param data defines the array of data [mipmap][face] to use to create each face
  121025. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  121026. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  121027. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  121028. * @returns a promsie that resolves when the operation is complete
  121029. */
  121030. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  121031. /**
  121032. * Clones the raw cube texture.
  121033. * @return a new cube texture
  121034. */
  121035. clone(): CubeTexture;
  121036. /** @hidden */
  121037. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  121038. }
  121039. }
  121040. declare module BABYLON {
  121041. /**
  121042. * Class used to store 3D textures containing user data
  121043. */
  121044. export class RawTexture3D extends Texture {
  121045. /** Gets or sets the texture format to use */
  121046. format: number;
  121047. private _engine;
  121048. /**
  121049. * Create a new RawTexture3D
  121050. * @param data defines the data of the texture
  121051. * @param width defines the width of the texture
  121052. * @param height defines the height of the texture
  121053. * @param depth defines the depth of the texture
  121054. * @param format defines the texture format to use
  121055. * @param scene defines the hosting scene
  121056. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  121057. * @param invertY defines if texture must be stored with Y axis inverted
  121058. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  121059. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  121060. */
  121061. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  121062. /** Gets or sets the texture format to use */
  121063. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  121064. /**
  121065. * Update the texture with new data
  121066. * @param data defines the data to store in the texture
  121067. */
  121068. update(data: ArrayBufferView): void;
  121069. }
  121070. }
  121071. declare module BABYLON {
  121072. /**
  121073. * Class used to store 2D array textures containing user data
  121074. */
  121075. export class RawTexture2DArray extends Texture {
  121076. /** Gets or sets the texture format to use */
  121077. format: number;
  121078. private _engine;
  121079. /**
  121080. * Create a new RawTexture2DArray
  121081. * @param data defines the data of the texture
  121082. * @param width defines the width of the texture
  121083. * @param height defines the height of the texture
  121084. * @param depth defines the number of layers of the texture
  121085. * @param format defines the texture format to use
  121086. * @param scene defines the hosting scene
  121087. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  121088. * @param invertY defines if texture must be stored with Y axis inverted
  121089. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  121090. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  121091. */
  121092. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  121093. /** Gets or sets the texture format to use */
  121094. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  121095. /**
  121096. * Update the texture with new data
  121097. * @param data defines the data to store in the texture
  121098. */
  121099. update(data: ArrayBufferView): void;
  121100. }
  121101. }
  121102. declare module BABYLON {
  121103. /**
  121104. * Creates a refraction texture used by refraction channel of the standard material.
  121105. * It is like a mirror but to see through a material.
  121106. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  121107. */
  121108. export class RefractionTexture extends RenderTargetTexture {
  121109. /**
  121110. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  121111. * It is possible to directly set the refractionPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the refractionPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the refractor as stated in the doc.
  121112. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  121113. */
  121114. refractionPlane: Plane;
  121115. /**
  121116. * Define how deep under the surface we should see.
  121117. */
  121118. depth: number;
  121119. /**
  121120. * Creates a refraction texture used by refraction channel of the standard material.
  121121. * It is like a mirror but to see through a material.
  121122. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  121123. * @param name Define the texture name
  121124. * @param size Define the size of the underlying texture
  121125. * @param scene Define the scene the refraction belongs to
  121126. * @param generateMipMaps Define if we need to generate mips level for the refraction
  121127. */
  121128. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  121129. /**
  121130. * Clone the refraction texture.
  121131. * @returns the cloned texture
  121132. */
  121133. clone(): RefractionTexture;
  121134. /**
  121135. * Serialize the texture to a JSON representation you could use in Parse later on
  121136. * @returns the serialized JSON representation
  121137. */
  121138. serialize(): any;
  121139. }
  121140. }
  121141. declare module BABYLON {
  121142. /**
  121143. * Defines the options related to the creation of an HtmlElementTexture
  121144. */
  121145. export interface IHtmlElementTextureOptions {
  121146. /**
  121147. * Defines wether mip maps should be created or not.
  121148. */
  121149. generateMipMaps?: boolean;
  121150. /**
  121151. * Defines the sampling mode of the texture.
  121152. */
  121153. samplingMode?: number;
  121154. /**
  121155. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  121156. */
  121157. engine: Nullable<ThinEngine>;
  121158. /**
  121159. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  121160. */
  121161. scene: Nullable<Scene>;
  121162. }
  121163. /**
  121164. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  121165. * To be as efficient as possible depending on your constraints nothing aside the first upload
  121166. * is automatically managed.
  121167. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  121168. * in your application.
  121169. *
  121170. * As the update is not automatic, you need to call them manually.
  121171. */
  121172. export class HtmlElementTexture extends BaseTexture {
  121173. /**
  121174. * The texture URL.
  121175. */
  121176. element: HTMLVideoElement | HTMLCanvasElement;
  121177. private static readonly DefaultOptions;
  121178. private _textureMatrix;
  121179. private _engine;
  121180. private _isVideo;
  121181. private _generateMipMaps;
  121182. private _samplingMode;
  121183. /**
  121184. * Instantiates a HtmlElementTexture from the following parameters.
  121185. *
  121186. * @param name Defines the name of the texture
  121187. * @param element Defines the video or canvas the texture is filled with
  121188. * @param options Defines the other none mandatory texture creation options
  121189. */
  121190. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  121191. private _createInternalTexture;
  121192. /**
  121193. * Returns the texture matrix used in most of the material.
  121194. */
  121195. getTextureMatrix(): Matrix;
  121196. /**
  121197. * Updates the content of the texture.
  121198. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  121199. */
  121200. update(invertY?: Nullable<boolean>): void;
  121201. }
  121202. }
  121203. declare module BABYLON {
  121204. /**
  121205. * Enum used to define the target of a block
  121206. */
  121207. export enum NodeMaterialBlockTargets {
  121208. /** Vertex shader */
  121209. Vertex = 1,
  121210. /** Fragment shader */
  121211. Fragment = 2,
  121212. /** Neutral */
  121213. Neutral = 4,
  121214. /** Vertex and Fragment */
  121215. VertexAndFragment = 3
  121216. }
  121217. }
  121218. declare module BABYLON {
  121219. /**
  121220. * Defines the kind of connection point for node based material
  121221. */
  121222. export enum NodeMaterialBlockConnectionPointTypes {
  121223. /** Float */
  121224. Float = 1,
  121225. /** Int */
  121226. Int = 2,
  121227. /** Vector2 */
  121228. Vector2 = 4,
  121229. /** Vector3 */
  121230. Vector3 = 8,
  121231. /** Vector4 */
  121232. Vector4 = 16,
  121233. /** Color3 */
  121234. Color3 = 32,
  121235. /** Color4 */
  121236. Color4 = 64,
  121237. /** Matrix */
  121238. Matrix = 128,
  121239. /** Detect type based on connection */
  121240. AutoDetect = 1024,
  121241. /** Output type that will be defined by input type */
  121242. BasedOnInput = 2048
  121243. }
  121244. }
  121245. declare module BABYLON {
  121246. /**
  121247. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  121248. */
  121249. export enum NodeMaterialBlockConnectionPointMode {
  121250. /** Value is an uniform */
  121251. Uniform = 0,
  121252. /** Value is a mesh attribute */
  121253. Attribute = 1,
  121254. /** Value is a varying between vertex and fragment shaders */
  121255. Varying = 2,
  121256. /** Mode is undefined */
  121257. Undefined = 3
  121258. }
  121259. }
  121260. declare module BABYLON {
  121261. /**
  121262. * Enum used to define system values e.g. values automatically provided by the system
  121263. */
  121264. export enum NodeMaterialSystemValues {
  121265. /** World */
  121266. World = 1,
  121267. /** View */
  121268. View = 2,
  121269. /** Projection */
  121270. Projection = 3,
  121271. /** ViewProjection */
  121272. ViewProjection = 4,
  121273. /** WorldView */
  121274. WorldView = 5,
  121275. /** WorldViewProjection */
  121276. WorldViewProjection = 6,
  121277. /** CameraPosition */
  121278. CameraPosition = 7,
  121279. /** Fog Color */
  121280. FogColor = 8,
  121281. /** Delta time */
  121282. DeltaTime = 9
  121283. }
  121284. }
  121285. declare module BABYLON {
  121286. /**
  121287. * Root class for all node material optimizers
  121288. */
  121289. export class NodeMaterialOptimizer {
  121290. /**
  121291. * Function used to optimize a NodeMaterial graph
  121292. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  121293. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  121294. */
  121295. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  121296. }
  121297. }
  121298. declare module BABYLON {
  121299. /**
  121300. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  121301. */
  121302. export class TransformBlock extends NodeMaterialBlock {
  121303. /**
  121304. * Defines the value to use to complement W value to transform it to a Vector4
  121305. */
  121306. complementW: number;
  121307. /**
  121308. * Defines the value to use to complement z value to transform it to a Vector4
  121309. */
  121310. complementZ: number;
  121311. /**
  121312. * Creates a new TransformBlock
  121313. * @param name defines the block name
  121314. */
  121315. constructor(name: string);
  121316. /**
  121317. * Gets the current class name
  121318. * @returns the class name
  121319. */
  121320. getClassName(): string;
  121321. /**
  121322. * Gets the vector input
  121323. */
  121324. readonly vector: NodeMaterialConnectionPoint;
  121325. /**
  121326. * Gets the output component
  121327. */
  121328. readonly output: NodeMaterialConnectionPoint;
  121329. /**
  121330. * Gets the matrix transform input
  121331. */
  121332. readonly transform: NodeMaterialConnectionPoint;
  121333. protected _buildBlock(state: NodeMaterialBuildState): this;
  121334. serialize(): any;
  121335. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121336. protected _dumpPropertiesCode(): string;
  121337. }
  121338. }
  121339. declare module BABYLON {
  121340. /**
  121341. * Block used to output the vertex position
  121342. */
  121343. export class VertexOutputBlock extends NodeMaterialBlock {
  121344. /**
  121345. * Creates a new VertexOutputBlock
  121346. * @param name defines the block name
  121347. */
  121348. constructor(name: string);
  121349. /**
  121350. * Gets the current class name
  121351. * @returns the class name
  121352. */
  121353. getClassName(): string;
  121354. /**
  121355. * Gets the vector input component
  121356. */
  121357. readonly vector: NodeMaterialConnectionPoint;
  121358. protected _buildBlock(state: NodeMaterialBuildState): this;
  121359. }
  121360. }
  121361. declare module BABYLON {
  121362. /**
  121363. * Block used to output the final color
  121364. */
  121365. export class FragmentOutputBlock extends NodeMaterialBlock {
  121366. /**
  121367. * Create a new FragmentOutputBlock
  121368. * @param name defines the block name
  121369. */
  121370. constructor(name: string);
  121371. /**
  121372. * Gets the current class name
  121373. * @returns the class name
  121374. */
  121375. getClassName(): string;
  121376. /**
  121377. * Gets the rgba input component
  121378. */
  121379. readonly rgba: NodeMaterialConnectionPoint;
  121380. /**
  121381. * Gets the rgb input component
  121382. */
  121383. readonly rgb: NodeMaterialConnectionPoint;
  121384. /**
  121385. * Gets the a input component
  121386. */
  121387. readonly a: NodeMaterialConnectionPoint;
  121388. protected _buildBlock(state: NodeMaterialBuildState): this;
  121389. }
  121390. }
  121391. declare module BABYLON {
  121392. /**
  121393. * Block used to read a reflection texture from a sampler
  121394. */
  121395. export class ReflectionTextureBlock extends NodeMaterialBlock {
  121396. private _define3DName;
  121397. private _defineCubicName;
  121398. private _defineExplicitName;
  121399. private _defineProjectionName;
  121400. private _defineLocalCubicName;
  121401. private _defineSphericalName;
  121402. private _definePlanarName;
  121403. private _defineEquirectangularName;
  121404. private _defineMirroredEquirectangularFixedName;
  121405. private _defineEquirectangularFixedName;
  121406. private _defineSkyboxName;
  121407. private _cubeSamplerName;
  121408. private _2DSamplerName;
  121409. private _positionUVWName;
  121410. private _directionWName;
  121411. private _reflectionCoordsName;
  121412. private _reflection2DCoordsName;
  121413. private _reflectionColorName;
  121414. private _reflectionMatrixName;
  121415. /**
  121416. * Gets or sets the texture associated with the node
  121417. */
  121418. texture: Nullable<BaseTexture>;
  121419. /**
  121420. * Create a new TextureBlock
  121421. * @param name defines the block name
  121422. */
  121423. constructor(name: string);
  121424. /**
  121425. * Gets the current class name
  121426. * @returns the class name
  121427. */
  121428. getClassName(): string;
  121429. /**
  121430. * Gets the world position input component
  121431. */
  121432. readonly position: NodeMaterialConnectionPoint;
  121433. /**
  121434. * Gets the world position input component
  121435. */
  121436. readonly worldPosition: NodeMaterialConnectionPoint;
  121437. /**
  121438. * Gets the world normal input component
  121439. */
  121440. readonly worldNormal: NodeMaterialConnectionPoint;
  121441. /**
  121442. * Gets the world input component
  121443. */
  121444. readonly world: NodeMaterialConnectionPoint;
  121445. /**
  121446. * Gets the camera (or eye) position component
  121447. */
  121448. readonly cameraPosition: NodeMaterialConnectionPoint;
  121449. /**
  121450. * Gets the view input component
  121451. */
  121452. readonly view: NodeMaterialConnectionPoint;
  121453. /**
  121454. * Gets the rgb output component
  121455. */
  121456. readonly rgb: NodeMaterialConnectionPoint;
  121457. /**
  121458. * Gets the r output component
  121459. */
  121460. readonly r: NodeMaterialConnectionPoint;
  121461. /**
  121462. * Gets the g output component
  121463. */
  121464. readonly g: NodeMaterialConnectionPoint;
  121465. /**
  121466. * Gets the b output component
  121467. */
  121468. readonly b: NodeMaterialConnectionPoint;
  121469. autoConfigure(material: NodeMaterial): void;
  121470. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  121471. isReady(): boolean;
  121472. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  121473. private _injectVertexCode;
  121474. private _writeOutput;
  121475. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  121476. protected _dumpPropertiesCode(): string;
  121477. serialize(): any;
  121478. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121479. }
  121480. }
  121481. declare module BABYLON {
  121482. /**
  121483. * Interface used to configure the node material editor
  121484. */
  121485. export interface INodeMaterialEditorOptions {
  121486. /** Define the URl to load node editor script */
  121487. editorURL?: string;
  121488. }
  121489. /** @hidden */
  121490. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  121491. /** BONES */
  121492. NUM_BONE_INFLUENCERS: number;
  121493. BonesPerMesh: number;
  121494. BONETEXTURE: boolean;
  121495. /** MORPH TARGETS */
  121496. MORPHTARGETS: boolean;
  121497. MORPHTARGETS_NORMAL: boolean;
  121498. MORPHTARGETS_TANGENT: boolean;
  121499. MORPHTARGETS_UV: boolean;
  121500. NUM_MORPH_INFLUENCERS: number;
  121501. /** IMAGE PROCESSING */
  121502. IMAGEPROCESSING: boolean;
  121503. VIGNETTE: boolean;
  121504. VIGNETTEBLENDMODEMULTIPLY: boolean;
  121505. VIGNETTEBLENDMODEOPAQUE: boolean;
  121506. TONEMAPPING: boolean;
  121507. TONEMAPPING_ACES: boolean;
  121508. CONTRAST: boolean;
  121509. EXPOSURE: boolean;
  121510. COLORCURVES: boolean;
  121511. COLORGRADING: boolean;
  121512. COLORGRADING3D: boolean;
  121513. SAMPLER3DGREENDEPTH: boolean;
  121514. SAMPLER3DBGRMAP: boolean;
  121515. IMAGEPROCESSINGPOSTPROCESS: boolean;
  121516. /** MISC. */
  121517. BUMPDIRECTUV: number;
  121518. constructor();
  121519. setValue(name: string, value: boolean): void;
  121520. }
  121521. /**
  121522. * Class used to configure NodeMaterial
  121523. */
  121524. export interface INodeMaterialOptions {
  121525. /**
  121526. * Defines if blocks should emit comments
  121527. */
  121528. emitComments: boolean;
  121529. }
  121530. /**
  121531. * Class used to create a node based material built by assembling shader blocks
  121532. */
  121533. export class NodeMaterial extends PushMaterial {
  121534. private static _BuildIdGenerator;
  121535. private _options;
  121536. private _vertexCompilationState;
  121537. private _fragmentCompilationState;
  121538. private _sharedData;
  121539. private _buildId;
  121540. private _buildWasSuccessful;
  121541. private _cachedWorldViewMatrix;
  121542. private _cachedWorldViewProjectionMatrix;
  121543. private _optimizers;
  121544. private _animationFrame;
  121545. /** Define the URl to load node editor script */
  121546. static EditorURL: string;
  121547. private BJSNODEMATERIALEDITOR;
  121548. /** Get the inspector from bundle or global */
  121549. private _getGlobalNodeMaterialEditor;
  121550. /**
  121551. * Gets or sets a boolean indicating that alpha value must be ignored (This will turn alpha blending off even if an alpha value is produced by the material)
  121552. */
  121553. ignoreAlpha: boolean;
  121554. /**
  121555. * Defines the maximum number of lights that can be used in the material
  121556. */
  121557. maxSimultaneousLights: number;
  121558. /**
  121559. * Observable raised when the material is built
  121560. */
  121561. onBuildObservable: Observable<NodeMaterial>;
  121562. /**
  121563. * Gets or sets the root nodes of the material vertex shader
  121564. */
  121565. _vertexOutputNodes: NodeMaterialBlock[];
  121566. /**
  121567. * Gets or sets the root nodes of the material fragment (pixel) shader
  121568. */
  121569. _fragmentOutputNodes: NodeMaterialBlock[];
  121570. /** Gets or sets options to control the node material overall behavior */
  121571. options: INodeMaterialOptions;
  121572. /**
  121573. * Default configuration related to image processing available in the standard Material.
  121574. */
  121575. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  121576. /**
  121577. * Gets the image processing configuration used either in this material.
  121578. */
  121579. /**
  121580. * Sets the Default image processing configuration used either in the this material.
  121581. *
  121582. * If sets to null, the scene one is in use.
  121583. */
  121584. imageProcessingConfiguration: ImageProcessingConfiguration;
  121585. /**
  121586. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  121587. */
  121588. attachedBlocks: NodeMaterialBlock[];
  121589. /**
  121590. * Create a new node based material
  121591. * @param name defines the material name
  121592. * @param scene defines the hosting scene
  121593. * @param options defines creation option
  121594. */
  121595. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  121596. /**
  121597. * Gets the current class name of the material e.g. "NodeMaterial"
  121598. * @returns the class name
  121599. */
  121600. getClassName(): string;
  121601. /**
  121602. * Keep track of the image processing observer to allow dispose and replace.
  121603. */
  121604. private _imageProcessingObserver;
  121605. /**
  121606. * Attaches a new image processing configuration to the Standard Material.
  121607. * @param configuration
  121608. */
  121609. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  121610. /**
  121611. * Get a block by its name
  121612. * @param name defines the name of the block to retrieve
  121613. * @returns the required block or null if not found
  121614. */
  121615. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  121616. /**
  121617. * Get a block by its name
  121618. * @param predicate defines the predicate used to find the good candidate
  121619. * @returns the required block or null if not found
  121620. */
  121621. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  121622. /**
  121623. * Get an input block by its name
  121624. * @param predicate defines the predicate used to find the good candidate
  121625. * @returns the required input block or null if not found
  121626. */
  121627. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  121628. /**
  121629. * Gets the list of input blocks attached to this material
  121630. * @returns an array of InputBlocks
  121631. */
  121632. getInputBlocks(): InputBlock[];
  121633. /**
  121634. * Adds a new optimizer to the list of optimizers
  121635. * @param optimizer defines the optimizers to add
  121636. * @returns the current material
  121637. */
  121638. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  121639. /**
  121640. * Remove an optimizer from the list of optimizers
  121641. * @param optimizer defines the optimizers to remove
  121642. * @returns the current material
  121643. */
  121644. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  121645. /**
  121646. * Add a new block to the list of output nodes
  121647. * @param node defines the node to add
  121648. * @returns the current material
  121649. */
  121650. addOutputNode(node: NodeMaterialBlock): this;
  121651. /**
  121652. * Remove a block from the list of root nodes
  121653. * @param node defines the node to remove
  121654. * @returns the current material
  121655. */
  121656. removeOutputNode(node: NodeMaterialBlock): this;
  121657. private _addVertexOutputNode;
  121658. private _removeVertexOutputNode;
  121659. private _addFragmentOutputNode;
  121660. private _removeFragmentOutputNode;
  121661. /**
  121662. * Specifies if the material will require alpha blending
  121663. * @returns a boolean specifying if alpha blending is needed
  121664. */
  121665. needAlphaBlending(): boolean;
  121666. /**
  121667. * Specifies if this material should be rendered in alpha test mode
  121668. * @returns a boolean specifying if an alpha test is needed.
  121669. */
  121670. needAlphaTesting(): boolean;
  121671. private _initializeBlock;
  121672. private _resetDualBlocks;
  121673. /**
  121674. * Build the material and generates the inner effect
  121675. * @param verbose defines if the build should log activity
  121676. */
  121677. build(verbose?: boolean): void;
  121678. /**
  121679. * Runs an otpimization phase to try to improve the shader code
  121680. */
  121681. optimize(): void;
  121682. private _prepareDefinesForAttributes;
  121683. /**
  121684. * Get if the submesh is ready to be used and all its information available.
  121685. * Child classes can use it to update shaders
  121686. * @param mesh defines the mesh to check
  121687. * @param subMesh defines which submesh to check
  121688. * @param useInstances specifies that instances should be used
  121689. * @returns a boolean indicating that the submesh is ready or not
  121690. */
  121691. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  121692. /**
  121693. * Get a string representing the shaders built by the current node graph
  121694. */
  121695. readonly compiledShaders: string;
  121696. /**
  121697. * Binds the world matrix to the material
  121698. * @param world defines the world transformation matrix
  121699. */
  121700. bindOnlyWorldMatrix(world: Matrix): void;
  121701. /**
  121702. * Binds the submesh to this material by preparing the effect and shader to draw
  121703. * @param world defines the world transformation matrix
  121704. * @param mesh defines the mesh containing the submesh
  121705. * @param subMesh defines the submesh to bind the material to
  121706. */
  121707. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  121708. /**
  121709. * Gets the active textures from the material
  121710. * @returns an array of textures
  121711. */
  121712. getActiveTextures(): BaseTexture[];
  121713. /**
  121714. * Gets the list of texture blocks
  121715. * @returns an array of texture blocks
  121716. */
  121717. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  121718. /**
  121719. * Specifies if the material uses a texture
  121720. * @param texture defines the texture to check against the material
  121721. * @returns a boolean specifying if the material uses the texture
  121722. */
  121723. hasTexture(texture: BaseTexture): boolean;
  121724. /**
  121725. * Disposes the material
  121726. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  121727. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  121728. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  121729. */
  121730. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  121731. /** Creates the node editor window. */
  121732. private _createNodeEditor;
  121733. /**
  121734. * Launch the node material editor
  121735. * @param config Define the configuration of the editor
  121736. * @return a promise fulfilled when the node editor is visible
  121737. */
  121738. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  121739. /**
  121740. * Clear the current material
  121741. */
  121742. clear(): void;
  121743. /**
  121744. * Clear the current material and set it to a default state
  121745. */
  121746. setToDefault(): void;
  121747. /**
  121748. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  121749. * @param url defines the url to load from
  121750. * @returns a promise that will fullfil when the material is fully loaded
  121751. */
  121752. loadAsync(url: string): Promise<void>;
  121753. private _gatherBlocks;
  121754. /**
  121755. * Generate a string containing the code declaration required to create an equivalent of this material
  121756. * @returns a string
  121757. */
  121758. generateCode(): string;
  121759. /**
  121760. * Serializes this material in a JSON representation
  121761. * @returns the serialized material object
  121762. */
  121763. serialize(): any;
  121764. private _restoreConnections;
  121765. /**
  121766. * Clear the current graph and load a new one from a serialization object
  121767. * @param source defines the JSON representation of the material
  121768. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  121769. */
  121770. loadFromSerialization(source: any, rootUrl?: string): void;
  121771. /**
  121772. * Creates a node material from parsed material data
  121773. * @param source defines the JSON representation of the material
  121774. * @param scene defines the hosting scene
  121775. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  121776. * @returns a new node material
  121777. */
  121778. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  121779. /**
  121780. * Creates a new node material set to default basic configuration
  121781. * @param name defines the name of the material
  121782. * @param scene defines the hosting scene
  121783. * @returns a new NodeMaterial
  121784. */
  121785. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  121786. }
  121787. }
  121788. declare module BABYLON {
  121789. /**
  121790. * Block used to read a texture from a sampler
  121791. */
  121792. export class TextureBlock extends NodeMaterialBlock {
  121793. private _defineName;
  121794. private _linearDefineName;
  121795. private _samplerName;
  121796. private _transformedUVName;
  121797. private _textureTransformName;
  121798. private _textureInfoName;
  121799. private _mainUVName;
  121800. private _mainUVDefineName;
  121801. /**
  121802. * Gets or sets the texture associated with the node
  121803. */
  121804. texture: Nullable<Texture>;
  121805. /**
  121806. * Create a new TextureBlock
  121807. * @param name defines the block name
  121808. */
  121809. constructor(name: string);
  121810. /**
  121811. * Gets the current class name
  121812. * @returns the class name
  121813. */
  121814. getClassName(): string;
  121815. /**
  121816. * Gets the uv input component
  121817. */
  121818. readonly uv: NodeMaterialConnectionPoint;
  121819. /**
  121820. * Gets the rgba output component
  121821. */
  121822. readonly rgba: NodeMaterialConnectionPoint;
  121823. /**
  121824. * Gets the rgb output component
  121825. */
  121826. readonly rgb: NodeMaterialConnectionPoint;
  121827. /**
  121828. * Gets the r output component
  121829. */
  121830. readonly r: NodeMaterialConnectionPoint;
  121831. /**
  121832. * Gets the g output component
  121833. */
  121834. readonly g: NodeMaterialConnectionPoint;
  121835. /**
  121836. * Gets the b output component
  121837. */
  121838. readonly b: NodeMaterialConnectionPoint;
  121839. /**
  121840. * Gets the a output component
  121841. */
  121842. readonly a: NodeMaterialConnectionPoint;
  121843. readonly target: NodeMaterialBlockTargets;
  121844. autoConfigure(material: NodeMaterial): void;
  121845. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  121846. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  121847. isReady(): boolean;
  121848. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  121849. private readonly _isMixed;
  121850. private _injectVertexCode;
  121851. private _writeOutput;
  121852. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  121853. protected _dumpPropertiesCode(): string;
  121854. serialize(): any;
  121855. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121856. }
  121857. }
  121858. declare module BABYLON {
  121859. /**
  121860. * Class used to store shared data between 2 NodeMaterialBuildState
  121861. */
  121862. export class NodeMaterialBuildStateSharedData {
  121863. /**
  121864. * Gets the list of emitted varyings
  121865. */
  121866. temps: string[];
  121867. /**
  121868. * Gets the list of emitted varyings
  121869. */
  121870. varyings: string[];
  121871. /**
  121872. * Gets the varying declaration string
  121873. */
  121874. varyingDeclaration: string;
  121875. /**
  121876. * Input blocks
  121877. */
  121878. inputBlocks: InputBlock[];
  121879. /**
  121880. * Input blocks
  121881. */
  121882. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  121883. /**
  121884. * Bindable blocks (Blocks that need to set data to the effect)
  121885. */
  121886. bindableBlocks: NodeMaterialBlock[];
  121887. /**
  121888. * List of blocks that can provide a compilation fallback
  121889. */
  121890. blocksWithFallbacks: NodeMaterialBlock[];
  121891. /**
  121892. * List of blocks that can provide a define update
  121893. */
  121894. blocksWithDefines: NodeMaterialBlock[];
  121895. /**
  121896. * List of blocks that can provide a repeatable content
  121897. */
  121898. repeatableContentBlocks: NodeMaterialBlock[];
  121899. /**
  121900. * List of blocks that can provide a dynamic list of uniforms
  121901. */
  121902. dynamicUniformBlocks: NodeMaterialBlock[];
  121903. /**
  121904. * List of blocks that can block the isReady function for the material
  121905. */
  121906. blockingBlocks: NodeMaterialBlock[];
  121907. /**
  121908. * Gets the list of animated inputs
  121909. */
  121910. animatedInputs: InputBlock[];
  121911. /**
  121912. * Build Id used to avoid multiple recompilations
  121913. */
  121914. buildId: number;
  121915. /** List of emitted variables */
  121916. variableNames: {
  121917. [key: string]: number;
  121918. };
  121919. /** List of emitted defines */
  121920. defineNames: {
  121921. [key: string]: number;
  121922. };
  121923. /** Should emit comments? */
  121924. emitComments: boolean;
  121925. /** Emit build activity */
  121926. verbose: boolean;
  121927. /** Gets or sets the hosting scene */
  121928. scene: Scene;
  121929. /**
  121930. * Gets the compilation hints emitted at compilation time
  121931. */
  121932. hints: {
  121933. needWorldViewMatrix: boolean;
  121934. needWorldViewProjectionMatrix: boolean;
  121935. needAlphaBlending: boolean;
  121936. needAlphaTesting: boolean;
  121937. };
  121938. /**
  121939. * List of compilation checks
  121940. */
  121941. checks: {
  121942. emitVertex: boolean;
  121943. emitFragment: boolean;
  121944. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  121945. };
  121946. /** Creates a new shared data */
  121947. constructor();
  121948. /**
  121949. * Emits console errors and exceptions if there is a failing check
  121950. */
  121951. emitErrors(): void;
  121952. }
  121953. }
  121954. declare module BABYLON {
  121955. /**
  121956. * Class used to store node based material build state
  121957. */
  121958. export class NodeMaterialBuildState {
  121959. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  121960. supportUniformBuffers: boolean;
  121961. /**
  121962. * Gets the list of emitted attributes
  121963. */
  121964. attributes: string[];
  121965. /**
  121966. * Gets the list of emitted uniforms
  121967. */
  121968. uniforms: string[];
  121969. /**
  121970. * Gets the list of emitted constants
  121971. */
  121972. constants: string[];
  121973. /**
  121974. * Gets the list of emitted samplers
  121975. */
  121976. samplers: string[];
  121977. /**
  121978. * Gets the list of emitted functions
  121979. */
  121980. functions: {
  121981. [key: string]: string;
  121982. };
  121983. /**
  121984. * Gets the list of emitted extensions
  121985. */
  121986. extensions: {
  121987. [key: string]: string;
  121988. };
  121989. /**
  121990. * Gets the target of the compilation state
  121991. */
  121992. target: NodeMaterialBlockTargets;
  121993. /**
  121994. * Gets the list of emitted counters
  121995. */
  121996. counters: {
  121997. [key: string]: number;
  121998. };
  121999. /**
  122000. * Shared data between multiple NodeMaterialBuildState instances
  122001. */
  122002. sharedData: NodeMaterialBuildStateSharedData;
  122003. /** @hidden */
  122004. _vertexState: NodeMaterialBuildState;
  122005. /** @hidden */
  122006. _attributeDeclaration: string;
  122007. /** @hidden */
  122008. _uniformDeclaration: string;
  122009. /** @hidden */
  122010. _constantDeclaration: string;
  122011. /** @hidden */
  122012. _samplerDeclaration: string;
  122013. /** @hidden */
  122014. _varyingTransfer: string;
  122015. private _repeatableContentAnchorIndex;
  122016. /** @hidden */
  122017. _builtCompilationString: string;
  122018. /**
  122019. * Gets the emitted compilation strings
  122020. */
  122021. compilationString: string;
  122022. /**
  122023. * Finalize the compilation strings
  122024. * @param state defines the current compilation state
  122025. */
  122026. finalize(state: NodeMaterialBuildState): void;
  122027. /** @hidden */
  122028. readonly _repeatableContentAnchor: string;
  122029. /** @hidden */
  122030. _getFreeVariableName(prefix: string): string;
  122031. /** @hidden */
  122032. _getFreeDefineName(prefix: string): string;
  122033. /** @hidden */
  122034. _excludeVariableName(name: string): void;
  122035. /** @hidden */
  122036. _emit2DSampler(name: string): void;
  122037. /** @hidden */
  122038. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  122039. /** @hidden */
  122040. _emitExtension(name: string, extension: string): void;
  122041. /** @hidden */
  122042. _emitFunction(name: string, code: string, comments: string): void;
  122043. /** @hidden */
  122044. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  122045. replaceStrings?: {
  122046. search: RegExp;
  122047. replace: string;
  122048. }[];
  122049. repeatKey?: string;
  122050. }): string;
  122051. /** @hidden */
  122052. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  122053. repeatKey?: string;
  122054. removeAttributes?: boolean;
  122055. removeUniforms?: boolean;
  122056. removeVaryings?: boolean;
  122057. removeIfDef?: boolean;
  122058. replaceStrings?: {
  122059. search: RegExp;
  122060. replace: string;
  122061. }[];
  122062. }, storeKey?: string): void;
  122063. /** @hidden */
  122064. _registerTempVariable(name: string): boolean;
  122065. /** @hidden */
  122066. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  122067. /** @hidden */
  122068. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  122069. /** @hidden */
  122070. _emitFloat(value: number): string;
  122071. }
  122072. }
  122073. declare module BABYLON {
  122074. /**
  122075. * Defines a block that can be used inside a node based material
  122076. */
  122077. export class NodeMaterialBlock {
  122078. private _buildId;
  122079. private _buildTarget;
  122080. private _target;
  122081. private _isFinalMerger;
  122082. private _isInput;
  122083. protected _isUnique: boolean;
  122084. /** @hidden */
  122085. _codeVariableName: string;
  122086. /** @hidden */
  122087. _inputs: NodeMaterialConnectionPoint[];
  122088. /** @hidden */
  122089. _outputs: NodeMaterialConnectionPoint[];
  122090. /** @hidden */
  122091. _preparationId: number;
  122092. /**
  122093. * Gets or sets the name of the block
  122094. */
  122095. name: string;
  122096. /**
  122097. * Gets or sets the unique id of the node
  122098. */
  122099. uniqueId: number;
  122100. /**
  122101. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  122102. */
  122103. readonly isUnique: boolean;
  122104. /**
  122105. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  122106. */
  122107. readonly isFinalMerger: boolean;
  122108. /**
  122109. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  122110. */
  122111. readonly isInput: boolean;
  122112. /**
  122113. * Gets or sets the build Id
  122114. */
  122115. buildId: number;
  122116. /**
  122117. * Gets or sets the target of the block
  122118. */
  122119. target: NodeMaterialBlockTargets;
  122120. /**
  122121. * Gets the list of input points
  122122. */
  122123. readonly inputs: NodeMaterialConnectionPoint[];
  122124. /** Gets the list of output points */
  122125. readonly outputs: NodeMaterialConnectionPoint[];
  122126. /**
  122127. * Find an input by its name
  122128. * @param name defines the name of the input to look for
  122129. * @returns the input or null if not found
  122130. */
  122131. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  122132. /**
  122133. * Find an output by its name
  122134. * @param name defines the name of the outputto look for
  122135. * @returns the output or null if not found
  122136. */
  122137. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  122138. /**
  122139. * Creates a new NodeMaterialBlock
  122140. * @param name defines the block name
  122141. * @param target defines the target of that block (Vertex by default)
  122142. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  122143. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  122144. */
  122145. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  122146. /**
  122147. * Initialize the block and prepare the context for build
  122148. * @param state defines the state that will be used for the build
  122149. */
  122150. initialize(state: NodeMaterialBuildState): void;
  122151. /**
  122152. * Bind data to effect. Will only be called for blocks with isBindable === true
  122153. * @param effect defines the effect to bind data to
  122154. * @param nodeMaterial defines the hosting NodeMaterial
  122155. * @param mesh defines the mesh that will be rendered
  122156. */
  122157. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122158. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  122159. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  122160. protected _writeFloat(value: number): string;
  122161. /**
  122162. * Gets the current class name e.g. "NodeMaterialBlock"
  122163. * @returns the class name
  122164. */
  122165. getClassName(): string;
  122166. /**
  122167. * Register a new input. Must be called inside a block constructor
  122168. * @param name defines the connection point name
  122169. * @param type defines the connection point type
  122170. * @param isOptional defines a boolean indicating that this input can be omitted
  122171. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  122172. * @returns the current block
  122173. */
  122174. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  122175. /**
  122176. * Register a new output. Must be called inside a block constructor
  122177. * @param name defines the connection point name
  122178. * @param type defines the connection point type
  122179. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  122180. * @returns the current block
  122181. */
  122182. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  122183. /**
  122184. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  122185. * @param forOutput defines an optional connection point to check compatibility with
  122186. * @returns the first available input or null
  122187. */
  122188. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  122189. /**
  122190. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  122191. * @param forBlock defines an optional block to check compatibility with
  122192. * @returns the first available input or null
  122193. */
  122194. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  122195. /**
  122196. * Gets the sibling of the given output
  122197. * @param current defines the current output
  122198. * @returns the next output in the list or null
  122199. */
  122200. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  122201. /**
  122202. * Connect current block with another block
  122203. * @param other defines the block to connect with
  122204. * @param options define the various options to help pick the right connections
  122205. * @returns the current block
  122206. */
  122207. connectTo(other: NodeMaterialBlock, options?: {
  122208. input?: string;
  122209. output?: string;
  122210. outputSwizzle?: string;
  122211. }): this | undefined;
  122212. protected _buildBlock(state: NodeMaterialBuildState): void;
  122213. /**
  122214. * Add uniforms, samplers and uniform buffers at compilation time
  122215. * @param state defines the state to update
  122216. * @param nodeMaterial defines the node material requesting the update
  122217. * @param defines defines the material defines to update
  122218. * @param uniformBuffers defines the list of uniform buffer names
  122219. */
  122220. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  122221. /**
  122222. * Add potential fallbacks if shader compilation fails
  122223. * @param mesh defines the mesh to be rendered
  122224. * @param fallbacks defines the current prioritized list of fallbacks
  122225. */
  122226. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  122227. /**
  122228. * Initialize defines for shader compilation
  122229. * @param mesh defines the mesh to be rendered
  122230. * @param nodeMaterial defines the node material requesting the update
  122231. * @param defines defines the material defines to update
  122232. * @param useInstances specifies that instances should be used
  122233. */
  122234. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  122235. /**
  122236. * Update defines for shader compilation
  122237. * @param mesh defines the mesh to be rendered
  122238. * @param nodeMaterial defines the node material requesting the update
  122239. * @param defines defines the material defines to update
  122240. * @param useInstances specifies that instances should be used
  122241. */
  122242. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  122243. /**
  122244. * Lets the block try to connect some inputs automatically
  122245. * @param material defines the hosting NodeMaterial
  122246. */
  122247. autoConfigure(material: NodeMaterial): void;
  122248. /**
  122249. * Function called when a block is declared as repeatable content generator
  122250. * @param vertexShaderState defines the current compilation state for the vertex shader
  122251. * @param fragmentShaderState defines the current compilation state for the fragment shader
  122252. * @param mesh defines the mesh to be rendered
  122253. * @param defines defines the material defines to update
  122254. */
  122255. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  122256. /**
  122257. * Checks if the block is ready
  122258. * @param mesh defines the mesh to be rendered
  122259. * @param nodeMaterial defines the node material requesting the update
  122260. * @param defines defines the material defines to update
  122261. * @param useInstances specifies that instances should be used
  122262. * @returns true if the block is ready
  122263. */
  122264. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  122265. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  122266. private _processBuild;
  122267. /**
  122268. * Compile the current node and generate the shader code
  122269. * @param state defines the current compilation state (uniforms, samplers, current string)
  122270. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  122271. * @returns true if already built
  122272. */
  122273. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  122274. protected _inputRename(name: string): string;
  122275. protected _outputRename(name: string): string;
  122276. protected _dumpPropertiesCode(): string;
  122277. /** @hidden */
  122278. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  122279. /** @hidden */
  122280. _dumpCodeForOutputConnections(): string;
  122281. /**
  122282. * Clone the current block to a new identical block
  122283. * @param scene defines the hosting scene
  122284. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  122285. * @returns a copy of the current block
  122286. */
  122287. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  122288. /**
  122289. * Serializes this block in a JSON representation
  122290. * @returns the serialized block object
  122291. */
  122292. serialize(): any;
  122293. /** @hidden */
  122294. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122295. /**
  122296. * Release resources
  122297. */
  122298. dispose(): void;
  122299. }
  122300. }
  122301. declare module BABYLON {
  122302. /**
  122303. * Enum defining the type of animations supported by InputBlock
  122304. */
  122305. export enum AnimatedInputBlockTypes {
  122306. /** No animation */
  122307. None = 0,
  122308. /** Time based animation. Will only work for floats */
  122309. Time = 1
  122310. }
  122311. }
  122312. declare module BABYLON {
  122313. /**
  122314. * Block used to expose an input value
  122315. */
  122316. export class InputBlock extends NodeMaterialBlock {
  122317. private _mode;
  122318. private _associatedVariableName;
  122319. private _storedValue;
  122320. private _valueCallback;
  122321. private _type;
  122322. private _animationType;
  122323. /** Gets or set a value used to limit the range of float values */
  122324. min: number;
  122325. /** Gets or set a value used to limit the range of float values */
  122326. max: number;
  122327. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  122328. matrixMode: number;
  122329. /** @hidden */
  122330. _systemValue: Nullable<NodeMaterialSystemValues>;
  122331. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  122332. visibleInInspector: boolean;
  122333. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  122334. isConstant: boolean;
  122335. /**
  122336. * Gets or sets the connection point type (default is float)
  122337. */
  122338. readonly type: NodeMaterialBlockConnectionPointTypes;
  122339. /**
  122340. * Creates a new InputBlock
  122341. * @param name defines the block name
  122342. * @param target defines the target of that block (Vertex by default)
  122343. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  122344. */
  122345. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  122346. /**
  122347. * Gets the output component
  122348. */
  122349. readonly output: NodeMaterialConnectionPoint;
  122350. /**
  122351. * Set the source of this connection point to a vertex attribute
  122352. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  122353. * @returns the current connection point
  122354. */
  122355. setAsAttribute(attributeName?: string): InputBlock;
  122356. /**
  122357. * Set the source of this connection point to a system value
  122358. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  122359. * @returns the current connection point
  122360. */
  122361. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  122362. /**
  122363. * Gets or sets the value of that point.
  122364. * Please note that this value will be ignored if valueCallback is defined
  122365. */
  122366. value: any;
  122367. /**
  122368. * Gets or sets a callback used to get the value of that point.
  122369. * Please note that setting this value will force the connection point to ignore the value property
  122370. */
  122371. valueCallback: () => any;
  122372. /**
  122373. * Gets or sets the associated variable name in the shader
  122374. */
  122375. associatedVariableName: string;
  122376. /** Gets or sets the type of animation applied to the input */
  122377. animationType: AnimatedInputBlockTypes;
  122378. /**
  122379. * Gets a boolean indicating that this connection point not defined yet
  122380. */
  122381. readonly isUndefined: boolean;
  122382. /**
  122383. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  122384. * In this case the connection point name must be the name of the uniform to use.
  122385. * Can only be set on inputs
  122386. */
  122387. isUniform: boolean;
  122388. /**
  122389. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  122390. * In this case the connection point name must be the name of the attribute to use
  122391. * Can only be set on inputs
  122392. */
  122393. isAttribute: boolean;
  122394. /**
  122395. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  122396. * Can only be set on exit points
  122397. */
  122398. isVarying: boolean;
  122399. /**
  122400. * Gets a boolean indicating that the current connection point is a system value
  122401. */
  122402. readonly isSystemValue: boolean;
  122403. /**
  122404. * Gets or sets the current well known value or null if not defined as a system value
  122405. */
  122406. systemValue: Nullable<NodeMaterialSystemValues>;
  122407. /**
  122408. * Gets the current class name
  122409. * @returns the class name
  122410. */
  122411. getClassName(): string;
  122412. /**
  122413. * Animate the input if animationType !== None
  122414. * @param scene defines the rendering scene
  122415. */
  122416. animate(scene: Scene): void;
  122417. private _emitDefine;
  122418. initialize(state: NodeMaterialBuildState): void;
  122419. /**
  122420. * Set the input block to its default value (based on its type)
  122421. */
  122422. setDefaultValue(): void;
  122423. private _emitConstant;
  122424. private _emit;
  122425. /** @hidden */
  122426. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  122427. /** @hidden */
  122428. _transmit(effect: Effect, scene: Scene): void;
  122429. protected _buildBlock(state: NodeMaterialBuildState): void;
  122430. protected _dumpPropertiesCode(): string;
  122431. serialize(): any;
  122432. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122433. }
  122434. }
  122435. declare module BABYLON {
  122436. /**
  122437. * Enum used to define the compatibility state between two connection points
  122438. */
  122439. export enum NodeMaterialConnectionPointCompatibilityStates {
  122440. /** Points are compatibles */
  122441. Compatible = 0,
  122442. /** Points are incompatible because of their types */
  122443. TypeIncompatible = 1,
  122444. /** Points are incompatible because of their targets (vertex vs fragment) */
  122445. TargetIncompatible = 2
  122446. }
  122447. /**
  122448. * Defines a connection point for a block
  122449. */
  122450. export class NodeMaterialConnectionPoint {
  122451. /** @hidden */
  122452. _ownerBlock: NodeMaterialBlock;
  122453. /** @hidden */
  122454. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  122455. private _endpoints;
  122456. private _associatedVariableName;
  122457. /** @hidden */
  122458. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  122459. /** @hidden */
  122460. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  122461. private _type;
  122462. /** @hidden */
  122463. _enforceAssociatedVariableName: boolean;
  122464. /**
  122465. * Gets or sets the additional types supported by this connection point
  122466. */
  122467. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  122468. /**
  122469. * Gets or sets the additional types excluded by this connection point
  122470. */
  122471. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  122472. /**
  122473. * Observable triggered when this point is connected
  122474. */
  122475. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  122476. /**
  122477. * Gets or sets the associated variable name in the shader
  122478. */
  122479. associatedVariableName: string;
  122480. /**
  122481. * Gets or sets the connection point type (default is float)
  122482. */
  122483. type: NodeMaterialBlockConnectionPointTypes;
  122484. /**
  122485. * Gets or sets the connection point name
  122486. */
  122487. name: string;
  122488. /**
  122489. * Gets or sets a boolean indicating that this connection point can be omitted
  122490. */
  122491. isOptional: boolean;
  122492. /**
  122493. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  122494. */
  122495. define: string;
  122496. /** @hidden */
  122497. _prioritizeVertex: boolean;
  122498. private _target;
  122499. /** Gets or sets the target of that connection point */
  122500. target: NodeMaterialBlockTargets;
  122501. /**
  122502. * Gets a boolean indicating that the current point is connected
  122503. */
  122504. readonly isConnected: boolean;
  122505. /**
  122506. * Gets a boolean indicating that the current point is connected to an input block
  122507. */
  122508. readonly isConnectedToInputBlock: boolean;
  122509. /**
  122510. * Gets a the connected input block (if any)
  122511. */
  122512. readonly connectInputBlock: Nullable<InputBlock>;
  122513. /** Get the other side of the connection (if any) */
  122514. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  122515. /** Get the block that owns this connection point */
  122516. readonly ownerBlock: NodeMaterialBlock;
  122517. /** Get the block connected on the other side of this connection (if any) */
  122518. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  122519. /** Get the block connected on the endpoints of this connection (if any) */
  122520. readonly connectedBlocks: Array<NodeMaterialBlock>;
  122521. /** Gets the list of connected endpoints */
  122522. readonly endpoints: NodeMaterialConnectionPoint[];
  122523. /** Gets a boolean indicating if that output point is connected to at least one input */
  122524. readonly hasEndpoints: boolean;
  122525. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  122526. readonly isConnectedInVertexShader: boolean;
  122527. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  122528. readonly isConnectedInFragmentShader: boolean;
  122529. /**
  122530. * Creates a new connection point
  122531. * @param name defines the connection point name
  122532. * @param ownerBlock defines the block hosting this connection point
  122533. */
  122534. constructor(name: string, ownerBlock: NodeMaterialBlock);
  122535. /**
  122536. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  122537. * @returns the class name
  122538. */
  122539. getClassName(): string;
  122540. /**
  122541. * Gets a boolean indicating if the current point can be connected to another point
  122542. * @param connectionPoint defines the other connection point
  122543. * @returns a boolean
  122544. */
  122545. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  122546. /**
  122547. * Gets a number indicating if the current point can be connected to another point
  122548. * @param connectionPoint defines the other connection point
  122549. * @returns a number defining the compatibility state
  122550. */
  122551. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  122552. /**
  122553. * Connect this point to another connection point
  122554. * @param connectionPoint defines the other connection point
  122555. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  122556. * @returns the current connection point
  122557. */
  122558. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  122559. /**
  122560. * Disconnect this point from one of his endpoint
  122561. * @param endpoint defines the other connection point
  122562. * @returns the current connection point
  122563. */
  122564. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  122565. /**
  122566. * Serializes this point in a JSON representation
  122567. * @returns the serialized point object
  122568. */
  122569. serialize(): any;
  122570. /**
  122571. * Release resources
  122572. */
  122573. dispose(): void;
  122574. }
  122575. }
  122576. declare module BABYLON {
  122577. /**
  122578. * Block used to add support for vertex skinning (bones)
  122579. */
  122580. export class BonesBlock extends NodeMaterialBlock {
  122581. /**
  122582. * Creates a new BonesBlock
  122583. * @param name defines the block name
  122584. */
  122585. constructor(name: string);
  122586. /**
  122587. * Initialize the block and prepare the context for build
  122588. * @param state defines the state that will be used for the build
  122589. */
  122590. initialize(state: NodeMaterialBuildState): void;
  122591. /**
  122592. * Gets the current class name
  122593. * @returns the class name
  122594. */
  122595. getClassName(): string;
  122596. /**
  122597. * Gets the matrix indices input component
  122598. */
  122599. readonly matricesIndices: NodeMaterialConnectionPoint;
  122600. /**
  122601. * Gets the matrix weights input component
  122602. */
  122603. readonly matricesWeights: NodeMaterialConnectionPoint;
  122604. /**
  122605. * Gets the extra matrix indices input component
  122606. */
  122607. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  122608. /**
  122609. * Gets the extra matrix weights input component
  122610. */
  122611. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  122612. /**
  122613. * Gets the world input component
  122614. */
  122615. readonly world: NodeMaterialConnectionPoint;
  122616. /**
  122617. * Gets the output component
  122618. */
  122619. readonly output: NodeMaterialConnectionPoint;
  122620. autoConfigure(material: NodeMaterial): void;
  122621. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  122622. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122623. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122624. protected _buildBlock(state: NodeMaterialBuildState): this;
  122625. }
  122626. }
  122627. declare module BABYLON {
  122628. /**
  122629. * Block used to add support for instances
  122630. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  122631. */
  122632. export class InstancesBlock extends NodeMaterialBlock {
  122633. /**
  122634. * Creates a new InstancesBlock
  122635. * @param name defines the block name
  122636. */
  122637. constructor(name: string);
  122638. /**
  122639. * Gets the current class name
  122640. * @returns the class name
  122641. */
  122642. getClassName(): string;
  122643. /**
  122644. * Gets the first world row input component
  122645. */
  122646. readonly world0: NodeMaterialConnectionPoint;
  122647. /**
  122648. * Gets the second world row input component
  122649. */
  122650. readonly world1: NodeMaterialConnectionPoint;
  122651. /**
  122652. * Gets the third world row input component
  122653. */
  122654. readonly world2: NodeMaterialConnectionPoint;
  122655. /**
  122656. * Gets the forth world row input component
  122657. */
  122658. readonly world3: NodeMaterialConnectionPoint;
  122659. /**
  122660. * Gets the world input component
  122661. */
  122662. readonly world: NodeMaterialConnectionPoint;
  122663. /**
  122664. * Gets the output component
  122665. */
  122666. readonly output: NodeMaterialConnectionPoint;
  122667. autoConfigure(material: NodeMaterial): void;
  122668. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  122669. protected _buildBlock(state: NodeMaterialBuildState): this;
  122670. }
  122671. }
  122672. declare module BABYLON {
  122673. /**
  122674. * Block used to add morph targets support to vertex shader
  122675. */
  122676. export class MorphTargetsBlock extends NodeMaterialBlock {
  122677. private _repeatableContentAnchor;
  122678. private _repeatebleContentGenerated;
  122679. /**
  122680. * Create a new MorphTargetsBlock
  122681. * @param name defines the block name
  122682. */
  122683. constructor(name: string);
  122684. /**
  122685. * Gets the current class name
  122686. * @returns the class name
  122687. */
  122688. getClassName(): string;
  122689. /**
  122690. * Gets the position input component
  122691. */
  122692. readonly position: NodeMaterialConnectionPoint;
  122693. /**
  122694. * Gets the normal input component
  122695. */
  122696. readonly normal: NodeMaterialConnectionPoint;
  122697. /**
  122698. * Gets the tangent input component
  122699. */
  122700. readonly tangent: NodeMaterialConnectionPoint;
  122701. /**
  122702. * Gets the tangent input component
  122703. */
  122704. readonly uv: NodeMaterialConnectionPoint;
  122705. /**
  122706. * Gets the position output component
  122707. */
  122708. readonly positionOutput: NodeMaterialConnectionPoint;
  122709. /**
  122710. * Gets the normal output component
  122711. */
  122712. readonly normalOutput: NodeMaterialConnectionPoint;
  122713. /**
  122714. * Gets the tangent output component
  122715. */
  122716. readonly tangentOutput: NodeMaterialConnectionPoint;
  122717. /**
  122718. * Gets the tangent output component
  122719. */
  122720. readonly uvOutput: NodeMaterialConnectionPoint;
  122721. initialize(state: NodeMaterialBuildState): void;
  122722. autoConfigure(material: NodeMaterial): void;
  122723. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122724. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122725. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  122726. protected _buildBlock(state: NodeMaterialBuildState): this;
  122727. }
  122728. }
  122729. declare module BABYLON {
  122730. /**
  122731. * Block used to get data information from a light
  122732. */
  122733. export class LightInformationBlock extends NodeMaterialBlock {
  122734. private _lightDataUniformName;
  122735. private _lightColorUniformName;
  122736. private _lightTypeDefineName;
  122737. /**
  122738. * Gets or sets the light associated with this block
  122739. */
  122740. light: Nullable<Light>;
  122741. /**
  122742. * Creates a new LightInformationBlock
  122743. * @param name defines the block name
  122744. */
  122745. constructor(name: string);
  122746. /**
  122747. * Gets the current class name
  122748. * @returns the class name
  122749. */
  122750. getClassName(): string;
  122751. /**
  122752. * Gets the world position input component
  122753. */
  122754. readonly worldPosition: NodeMaterialConnectionPoint;
  122755. /**
  122756. * Gets the direction output component
  122757. */
  122758. readonly direction: NodeMaterialConnectionPoint;
  122759. /**
  122760. * Gets the direction output component
  122761. */
  122762. readonly color: NodeMaterialConnectionPoint;
  122763. /**
  122764. * Gets the direction output component
  122765. */
  122766. readonly intensity: NodeMaterialConnectionPoint;
  122767. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122768. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122769. protected _buildBlock(state: NodeMaterialBuildState): this;
  122770. serialize(): any;
  122771. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122772. }
  122773. }
  122774. declare module BABYLON {
  122775. /**
  122776. * Block used to add image processing support to fragment shader
  122777. */
  122778. export class ImageProcessingBlock extends NodeMaterialBlock {
  122779. /**
  122780. * Create a new ImageProcessingBlock
  122781. * @param name defines the block name
  122782. */
  122783. constructor(name: string);
  122784. /**
  122785. * Gets the current class name
  122786. * @returns the class name
  122787. */
  122788. getClassName(): string;
  122789. /**
  122790. * Gets the color input component
  122791. */
  122792. readonly color: NodeMaterialConnectionPoint;
  122793. /**
  122794. * Gets the output component
  122795. */
  122796. readonly output: NodeMaterialConnectionPoint;
  122797. /**
  122798. * Initialize the block and prepare the context for build
  122799. * @param state defines the state that will be used for the build
  122800. */
  122801. initialize(state: NodeMaterialBuildState): void;
  122802. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  122803. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122804. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122805. protected _buildBlock(state: NodeMaterialBuildState): this;
  122806. }
  122807. }
  122808. declare module BABYLON {
  122809. /**
  122810. * Block used to pertub normals based on a normal map
  122811. */
  122812. export class PerturbNormalBlock extends NodeMaterialBlock {
  122813. private _tangentSpaceParameterName;
  122814. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  122815. invertX: boolean;
  122816. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  122817. invertY: boolean;
  122818. /**
  122819. * Create a new PerturbNormalBlock
  122820. * @param name defines the block name
  122821. */
  122822. constructor(name: string);
  122823. /**
  122824. * Gets the current class name
  122825. * @returns the class name
  122826. */
  122827. getClassName(): string;
  122828. /**
  122829. * Gets the world position input component
  122830. */
  122831. readonly worldPosition: NodeMaterialConnectionPoint;
  122832. /**
  122833. * Gets the world normal input component
  122834. */
  122835. readonly worldNormal: NodeMaterialConnectionPoint;
  122836. /**
  122837. * Gets the uv input component
  122838. */
  122839. readonly uv: NodeMaterialConnectionPoint;
  122840. /**
  122841. * Gets the normal map color input component
  122842. */
  122843. readonly normalMapColor: NodeMaterialConnectionPoint;
  122844. /**
  122845. * Gets the strength input component
  122846. */
  122847. readonly strength: NodeMaterialConnectionPoint;
  122848. /**
  122849. * Gets the output component
  122850. */
  122851. readonly output: NodeMaterialConnectionPoint;
  122852. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122853. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122854. autoConfigure(material: NodeMaterial): void;
  122855. protected _buildBlock(state: NodeMaterialBuildState): this;
  122856. protected _dumpPropertiesCode(): string;
  122857. serialize(): any;
  122858. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122859. }
  122860. }
  122861. declare module BABYLON {
  122862. /**
  122863. * Block used to discard a pixel if a value is smaller than a cutoff
  122864. */
  122865. export class DiscardBlock extends NodeMaterialBlock {
  122866. /**
  122867. * Create a new DiscardBlock
  122868. * @param name defines the block name
  122869. */
  122870. constructor(name: string);
  122871. /**
  122872. * Gets the current class name
  122873. * @returns the class name
  122874. */
  122875. getClassName(): string;
  122876. /**
  122877. * Gets the color input component
  122878. */
  122879. readonly value: NodeMaterialConnectionPoint;
  122880. /**
  122881. * Gets the cutoff input component
  122882. */
  122883. readonly cutoff: NodeMaterialConnectionPoint;
  122884. protected _buildBlock(state: NodeMaterialBuildState): this;
  122885. }
  122886. }
  122887. declare module BABYLON {
  122888. /**
  122889. * Block used to test if the fragment shader is front facing
  122890. */
  122891. export class FrontFacingBlock extends NodeMaterialBlock {
  122892. /**
  122893. * Creates a new FrontFacingBlock
  122894. * @param name defines the block name
  122895. */
  122896. constructor(name: string);
  122897. /**
  122898. * Gets the current class name
  122899. * @returns the class name
  122900. */
  122901. getClassName(): string;
  122902. /**
  122903. * Gets the output component
  122904. */
  122905. readonly output: NodeMaterialConnectionPoint;
  122906. protected _buildBlock(state: NodeMaterialBuildState): this;
  122907. }
  122908. }
  122909. declare module BABYLON {
  122910. /**
  122911. * Block used to add support for scene fog
  122912. */
  122913. export class FogBlock extends NodeMaterialBlock {
  122914. private _fogDistanceName;
  122915. private _fogParameters;
  122916. /**
  122917. * Create a new FogBlock
  122918. * @param name defines the block name
  122919. */
  122920. constructor(name: string);
  122921. /**
  122922. * Gets the current class name
  122923. * @returns the class name
  122924. */
  122925. getClassName(): string;
  122926. /**
  122927. * Gets the world position input component
  122928. */
  122929. readonly worldPosition: NodeMaterialConnectionPoint;
  122930. /**
  122931. * Gets the view input component
  122932. */
  122933. readonly view: NodeMaterialConnectionPoint;
  122934. /**
  122935. * Gets the color input component
  122936. */
  122937. readonly input: NodeMaterialConnectionPoint;
  122938. /**
  122939. * Gets the fog color input component
  122940. */
  122941. readonly fogColor: NodeMaterialConnectionPoint;
  122942. /**
  122943. * Gets the output component
  122944. */
  122945. readonly output: NodeMaterialConnectionPoint;
  122946. autoConfigure(material: NodeMaterial): void;
  122947. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122948. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122949. protected _buildBlock(state: NodeMaterialBuildState): this;
  122950. }
  122951. }
  122952. declare module BABYLON {
  122953. /**
  122954. * Block used to add light in the fragment shader
  122955. */
  122956. export class LightBlock extends NodeMaterialBlock {
  122957. private _lightId;
  122958. /**
  122959. * Gets or sets the light associated with this block
  122960. */
  122961. light: Nullable<Light>;
  122962. /**
  122963. * Create a new LightBlock
  122964. * @param name defines the block name
  122965. */
  122966. constructor(name: string);
  122967. /**
  122968. * Gets the current class name
  122969. * @returns the class name
  122970. */
  122971. getClassName(): string;
  122972. /**
  122973. * Gets the world position input component
  122974. */
  122975. readonly worldPosition: NodeMaterialConnectionPoint;
  122976. /**
  122977. * Gets the world normal input component
  122978. */
  122979. readonly worldNormal: NodeMaterialConnectionPoint;
  122980. /**
  122981. * Gets the camera (or eye) position component
  122982. */
  122983. readonly cameraPosition: NodeMaterialConnectionPoint;
  122984. /**
  122985. * Gets the glossiness component
  122986. */
  122987. readonly glossiness: NodeMaterialConnectionPoint;
  122988. /**
  122989. * Gets the glossinness power component
  122990. */
  122991. readonly glossPower: NodeMaterialConnectionPoint;
  122992. /**
  122993. * Gets the diffuse color component
  122994. */
  122995. readonly diffuseColor: NodeMaterialConnectionPoint;
  122996. /**
  122997. * Gets the specular color component
  122998. */
  122999. readonly specularColor: NodeMaterialConnectionPoint;
  123000. /**
  123001. * Gets the diffuse output component
  123002. */
  123003. readonly diffuseOutput: NodeMaterialConnectionPoint;
  123004. /**
  123005. * Gets the specular output component
  123006. */
  123007. readonly specularOutput: NodeMaterialConnectionPoint;
  123008. autoConfigure(material: NodeMaterial): void;
  123009. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123010. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  123011. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123012. private _injectVertexCode;
  123013. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  123014. serialize(): any;
  123015. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123016. }
  123017. }
  123018. declare module BABYLON {
  123019. /**
  123020. * Block used to multiply 2 values
  123021. */
  123022. export class MultiplyBlock extends NodeMaterialBlock {
  123023. /**
  123024. * Creates a new MultiplyBlock
  123025. * @param name defines the block name
  123026. */
  123027. constructor(name: string);
  123028. /**
  123029. * Gets the current class name
  123030. * @returns the class name
  123031. */
  123032. getClassName(): string;
  123033. /**
  123034. * Gets the left operand input component
  123035. */
  123036. readonly left: NodeMaterialConnectionPoint;
  123037. /**
  123038. * Gets the right operand input component
  123039. */
  123040. readonly right: NodeMaterialConnectionPoint;
  123041. /**
  123042. * Gets the output component
  123043. */
  123044. readonly output: NodeMaterialConnectionPoint;
  123045. protected _buildBlock(state: NodeMaterialBuildState): this;
  123046. }
  123047. }
  123048. declare module BABYLON {
  123049. /**
  123050. * Block used to add 2 vectors
  123051. */
  123052. export class AddBlock extends NodeMaterialBlock {
  123053. /**
  123054. * Creates a new AddBlock
  123055. * @param name defines the block name
  123056. */
  123057. constructor(name: string);
  123058. /**
  123059. * Gets the current class name
  123060. * @returns the class name
  123061. */
  123062. getClassName(): string;
  123063. /**
  123064. * Gets the left operand input component
  123065. */
  123066. readonly left: NodeMaterialConnectionPoint;
  123067. /**
  123068. * Gets the right operand input component
  123069. */
  123070. readonly right: NodeMaterialConnectionPoint;
  123071. /**
  123072. * Gets the output component
  123073. */
  123074. readonly output: NodeMaterialConnectionPoint;
  123075. protected _buildBlock(state: NodeMaterialBuildState): this;
  123076. }
  123077. }
  123078. declare module BABYLON {
  123079. /**
  123080. * Block used to scale a vector by a float
  123081. */
  123082. export class ScaleBlock extends NodeMaterialBlock {
  123083. /**
  123084. * Creates a new ScaleBlock
  123085. * @param name defines the block name
  123086. */
  123087. constructor(name: string);
  123088. /**
  123089. * Gets the current class name
  123090. * @returns the class name
  123091. */
  123092. getClassName(): string;
  123093. /**
  123094. * Gets the input component
  123095. */
  123096. readonly input: NodeMaterialConnectionPoint;
  123097. /**
  123098. * Gets the factor input component
  123099. */
  123100. readonly factor: NodeMaterialConnectionPoint;
  123101. /**
  123102. * Gets the output component
  123103. */
  123104. readonly output: NodeMaterialConnectionPoint;
  123105. protected _buildBlock(state: NodeMaterialBuildState): this;
  123106. }
  123107. }
  123108. declare module BABYLON {
  123109. /**
  123110. * Block used to clamp a float
  123111. */
  123112. export class ClampBlock extends NodeMaterialBlock {
  123113. /** Gets or sets the minimum range */
  123114. minimum: number;
  123115. /** Gets or sets the maximum range */
  123116. maximum: number;
  123117. /**
  123118. * Creates a new ClampBlock
  123119. * @param name defines the block name
  123120. */
  123121. constructor(name: string);
  123122. /**
  123123. * Gets the current class name
  123124. * @returns the class name
  123125. */
  123126. getClassName(): string;
  123127. /**
  123128. * Gets the value input component
  123129. */
  123130. readonly value: NodeMaterialConnectionPoint;
  123131. /**
  123132. * Gets the output component
  123133. */
  123134. readonly output: NodeMaterialConnectionPoint;
  123135. protected _buildBlock(state: NodeMaterialBuildState): this;
  123136. protected _dumpPropertiesCode(): string;
  123137. serialize(): any;
  123138. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123139. }
  123140. }
  123141. declare module BABYLON {
  123142. /**
  123143. * Block used to apply a cross product between 2 vectors
  123144. */
  123145. export class CrossBlock extends NodeMaterialBlock {
  123146. /**
  123147. * Creates a new CrossBlock
  123148. * @param name defines the block name
  123149. */
  123150. constructor(name: string);
  123151. /**
  123152. * Gets the current class name
  123153. * @returns the class name
  123154. */
  123155. getClassName(): string;
  123156. /**
  123157. * Gets the left operand input component
  123158. */
  123159. readonly left: NodeMaterialConnectionPoint;
  123160. /**
  123161. * Gets the right operand input component
  123162. */
  123163. readonly right: NodeMaterialConnectionPoint;
  123164. /**
  123165. * Gets the output component
  123166. */
  123167. readonly output: NodeMaterialConnectionPoint;
  123168. protected _buildBlock(state: NodeMaterialBuildState): this;
  123169. }
  123170. }
  123171. declare module BABYLON {
  123172. /**
  123173. * Block used to apply a dot product between 2 vectors
  123174. */
  123175. export class DotBlock extends NodeMaterialBlock {
  123176. /**
  123177. * Creates a new DotBlock
  123178. * @param name defines the block name
  123179. */
  123180. constructor(name: string);
  123181. /**
  123182. * Gets the current class name
  123183. * @returns the class name
  123184. */
  123185. getClassName(): string;
  123186. /**
  123187. * Gets the left operand input component
  123188. */
  123189. readonly left: NodeMaterialConnectionPoint;
  123190. /**
  123191. * Gets the right operand input component
  123192. */
  123193. readonly right: NodeMaterialConnectionPoint;
  123194. /**
  123195. * Gets the output component
  123196. */
  123197. readonly output: NodeMaterialConnectionPoint;
  123198. protected _buildBlock(state: NodeMaterialBuildState): this;
  123199. }
  123200. }
  123201. declare module BABYLON {
  123202. /**
  123203. * Block used to remap a float from a range to a new one
  123204. */
  123205. export class RemapBlock extends NodeMaterialBlock {
  123206. /**
  123207. * Gets or sets the source range
  123208. */
  123209. sourceRange: Vector2;
  123210. /**
  123211. * Gets or sets the target range
  123212. */
  123213. targetRange: Vector2;
  123214. /**
  123215. * Creates a new RemapBlock
  123216. * @param name defines the block name
  123217. */
  123218. constructor(name: string);
  123219. /**
  123220. * Gets the current class name
  123221. * @returns the class name
  123222. */
  123223. getClassName(): string;
  123224. /**
  123225. * Gets the input component
  123226. */
  123227. readonly input: NodeMaterialConnectionPoint;
  123228. /**
  123229. * Gets the source min input component
  123230. */
  123231. readonly sourceMin: NodeMaterialConnectionPoint;
  123232. /**
  123233. * Gets the source max input component
  123234. */
  123235. readonly sourceMax: NodeMaterialConnectionPoint;
  123236. /**
  123237. * Gets the target min input component
  123238. */
  123239. readonly targetMin: NodeMaterialConnectionPoint;
  123240. /**
  123241. * Gets the target max input component
  123242. */
  123243. readonly targetMax: NodeMaterialConnectionPoint;
  123244. /**
  123245. * Gets the output component
  123246. */
  123247. readonly output: NodeMaterialConnectionPoint;
  123248. protected _buildBlock(state: NodeMaterialBuildState): this;
  123249. protected _dumpPropertiesCode(): string;
  123250. serialize(): any;
  123251. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123252. }
  123253. }
  123254. declare module BABYLON {
  123255. /**
  123256. * Block used to normalize a vector
  123257. */
  123258. export class NormalizeBlock extends NodeMaterialBlock {
  123259. /**
  123260. * Creates a new NormalizeBlock
  123261. * @param name defines the block name
  123262. */
  123263. constructor(name: string);
  123264. /**
  123265. * Gets the current class name
  123266. * @returns the class name
  123267. */
  123268. getClassName(): string;
  123269. /**
  123270. * Gets the input component
  123271. */
  123272. readonly input: NodeMaterialConnectionPoint;
  123273. /**
  123274. * Gets the output component
  123275. */
  123276. readonly output: NodeMaterialConnectionPoint;
  123277. protected _buildBlock(state: NodeMaterialBuildState): this;
  123278. }
  123279. }
  123280. declare module BABYLON {
  123281. /**
  123282. * Operations supported by the Trigonometry block
  123283. */
  123284. export enum TrigonometryBlockOperations {
  123285. /** Cos */
  123286. Cos = 0,
  123287. /** Sin */
  123288. Sin = 1,
  123289. /** Abs */
  123290. Abs = 2,
  123291. /** Exp */
  123292. Exp = 3,
  123293. /** Exp2 */
  123294. Exp2 = 4,
  123295. /** Round */
  123296. Round = 5,
  123297. /** Floor */
  123298. Floor = 6,
  123299. /** Ceiling */
  123300. Ceiling = 7,
  123301. /** Square root */
  123302. Sqrt = 8,
  123303. /** Log */
  123304. Log = 9,
  123305. /** Tangent */
  123306. Tan = 10,
  123307. /** Arc tangent */
  123308. ArcTan = 11,
  123309. /** Arc cosinus */
  123310. ArcCos = 12,
  123311. /** Arc sinus */
  123312. ArcSin = 13,
  123313. /** Fraction */
  123314. Fract = 14,
  123315. /** Sign */
  123316. Sign = 15,
  123317. /** To radians (from degrees) */
  123318. Radians = 16,
  123319. /** To degrees (from radians) */
  123320. Degrees = 17
  123321. }
  123322. /**
  123323. * Block used to apply trigonometry operation to floats
  123324. */
  123325. export class TrigonometryBlock extends NodeMaterialBlock {
  123326. /**
  123327. * Gets or sets the operation applied by the block
  123328. */
  123329. operation: TrigonometryBlockOperations;
  123330. /**
  123331. * Creates a new TrigonometryBlock
  123332. * @param name defines the block name
  123333. */
  123334. constructor(name: string);
  123335. /**
  123336. * Gets the current class name
  123337. * @returns the class name
  123338. */
  123339. getClassName(): string;
  123340. /**
  123341. * Gets the input component
  123342. */
  123343. readonly input: NodeMaterialConnectionPoint;
  123344. /**
  123345. * Gets the output component
  123346. */
  123347. readonly output: NodeMaterialConnectionPoint;
  123348. protected _buildBlock(state: NodeMaterialBuildState): this;
  123349. serialize(): any;
  123350. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123351. }
  123352. }
  123353. declare module BABYLON {
  123354. /**
  123355. * Block used to create a Color3/4 out of individual inputs (one for each component)
  123356. */
  123357. export class ColorMergerBlock extends NodeMaterialBlock {
  123358. /**
  123359. * Create a new ColorMergerBlock
  123360. * @param name defines the block name
  123361. */
  123362. constructor(name: string);
  123363. /**
  123364. * Gets the current class name
  123365. * @returns the class name
  123366. */
  123367. getClassName(): string;
  123368. /**
  123369. * Gets the r component (input)
  123370. */
  123371. readonly r: NodeMaterialConnectionPoint;
  123372. /**
  123373. * Gets the g component (input)
  123374. */
  123375. readonly g: NodeMaterialConnectionPoint;
  123376. /**
  123377. * Gets the b component (input)
  123378. */
  123379. readonly b: NodeMaterialConnectionPoint;
  123380. /**
  123381. * Gets the a component (input)
  123382. */
  123383. readonly a: NodeMaterialConnectionPoint;
  123384. /**
  123385. * Gets the rgba component (output)
  123386. */
  123387. readonly rgba: NodeMaterialConnectionPoint;
  123388. /**
  123389. * Gets the rgb component (output)
  123390. */
  123391. readonly rgb: NodeMaterialConnectionPoint;
  123392. protected _buildBlock(state: NodeMaterialBuildState): this;
  123393. }
  123394. }
  123395. declare module BABYLON {
  123396. /**
  123397. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  123398. */
  123399. export class VectorMergerBlock extends NodeMaterialBlock {
  123400. /**
  123401. * Create a new VectorMergerBlock
  123402. * @param name defines the block name
  123403. */
  123404. constructor(name: string);
  123405. /**
  123406. * Gets the current class name
  123407. * @returns the class name
  123408. */
  123409. getClassName(): string;
  123410. /**
  123411. * Gets the x component (input)
  123412. */
  123413. readonly x: NodeMaterialConnectionPoint;
  123414. /**
  123415. * Gets the y component (input)
  123416. */
  123417. readonly y: NodeMaterialConnectionPoint;
  123418. /**
  123419. * Gets the z component (input)
  123420. */
  123421. readonly z: NodeMaterialConnectionPoint;
  123422. /**
  123423. * Gets the w component (input)
  123424. */
  123425. readonly w: NodeMaterialConnectionPoint;
  123426. /**
  123427. * Gets the xyzw component (output)
  123428. */
  123429. readonly xyzw: NodeMaterialConnectionPoint;
  123430. /**
  123431. * Gets the xyz component (output)
  123432. */
  123433. readonly xyz: NodeMaterialConnectionPoint;
  123434. /**
  123435. * Gets the xy component (output)
  123436. */
  123437. readonly xy: NodeMaterialConnectionPoint;
  123438. protected _buildBlock(state: NodeMaterialBuildState): this;
  123439. }
  123440. }
  123441. declare module BABYLON {
  123442. /**
  123443. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  123444. */
  123445. export class ColorSplitterBlock extends NodeMaterialBlock {
  123446. /**
  123447. * Create a new ColorSplitterBlock
  123448. * @param name defines the block name
  123449. */
  123450. constructor(name: string);
  123451. /**
  123452. * Gets the current class name
  123453. * @returns the class name
  123454. */
  123455. getClassName(): string;
  123456. /**
  123457. * Gets the rgba component (input)
  123458. */
  123459. readonly rgba: NodeMaterialConnectionPoint;
  123460. /**
  123461. * Gets the rgb component (input)
  123462. */
  123463. readonly rgbIn: NodeMaterialConnectionPoint;
  123464. /**
  123465. * Gets the rgb component (output)
  123466. */
  123467. readonly rgbOut: NodeMaterialConnectionPoint;
  123468. /**
  123469. * Gets the r component (output)
  123470. */
  123471. readonly r: NodeMaterialConnectionPoint;
  123472. /**
  123473. * Gets the g component (output)
  123474. */
  123475. readonly g: NodeMaterialConnectionPoint;
  123476. /**
  123477. * Gets the b component (output)
  123478. */
  123479. readonly b: NodeMaterialConnectionPoint;
  123480. /**
  123481. * Gets the a component (output)
  123482. */
  123483. readonly a: NodeMaterialConnectionPoint;
  123484. protected _inputRename(name: string): string;
  123485. protected _outputRename(name: string): string;
  123486. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  123487. }
  123488. }
  123489. declare module BABYLON {
  123490. /**
  123491. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  123492. */
  123493. export class VectorSplitterBlock extends NodeMaterialBlock {
  123494. /**
  123495. * Create a new VectorSplitterBlock
  123496. * @param name defines the block name
  123497. */
  123498. constructor(name: string);
  123499. /**
  123500. * Gets the current class name
  123501. * @returns the class name
  123502. */
  123503. getClassName(): string;
  123504. /**
  123505. * Gets the xyzw component (input)
  123506. */
  123507. readonly xyzw: NodeMaterialConnectionPoint;
  123508. /**
  123509. * Gets the xyz component (input)
  123510. */
  123511. readonly xyzIn: NodeMaterialConnectionPoint;
  123512. /**
  123513. * Gets the xy component (input)
  123514. */
  123515. readonly xyIn: NodeMaterialConnectionPoint;
  123516. /**
  123517. * Gets the xyz component (output)
  123518. */
  123519. readonly xyzOut: NodeMaterialConnectionPoint;
  123520. /**
  123521. * Gets the xy component (output)
  123522. */
  123523. readonly xyOut: NodeMaterialConnectionPoint;
  123524. /**
  123525. * Gets the x component (output)
  123526. */
  123527. readonly x: NodeMaterialConnectionPoint;
  123528. /**
  123529. * Gets the y component (output)
  123530. */
  123531. readonly y: NodeMaterialConnectionPoint;
  123532. /**
  123533. * Gets the z component (output)
  123534. */
  123535. readonly z: NodeMaterialConnectionPoint;
  123536. /**
  123537. * Gets the w component (output)
  123538. */
  123539. readonly w: NodeMaterialConnectionPoint;
  123540. protected _inputRename(name: string): string;
  123541. protected _outputRename(name: string): string;
  123542. protected _buildBlock(state: NodeMaterialBuildState): this;
  123543. }
  123544. }
  123545. declare module BABYLON {
  123546. /**
  123547. * Block used to lerp between 2 values
  123548. */
  123549. export class LerpBlock extends NodeMaterialBlock {
  123550. /**
  123551. * Creates a new LerpBlock
  123552. * @param name defines the block name
  123553. */
  123554. constructor(name: string);
  123555. /**
  123556. * Gets the current class name
  123557. * @returns the class name
  123558. */
  123559. getClassName(): string;
  123560. /**
  123561. * Gets the left operand input component
  123562. */
  123563. readonly left: NodeMaterialConnectionPoint;
  123564. /**
  123565. * Gets the right operand input component
  123566. */
  123567. readonly right: NodeMaterialConnectionPoint;
  123568. /**
  123569. * Gets the gradient operand input component
  123570. */
  123571. readonly gradient: NodeMaterialConnectionPoint;
  123572. /**
  123573. * Gets the output component
  123574. */
  123575. readonly output: NodeMaterialConnectionPoint;
  123576. protected _buildBlock(state: NodeMaterialBuildState): this;
  123577. }
  123578. }
  123579. declare module BABYLON {
  123580. /**
  123581. * Block used to divide 2 vectors
  123582. */
  123583. export class DivideBlock extends NodeMaterialBlock {
  123584. /**
  123585. * Creates a new DivideBlock
  123586. * @param name defines the block name
  123587. */
  123588. constructor(name: string);
  123589. /**
  123590. * Gets the current class name
  123591. * @returns the class name
  123592. */
  123593. getClassName(): string;
  123594. /**
  123595. * Gets the left operand input component
  123596. */
  123597. readonly left: NodeMaterialConnectionPoint;
  123598. /**
  123599. * Gets the right operand input component
  123600. */
  123601. readonly right: NodeMaterialConnectionPoint;
  123602. /**
  123603. * Gets the output component
  123604. */
  123605. readonly output: NodeMaterialConnectionPoint;
  123606. protected _buildBlock(state: NodeMaterialBuildState): this;
  123607. }
  123608. }
  123609. declare module BABYLON {
  123610. /**
  123611. * Block used to subtract 2 vectors
  123612. */
  123613. export class SubtractBlock extends NodeMaterialBlock {
  123614. /**
  123615. * Creates a new SubtractBlock
  123616. * @param name defines the block name
  123617. */
  123618. constructor(name: string);
  123619. /**
  123620. * Gets the current class name
  123621. * @returns the class name
  123622. */
  123623. getClassName(): string;
  123624. /**
  123625. * Gets the left operand input component
  123626. */
  123627. readonly left: NodeMaterialConnectionPoint;
  123628. /**
  123629. * Gets the right operand input component
  123630. */
  123631. readonly right: NodeMaterialConnectionPoint;
  123632. /**
  123633. * Gets the output component
  123634. */
  123635. readonly output: NodeMaterialConnectionPoint;
  123636. protected _buildBlock(state: NodeMaterialBuildState): this;
  123637. }
  123638. }
  123639. declare module BABYLON {
  123640. /**
  123641. * Block used to step a value
  123642. */
  123643. export class StepBlock extends NodeMaterialBlock {
  123644. /**
  123645. * Creates a new StepBlock
  123646. * @param name defines the block name
  123647. */
  123648. constructor(name: string);
  123649. /**
  123650. * Gets the current class name
  123651. * @returns the class name
  123652. */
  123653. getClassName(): string;
  123654. /**
  123655. * Gets the value operand input component
  123656. */
  123657. readonly value: NodeMaterialConnectionPoint;
  123658. /**
  123659. * Gets the edge operand input component
  123660. */
  123661. readonly edge: NodeMaterialConnectionPoint;
  123662. /**
  123663. * Gets the output component
  123664. */
  123665. readonly output: NodeMaterialConnectionPoint;
  123666. protected _buildBlock(state: NodeMaterialBuildState): this;
  123667. }
  123668. }
  123669. declare module BABYLON {
  123670. /**
  123671. * Block used to get the opposite (1 - x) of a value
  123672. */
  123673. export class OneMinusBlock extends NodeMaterialBlock {
  123674. /**
  123675. * Creates a new OneMinusBlock
  123676. * @param name defines the block name
  123677. */
  123678. constructor(name: string);
  123679. /**
  123680. * Gets the current class name
  123681. * @returns the class name
  123682. */
  123683. getClassName(): string;
  123684. /**
  123685. * Gets the input component
  123686. */
  123687. readonly input: NodeMaterialConnectionPoint;
  123688. /**
  123689. * Gets the output component
  123690. */
  123691. readonly output: NodeMaterialConnectionPoint;
  123692. protected _buildBlock(state: NodeMaterialBuildState): this;
  123693. }
  123694. }
  123695. declare module BABYLON {
  123696. /**
  123697. * Block used to get the view direction
  123698. */
  123699. export class ViewDirectionBlock extends NodeMaterialBlock {
  123700. /**
  123701. * Creates a new ViewDirectionBlock
  123702. * @param name defines the block name
  123703. */
  123704. constructor(name: string);
  123705. /**
  123706. * Gets the current class name
  123707. * @returns the class name
  123708. */
  123709. getClassName(): string;
  123710. /**
  123711. * Gets the world position component
  123712. */
  123713. readonly worldPosition: NodeMaterialConnectionPoint;
  123714. /**
  123715. * Gets the camera position component
  123716. */
  123717. readonly cameraPosition: NodeMaterialConnectionPoint;
  123718. /**
  123719. * Gets the output component
  123720. */
  123721. readonly output: NodeMaterialConnectionPoint;
  123722. autoConfigure(material: NodeMaterial): void;
  123723. protected _buildBlock(state: NodeMaterialBuildState): this;
  123724. }
  123725. }
  123726. declare module BABYLON {
  123727. /**
  123728. * Block used to compute fresnel value
  123729. */
  123730. export class FresnelBlock extends NodeMaterialBlock {
  123731. /**
  123732. * Create a new FresnelBlock
  123733. * @param name defines the block name
  123734. */
  123735. constructor(name: string);
  123736. /**
  123737. * Gets the current class name
  123738. * @returns the class name
  123739. */
  123740. getClassName(): string;
  123741. /**
  123742. * Gets the world normal input component
  123743. */
  123744. readonly worldNormal: NodeMaterialConnectionPoint;
  123745. /**
  123746. * Gets the view direction input component
  123747. */
  123748. readonly viewDirection: NodeMaterialConnectionPoint;
  123749. /**
  123750. * Gets the bias input component
  123751. */
  123752. readonly bias: NodeMaterialConnectionPoint;
  123753. /**
  123754. * Gets the camera (or eye) position component
  123755. */
  123756. readonly power: NodeMaterialConnectionPoint;
  123757. /**
  123758. * Gets the fresnel output component
  123759. */
  123760. readonly fresnel: NodeMaterialConnectionPoint;
  123761. autoConfigure(material: NodeMaterial): void;
  123762. protected _buildBlock(state: NodeMaterialBuildState): this;
  123763. }
  123764. }
  123765. declare module BABYLON {
  123766. /**
  123767. * Block used to get the max of 2 values
  123768. */
  123769. export class MaxBlock extends NodeMaterialBlock {
  123770. /**
  123771. * Creates a new MaxBlock
  123772. * @param name defines the block name
  123773. */
  123774. constructor(name: string);
  123775. /**
  123776. * Gets the current class name
  123777. * @returns the class name
  123778. */
  123779. getClassName(): string;
  123780. /**
  123781. * Gets the left operand input component
  123782. */
  123783. readonly left: NodeMaterialConnectionPoint;
  123784. /**
  123785. * Gets the right operand input component
  123786. */
  123787. readonly right: NodeMaterialConnectionPoint;
  123788. /**
  123789. * Gets the output component
  123790. */
  123791. readonly output: NodeMaterialConnectionPoint;
  123792. protected _buildBlock(state: NodeMaterialBuildState): this;
  123793. }
  123794. }
  123795. declare module BABYLON {
  123796. /**
  123797. * Block used to get the min of 2 values
  123798. */
  123799. export class MinBlock extends NodeMaterialBlock {
  123800. /**
  123801. * Creates a new MinBlock
  123802. * @param name defines the block name
  123803. */
  123804. constructor(name: string);
  123805. /**
  123806. * Gets the current class name
  123807. * @returns the class name
  123808. */
  123809. getClassName(): string;
  123810. /**
  123811. * Gets the left operand input component
  123812. */
  123813. readonly left: NodeMaterialConnectionPoint;
  123814. /**
  123815. * Gets the right operand input component
  123816. */
  123817. readonly right: NodeMaterialConnectionPoint;
  123818. /**
  123819. * Gets the output component
  123820. */
  123821. readonly output: NodeMaterialConnectionPoint;
  123822. protected _buildBlock(state: NodeMaterialBuildState): this;
  123823. }
  123824. }
  123825. declare module BABYLON {
  123826. /**
  123827. * Block used to get the distance between 2 values
  123828. */
  123829. export class DistanceBlock extends NodeMaterialBlock {
  123830. /**
  123831. * Creates a new DistanceBlock
  123832. * @param name defines the block name
  123833. */
  123834. constructor(name: string);
  123835. /**
  123836. * Gets the current class name
  123837. * @returns the class name
  123838. */
  123839. getClassName(): string;
  123840. /**
  123841. * Gets the left operand input component
  123842. */
  123843. readonly left: NodeMaterialConnectionPoint;
  123844. /**
  123845. * Gets the right operand input component
  123846. */
  123847. readonly right: NodeMaterialConnectionPoint;
  123848. /**
  123849. * Gets the output component
  123850. */
  123851. readonly output: NodeMaterialConnectionPoint;
  123852. protected _buildBlock(state: NodeMaterialBuildState): this;
  123853. }
  123854. }
  123855. declare module BABYLON {
  123856. /**
  123857. * Block used to get the length of a vector
  123858. */
  123859. export class LengthBlock extends NodeMaterialBlock {
  123860. /**
  123861. * Creates a new LengthBlock
  123862. * @param name defines the block name
  123863. */
  123864. constructor(name: string);
  123865. /**
  123866. * Gets the current class name
  123867. * @returns the class name
  123868. */
  123869. getClassName(): string;
  123870. /**
  123871. * Gets the value input component
  123872. */
  123873. readonly value: NodeMaterialConnectionPoint;
  123874. /**
  123875. * Gets the output component
  123876. */
  123877. readonly output: NodeMaterialConnectionPoint;
  123878. protected _buildBlock(state: NodeMaterialBuildState): this;
  123879. }
  123880. }
  123881. declare module BABYLON {
  123882. /**
  123883. * Block used to get negative version of a value (i.e. x * -1)
  123884. */
  123885. export class NegateBlock extends NodeMaterialBlock {
  123886. /**
  123887. * Creates a new NegateBlock
  123888. * @param name defines the block name
  123889. */
  123890. constructor(name: string);
  123891. /**
  123892. * Gets the current class name
  123893. * @returns the class name
  123894. */
  123895. getClassName(): string;
  123896. /**
  123897. * Gets the value input component
  123898. */
  123899. readonly value: NodeMaterialConnectionPoint;
  123900. /**
  123901. * Gets the output component
  123902. */
  123903. readonly output: NodeMaterialConnectionPoint;
  123904. protected _buildBlock(state: NodeMaterialBuildState): this;
  123905. }
  123906. }
  123907. declare module BABYLON {
  123908. /**
  123909. * Block used to get the value of the first parameter raised to the power of the second
  123910. */
  123911. export class PowBlock extends NodeMaterialBlock {
  123912. /**
  123913. * Creates a new PowBlock
  123914. * @param name defines the block name
  123915. */
  123916. constructor(name: string);
  123917. /**
  123918. * Gets the current class name
  123919. * @returns the class name
  123920. */
  123921. getClassName(): string;
  123922. /**
  123923. * Gets the value operand input component
  123924. */
  123925. readonly value: NodeMaterialConnectionPoint;
  123926. /**
  123927. * Gets the power operand input component
  123928. */
  123929. readonly power: NodeMaterialConnectionPoint;
  123930. /**
  123931. * Gets the output component
  123932. */
  123933. readonly output: NodeMaterialConnectionPoint;
  123934. protected _buildBlock(state: NodeMaterialBuildState): this;
  123935. }
  123936. }
  123937. declare module BABYLON {
  123938. /**
  123939. * Block used to get a random number
  123940. */
  123941. export class RandomNumberBlock extends NodeMaterialBlock {
  123942. /**
  123943. * Creates a new RandomNumberBlock
  123944. * @param name defines the block name
  123945. */
  123946. constructor(name: string);
  123947. /**
  123948. * Gets the current class name
  123949. * @returns the class name
  123950. */
  123951. getClassName(): string;
  123952. /**
  123953. * Gets the seed input component
  123954. */
  123955. readonly seed: NodeMaterialConnectionPoint;
  123956. /**
  123957. * Gets the output component
  123958. */
  123959. readonly output: NodeMaterialConnectionPoint;
  123960. protected _buildBlock(state: NodeMaterialBuildState): this;
  123961. }
  123962. }
  123963. declare module BABYLON {
  123964. /**
  123965. * Block used to compute arc tangent of 2 values
  123966. */
  123967. export class ArcTan2Block extends NodeMaterialBlock {
  123968. /**
  123969. * Creates a new ArcTan2Block
  123970. * @param name defines the block name
  123971. */
  123972. constructor(name: string);
  123973. /**
  123974. * Gets the current class name
  123975. * @returns the class name
  123976. */
  123977. getClassName(): string;
  123978. /**
  123979. * Gets the x operand input component
  123980. */
  123981. readonly x: NodeMaterialConnectionPoint;
  123982. /**
  123983. * Gets the y operand input component
  123984. */
  123985. readonly y: NodeMaterialConnectionPoint;
  123986. /**
  123987. * Gets the output component
  123988. */
  123989. readonly output: NodeMaterialConnectionPoint;
  123990. protected _buildBlock(state: NodeMaterialBuildState): this;
  123991. }
  123992. }
  123993. declare module BABYLON {
  123994. /**
  123995. * Block used to smooth step a value
  123996. */
  123997. export class SmoothStepBlock extends NodeMaterialBlock {
  123998. /**
  123999. * Creates a new SmoothStepBlock
  124000. * @param name defines the block name
  124001. */
  124002. constructor(name: string);
  124003. /**
  124004. * Gets the current class name
  124005. * @returns the class name
  124006. */
  124007. getClassName(): string;
  124008. /**
  124009. * Gets the value operand input component
  124010. */
  124011. readonly value: NodeMaterialConnectionPoint;
  124012. /**
  124013. * Gets the first edge operand input component
  124014. */
  124015. readonly edge0: NodeMaterialConnectionPoint;
  124016. /**
  124017. * Gets the second edge operand input component
  124018. */
  124019. readonly edge1: NodeMaterialConnectionPoint;
  124020. /**
  124021. * Gets the output component
  124022. */
  124023. readonly output: NodeMaterialConnectionPoint;
  124024. protected _buildBlock(state: NodeMaterialBuildState): this;
  124025. }
  124026. }
  124027. declare module BABYLON {
  124028. /**
  124029. * Block used to get the reciprocal (1 / x) of a value
  124030. */
  124031. export class ReciprocalBlock extends NodeMaterialBlock {
  124032. /**
  124033. * Creates a new ReciprocalBlock
  124034. * @param name defines the block name
  124035. */
  124036. constructor(name: string);
  124037. /**
  124038. * Gets the current class name
  124039. * @returns the class name
  124040. */
  124041. getClassName(): string;
  124042. /**
  124043. * Gets the input component
  124044. */
  124045. readonly input: NodeMaterialConnectionPoint;
  124046. /**
  124047. * Gets the output component
  124048. */
  124049. readonly output: NodeMaterialConnectionPoint;
  124050. protected _buildBlock(state: NodeMaterialBuildState): this;
  124051. }
  124052. }
  124053. declare module BABYLON {
  124054. /**
  124055. * Block used to replace a color by another one
  124056. */
  124057. export class ReplaceColorBlock extends NodeMaterialBlock {
  124058. /**
  124059. * Creates a new ReplaceColorBlock
  124060. * @param name defines the block name
  124061. */
  124062. constructor(name: string);
  124063. /**
  124064. * Gets the current class name
  124065. * @returns the class name
  124066. */
  124067. getClassName(): string;
  124068. /**
  124069. * Gets the value input component
  124070. */
  124071. readonly value: NodeMaterialConnectionPoint;
  124072. /**
  124073. * Gets the reference input component
  124074. */
  124075. readonly reference: NodeMaterialConnectionPoint;
  124076. /**
  124077. * Gets the distance input component
  124078. */
  124079. readonly distance: NodeMaterialConnectionPoint;
  124080. /**
  124081. * Gets the replacement input component
  124082. */
  124083. readonly replacement: NodeMaterialConnectionPoint;
  124084. /**
  124085. * Gets the output component
  124086. */
  124087. readonly output: NodeMaterialConnectionPoint;
  124088. protected _buildBlock(state: NodeMaterialBuildState): this;
  124089. }
  124090. }
  124091. declare module BABYLON {
  124092. /**
  124093. * Block used to posterize a value
  124094. * @see https://en.wikipedia.org/wiki/Posterization
  124095. */
  124096. export class PosterizeBlock extends NodeMaterialBlock {
  124097. /**
  124098. * Creates a new PosterizeBlock
  124099. * @param name defines the block name
  124100. */
  124101. constructor(name: string);
  124102. /**
  124103. * Gets the current class name
  124104. * @returns the class name
  124105. */
  124106. getClassName(): string;
  124107. /**
  124108. * Gets the value input component
  124109. */
  124110. readonly value: NodeMaterialConnectionPoint;
  124111. /**
  124112. * Gets the steps input component
  124113. */
  124114. readonly steps: NodeMaterialConnectionPoint;
  124115. /**
  124116. * Gets the output component
  124117. */
  124118. readonly output: NodeMaterialConnectionPoint;
  124119. protected _buildBlock(state: NodeMaterialBuildState): this;
  124120. }
  124121. }
  124122. declare module BABYLON {
  124123. /**
  124124. * Operations supported by the Wave block
  124125. */
  124126. export enum WaveBlockKind {
  124127. /** SawTooth */
  124128. SawTooth = 0,
  124129. /** Square */
  124130. Square = 1,
  124131. /** Triangle */
  124132. Triangle = 2
  124133. }
  124134. /**
  124135. * Block used to apply wave operation to floats
  124136. */
  124137. export class WaveBlock extends NodeMaterialBlock {
  124138. /**
  124139. * Gets or sets the kibnd of wave to be applied by the block
  124140. */
  124141. kind: WaveBlockKind;
  124142. /**
  124143. * Creates a new WaveBlock
  124144. * @param name defines the block name
  124145. */
  124146. constructor(name: string);
  124147. /**
  124148. * Gets the current class name
  124149. * @returns the class name
  124150. */
  124151. getClassName(): string;
  124152. /**
  124153. * Gets the input component
  124154. */
  124155. readonly input: NodeMaterialConnectionPoint;
  124156. /**
  124157. * Gets the output component
  124158. */
  124159. readonly output: NodeMaterialConnectionPoint;
  124160. protected _buildBlock(state: NodeMaterialBuildState): this;
  124161. serialize(): any;
  124162. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  124163. }
  124164. }
  124165. declare module BABYLON {
  124166. /**
  124167. * Class used to store a color step for the GradientBlock
  124168. */
  124169. export class GradientBlockColorStep {
  124170. /**
  124171. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  124172. */
  124173. step: number;
  124174. /**
  124175. * Gets or sets the color associated with this step
  124176. */
  124177. color: Color3;
  124178. /**
  124179. * Creates a new GradientBlockColorStep
  124180. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  124181. * @param color defines the color associated with this step
  124182. */
  124183. constructor(
  124184. /**
  124185. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  124186. */
  124187. step: number,
  124188. /**
  124189. * Gets or sets the color associated with this step
  124190. */
  124191. color: Color3);
  124192. }
  124193. /**
  124194. * Block used to return a color from a gradient based on an input value between 0 and 1
  124195. */
  124196. export class GradientBlock extends NodeMaterialBlock {
  124197. /**
  124198. * Gets or sets the list of color steps
  124199. */
  124200. colorSteps: GradientBlockColorStep[];
  124201. /**
  124202. * Creates a new GradientBlock
  124203. * @param name defines the block name
  124204. */
  124205. constructor(name: string);
  124206. /**
  124207. * Gets the current class name
  124208. * @returns the class name
  124209. */
  124210. getClassName(): string;
  124211. /**
  124212. * Gets the gradient input component
  124213. */
  124214. readonly gradient: NodeMaterialConnectionPoint;
  124215. /**
  124216. * Gets the output component
  124217. */
  124218. readonly output: NodeMaterialConnectionPoint;
  124219. private _writeColorConstant;
  124220. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  124221. serialize(): any;
  124222. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  124223. protected _dumpPropertiesCode(): string;
  124224. }
  124225. }
  124226. declare module BABYLON {
  124227. /**
  124228. * Block used to normalize lerp between 2 values
  124229. */
  124230. export class NLerpBlock extends NodeMaterialBlock {
  124231. /**
  124232. * Creates a new NLerpBlock
  124233. * @param name defines the block name
  124234. */
  124235. constructor(name: string);
  124236. /**
  124237. * Gets the current class name
  124238. * @returns the class name
  124239. */
  124240. getClassName(): string;
  124241. /**
  124242. * Gets the left operand input component
  124243. */
  124244. readonly left: NodeMaterialConnectionPoint;
  124245. /**
  124246. * Gets the right operand input component
  124247. */
  124248. readonly right: NodeMaterialConnectionPoint;
  124249. /**
  124250. * Gets the gradient operand input component
  124251. */
  124252. readonly gradient: NodeMaterialConnectionPoint;
  124253. /**
  124254. * Gets the output component
  124255. */
  124256. readonly output: NodeMaterialConnectionPoint;
  124257. protected _buildBlock(state: NodeMaterialBuildState): this;
  124258. }
  124259. }
  124260. declare module BABYLON {
  124261. /**
  124262. * Effect Render Options
  124263. */
  124264. export interface IEffectRendererOptions {
  124265. /**
  124266. * Defines the vertices positions.
  124267. */
  124268. positions?: number[];
  124269. /**
  124270. * Defines the indices.
  124271. */
  124272. indices?: number[];
  124273. }
  124274. /**
  124275. * Helper class to render one or more effects
  124276. */
  124277. export class EffectRenderer {
  124278. private engine;
  124279. private static _DefaultOptions;
  124280. private _vertexBuffers;
  124281. private _indexBuffer;
  124282. private _ringBufferIndex;
  124283. private _ringScreenBuffer;
  124284. private _fullscreenViewport;
  124285. private _getNextFrameBuffer;
  124286. /**
  124287. * Creates an effect renderer
  124288. * @param engine the engine to use for rendering
  124289. * @param options defines the options of the effect renderer
  124290. */
  124291. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  124292. /**
  124293. * Sets the current viewport in normalized coordinates 0-1
  124294. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  124295. */
  124296. setViewport(viewport?: Viewport): void;
  124297. /**
  124298. * Binds the embedded attributes buffer to the effect.
  124299. * @param effect Defines the effect to bind the attributes for
  124300. */
  124301. bindBuffers(effect: Effect): void;
  124302. /**
  124303. * Sets the current effect wrapper to use during draw.
  124304. * The effect needs to be ready before calling this api.
  124305. * This also sets the default full screen position attribute.
  124306. * @param effectWrapper Defines the effect to draw with
  124307. */
  124308. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  124309. /**
  124310. * Draws a full screen quad.
  124311. */
  124312. draw(): void;
  124313. /**
  124314. * renders one or more effects to a specified texture
  124315. * @param effectWrappers list of effects to renderer
  124316. * @param outputTexture texture to draw to, if null it will render to the screen
  124317. */
  124318. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  124319. /**
  124320. * Disposes of the effect renderer
  124321. */
  124322. dispose(): void;
  124323. }
  124324. /**
  124325. * Options to create an EffectWrapper
  124326. */
  124327. interface EffectWrapperCreationOptions {
  124328. /**
  124329. * Engine to use to create the effect
  124330. */
  124331. engine: ThinEngine;
  124332. /**
  124333. * Fragment shader for the effect
  124334. */
  124335. fragmentShader: string;
  124336. /**
  124337. * Vertex shader for the effect
  124338. */
  124339. vertexShader?: string;
  124340. /**
  124341. * Attributes to use in the shader
  124342. */
  124343. attributeNames?: Array<string>;
  124344. /**
  124345. * Uniforms to use in the shader
  124346. */
  124347. uniformNames?: Array<string>;
  124348. /**
  124349. * Texture sampler names to use in the shader
  124350. */
  124351. samplerNames?: Array<string>;
  124352. /**
  124353. * The friendly name of the effect displayed in Spector.
  124354. */
  124355. name?: string;
  124356. }
  124357. /**
  124358. * Wraps an effect to be used for rendering
  124359. */
  124360. export class EffectWrapper {
  124361. /**
  124362. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  124363. */
  124364. onApplyObservable: Observable<{}>;
  124365. /**
  124366. * The underlying effect
  124367. */
  124368. effect: Effect;
  124369. /**
  124370. * Creates an effect to be renderer
  124371. * @param creationOptions options to create the effect
  124372. */
  124373. constructor(creationOptions: EffectWrapperCreationOptions);
  124374. /**
  124375. * Disposes of the effect wrapper
  124376. */
  124377. dispose(): void;
  124378. }
  124379. }
  124380. declare module BABYLON {
  124381. /**
  124382. * Helper class to push actions to a pool of workers.
  124383. */
  124384. export class WorkerPool implements IDisposable {
  124385. private _workerInfos;
  124386. private _pendingActions;
  124387. /**
  124388. * Constructor
  124389. * @param workers Array of workers to use for actions
  124390. */
  124391. constructor(workers: Array<Worker>);
  124392. /**
  124393. * Terminates all workers and clears any pending actions.
  124394. */
  124395. dispose(): void;
  124396. /**
  124397. * Pushes an action to the worker pool. If all the workers are active, the action will be
  124398. * pended until a worker has completed its action.
  124399. * @param action The action to perform. Call onComplete when the action is complete.
  124400. */
  124401. push(action: (worker: Worker, onComplete: () => void) => void): void;
  124402. private _execute;
  124403. }
  124404. }
  124405. declare module BABYLON {
  124406. /**
  124407. * Configuration for Draco compression
  124408. */
  124409. export interface IDracoCompressionConfiguration {
  124410. /**
  124411. * Configuration for the decoder.
  124412. */
  124413. decoder: {
  124414. /**
  124415. * The url to the WebAssembly module.
  124416. */
  124417. wasmUrl?: string;
  124418. /**
  124419. * The url to the WebAssembly binary.
  124420. */
  124421. wasmBinaryUrl?: string;
  124422. /**
  124423. * The url to the fallback JavaScript module.
  124424. */
  124425. fallbackUrl?: string;
  124426. };
  124427. }
  124428. /**
  124429. * Draco compression (https://google.github.io/draco/)
  124430. *
  124431. * This class wraps the Draco module.
  124432. *
  124433. * **Encoder**
  124434. *
  124435. * The encoder is not currently implemented.
  124436. *
  124437. * **Decoder**
  124438. *
  124439. * By default, the configuration points to a copy of the Draco decoder files for glTF from the babylon.js preview cdn https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js.
  124440. *
  124441. * To update the configuration, use the following code:
  124442. * ```javascript
  124443. * DracoCompression.Configuration = {
  124444. * decoder: {
  124445. * wasmUrl: "<url to the WebAssembly library>",
  124446. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  124447. * fallbackUrl: "<url to the fallback JavaScript library>",
  124448. * }
  124449. * };
  124450. * ```
  124451. *
  124452. * Draco has two versions, one for WebAssembly and one for JavaScript. The decoder configuration can be set to only support Webssembly or only support the JavaScript version.
  124453. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  124454. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  124455. *
  124456. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  124457. * ```javascript
  124458. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  124459. * ```
  124460. *
  124461. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  124462. */
  124463. export class DracoCompression implements IDisposable {
  124464. private _workerPoolPromise?;
  124465. private _decoderModulePromise?;
  124466. /**
  124467. * The configuration. Defaults to the following urls:
  124468. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  124469. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  124470. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  124471. */
  124472. static Configuration: IDracoCompressionConfiguration;
  124473. /**
  124474. * Returns true if the decoder configuration is available.
  124475. */
  124476. static readonly DecoderAvailable: boolean;
  124477. /**
  124478. * Default number of workers to create when creating the draco compression object.
  124479. */
  124480. static DefaultNumWorkers: number;
  124481. private static GetDefaultNumWorkers;
  124482. private static _Default;
  124483. /**
  124484. * Default instance for the draco compression object.
  124485. */
  124486. static readonly Default: DracoCompression;
  124487. /**
  124488. * Constructor
  124489. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  124490. */
  124491. constructor(numWorkers?: number);
  124492. /**
  124493. * Stop all async operations and release resources.
  124494. */
  124495. dispose(): void;
  124496. /**
  124497. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  124498. * @returns a promise that resolves when ready
  124499. */
  124500. whenReadyAsync(): Promise<void>;
  124501. /**
  124502. * Decode Draco compressed mesh data to vertex data.
  124503. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  124504. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  124505. * @returns A promise that resolves with the decoded vertex data
  124506. */
  124507. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  124508. [kind: string]: number;
  124509. }): Promise<VertexData>;
  124510. }
  124511. }
  124512. declare module BABYLON {
  124513. /**
  124514. * Class for building Constructive Solid Geometry
  124515. */
  124516. export class CSG {
  124517. private polygons;
  124518. /**
  124519. * The world matrix
  124520. */
  124521. matrix: Matrix;
  124522. /**
  124523. * Stores the position
  124524. */
  124525. position: Vector3;
  124526. /**
  124527. * Stores the rotation
  124528. */
  124529. rotation: Vector3;
  124530. /**
  124531. * Stores the rotation quaternion
  124532. */
  124533. rotationQuaternion: Nullable<Quaternion>;
  124534. /**
  124535. * Stores the scaling vector
  124536. */
  124537. scaling: Vector3;
  124538. /**
  124539. * Convert the Mesh to CSG
  124540. * @param mesh The Mesh to convert to CSG
  124541. * @returns A new CSG from the Mesh
  124542. */
  124543. static FromMesh(mesh: Mesh): CSG;
  124544. /**
  124545. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  124546. * @param polygons Polygons used to construct a CSG solid
  124547. */
  124548. private static FromPolygons;
  124549. /**
  124550. * Clones, or makes a deep copy, of the CSG
  124551. * @returns A new CSG
  124552. */
  124553. clone(): CSG;
  124554. /**
  124555. * Unions this CSG with another CSG
  124556. * @param csg The CSG to union against this CSG
  124557. * @returns The unioned CSG
  124558. */
  124559. union(csg: CSG): CSG;
  124560. /**
  124561. * Unions this CSG with another CSG in place
  124562. * @param csg The CSG to union against this CSG
  124563. */
  124564. unionInPlace(csg: CSG): void;
  124565. /**
  124566. * Subtracts this CSG with another CSG
  124567. * @param csg The CSG to subtract against this CSG
  124568. * @returns A new CSG
  124569. */
  124570. subtract(csg: CSG): CSG;
  124571. /**
  124572. * Subtracts this CSG with another CSG in place
  124573. * @param csg The CSG to subtact against this CSG
  124574. */
  124575. subtractInPlace(csg: CSG): void;
  124576. /**
  124577. * Intersect this CSG with another CSG
  124578. * @param csg The CSG to intersect against this CSG
  124579. * @returns A new CSG
  124580. */
  124581. intersect(csg: CSG): CSG;
  124582. /**
  124583. * Intersects this CSG with another CSG in place
  124584. * @param csg The CSG to intersect against this CSG
  124585. */
  124586. intersectInPlace(csg: CSG): void;
  124587. /**
  124588. * Return a new CSG solid with solid and empty space switched. This solid is
  124589. * not modified.
  124590. * @returns A new CSG solid with solid and empty space switched
  124591. */
  124592. inverse(): CSG;
  124593. /**
  124594. * Inverses the CSG in place
  124595. */
  124596. inverseInPlace(): void;
  124597. /**
  124598. * This is used to keep meshes transformations so they can be restored
  124599. * when we build back a Babylon Mesh
  124600. * NB : All CSG operations are performed in world coordinates
  124601. * @param csg The CSG to copy the transform attributes from
  124602. * @returns This CSG
  124603. */
  124604. copyTransformAttributes(csg: CSG): CSG;
  124605. /**
  124606. * Build Raw mesh from CSG
  124607. * Coordinates here are in world space
  124608. * @param name The name of the mesh geometry
  124609. * @param scene The Scene
  124610. * @param keepSubMeshes Specifies if the submeshes should be kept
  124611. * @returns A new Mesh
  124612. */
  124613. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  124614. /**
  124615. * Build Mesh from CSG taking material and transforms into account
  124616. * @param name The name of the Mesh
  124617. * @param material The material of the Mesh
  124618. * @param scene The Scene
  124619. * @param keepSubMeshes Specifies if submeshes should be kept
  124620. * @returns The new Mesh
  124621. */
  124622. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  124623. }
  124624. }
  124625. declare module BABYLON {
  124626. /**
  124627. * Class used to create a trail following a mesh
  124628. */
  124629. export class TrailMesh extends Mesh {
  124630. private _generator;
  124631. private _autoStart;
  124632. private _running;
  124633. private _diameter;
  124634. private _length;
  124635. private _sectionPolygonPointsCount;
  124636. private _sectionVectors;
  124637. private _sectionNormalVectors;
  124638. private _beforeRenderObserver;
  124639. /**
  124640. * @constructor
  124641. * @param name The value used by scene.getMeshByName() to do a lookup.
  124642. * @param generator The mesh to generate a trail.
  124643. * @param scene The scene to add this mesh to.
  124644. * @param diameter Diameter of trailing mesh. Default is 1.
  124645. * @param length Length of trailing mesh. Default is 60.
  124646. * @param autoStart Automatically start trailing mesh. Default true.
  124647. */
  124648. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  124649. /**
  124650. * "TrailMesh"
  124651. * @returns "TrailMesh"
  124652. */
  124653. getClassName(): string;
  124654. private _createMesh;
  124655. /**
  124656. * Start trailing mesh.
  124657. */
  124658. start(): void;
  124659. /**
  124660. * Stop trailing mesh.
  124661. */
  124662. stop(): void;
  124663. /**
  124664. * Update trailing mesh geometry.
  124665. */
  124666. update(): void;
  124667. /**
  124668. * Returns a new TrailMesh object.
  124669. * @param name is a string, the name given to the new mesh
  124670. * @param newGenerator use new generator object for cloned trail mesh
  124671. * @returns a new mesh
  124672. */
  124673. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  124674. /**
  124675. * Serializes this trail mesh
  124676. * @param serializationObject object to write serialization to
  124677. */
  124678. serialize(serializationObject: any): void;
  124679. /**
  124680. * Parses a serialized trail mesh
  124681. * @param parsedMesh the serialized mesh
  124682. * @param scene the scene to create the trail mesh in
  124683. * @returns the created trail mesh
  124684. */
  124685. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  124686. }
  124687. }
  124688. declare module BABYLON {
  124689. /**
  124690. * Class containing static functions to help procedurally build meshes
  124691. */
  124692. export class TiledBoxBuilder {
  124693. /**
  124694. * Creates a box mesh
  124695. * faceTiles sets the pattern, tile size and number of tiles for a face * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of 6 Color3 elements) and `faceUV` (an array of 6 Vector4 elements)
  124696. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  124697. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124698. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124699. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124700. * @param name defines the name of the mesh
  124701. * @param options defines the options used to create the mesh
  124702. * @param scene defines the hosting scene
  124703. * @returns the box mesh
  124704. */
  124705. static CreateTiledBox(name: string, options: {
  124706. pattern?: number;
  124707. width?: number;
  124708. height?: number;
  124709. depth?: number;
  124710. tileSize?: number;
  124711. tileWidth?: number;
  124712. tileHeight?: number;
  124713. alignHorizontal?: number;
  124714. alignVertical?: number;
  124715. faceUV?: Vector4[];
  124716. faceColors?: Color4[];
  124717. sideOrientation?: number;
  124718. updatable?: boolean;
  124719. }, scene?: Nullable<Scene>): Mesh;
  124720. }
  124721. }
  124722. declare module BABYLON {
  124723. /**
  124724. * Class containing static functions to help procedurally build meshes
  124725. */
  124726. export class TorusKnotBuilder {
  124727. /**
  124728. * Creates a torus knot mesh
  124729. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  124730. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  124731. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  124732. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  124733. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124734. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124735. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  124736. * @param name defines the name of the mesh
  124737. * @param options defines the options used to create the mesh
  124738. * @param scene defines the hosting scene
  124739. * @returns the torus knot mesh
  124740. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  124741. */
  124742. static CreateTorusKnot(name: string, options: {
  124743. radius?: number;
  124744. tube?: number;
  124745. radialSegments?: number;
  124746. tubularSegments?: number;
  124747. p?: number;
  124748. q?: number;
  124749. updatable?: boolean;
  124750. sideOrientation?: number;
  124751. frontUVs?: Vector4;
  124752. backUVs?: Vector4;
  124753. }, scene: any): Mesh;
  124754. }
  124755. }
  124756. declare module BABYLON {
  124757. /**
  124758. * Polygon
  124759. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  124760. */
  124761. export class Polygon {
  124762. /**
  124763. * Creates a rectangle
  124764. * @param xmin bottom X coord
  124765. * @param ymin bottom Y coord
  124766. * @param xmax top X coord
  124767. * @param ymax top Y coord
  124768. * @returns points that make the resulting rectation
  124769. */
  124770. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  124771. /**
  124772. * Creates a circle
  124773. * @param radius radius of circle
  124774. * @param cx scale in x
  124775. * @param cy scale in y
  124776. * @param numberOfSides number of sides that make up the circle
  124777. * @returns points that make the resulting circle
  124778. */
  124779. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  124780. /**
  124781. * Creates a polygon from input string
  124782. * @param input Input polygon data
  124783. * @returns the parsed points
  124784. */
  124785. static Parse(input: string): Vector2[];
  124786. /**
  124787. * Starts building a polygon from x and y coordinates
  124788. * @param x x coordinate
  124789. * @param y y coordinate
  124790. * @returns the started path2
  124791. */
  124792. static StartingAt(x: number, y: number): Path2;
  124793. }
  124794. /**
  124795. * Builds a polygon
  124796. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  124797. */
  124798. export class PolygonMeshBuilder {
  124799. private _points;
  124800. private _outlinepoints;
  124801. private _holes;
  124802. private _name;
  124803. private _scene;
  124804. private _epoints;
  124805. private _eholes;
  124806. private _addToepoint;
  124807. /**
  124808. * Babylon reference to the earcut plugin.
  124809. */
  124810. bjsEarcut: any;
  124811. /**
  124812. * Creates a PolygonMeshBuilder
  124813. * @param name name of the builder
  124814. * @param contours Path of the polygon
  124815. * @param scene scene to add to when creating the mesh
  124816. * @param earcutInjection can be used to inject your own earcut reference
  124817. */
  124818. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  124819. /**
  124820. * Adds a whole within the polygon
  124821. * @param hole Array of points defining the hole
  124822. * @returns this
  124823. */
  124824. addHole(hole: Vector2[]): PolygonMeshBuilder;
  124825. /**
  124826. * Creates the polygon
  124827. * @param updatable If the mesh should be updatable
  124828. * @param depth The depth of the mesh created
  124829. * @returns the created mesh
  124830. */
  124831. build(updatable?: boolean, depth?: number): Mesh;
  124832. /**
  124833. * Creates the polygon
  124834. * @param depth The depth of the mesh created
  124835. * @returns the created VertexData
  124836. */
  124837. buildVertexData(depth?: number): VertexData;
  124838. /**
  124839. * Adds a side to the polygon
  124840. * @param positions points that make the polygon
  124841. * @param normals normals of the polygon
  124842. * @param uvs uvs of the polygon
  124843. * @param indices indices of the polygon
  124844. * @param bounds bounds of the polygon
  124845. * @param points points of the polygon
  124846. * @param depth depth of the polygon
  124847. * @param flip flip of the polygon
  124848. */
  124849. private addSide;
  124850. }
  124851. }
  124852. declare module BABYLON {
  124853. /**
  124854. * Class containing static functions to help procedurally build meshes
  124855. */
  124856. export class PolygonBuilder {
  124857. /**
  124858. * Creates a polygon mesh
  124859. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  124860. * * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  124861. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  124862. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124863. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  124864. * * Remember you can only change the shape positions, not their number when updating a polygon
  124865. * @param name defines the name of the mesh
  124866. * @param options defines the options used to create the mesh
  124867. * @param scene defines the hosting scene
  124868. * @param earcutInjection can be used to inject your own earcut reference
  124869. * @returns the polygon mesh
  124870. */
  124871. static CreatePolygon(name: string, options: {
  124872. shape: Vector3[];
  124873. holes?: Vector3[][];
  124874. depth?: number;
  124875. faceUV?: Vector4[];
  124876. faceColors?: Color4[];
  124877. updatable?: boolean;
  124878. sideOrientation?: number;
  124879. frontUVs?: Vector4;
  124880. backUVs?: Vector4;
  124881. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  124882. /**
  124883. * Creates an extruded polygon mesh, with depth in the Y direction.
  124884. * * You can set different colors and different images to the top, bottom and extruded side by using the parameters `faceColors` (an array of 3 Color3 elements) and `faceUV` (an array of 3 Vector4 elements)
  124885. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  124886. * @param name defines the name of the mesh
  124887. * @param options defines the options used to create the mesh
  124888. * @param scene defines the hosting scene
  124889. * @param earcutInjection can be used to inject your own earcut reference
  124890. * @returns the polygon mesh
  124891. */
  124892. static ExtrudePolygon(name: string, options: {
  124893. shape: Vector3[];
  124894. holes?: Vector3[][];
  124895. depth?: number;
  124896. faceUV?: Vector4[];
  124897. faceColors?: Color4[];
  124898. updatable?: boolean;
  124899. sideOrientation?: number;
  124900. frontUVs?: Vector4;
  124901. backUVs?: Vector4;
  124902. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  124903. }
  124904. }
  124905. declare module BABYLON {
  124906. /**
  124907. * Class containing static functions to help procedurally build meshes
  124908. */
  124909. export class LatheBuilder {
  124910. /**
  124911. * Creates lathe mesh.
  124912. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  124913. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  124914. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  124915. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  124916. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  124917. * * The parameter `arc` (positive float, default 1) is the ratio of the lathe. 0.5 builds for instance half a lathe, so an opened shape
  124918. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  124919. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  124920. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  124921. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124922. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  124923. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  124924. * @param name defines the name of the mesh
  124925. * @param options defines the options used to create the mesh
  124926. * @param scene defines the hosting scene
  124927. * @returns the lathe mesh
  124928. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  124929. */
  124930. static CreateLathe(name: string, options: {
  124931. shape: Vector3[];
  124932. radius?: number;
  124933. tessellation?: number;
  124934. clip?: number;
  124935. arc?: number;
  124936. closed?: boolean;
  124937. updatable?: boolean;
  124938. sideOrientation?: number;
  124939. frontUVs?: Vector4;
  124940. backUVs?: Vector4;
  124941. cap?: number;
  124942. invertUV?: boolean;
  124943. }, scene?: Nullable<Scene>): Mesh;
  124944. }
  124945. }
  124946. declare module BABYLON {
  124947. /**
  124948. * Class containing static functions to help procedurally build meshes
  124949. */
  124950. export class TiledPlaneBuilder {
  124951. /**
  124952. * Creates a tiled plane mesh
  124953. * * The parameter `pattern` will, depending on value, do nothing or
  124954. * * * flip (reflect about central vertical) alternate tiles across and up
  124955. * * * flip every tile on alternate rows
  124956. * * * rotate (180 degs) alternate tiles across and up
  124957. * * * rotate every tile on alternate rows
  124958. * * * flip and rotate alternate tiles across and up
  124959. * * * flip and rotate every tile on alternate rows
  124960. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  124961. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  124962. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  124963. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  124964. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  124965. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  124966. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  124967. * @param name defines the name of the mesh
  124968. * @param options defines the options used to create the mesh
  124969. * @param scene defines the hosting scene
  124970. * @returns the box mesh
  124971. */
  124972. static CreateTiledPlane(name: string, options: {
  124973. pattern?: number;
  124974. tileSize?: number;
  124975. tileWidth?: number;
  124976. tileHeight?: number;
  124977. size?: number;
  124978. width?: number;
  124979. height?: number;
  124980. alignHorizontal?: number;
  124981. alignVertical?: number;
  124982. sideOrientation?: number;
  124983. frontUVs?: Vector4;
  124984. backUVs?: Vector4;
  124985. updatable?: boolean;
  124986. }, scene?: Nullable<Scene>): Mesh;
  124987. }
  124988. }
  124989. declare module BABYLON {
  124990. /**
  124991. * Class containing static functions to help procedurally build meshes
  124992. */
  124993. export class TubeBuilder {
  124994. /**
  124995. * Creates a tube mesh.
  124996. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  124997. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  124998. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  124999. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  125000. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  125001. * * This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path. It must return a radius value (positive float)
  125002. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  125003. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  125004. * * The optional parameter `instance` is an instance of an existing Tube object to be updated with the passed `pathArray` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#tube
  125005. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125006. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125007. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125008. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125009. * @param name defines the name of the mesh
  125010. * @param options defines the options used to create the mesh
  125011. * @param scene defines the hosting scene
  125012. * @returns the tube mesh
  125013. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125014. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  125015. */
  125016. static CreateTube(name: string, options: {
  125017. path: Vector3[];
  125018. radius?: number;
  125019. tessellation?: number;
  125020. radiusFunction?: {
  125021. (i: number, distance: number): number;
  125022. };
  125023. cap?: number;
  125024. arc?: number;
  125025. updatable?: boolean;
  125026. sideOrientation?: number;
  125027. frontUVs?: Vector4;
  125028. backUVs?: Vector4;
  125029. instance?: Mesh;
  125030. invertUV?: boolean;
  125031. }, scene?: Nullable<Scene>): Mesh;
  125032. }
  125033. }
  125034. declare module BABYLON {
  125035. /**
  125036. * Class containing static functions to help procedurally build meshes
  125037. */
  125038. export class IcoSphereBuilder {
  125039. /**
  125040. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  125041. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  125042. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value of `radius`)
  125043. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  125044. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  125045. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125046. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125047. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125048. * @param name defines the name of the mesh
  125049. * @param options defines the options used to create the mesh
  125050. * @param scene defines the hosting scene
  125051. * @returns the icosahedron mesh
  125052. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  125053. */
  125054. static CreateIcoSphere(name: string, options: {
  125055. radius?: number;
  125056. radiusX?: number;
  125057. radiusY?: number;
  125058. radiusZ?: number;
  125059. flat?: boolean;
  125060. subdivisions?: number;
  125061. sideOrientation?: number;
  125062. frontUVs?: Vector4;
  125063. backUVs?: Vector4;
  125064. updatable?: boolean;
  125065. }, scene?: Nullable<Scene>): Mesh;
  125066. }
  125067. }
  125068. declare module BABYLON {
  125069. /**
  125070. * Class containing static functions to help procedurally build meshes
  125071. */
  125072. export class DecalBuilder {
  125073. /**
  125074. * Creates a decal mesh.
  125075. * A decal is a mesh usually applied as a model onto the surface of another mesh. So don't forget the parameter `sourceMesh` depicting the decal
  125076. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  125077. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  125078. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  125079. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  125080. * @param name defines the name of the mesh
  125081. * @param sourceMesh defines the mesh where the decal must be applied
  125082. * @param options defines the options used to create the mesh
  125083. * @param scene defines the hosting scene
  125084. * @returns the decal mesh
  125085. * @see https://doc.babylonjs.com/how_to/decals
  125086. */
  125087. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  125088. position?: Vector3;
  125089. normal?: Vector3;
  125090. size?: Vector3;
  125091. angle?: number;
  125092. }): Mesh;
  125093. }
  125094. }
  125095. declare module BABYLON {
  125096. /**
  125097. * Class containing static functions to help procedurally build meshes
  125098. */
  125099. export class MeshBuilder {
  125100. /**
  125101. * Creates a box mesh
  125102. * * The parameter `size` sets the size (float) of each box side (default 1)
  125103. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  125104. * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of 6 Color3 elements) and `faceUV` (an array of 6 Vector4 elements)
  125105. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125106. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125107. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125108. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125109. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  125110. * @param name defines the name of the mesh
  125111. * @param options defines the options used to create the mesh
  125112. * @param scene defines the hosting scene
  125113. * @returns the box mesh
  125114. */
  125115. static CreateBox(name: string, options: {
  125116. size?: number;
  125117. width?: number;
  125118. height?: number;
  125119. depth?: number;
  125120. faceUV?: Vector4[];
  125121. faceColors?: Color4[];
  125122. sideOrientation?: number;
  125123. frontUVs?: Vector4;
  125124. backUVs?: Vector4;
  125125. updatable?: boolean;
  125126. }, scene?: Nullable<Scene>): Mesh;
  125127. /**
  125128. * Creates a tiled box mesh
  125129. * * faceTiles sets the pattern, tile size and number of tiles for a face
  125130. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125131. * @param name defines the name of the mesh
  125132. * @param options defines the options used to create the mesh
  125133. * @param scene defines the hosting scene
  125134. * @returns the tiled box mesh
  125135. */
  125136. static CreateTiledBox(name: string, options: {
  125137. pattern?: number;
  125138. size?: number;
  125139. width?: number;
  125140. height?: number;
  125141. depth: number;
  125142. tileSize?: number;
  125143. tileWidth?: number;
  125144. tileHeight?: number;
  125145. faceUV?: Vector4[];
  125146. faceColors?: Color4[];
  125147. alignHorizontal?: number;
  125148. alignVertical?: number;
  125149. sideOrientation?: number;
  125150. updatable?: boolean;
  125151. }, scene?: Nullable<Scene>): Mesh;
  125152. /**
  125153. * Creates a sphere mesh
  125154. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  125155. * * You can set some different sphere dimensions, for instance to build an ellipsoid, by using the parameters `diameterX`, `diameterY` and `diameterZ` (all by default have the same value of `diameter`)
  125156. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  125157. * * You can create an unclosed sphere with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference (latitude) : 2 x PI x ratio
  125158. * * You can create an unclosed sphere on its height with the parameter `slice` (positive float, default1), valued between 0 and 1, what is the height ratio (longitude)
  125159. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125160. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125161. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125162. * @param name defines the name of the mesh
  125163. * @param options defines the options used to create the mesh
  125164. * @param scene defines the hosting scene
  125165. * @returns the sphere mesh
  125166. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  125167. */
  125168. static CreateSphere(name: string, options: {
  125169. segments?: number;
  125170. diameter?: number;
  125171. diameterX?: number;
  125172. diameterY?: number;
  125173. diameterZ?: number;
  125174. arc?: number;
  125175. slice?: number;
  125176. sideOrientation?: number;
  125177. frontUVs?: Vector4;
  125178. backUVs?: Vector4;
  125179. updatable?: boolean;
  125180. }, scene?: Nullable<Scene>): Mesh;
  125181. /**
  125182. * Creates a plane polygonal mesh. By default, this is a disc
  125183. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  125184. * * The parameter `tessellation` sets the number of polygon sides (positive integer, default 64). So a tessellation valued to 3 will build a triangle, to 4 a square, etc
  125185. * * You can create an unclosed polygon with the parameter `arc` (positive float, default 1), valued between 0 and 1, what is the ratio of the circumference : 2 x PI x ratio
  125186. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125187. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125188. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125189. * @param name defines the name of the mesh
  125190. * @param options defines the options used to create the mesh
  125191. * @param scene defines the hosting scene
  125192. * @returns the plane polygonal mesh
  125193. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  125194. */
  125195. static CreateDisc(name: string, options: {
  125196. radius?: number;
  125197. tessellation?: number;
  125198. arc?: number;
  125199. updatable?: boolean;
  125200. sideOrientation?: number;
  125201. frontUVs?: Vector4;
  125202. backUVs?: Vector4;
  125203. }, scene?: Nullable<Scene>): Mesh;
  125204. /**
  125205. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  125206. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  125207. * * You can set some different icosphere dimensions, for instance to build an ellipsoid, by using the parameters `radiusX`, `radiusY` and `radiusZ` (all by default have the same value of `radius`)
  125208. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  125209. * * The parameter `flat` (boolean, default true) gives each side its own normals. Set it to false to get a smooth continuous light reflection on the surface
  125210. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125211. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125212. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125213. * @param name defines the name of the mesh
  125214. * @param options defines the options used to create the mesh
  125215. * @param scene defines the hosting scene
  125216. * @returns the icosahedron mesh
  125217. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  125218. */
  125219. static CreateIcoSphere(name: string, options: {
  125220. radius?: number;
  125221. radiusX?: number;
  125222. radiusY?: number;
  125223. radiusZ?: number;
  125224. flat?: boolean;
  125225. subdivisions?: number;
  125226. sideOrientation?: number;
  125227. frontUVs?: Vector4;
  125228. backUVs?: Vector4;
  125229. updatable?: boolean;
  125230. }, scene?: Nullable<Scene>): Mesh;
  125231. /**
  125232. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  125233. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  125234. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  125235. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  125236. * * The parameter `offset` (positive integer, default : rounded half size of the pathArray length), is taken in account only if the `pathArray` is containing a single path
  125237. * * It's the offset to join the points from the same path. Ex : offset = 10 means the point 1 is joined to the point 11
  125238. * * The optional parameter `instance` is an instance of an existing Ribbon object to be updated with the passed `pathArray` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#ribbon
  125239. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125240. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125241. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125242. * * The parameter `uvs` is an optional flat array of `Vector2` to update/set each ribbon vertex with its own custom UV values instead of the computed ones
  125243. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  125244. * * Note that if you use the parameters `uvs` or `colors`, the passed arrays must be populated with the right number of elements, it is to say the number of ribbon vertices. Remember that if you set `closePath` to `true`, there's one extra vertex per path in the geometry
  125245. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  125246. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125247. * @param name defines the name of the mesh
  125248. * @param options defines the options used to create the mesh
  125249. * @param scene defines the hosting scene
  125250. * @returns the ribbon mesh
  125251. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  125252. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125253. */
  125254. static CreateRibbon(name: string, options: {
  125255. pathArray: Vector3[][];
  125256. closeArray?: boolean;
  125257. closePath?: boolean;
  125258. offset?: number;
  125259. updatable?: boolean;
  125260. sideOrientation?: number;
  125261. frontUVs?: Vector4;
  125262. backUVs?: Vector4;
  125263. instance?: Mesh;
  125264. invertUV?: boolean;
  125265. uvs?: Vector2[];
  125266. colors?: Color4[];
  125267. }, scene?: Nullable<Scene>): Mesh;
  125268. /**
  125269. * Creates a cylinder or a cone mesh
  125270. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  125271. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  125272. * * The parameters `diameterTop` and `diameterBottom` overwrite the parameter `diameter` and set respectively the top cap and bottom cap diameter (floats, default 1). The parameter "diameterBottom" can't be zero.
  125273. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  125274. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  125275. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  125276. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  125277. * * The parameter `cap` sets the way the cylinder is capped. Possible values : BABYLON.Mesh.NO_CAP, BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL (default).
  125278. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  125279. * * You can set different colors and different images to each box side by using the parameters `faceColors` (an array of n Color3 elements) and `faceUV` (an array of n Vector4 elements).
  125280. * * The value of n is the number of cylinder faces. If the cylinder has only 1 subdivisions, n equals : top face + cylinder surface + bottom face = 3
  125281. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  125282. * * Finally, if the cylinder has 5 independent subdivisions and is enclose, n equals : top face + 5 x (stripe surface + 2 closing faces) + bottom face = 2 + 5 * 3 = 17
  125283. * * Each array (color or UVs) is always ordered the same way : the first element is the bottom cap, the last element is the top cap. The other elements are each a ring surface.
  125284. * * If `enclose` is false, a ring surface is one element.
  125285. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  125286. * * Example how to set colors and textures on a sliced cylinder : https://www.html5gamedevs.com/topic/17945-creating-a-closed-slice-of-a-cylinder/#comment-106379
  125287. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125288. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125289. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125290. * @param name defines the name of the mesh
  125291. * @param options defines the options used to create the mesh
  125292. * @param scene defines the hosting scene
  125293. * @returns the cylinder mesh
  125294. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  125295. */
  125296. static CreateCylinder(name: string, options: {
  125297. height?: number;
  125298. diameterTop?: number;
  125299. diameterBottom?: number;
  125300. diameter?: number;
  125301. tessellation?: number;
  125302. subdivisions?: number;
  125303. arc?: number;
  125304. faceColors?: Color4[];
  125305. faceUV?: Vector4[];
  125306. updatable?: boolean;
  125307. hasRings?: boolean;
  125308. enclose?: boolean;
  125309. cap?: number;
  125310. sideOrientation?: number;
  125311. frontUVs?: Vector4;
  125312. backUVs?: Vector4;
  125313. }, scene?: Nullable<Scene>): Mesh;
  125314. /**
  125315. * Creates a torus mesh
  125316. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  125317. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  125318. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  125319. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125320. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125321. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125322. * @param name defines the name of the mesh
  125323. * @param options defines the options used to create the mesh
  125324. * @param scene defines the hosting scene
  125325. * @returns the torus mesh
  125326. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  125327. */
  125328. static CreateTorus(name: string, options: {
  125329. diameter?: number;
  125330. thickness?: number;
  125331. tessellation?: number;
  125332. updatable?: boolean;
  125333. sideOrientation?: number;
  125334. frontUVs?: Vector4;
  125335. backUVs?: Vector4;
  125336. }, scene?: Nullable<Scene>): Mesh;
  125337. /**
  125338. * Creates a torus knot mesh
  125339. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  125340. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  125341. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  125342. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  125343. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125344. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125345. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125346. * @param name defines the name of the mesh
  125347. * @param options defines the options used to create the mesh
  125348. * @param scene defines the hosting scene
  125349. * @returns the torus knot mesh
  125350. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  125351. */
  125352. static CreateTorusKnot(name: string, options: {
  125353. radius?: number;
  125354. tube?: number;
  125355. radialSegments?: number;
  125356. tubularSegments?: number;
  125357. p?: number;
  125358. q?: number;
  125359. updatable?: boolean;
  125360. sideOrientation?: number;
  125361. frontUVs?: Vector4;
  125362. backUVs?: Vector4;
  125363. }, scene?: Nullable<Scene>): Mesh;
  125364. /**
  125365. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  125366. * * A line system mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of lines as an input parameter
  125367. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  125368. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  125369. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  125370. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  125371. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  125372. * * Updating a simple Line mesh, you just need to update every line in the `lines` array : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  125373. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  125374. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125375. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  125376. * @param name defines the name of the new line system
  125377. * @param options defines the options used to create the line system
  125378. * @param scene defines the hosting scene
  125379. * @returns a new line system mesh
  125380. */
  125381. static CreateLineSystem(name: string, options: {
  125382. lines: Vector3[][];
  125383. updatable?: boolean;
  125384. instance?: Nullable<LinesMesh>;
  125385. colors?: Nullable<Color4[][]>;
  125386. useVertexAlpha?: boolean;
  125387. }, scene: Nullable<Scene>): LinesMesh;
  125388. /**
  125389. * Creates a line mesh
  125390. * A line mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of points as an input parameter
  125391. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  125392. * * The parameter `points` is an array successive Vector3
  125393. * * The optional parameter `instance` is an instance of an existing LineMesh object to be updated with the passed `points` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  125394. * * The optional parameter `colors` is an array of successive Color4, one per line point
  125395. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  125396. * * When updating an instance, remember that only point positions can change, not the number of points
  125397. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125398. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  125399. * @param name defines the name of the new line system
  125400. * @param options defines the options used to create the line system
  125401. * @param scene defines the hosting scene
  125402. * @returns a new line mesh
  125403. */
  125404. static CreateLines(name: string, options: {
  125405. points: Vector3[];
  125406. updatable?: boolean;
  125407. instance?: Nullable<LinesMesh>;
  125408. colors?: Color4[];
  125409. useVertexAlpha?: boolean;
  125410. }, scene?: Nullable<Scene>): LinesMesh;
  125411. /**
  125412. * Creates a dashed line mesh
  125413. * * A dashed line mesh is considered as a parametric shape since it has no predefined original shape. Its shape is determined by the passed array of points as an input parameter
  125414. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  125415. * * The parameter `points` is an array successive Vector3
  125416. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  125417. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  125418. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  125419. * * The optional parameter `instance` is an instance of an existing LineMesh object to be updated with the passed `points` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#lines-and-dashedlines
  125420. * * When updating an instance, remember that only point positions can change, not the number of points
  125421. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125422. * @param name defines the name of the mesh
  125423. * @param options defines the options used to create the mesh
  125424. * @param scene defines the hosting scene
  125425. * @returns the dashed line mesh
  125426. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  125427. */
  125428. static CreateDashedLines(name: string, options: {
  125429. points: Vector3[];
  125430. dashSize?: number;
  125431. gapSize?: number;
  125432. dashNb?: number;
  125433. updatable?: boolean;
  125434. instance?: LinesMesh;
  125435. }, scene?: Nullable<Scene>): LinesMesh;
  125436. /**
  125437. * Creates an extruded shape mesh. The extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  125438. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis.
  125439. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  125440. * * The parameter `rotation` (float, default 0 radians) is the angle value to rotate the shape each step (each path point), from the former step (so rotation added each step) along the curve.
  125441. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  125442. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  125443. * * The optional parameter `instance` is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape
  125444. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  125445. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125446. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125447. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  125448. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125449. * @param name defines the name of the mesh
  125450. * @param options defines the options used to create the mesh
  125451. * @param scene defines the hosting scene
  125452. * @returns the extruded shape mesh
  125453. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125454. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  125455. */
  125456. static ExtrudeShape(name: string, options: {
  125457. shape: Vector3[];
  125458. path: Vector3[];
  125459. scale?: number;
  125460. rotation?: number;
  125461. cap?: number;
  125462. updatable?: boolean;
  125463. sideOrientation?: number;
  125464. frontUVs?: Vector4;
  125465. backUVs?: Vector4;
  125466. instance?: Mesh;
  125467. invertUV?: boolean;
  125468. }, scene?: Nullable<Scene>): Mesh;
  125469. /**
  125470. * Creates an custom extruded shape mesh.
  125471. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  125472. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be extruded in its local space : the shape must be designed in the xOy plane and will be extruded along the Z axis.
  125473. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  125474. * * The parameter `rotationFunction` (JS function) is a custom Javascript function called on each path point. This function is passed the position i of the point in the path and the distance of this point from the begining of the path
  125475. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  125476. * * The parameter `scaleFunction` (JS function) is a custom Javascript function called on each path point. This function is passed the position i of the point in the path and the distance of this point from the begining of the path
  125477. * * It must returns a float value that will be the scale value applied to the shape on each path point
  125478. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  125479. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  125480. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  125481. * * The optional parameter `instance` is an instance of an existing ExtrudedShape object to be updated with the passed `shape`, `path`, `scale` or `rotation` parameters : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#extruded-shape
  125482. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  125483. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125484. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125485. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125486. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125487. * @param name defines the name of the mesh
  125488. * @param options defines the options used to create the mesh
  125489. * @param scene defines the hosting scene
  125490. * @returns the custom extruded shape mesh
  125491. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  125492. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125493. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  125494. */
  125495. static ExtrudeShapeCustom(name: string, options: {
  125496. shape: Vector3[];
  125497. path: Vector3[];
  125498. scaleFunction?: any;
  125499. rotationFunction?: any;
  125500. ribbonCloseArray?: boolean;
  125501. ribbonClosePath?: boolean;
  125502. cap?: number;
  125503. updatable?: boolean;
  125504. sideOrientation?: number;
  125505. frontUVs?: Vector4;
  125506. backUVs?: Vector4;
  125507. instance?: Mesh;
  125508. invertUV?: boolean;
  125509. }, scene?: Nullable<Scene>): Mesh;
  125510. /**
  125511. * Creates lathe mesh.
  125512. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  125513. * * The parameter `shape` is a required array of successive Vector3. This array depicts the shape to be rotated in its local space : the shape must be designed in the xOy plane and will be rotated around the Y axis. It's usually a 2D shape, so the Vector3 z coordinates are often set to zero
  125514. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  125515. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  125516. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  125517. * * The parameter `arc` (positive float, default 1) is the ratio of the lathe. 0.5 builds for instance half a lathe, so an opened shape
  125518. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  125519. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  125520. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125521. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125522. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125523. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125524. * @param name defines the name of the mesh
  125525. * @param options defines the options used to create the mesh
  125526. * @param scene defines the hosting scene
  125527. * @returns the lathe mesh
  125528. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  125529. */
  125530. static CreateLathe(name: string, options: {
  125531. shape: Vector3[];
  125532. radius?: number;
  125533. tessellation?: number;
  125534. clip?: number;
  125535. arc?: number;
  125536. closed?: boolean;
  125537. updatable?: boolean;
  125538. sideOrientation?: number;
  125539. frontUVs?: Vector4;
  125540. backUVs?: Vector4;
  125541. cap?: number;
  125542. invertUV?: boolean;
  125543. }, scene?: Nullable<Scene>): Mesh;
  125544. /**
  125545. * Creates a tiled plane mesh
  125546. * * You can set a limited pattern arrangement with the tiles
  125547. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125548. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125549. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125550. * @param name defines the name of the mesh
  125551. * @param options defines the options used to create the mesh
  125552. * @param scene defines the hosting scene
  125553. * @returns the plane mesh
  125554. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  125555. */
  125556. static CreateTiledPlane(name: string, options: {
  125557. pattern?: number;
  125558. tileSize?: number;
  125559. tileWidth?: number;
  125560. tileHeight?: number;
  125561. size?: number;
  125562. width?: number;
  125563. height?: number;
  125564. alignHorizontal?: number;
  125565. alignVertical?: number;
  125566. sideOrientation?: number;
  125567. frontUVs?: Vector4;
  125568. backUVs?: Vector4;
  125569. updatable?: boolean;
  125570. }, scene?: Nullable<Scene>): Mesh;
  125571. /**
  125572. * Creates a plane mesh
  125573. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  125574. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  125575. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  125576. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125577. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125578. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125579. * @param name defines the name of the mesh
  125580. * @param options defines the options used to create the mesh
  125581. * @param scene defines the hosting scene
  125582. * @returns the plane mesh
  125583. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  125584. */
  125585. static CreatePlane(name: string, options: {
  125586. size?: number;
  125587. width?: number;
  125588. height?: number;
  125589. sideOrientation?: number;
  125590. frontUVs?: Vector4;
  125591. backUVs?: Vector4;
  125592. updatable?: boolean;
  125593. sourcePlane?: Plane;
  125594. }, scene?: Nullable<Scene>): Mesh;
  125595. /**
  125596. * Creates a ground mesh
  125597. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  125598. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  125599. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125600. * @param name defines the name of the mesh
  125601. * @param options defines the options used to create the mesh
  125602. * @param scene defines the hosting scene
  125603. * @returns the ground mesh
  125604. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  125605. */
  125606. static CreateGround(name: string, options: {
  125607. width?: number;
  125608. height?: number;
  125609. subdivisions?: number;
  125610. subdivisionsX?: number;
  125611. subdivisionsY?: number;
  125612. updatable?: boolean;
  125613. }, scene?: Nullable<Scene>): Mesh;
  125614. /**
  125615. * Creates a tiled ground mesh
  125616. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  125617. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  125618. * * The parameter `subdivisions` is a javascript object `{w: positive integer, h: positive integer}` (default `{w: 6, h: 6}`). `w` and `h` are the numbers of subdivisions on the ground width and height. Each subdivision is called a tile
  125619. * * The parameter `precision` is a javascript object `{w: positive integer, h: positive integer}` (default `{w: 2, h: 2}`). `w` and `h` are the numbers of subdivisions on the ground width and height of each tile
  125620. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125621. * @param name defines the name of the mesh
  125622. * @param options defines the options used to create the mesh
  125623. * @param scene defines the hosting scene
  125624. * @returns the tiled ground mesh
  125625. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  125626. */
  125627. static CreateTiledGround(name: string, options: {
  125628. xmin: number;
  125629. zmin: number;
  125630. xmax: number;
  125631. zmax: number;
  125632. subdivisions?: {
  125633. w: number;
  125634. h: number;
  125635. };
  125636. precision?: {
  125637. w: number;
  125638. h: number;
  125639. };
  125640. updatable?: boolean;
  125641. }, scene?: Nullable<Scene>): Mesh;
  125642. /**
  125643. * Creates a ground mesh from a height map
  125644. * * The parameter `url` sets the URL of the height map image resource.
  125645. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  125646. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  125647. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  125648. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  125649. * * The parameter `colorFilter` (optional Color3, default (0.3, 0.59, 0.11) ) is the filter to apply to the image pixel colors to compute the height.
  125650. * * The parameter `onReady` is a javascript callback function that will be called once the mesh is just built (the height map download can last some time).
  125651. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  125652. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125653. * @param name defines the name of the mesh
  125654. * @param url defines the url to the height map
  125655. * @param options defines the options used to create the mesh
  125656. * @param scene defines the hosting scene
  125657. * @returns the ground mesh
  125658. * @see https://doc.babylonjs.com/babylon101/height_map
  125659. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  125660. */
  125661. static CreateGroundFromHeightMap(name: string, url: string, options: {
  125662. width?: number;
  125663. height?: number;
  125664. subdivisions?: number;
  125665. minHeight?: number;
  125666. maxHeight?: number;
  125667. colorFilter?: Color3;
  125668. alphaFilter?: number;
  125669. updatable?: boolean;
  125670. onReady?: (mesh: GroundMesh) => void;
  125671. }, scene?: Nullable<Scene>): GroundMesh;
  125672. /**
  125673. * Creates a polygon mesh
  125674. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  125675. * * The parameter `shape` is a required array of successive Vector3 representing the corners of the polygon in th XoZ plane, that is y = 0 for all vectors
  125676. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  125677. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125678. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  125679. * * Remember you can only change the shape positions, not their number when updating a polygon
  125680. * @param name defines the name of the mesh
  125681. * @param options defines the options used to create the mesh
  125682. * @param scene defines the hosting scene
  125683. * @param earcutInjection can be used to inject your own earcut reference
  125684. * @returns the polygon mesh
  125685. */
  125686. static CreatePolygon(name: string, options: {
  125687. shape: Vector3[];
  125688. holes?: Vector3[][];
  125689. depth?: number;
  125690. faceUV?: Vector4[];
  125691. faceColors?: Color4[];
  125692. updatable?: boolean;
  125693. sideOrientation?: number;
  125694. frontUVs?: Vector4;
  125695. backUVs?: Vector4;
  125696. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  125697. /**
  125698. * Creates an extruded polygon mesh, with depth in the Y direction.
  125699. * * You can set different colors and different images to the top, bottom and extruded side by using the parameters `faceColors` (an array of 3 Color3 elements) and `faceUV` (an array of 3 Vector4 elements)
  125700. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125701. * @param name defines the name of the mesh
  125702. * @param options defines the options used to create the mesh
  125703. * @param scene defines the hosting scene
  125704. * @param earcutInjection can be used to inject your own earcut reference
  125705. * @returns the polygon mesh
  125706. */
  125707. static ExtrudePolygon(name: string, options: {
  125708. shape: Vector3[];
  125709. holes?: Vector3[][];
  125710. depth?: number;
  125711. faceUV?: Vector4[];
  125712. faceColors?: Color4[];
  125713. updatable?: boolean;
  125714. sideOrientation?: number;
  125715. frontUVs?: Vector4;
  125716. backUVs?: Vector4;
  125717. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  125718. /**
  125719. * Creates a tube mesh.
  125720. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  125721. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  125722. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  125723. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  125724. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  125725. * * This function is called on each point of the tube path and is passed the index `i` of the i-th point and the distance of this point from the first point of the path. It must return a radius value (positive float)
  125726. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  125727. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  125728. * * The optional parameter `instance` is an instance of an existing Tube object to be updated with the passed `pathArray` parameter : https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#tube
  125729. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125730. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125731. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125732. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125733. * @param name defines the name of the mesh
  125734. * @param options defines the options used to create the mesh
  125735. * @param scene defines the hosting scene
  125736. * @returns the tube mesh
  125737. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125738. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  125739. */
  125740. static CreateTube(name: string, options: {
  125741. path: Vector3[];
  125742. radius?: number;
  125743. tessellation?: number;
  125744. radiusFunction?: {
  125745. (i: number, distance: number): number;
  125746. };
  125747. cap?: number;
  125748. arc?: number;
  125749. updatable?: boolean;
  125750. sideOrientation?: number;
  125751. frontUVs?: Vector4;
  125752. backUVs?: Vector4;
  125753. instance?: Mesh;
  125754. invertUV?: boolean;
  125755. }, scene?: Nullable<Scene>): Mesh;
  125756. /**
  125757. * Creates a polyhedron mesh
  125758. * * The parameter `type` (positive integer, max 14, default 0) sets the polyhedron type to build among the 15 embbeded types. Please refer to the type sheet in the tutorial to choose the wanted type
  125759. * * The parameter `size` (positive float, default 1) sets the polygon size
  125760. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  125761. * * You can build other polyhedron types than the 15 embbeded ones by setting the parameter `custom` (`polyhedronObject`, default null). If you set the parameter `custom`, this overwrittes the parameter `type`
  125762. * * A `polyhedronObject` is a formatted javascript object. You'll find a full file with pre-set polyhedra here : https://github.com/BabylonJS/Extensions/tree/master/Polyhedron
  125763. * * You can set the color and the UV of each side of the polyhedron with the parameters `faceColors` (Color4, default `(1, 1, 1, 1)`) and faceUV (Vector4, default `(0, 0, 1, 1)`)
  125764. * * To understand how to set `faceUV` or `faceColors`, please read this by considering the right number of faces of your polyhedron, instead of only 6 for the box : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125765. * * The parameter `flat` (boolean, default true). If set to false, it gives the polyhedron a single global face, so less vertices and shared normals. In this case, `faceColors` and `faceUV` are ignored
  125766. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125767. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125768. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125769. * @param name defines the name of the mesh
  125770. * @param options defines the options used to create the mesh
  125771. * @param scene defines the hosting scene
  125772. * @returns the polyhedron mesh
  125773. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  125774. */
  125775. static CreatePolyhedron(name: string, options: {
  125776. type?: number;
  125777. size?: number;
  125778. sizeX?: number;
  125779. sizeY?: number;
  125780. sizeZ?: number;
  125781. custom?: any;
  125782. faceUV?: Vector4[];
  125783. faceColors?: Color4[];
  125784. flat?: boolean;
  125785. updatable?: boolean;
  125786. sideOrientation?: number;
  125787. frontUVs?: Vector4;
  125788. backUVs?: Vector4;
  125789. }, scene?: Nullable<Scene>): Mesh;
  125790. /**
  125791. * Creates a decal mesh.
  125792. * A decal is a mesh usually applied as a model onto the surface of another mesh. So don't forget the parameter `sourceMesh` depicting the decal
  125793. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  125794. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  125795. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  125796. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  125797. * @param name defines the name of the mesh
  125798. * @param sourceMesh defines the mesh where the decal must be applied
  125799. * @param options defines the options used to create the mesh
  125800. * @param scene defines the hosting scene
  125801. * @returns the decal mesh
  125802. * @see https://doc.babylonjs.com/how_to/decals
  125803. */
  125804. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  125805. position?: Vector3;
  125806. normal?: Vector3;
  125807. size?: Vector3;
  125808. angle?: number;
  125809. }): Mesh;
  125810. }
  125811. }
  125812. declare module BABYLON {
  125813. /**
  125814. * A simplifier interface for future simplification implementations
  125815. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125816. */
  125817. export interface ISimplifier {
  125818. /**
  125819. * Simplification of a given mesh according to the given settings.
  125820. * Since this requires computation, it is assumed that the function runs async.
  125821. * @param settings The settings of the simplification, including quality and distance
  125822. * @param successCallback A callback that will be called after the mesh was simplified.
  125823. * @param errorCallback in case of an error, this callback will be called. optional.
  125824. */
  125825. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  125826. }
  125827. /**
  125828. * Expected simplification settings.
  125829. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  125830. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125831. */
  125832. export interface ISimplificationSettings {
  125833. /**
  125834. * Gets or sets the expected quality
  125835. */
  125836. quality: number;
  125837. /**
  125838. * Gets or sets the distance when this optimized version should be used
  125839. */
  125840. distance: number;
  125841. /**
  125842. * Gets an already optimized mesh
  125843. */
  125844. optimizeMesh?: boolean;
  125845. }
  125846. /**
  125847. * Class used to specify simplification options
  125848. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125849. */
  125850. export class SimplificationSettings implements ISimplificationSettings {
  125851. /** expected quality */
  125852. quality: number;
  125853. /** distance when this optimized version should be used */
  125854. distance: number;
  125855. /** already optimized mesh */
  125856. optimizeMesh?: boolean | undefined;
  125857. /**
  125858. * Creates a SimplificationSettings
  125859. * @param quality expected quality
  125860. * @param distance distance when this optimized version should be used
  125861. * @param optimizeMesh already optimized mesh
  125862. */
  125863. constructor(
  125864. /** expected quality */
  125865. quality: number,
  125866. /** distance when this optimized version should be used */
  125867. distance: number,
  125868. /** already optimized mesh */
  125869. optimizeMesh?: boolean | undefined);
  125870. }
  125871. /**
  125872. * Interface used to define a simplification task
  125873. */
  125874. export interface ISimplificationTask {
  125875. /**
  125876. * Array of settings
  125877. */
  125878. settings: Array<ISimplificationSettings>;
  125879. /**
  125880. * Simplification type
  125881. */
  125882. simplificationType: SimplificationType;
  125883. /**
  125884. * Mesh to simplify
  125885. */
  125886. mesh: Mesh;
  125887. /**
  125888. * Callback called on success
  125889. */
  125890. successCallback?: () => void;
  125891. /**
  125892. * Defines if parallel processing can be used
  125893. */
  125894. parallelProcessing: boolean;
  125895. }
  125896. /**
  125897. * Queue used to order the simplification tasks
  125898. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125899. */
  125900. export class SimplificationQueue {
  125901. private _simplificationArray;
  125902. /**
  125903. * Gets a boolean indicating that the process is still running
  125904. */
  125905. running: boolean;
  125906. /**
  125907. * Creates a new queue
  125908. */
  125909. constructor();
  125910. /**
  125911. * Adds a new simplification task
  125912. * @param task defines a task to add
  125913. */
  125914. addTask(task: ISimplificationTask): void;
  125915. /**
  125916. * Execute next task
  125917. */
  125918. executeNext(): void;
  125919. /**
  125920. * Execute a simplification task
  125921. * @param task defines the task to run
  125922. */
  125923. runSimplification(task: ISimplificationTask): void;
  125924. private getSimplifier;
  125925. }
  125926. /**
  125927. * The implemented types of simplification
  125928. * At the moment only Quadratic Error Decimation is implemented
  125929. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125930. */
  125931. export enum SimplificationType {
  125932. /** Quadratic error decimation */
  125933. QUADRATIC = 0
  125934. }
  125935. }
  125936. declare module BABYLON {
  125937. interface Scene {
  125938. /** @hidden (Backing field) */
  125939. _simplificationQueue: SimplificationQueue;
  125940. /**
  125941. * Gets or sets the simplification queue attached to the scene
  125942. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  125943. */
  125944. simplificationQueue: SimplificationQueue;
  125945. }
  125946. interface Mesh {
  125947. /**
  125948. * Simplify the mesh according to the given array of settings.
  125949. * Function will return immediately and will simplify async
  125950. * @param settings a collection of simplification settings
  125951. * @param parallelProcessing should all levels calculate parallel or one after the other
  125952. * @param simplificationType the type of simplification to run
  125953. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  125954. * @returns the current mesh
  125955. */
  125956. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  125957. }
  125958. /**
  125959. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  125960. * created in a scene
  125961. */
  125962. export class SimplicationQueueSceneComponent implements ISceneComponent {
  125963. /**
  125964. * The component name helpfull to identify the component in the list of scene components.
  125965. */
  125966. readonly name: string;
  125967. /**
  125968. * The scene the component belongs to.
  125969. */
  125970. scene: Scene;
  125971. /**
  125972. * Creates a new instance of the component for the given scene
  125973. * @param scene Defines the scene to register the component in
  125974. */
  125975. constructor(scene: Scene);
  125976. /**
  125977. * Registers the component in a given scene
  125978. */
  125979. register(): void;
  125980. /**
  125981. * Rebuilds the elements related to this component in case of
  125982. * context lost for instance.
  125983. */
  125984. rebuild(): void;
  125985. /**
  125986. * Disposes the component and the associated ressources
  125987. */
  125988. dispose(): void;
  125989. private _beforeCameraUpdate;
  125990. }
  125991. }
  125992. declare module BABYLON {
  125993. /**
  125994. * Navigation plugin interface to add navigation constrained by a navigation mesh
  125995. */
  125996. export interface INavigationEnginePlugin {
  125997. /**
  125998. * plugin name
  125999. */
  126000. name: string;
  126001. /**
  126002. * Creates a navigation mesh
  126003. * @param meshes array of all the geometry used to compute the navigatio mesh
  126004. * @param parameters bunch of parameters used to filter geometry
  126005. */
  126006. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  126007. /**
  126008. * Create a navigation mesh debug mesh
  126009. * @param scene is where the mesh will be added
  126010. * @returns debug display mesh
  126011. */
  126012. createDebugNavMesh(scene: Scene): Mesh;
  126013. /**
  126014. * Get a navigation mesh constrained position, closest to the parameter position
  126015. * @param position world position
  126016. * @returns the closest point to position constrained by the navigation mesh
  126017. */
  126018. getClosestPoint(position: Vector3): Vector3;
  126019. /**
  126020. * Get a navigation mesh constrained position, within a particular radius
  126021. * @param position world position
  126022. * @param maxRadius the maximum distance to the constrained world position
  126023. * @returns the closest point to position constrained by the navigation mesh
  126024. */
  126025. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  126026. /**
  126027. * Compute the final position from a segment made of destination-position
  126028. * @param position world position
  126029. * @param destination world position
  126030. * @returns the resulting point along the navmesh
  126031. */
  126032. moveAlong(position: Vector3, destination: Vector3): Vector3;
  126033. /**
  126034. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  126035. * @param start world position
  126036. * @param end world position
  126037. * @returns array containing world position composing the path
  126038. */
  126039. computePath(start: Vector3, end: Vector3): Vector3[];
  126040. /**
  126041. * If this plugin is supported
  126042. * @returns true if plugin is supported
  126043. */
  126044. isSupported(): boolean;
  126045. /**
  126046. * Create a new Crowd so you can add agents
  126047. * @param maxAgents the maximum agent count in the crowd
  126048. * @param maxAgentRadius the maximum radius an agent can have
  126049. * @param scene to attach the crowd to
  126050. * @returns the crowd you can add agents to
  126051. */
  126052. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  126053. /**
  126054. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126055. * The queries will try to find a solution within those bounds
  126056. * default is (1,1,1)
  126057. * @param extent x,y,z value that define the extent around the queries point of reference
  126058. */
  126059. setDefaultQueryExtent(extent: Vector3): void;
  126060. /**
  126061. * Get the Bounding box extent specified by setDefaultQueryExtent
  126062. * @returns the box extent values
  126063. */
  126064. getDefaultQueryExtent(): Vector3;
  126065. /**
  126066. * Release all resources
  126067. */
  126068. dispose(): void;
  126069. }
  126070. /**
  126071. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  126072. */
  126073. export interface ICrowd {
  126074. /**
  126075. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  126076. * You can attach anything to that node. The node position is updated in the scene update tick.
  126077. * @param pos world position that will be constrained by the navigation mesh
  126078. * @param parameters agent parameters
  126079. * @param transform hooked to the agent that will be update by the scene
  126080. * @returns agent index
  126081. */
  126082. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  126083. /**
  126084. * Returns the agent position in world space
  126085. * @param index agent index returned by addAgent
  126086. * @returns world space position
  126087. */
  126088. getAgentPosition(index: number): Vector3;
  126089. /**
  126090. * Gets the agent velocity in world space
  126091. * @param index agent index returned by addAgent
  126092. * @returns world space velocity
  126093. */
  126094. getAgentVelocity(index: number): Vector3;
  126095. /**
  126096. * remove a particular agent previously created
  126097. * @param index agent index returned by addAgent
  126098. */
  126099. removeAgent(index: number): void;
  126100. /**
  126101. * get the list of all agents attached to this crowd
  126102. * @returns list of agent indices
  126103. */
  126104. getAgents(): number[];
  126105. /**
  126106. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  126107. * @param deltaTime in seconds
  126108. */
  126109. update(deltaTime: number): void;
  126110. /**
  126111. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  126112. * @param index agent index returned by addAgent
  126113. * @param destination targeted world position
  126114. */
  126115. agentGoto(index: number, destination: Vector3): void;
  126116. /**
  126117. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126118. * The queries will try to find a solution within those bounds
  126119. * default is (1,1,1)
  126120. * @param extent x,y,z value that define the extent around the queries point of reference
  126121. */
  126122. setDefaultQueryExtent(extent: Vector3): void;
  126123. /**
  126124. * Get the Bounding box extent specified by setDefaultQueryExtent
  126125. * @returns the box extent values
  126126. */
  126127. getDefaultQueryExtent(): Vector3;
  126128. /**
  126129. * Release all resources
  126130. */
  126131. dispose(): void;
  126132. }
  126133. /**
  126134. * Configures an agent
  126135. */
  126136. export interface IAgentParameters {
  126137. /**
  126138. * Agent radius. [Limit: >= 0]
  126139. */
  126140. radius: number;
  126141. /**
  126142. * Agent height. [Limit: > 0]
  126143. */
  126144. height: number;
  126145. /**
  126146. * Maximum allowed acceleration. [Limit: >= 0]
  126147. */
  126148. maxAcceleration: number;
  126149. /**
  126150. * Maximum allowed speed. [Limit: >= 0]
  126151. */
  126152. maxSpeed: number;
  126153. /**
  126154. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  126155. */
  126156. collisionQueryRange: number;
  126157. /**
  126158. * The path visibility optimization range. [Limit: > 0]
  126159. */
  126160. pathOptimizationRange: number;
  126161. /**
  126162. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  126163. */
  126164. separationWeight: number;
  126165. }
  126166. /**
  126167. * Configures the navigation mesh creation
  126168. */
  126169. export interface INavMeshParameters {
  126170. /**
  126171. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  126172. */
  126173. cs: number;
  126174. /**
  126175. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  126176. */
  126177. ch: number;
  126178. /**
  126179. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  126180. */
  126181. walkableSlopeAngle: number;
  126182. /**
  126183. * Minimum floor to 'ceiling' height that will still allow the floor area to
  126184. * be considered walkable. [Limit: >= 3] [Units: vx]
  126185. */
  126186. walkableHeight: number;
  126187. /**
  126188. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  126189. */
  126190. walkableClimb: number;
  126191. /**
  126192. * The distance to erode/shrink the walkable area of the heightfield away from
  126193. * obstructions. [Limit: >=0] [Units: vx]
  126194. */
  126195. walkableRadius: number;
  126196. /**
  126197. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  126198. */
  126199. maxEdgeLen: number;
  126200. /**
  126201. * The maximum distance a simplfied contour's border edges should deviate
  126202. * the original raw contour. [Limit: >=0] [Units: vx]
  126203. */
  126204. maxSimplificationError: number;
  126205. /**
  126206. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  126207. */
  126208. minRegionArea: number;
  126209. /**
  126210. * Any regions with a span count smaller than this value will, if possible,
  126211. * be merged with larger regions. [Limit: >=0] [Units: vx]
  126212. */
  126213. mergeRegionArea: number;
  126214. /**
  126215. * The maximum number of vertices allowed for polygons generated during the
  126216. * contour to polygon conversion process. [Limit: >= 3]
  126217. */
  126218. maxVertsPerPoly: number;
  126219. /**
  126220. * Sets the sampling distance to use when generating the detail mesh.
  126221. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  126222. */
  126223. detailSampleDist: number;
  126224. /**
  126225. * The maximum distance the detail mesh surface should deviate from heightfield
  126226. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  126227. */
  126228. detailSampleMaxError: number;
  126229. }
  126230. }
  126231. declare module BABYLON {
  126232. /**
  126233. * RecastJS navigation plugin
  126234. */
  126235. export class RecastJSPlugin implements INavigationEnginePlugin {
  126236. /**
  126237. * Reference to the Recast library
  126238. */
  126239. bjsRECAST: any;
  126240. /**
  126241. * plugin name
  126242. */
  126243. name: string;
  126244. /**
  126245. * the first navmesh created. We might extend this to support multiple navmeshes
  126246. */
  126247. navMesh: any;
  126248. /**
  126249. * Initializes the recastJS plugin
  126250. * @param recastInjection can be used to inject your own recast reference
  126251. */
  126252. constructor(recastInjection?: any);
  126253. /**
  126254. * Creates a navigation mesh
  126255. * @param meshes array of all the geometry used to compute the navigatio mesh
  126256. * @param parameters bunch of parameters used to filter geometry
  126257. */
  126258. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  126259. /**
  126260. * Create a navigation mesh debug mesh
  126261. * @param scene is where the mesh will be added
  126262. * @returns debug display mesh
  126263. */
  126264. createDebugNavMesh(scene: Scene): Mesh;
  126265. /**
  126266. * Get a navigation mesh constrained position, closest to the parameter position
  126267. * @param position world position
  126268. * @returns the closest point to position constrained by the navigation mesh
  126269. */
  126270. getClosestPoint(position: Vector3): Vector3;
  126271. /**
  126272. * Get a navigation mesh constrained position, within a particular radius
  126273. * @param position world position
  126274. * @param maxRadius the maximum distance to the constrained world position
  126275. * @returns the closest point to position constrained by the navigation mesh
  126276. */
  126277. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  126278. /**
  126279. * Compute the final position from a segment made of destination-position
  126280. * @param position world position
  126281. * @param destination world position
  126282. * @returns the resulting point along the navmesh
  126283. */
  126284. moveAlong(position: Vector3, destination: Vector3): Vector3;
  126285. /**
  126286. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  126287. * @param start world position
  126288. * @param end world position
  126289. * @returns array containing world position composing the path
  126290. */
  126291. computePath(start: Vector3, end: Vector3): Vector3[];
  126292. /**
  126293. * Create a new Crowd so you can add agents
  126294. * @param maxAgents the maximum agent count in the crowd
  126295. * @param maxAgentRadius the maximum radius an agent can have
  126296. * @param scene to attach the crowd to
  126297. * @returns the crowd you can add agents to
  126298. */
  126299. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  126300. /**
  126301. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126302. * The queries will try to find a solution within those bounds
  126303. * default is (1,1,1)
  126304. * @param extent x,y,z value that define the extent around the queries point of reference
  126305. */
  126306. setDefaultQueryExtent(extent: Vector3): void;
  126307. /**
  126308. * Get the Bounding box extent specified by setDefaultQueryExtent
  126309. * @returns the box extent values
  126310. */
  126311. getDefaultQueryExtent(): Vector3;
  126312. /**
  126313. * Disposes
  126314. */
  126315. dispose(): void;
  126316. /**
  126317. * If this plugin is supported
  126318. * @returns true if plugin is supported
  126319. */
  126320. isSupported(): boolean;
  126321. }
  126322. /**
  126323. * Recast detour crowd implementation
  126324. */
  126325. export class RecastJSCrowd implements ICrowd {
  126326. /**
  126327. * Recast/detour plugin
  126328. */
  126329. bjsRECASTPlugin: RecastJSPlugin;
  126330. /**
  126331. * Link to the detour crowd
  126332. */
  126333. recastCrowd: any;
  126334. /**
  126335. * One transform per agent
  126336. */
  126337. transforms: TransformNode[];
  126338. /**
  126339. * All agents created
  126340. */
  126341. agents: number[];
  126342. /**
  126343. * Link to the scene is kept to unregister the crowd from the scene
  126344. */
  126345. private _scene;
  126346. /**
  126347. * Observer for crowd updates
  126348. */
  126349. private _onBeforeAnimationsObserver;
  126350. /**
  126351. * Constructor
  126352. * @param plugin recastJS plugin
  126353. * @param maxAgents the maximum agent count in the crowd
  126354. * @param maxAgentRadius the maximum radius an agent can have
  126355. * @param scene to attach the crowd to
  126356. * @returns the crowd you can add agents to
  126357. */
  126358. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  126359. /**
  126360. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  126361. * You can attach anything to that node. The node position is updated in the scene update tick.
  126362. * @param pos world position that will be constrained by the navigation mesh
  126363. * @param parameters agent parameters
  126364. * @param transform hooked to the agent that will be update by the scene
  126365. * @returns agent index
  126366. */
  126367. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  126368. /**
  126369. * Returns the agent position in world space
  126370. * @param index agent index returned by addAgent
  126371. * @returns world space position
  126372. */
  126373. getAgentPosition(index: number): Vector3;
  126374. /**
  126375. * Returns the agent velocity in world space
  126376. * @param index agent index returned by addAgent
  126377. * @returns world space velocity
  126378. */
  126379. getAgentVelocity(index: number): Vector3;
  126380. /**
  126381. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  126382. * @param index agent index returned by addAgent
  126383. * @param destination targeted world position
  126384. */
  126385. agentGoto(index: number, destination: Vector3): void;
  126386. /**
  126387. * remove a particular agent previously created
  126388. * @param index agent index returned by addAgent
  126389. */
  126390. removeAgent(index: number): void;
  126391. /**
  126392. * get the list of all agents attached to this crowd
  126393. * @returns list of agent indices
  126394. */
  126395. getAgents(): number[];
  126396. /**
  126397. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  126398. * @param deltaTime in seconds
  126399. */
  126400. update(deltaTime: number): void;
  126401. /**
  126402. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126403. * The queries will try to find a solution within those bounds
  126404. * default is (1,1,1)
  126405. * @param extent x,y,z value that define the extent around the queries point of reference
  126406. */
  126407. setDefaultQueryExtent(extent: Vector3): void;
  126408. /**
  126409. * Get the Bounding box extent specified by setDefaultQueryExtent
  126410. * @returns the box extent values
  126411. */
  126412. getDefaultQueryExtent(): Vector3;
  126413. /**
  126414. * Release all resources
  126415. */
  126416. dispose(): void;
  126417. }
  126418. }
  126419. declare module BABYLON {
  126420. /**
  126421. * Class used to enable access to IndexedDB
  126422. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  126423. */
  126424. export class Database implements IOfflineProvider {
  126425. private _callbackManifestChecked;
  126426. private _currentSceneUrl;
  126427. private _db;
  126428. private _enableSceneOffline;
  126429. private _enableTexturesOffline;
  126430. private _manifestVersionFound;
  126431. private _mustUpdateRessources;
  126432. private _hasReachedQuota;
  126433. private _isSupported;
  126434. private _idbFactory;
  126435. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  126436. private static IsUASupportingBlobStorage;
  126437. /**
  126438. * Gets a boolean indicating if Database storate is enabled (off by default)
  126439. */
  126440. static IDBStorageEnabled: boolean;
  126441. /**
  126442. * Gets a boolean indicating if scene must be saved in the database
  126443. */
  126444. readonly enableSceneOffline: boolean;
  126445. /**
  126446. * Gets a boolean indicating if textures must be saved in the database
  126447. */
  126448. readonly enableTexturesOffline: boolean;
  126449. /**
  126450. * Creates a new Database
  126451. * @param urlToScene defines the url to load the scene
  126452. * @param callbackManifestChecked defines the callback to use when manifest is checked
  126453. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  126454. */
  126455. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  126456. private static _ParseURL;
  126457. private static _ReturnFullUrlLocation;
  126458. private _checkManifestFile;
  126459. /**
  126460. * Open the database and make it available
  126461. * @param successCallback defines the callback to call on success
  126462. * @param errorCallback defines the callback to call on error
  126463. */
  126464. open(successCallback: () => void, errorCallback: () => void): void;
  126465. /**
  126466. * Loads an image from the database
  126467. * @param url defines the url to load from
  126468. * @param image defines the target DOM image
  126469. */
  126470. loadImage(url: string, image: HTMLImageElement): void;
  126471. private _loadImageFromDBAsync;
  126472. private _saveImageIntoDBAsync;
  126473. private _checkVersionFromDB;
  126474. private _loadVersionFromDBAsync;
  126475. private _saveVersionIntoDBAsync;
  126476. /**
  126477. * Loads a file from database
  126478. * @param url defines the URL to load from
  126479. * @param sceneLoaded defines a callback to call on success
  126480. * @param progressCallBack defines a callback to call when progress changed
  126481. * @param errorCallback defines a callback to call on error
  126482. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  126483. */
  126484. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  126485. private _loadFileAsync;
  126486. private _saveFileAsync;
  126487. /**
  126488. * Validates if xhr data is correct
  126489. * @param xhr defines the request to validate
  126490. * @param dataType defines the expected data type
  126491. * @returns true if data is correct
  126492. */
  126493. private static _ValidateXHRData;
  126494. }
  126495. }
  126496. declare module BABYLON {
  126497. /** @hidden */
  126498. export var gpuUpdateParticlesPixelShader: {
  126499. name: string;
  126500. shader: string;
  126501. };
  126502. }
  126503. declare module BABYLON {
  126504. /** @hidden */
  126505. export var gpuUpdateParticlesVertexShader: {
  126506. name: string;
  126507. shader: string;
  126508. };
  126509. }
  126510. declare module BABYLON {
  126511. /** @hidden */
  126512. export var clipPlaneFragmentDeclaration2: {
  126513. name: string;
  126514. shader: string;
  126515. };
  126516. }
  126517. declare module BABYLON {
  126518. /** @hidden */
  126519. export var gpuRenderParticlesPixelShader: {
  126520. name: string;
  126521. shader: string;
  126522. };
  126523. }
  126524. declare module BABYLON {
  126525. /** @hidden */
  126526. export var clipPlaneVertexDeclaration2: {
  126527. name: string;
  126528. shader: string;
  126529. };
  126530. }
  126531. declare module BABYLON {
  126532. /** @hidden */
  126533. export var gpuRenderParticlesVertexShader: {
  126534. name: string;
  126535. shader: string;
  126536. };
  126537. }
  126538. declare module BABYLON {
  126539. /**
  126540. * This represents a GPU particle system in Babylon
  126541. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  126542. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  126543. */
  126544. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  126545. /**
  126546. * The layer mask we are rendering the particles through.
  126547. */
  126548. layerMask: number;
  126549. private _capacity;
  126550. private _activeCount;
  126551. private _currentActiveCount;
  126552. private _accumulatedCount;
  126553. private _renderEffect;
  126554. private _updateEffect;
  126555. private _buffer0;
  126556. private _buffer1;
  126557. private _spriteBuffer;
  126558. private _updateVAO;
  126559. private _renderVAO;
  126560. private _targetIndex;
  126561. private _sourceBuffer;
  126562. private _targetBuffer;
  126563. private _engine;
  126564. private _currentRenderId;
  126565. private _started;
  126566. private _stopped;
  126567. private _timeDelta;
  126568. private _randomTexture;
  126569. private _randomTexture2;
  126570. private _attributesStrideSize;
  126571. private _updateEffectOptions;
  126572. private _randomTextureSize;
  126573. private _actualFrame;
  126574. private readonly _rawTextureWidth;
  126575. /**
  126576. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  126577. */
  126578. static readonly IsSupported: boolean;
  126579. /**
  126580. * An event triggered when the system is disposed.
  126581. */
  126582. onDisposeObservable: Observable<GPUParticleSystem>;
  126583. /**
  126584. * Gets the maximum number of particles active at the same time.
  126585. * @returns The max number of active particles.
  126586. */
  126587. getCapacity(): number;
  126588. /**
  126589. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  126590. * to override the particles.
  126591. */
  126592. forceDepthWrite: boolean;
  126593. /**
  126594. * Gets or set the number of active particles
  126595. */
  126596. activeParticleCount: number;
  126597. private _preWarmDone;
  126598. /**
  126599. * Is this system ready to be used/rendered
  126600. * @return true if the system is ready
  126601. */
  126602. isReady(): boolean;
  126603. /**
  126604. * Gets if the system has been started. (Note: this will still be true after stop is called)
  126605. * @returns True if it has been started, otherwise false.
  126606. */
  126607. isStarted(): boolean;
  126608. /**
  126609. * Starts the particle system and begins to emit
  126610. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  126611. */
  126612. start(delay?: number): void;
  126613. /**
  126614. * Stops the particle system.
  126615. */
  126616. stop(): void;
  126617. /**
  126618. * Remove all active particles
  126619. */
  126620. reset(): void;
  126621. /**
  126622. * Returns the string "GPUParticleSystem"
  126623. * @returns a string containing the class name
  126624. */
  126625. getClassName(): string;
  126626. private _colorGradientsTexture;
  126627. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  126628. /**
  126629. * Adds a new color gradient
  126630. * @param gradient defines the gradient to use (between 0 and 1)
  126631. * @param color1 defines the color to affect to the specified gradient
  126632. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  126633. * @returns the current particle system
  126634. */
  126635. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  126636. /**
  126637. * Remove a specific color gradient
  126638. * @param gradient defines the gradient to remove
  126639. * @returns the current particle system
  126640. */
  126641. removeColorGradient(gradient: number): GPUParticleSystem;
  126642. private _angularSpeedGradientsTexture;
  126643. private _sizeGradientsTexture;
  126644. private _velocityGradientsTexture;
  126645. private _limitVelocityGradientsTexture;
  126646. private _dragGradientsTexture;
  126647. private _addFactorGradient;
  126648. /**
  126649. * Adds a new size gradient
  126650. * @param gradient defines the gradient to use (between 0 and 1)
  126651. * @param factor defines the size factor to affect to the specified gradient
  126652. * @returns the current particle system
  126653. */
  126654. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  126655. /**
  126656. * Remove a specific size gradient
  126657. * @param gradient defines the gradient to remove
  126658. * @returns the current particle system
  126659. */
  126660. removeSizeGradient(gradient: number): GPUParticleSystem;
  126661. /**
  126662. * Adds a new angular speed gradient
  126663. * @param gradient defines the gradient to use (between 0 and 1)
  126664. * @param factor defines the angular speed to affect to the specified gradient
  126665. * @returns the current particle system
  126666. */
  126667. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  126668. /**
  126669. * Remove a specific angular speed gradient
  126670. * @param gradient defines the gradient to remove
  126671. * @returns the current particle system
  126672. */
  126673. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  126674. /**
  126675. * Adds a new velocity gradient
  126676. * @param gradient defines the gradient to use (between 0 and 1)
  126677. * @param factor defines the velocity to affect to the specified gradient
  126678. * @returns the current particle system
  126679. */
  126680. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  126681. /**
  126682. * Remove a specific velocity gradient
  126683. * @param gradient defines the gradient to remove
  126684. * @returns the current particle system
  126685. */
  126686. removeVelocityGradient(gradient: number): GPUParticleSystem;
  126687. /**
  126688. * Adds a new limit velocity gradient
  126689. * @param gradient defines the gradient to use (between 0 and 1)
  126690. * @param factor defines the limit velocity value to affect to the specified gradient
  126691. * @returns the current particle system
  126692. */
  126693. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  126694. /**
  126695. * Remove a specific limit velocity gradient
  126696. * @param gradient defines the gradient to remove
  126697. * @returns the current particle system
  126698. */
  126699. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  126700. /**
  126701. * Adds a new drag gradient
  126702. * @param gradient defines the gradient to use (between 0 and 1)
  126703. * @param factor defines the drag value to affect to the specified gradient
  126704. * @returns the current particle system
  126705. */
  126706. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  126707. /**
  126708. * Remove a specific drag gradient
  126709. * @param gradient defines the gradient to remove
  126710. * @returns the current particle system
  126711. */
  126712. removeDragGradient(gradient: number): GPUParticleSystem;
  126713. /**
  126714. * Not supported by GPUParticleSystem
  126715. * @param gradient defines the gradient to use (between 0 and 1)
  126716. * @param factor defines the emit rate value to affect to the specified gradient
  126717. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  126718. * @returns the current particle system
  126719. */
  126720. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  126721. /**
  126722. * Not supported by GPUParticleSystem
  126723. * @param gradient defines the gradient to remove
  126724. * @returns the current particle system
  126725. */
  126726. removeEmitRateGradient(gradient: number): IParticleSystem;
  126727. /**
  126728. * Not supported by GPUParticleSystem
  126729. * @param gradient defines the gradient to use (between 0 and 1)
  126730. * @param factor defines the start size value to affect to the specified gradient
  126731. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  126732. * @returns the current particle system
  126733. */
  126734. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  126735. /**
  126736. * Not supported by GPUParticleSystem
  126737. * @param gradient defines the gradient to remove
  126738. * @returns the current particle system
  126739. */
  126740. removeStartSizeGradient(gradient: number): IParticleSystem;
  126741. /**
  126742. * Not supported by GPUParticleSystem
  126743. * @param gradient defines the gradient to use (between 0 and 1)
  126744. * @param min defines the color remap minimal range
  126745. * @param max defines the color remap maximal range
  126746. * @returns the current particle system
  126747. */
  126748. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  126749. /**
  126750. * Not supported by GPUParticleSystem
  126751. * @param gradient defines the gradient to remove
  126752. * @returns the current particle system
  126753. */
  126754. removeColorRemapGradient(): IParticleSystem;
  126755. /**
  126756. * Not supported by GPUParticleSystem
  126757. * @param gradient defines the gradient to use (between 0 and 1)
  126758. * @param min defines the alpha remap minimal range
  126759. * @param max defines the alpha remap maximal range
  126760. * @returns the current particle system
  126761. */
  126762. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  126763. /**
  126764. * Not supported by GPUParticleSystem
  126765. * @param gradient defines the gradient to remove
  126766. * @returns the current particle system
  126767. */
  126768. removeAlphaRemapGradient(): IParticleSystem;
  126769. /**
  126770. * Not supported by GPUParticleSystem
  126771. * @param gradient defines the gradient to use (between 0 and 1)
  126772. * @param color defines the color to affect to the specified gradient
  126773. * @returns the current particle system
  126774. */
  126775. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  126776. /**
  126777. * Not supported by GPUParticleSystem
  126778. * @param gradient defines the gradient to remove
  126779. * @returns the current particle system
  126780. */
  126781. removeRampGradient(): IParticleSystem;
  126782. /**
  126783. * Not supported by GPUParticleSystem
  126784. * @returns the list of ramp gradients
  126785. */
  126786. getRampGradients(): Nullable<Array<Color3Gradient>>;
  126787. /**
  126788. * Not supported by GPUParticleSystem
  126789. * Gets or sets a boolean indicating that ramp gradients must be used
  126790. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  126791. */
  126792. useRampGradients: boolean;
  126793. /**
  126794. * Not supported by GPUParticleSystem
  126795. * @param gradient defines the gradient to use (between 0 and 1)
  126796. * @param factor defines the life time factor to affect to the specified gradient
  126797. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  126798. * @returns the current particle system
  126799. */
  126800. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  126801. /**
  126802. * Not supported by GPUParticleSystem
  126803. * @param gradient defines the gradient to remove
  126804. * @returns the current particle system
  126805. */
  126806. removeLifeTimeGradient(gradient: number): IParticleSystem;
  126807. /**
  126808. * Instantiates a GPU particle system.
  126809. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  126810. * @param name The name of the particle system
  126811. * @param options The options used to create the system
  126812. * @param scene The scene the particle system belongs to
  126813. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  126814. */
  126815. constructor(name: string, options: Partial<{
  126816. capacity: number;
  126817. randomTextureSize: number;
  126818. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  126819. protected _reset(): void;
  126820. private _createUpdateVAO;
  126821. private _createRenderVAO;
  126822. private _initialize;
  126823. /** @hidden */
  126824. _recreateUpdateEffect(): void;
  126825. /** @hidden */
  126826. _recreateRenderEffect(): void;
  126827. /**
  126828. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  126829. * @param preWarm defines if we are in the pre-warmimg phase
  126830. */
  126831. animate(preWarm?: boolean): void;
  126832. private _createFactorGradientTexture;
  126833. private _createSizeGradientTexture;
  126834. private _createAngularSpeedGradientTexture;
  126835. private _createVelocityGradientTexture;
  126836. private _createLimitVelocityGradientTexture;
  126837. private _createDragGradientTexture;
  126838. private _createColorGradientTexture;
  126839. /**
  126840. * Renders the particle system in its current state
  126841. * @param preWarm defines if the system should only update the particles but not render them
  126842. * @returns the current number of particles
  126843. */
  126844. render(preWarm?: boolean): number;
  126845. /**
  126846. * Rebuilds the particle system
  126847. */
  126848. rebuild(): void;
  126849. private _releaseBuffers;
  126850. private _releaseVAOs;
  126851. /**
  126852. * Disposes the particle system and free the associated resources
  126853. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  126854. */
  126855. dispose(disposeTexture?: boolean): void;
  126856. /**
  126857. * Clones the particle system.
  126858. * @param name The name of the cloned object
  126859. * @param newEmitter The new emitter to use
  126860. * @returns the cloned particle system
  126861. */
  126862. clone(name: string, newEmitter: any): GPUParticleSystem;
  126863. /**
  126864. * Serializes the particle system to a JSON object.
  126865. * @returns the JSON object
  126866. */
  126867. serialize(): any;
  126868. /**
  126869. * Parses a JSON object to create a GPU particle system.
  126870. * @param parsedParticleSystem The JSON object to parse
  126871. * @param scene The scene to create the particle system in
  126872. * @param rootUrl The root url to use to load external dependencies like texture
  126873. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  126874. * @returns the parsed GPU particle system
  126875. */
  126876. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  126877. }
  126878. }
  126879. declare module BABYLON {
  126880. /**
  126881. * Represents a set of particle systems working together to create a specific effect
  126882. */
  126883. export class ParticleSystemSet implements IDisposable {
  126884. /**
  126885. * Gets or sets base Assets URL
  126886. */
  126887. static BaseAssetsUrl: string;
  126888. private _emitterCreationOptions;
  126889. private _emitterNode;
  126890. /**
  126891. * Gets the particle system list
  126892. */
  126893. systems: IParticleSystem[];
  126894. /**
  126895. * Gets the emitter node used with this set
  126896. */
  126897. readonly emitterNode: Nullable<TransformNode>;
  126898. /**
  126899. * Creates a new emitter mesh as a sphere
  126900. * @param options defines the options used to create the sphere
  126901. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  126902. * @param scene defines the hosting scene
  126903. */
  126904. setEmitterAsSphere(options: {
  126905. diameter: number;
  126906. segments: number;
  126907. color: Color3;
  126908. }, renderingGroupId: number, scene: Scene): void;
  126909. /**
  126910. * Starts all particle systems of the set
  126911. * @param emitter defines an optional mesh to use as emitter for the particle systems
  126912. */
  126913. start(emitter?: AbstractMesh): void;
  126914. /**
  126915. * Release all associated resources
  126916. */
  126917. dispose(): void;
  126918. /**
  126919. * Serialize the set into a JSON compatible object
  126920. * @returns a JSON compatible representation of the set
  126921. */
  126922. serialize(): any;
  126923. /**
  126924. * Parse a new ParticleSystemSet from a serialized source
  126925. * @param data defines a JSON compatible representation of the set
  126926. * @param scene defines the hosting scene
  126927. * @param gpu defines if we want GPU particles or CPU particles
  126928. * @returns a new ParticleSystemSet
  126929. */
  126930. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  126931. }
  126932. }
  126933. declare module BABYLON {
  126934. /**
  126935. * This class is made for on one-liner static method to help creating particle system set.
  126936. */
  126937. export class ParticleHelper {
  126938. /**
  126939. * Gets or sets base Assets URL
  126940. */
  126941. static BaseAssetsUrl: string;
  126942. /**
  126943. * Create a default particle system that you can tweak
  126944. * @param emitter defines the emitter to use
  126945. * @param capacity defines the system capacity (default is 500 particles)
  126946. * @param scene defines the hosting scene
  126947. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  126948. * @returns the new Particle system
  126949. */
  126950. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  126951. /**
  126952. * This is the main static method (one-liner) of this helper to create different particle systems
  126953. * @param type This string represents the type to the particle system to create
  126954. * @param scene The scene where the particle system should live
  126955. * @param gpu If the system will use gpu
  126956. * @returns the ParticleSystemSet created
  126957. */
  126958. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  126959. /**
  126960. * Static function used to export a particle system to a ParticleSystemSet variable.
  126961. * Please note that the emitter shape is not exported
  126962. * @param systems defines the particle systems to export
  126963. * @returns the created particle system set
  126964. */
  126965. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  126966. }
  126967. }
  126968. declare module BABYLON {
  126969. interface Engine {
  126970. /**
  126971. * Create an effect to use with particle systems.
  126972. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  126973. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  126974. * @param uniformsNames defines a list of attribute names
  126975. * @param samplers defines an array of string used to represent textures
  126976. * @param defines defines the string containing the defines to use to compile the shaders
  126977. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  126978. * @param onCompiled defines a function to call when the effect creation is successful
  126979. * @param onError defines a function to call when the effect creation has failed
  126980. * @returns the new Effect
  126981. */
  126982. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  126983. }
  126984. interface Mesh {
  126985. /**
  126986. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  126987. * @returns an array of IParticleSystem
  126988. */
  126989. getEmittedParticleSystems(): IParticleSystem[];
  126990. /**
  126991. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  126992. * @returns an array of IParticleSystem
  126993. */
  126994. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  126995. }
  126996. /**
  126997. * @hidden
  126998. */
  126999. export var _IDoNeedToBeInTheBuild: number;
  127000. }
  127001. declare module BABYLON {
  127002. /** Defines the 4 color options */
  127003. export enum PointColor {
  127004. /** color value */
  127005. Color = 2,
  127006. /** uv value */
  127007. UV = 1,
  127008. /** random value */
  127009. Random = 0,
  127010. /** stated value */
  127011. Stated = 3
  127012. }
  127013. /**
  127014. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  127015. * As it is just a mesh, the PointCloudSystem has all the same properties as any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  127016. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  127017. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  127018. *
  127019. * Full documentation here : TO BE ENTERED
  127020. */
  127021. export class PointsCloudSystem implements IDisposable {
  127022. /**
  127023. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  127024. * Example : var p = SPS.particles[i];
  127025. */
  127026. particles: CloudPoint[];
  127027. /**
  127028. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  127029. */
  127030. nbParticles: number;
  127031. /**
  127032. * This a counter for your own usage. It's not set by any SPS functions.
  127033. */
  127034. counter: number;
  127035. /**
  127036. * The PCS name. This name is also given to the underlying mesh.
  127037. */
  127038. name: string;
  127039. /**
  127040. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  127041. */
  127042. mesh: Mesh;
  127043. /**
  127044. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  127045. * Please read :
  127046. */
  127047. vars: any;
  127048. /**
  127049. * @hidden
  127050. */
  127051. _size: number;
  127052. private _scene;
  127053. private _promises;
  127054. private _positions;
  127055. private _indices;
  127056. private _normals;
  127057. private _colors;
  127058. private _uvs;
  127059. private _indices32;
  127060. private _positions32;
  127061. private _colors32;
  127062. private _uvs32;
  127063. private _updatable;
  127064. private _isVisibilityBoxLocked;
  127065. private _alwaysVisible;
  127066. private _groups;
  127067. private _groupCounter;
  127068. private _computeParticleColor;
  127069. private _computeParticleTexture;
  127070. private _computeParticleRotation;
  127071. private _computeBoundingBox;
  127072. private _isReady;
  127073. /**
  127074. * Creates a PCS (Points Cloud System) object
  127075. * @param name (String) is the PCS name, this will be the underlying mesh name
  127076. * @param pointSize (number) is the size for each point
  127077. * @param scene (Scene) is the scene in which the PCS is added
  127078. * @param options defines the options of the PCS e.g.
  127079. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  127080. */
  127081. constructor(name: string, pointSize: number, scene: Scene, options?: {
  127082. updatable?: boolean;
  127083. });
  127084. /**
  127085. * Builds the PCS underlying mesh. Returns a standard Mesh.
  127086. * If no points were added to the PCS, the returned mesh is just a single point.
  127087. * @returns a promise for the created mesh
  127088. */
  127089. buildMeshAsync(): Promise<Mesh>;
  127090. /**
  127091. * @hidden
  127092. */
  127093. private _buildMesh;
  127094. private _addParticle;
  127095. private _randomUnitVector;
  127096. private _getColorIndicesForCoord;
  127097. private _setPointsColorOrUV;
  127098. private _colorFromTexture;
  127099. private _calculateDensity;
  127100. /**
  127101. * Adds points to the PCS in random positions within a unit sphere
  127102. * @param nb (positive integer) the number of particles to be created from this model
  127103. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  127104. * @returns the number of groups in the system
  127105. */
  127106. addPoints(nb: number, pointFunction?: any): number;
  127107. /**
  127108. * Adds points to the PCS from the surface of the model shape
  127109. * @param mesh is any Mesh object that will be used as a surface model for the points
  127110. * @param nb (positive integer) the number of particles to be created from this model
  127111. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  127112. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  127113. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  127114. * @returns the number of groups in the system
  127115. */
  127116. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  127117. /**
  127118. * Adds points to the PCS inside the model shape
  127119. * @param mesh is any Mesh object that will be used as a surface model for the points
  127120. * @param nb (positive integer) the number of particles to be created from this model
  127121. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  127122. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  127123. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  127124. * @returns the number of groups in the system
  127125. */
  127126. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  127127. /**
  127128. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  127129. * This method calls `updateParticle()` for each particle of the SPS.
  127130. * For an animated SPS, it is usually called within the render loop.
  127131. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  127132. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  127133. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  127134. * @returns the PCS.
  127135. */
  127136. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  127137. /**
  127138. * Disposes the PCS.
  127139. */
  127140. dispose(): void;
  127141. /**
  127142. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  127143. * doc :
  127144. * @returns the PCS.
  127145. */
  127146. refreshVisibleSize(): PointsCloudSystem;
  127147. /**
  127148. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  127149. * @param size the size (float) of the visibility box
  127150. * note : this doesn't lock the PCS mesh bounding box.
  127151. * doc :
  127152. */
  127153. setVisibilityBox(size: number): void;
  127154. /**
  127155. * Gets whether the PCS is always visible or not
  127156. * doc :
  127157. */
  127158. /**
  127159. * Sets the PCS as always visible or not
  127160. * doc :
  127161. */
  127162. isAlwaysVisible: boolean;
  127163. /**
  127164. * Tells to `setParticles()` to compute the particle rotations or not
  127165. * Default value : false. The PCS is faster when it's set to false
  127166. * Note : particle rotations are only applied to parent particles
  127167. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  127168. */
  127169. computeParticleRotation: boolean;
  127170. /**
  127171. * Tells to `setParticles()` to compute the particle colors or not.
  127172. * Default value : true. The PCS is faster when it's set to false.
  127173. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  127174. */
  127175. /**
  127176. * Gets if `setParticles()` computes the particle colors or not.
  127177. * Default value : false. The PCS is faster when it's set to false.
  127178. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  127179. */
  127180. computeParticleColor: boolean;
  127181. /**
  127182. * Gets if `setParticles()` computes the particle textures or not.
  127183. * Default value : false. The PCS is faster when it's set to false.
  127184. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  127185. */
  127186. computeParticleTexture: boolean;
  127187. /**
  127188. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  127189. */
  127190. /**
  127191. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  127192. */
  127193. computeBoundingBox: boolean;
  127194. /**
  127195. * This function does nothing. It may be overwritten to set all the particle first values.
  127196. * The PCS doesn't call this function, you may have to call it by your own.
  127197. * doc :
  127198. */
  127199. initParticles(): void;
  127200. /**
  127201. * This function does nothing. It may be overwritten to recycle a particle
  127202. * The PCS doesn't call this function, you can to call it
  127203. * doc :
  127204. * @param particle The particle to recycle
  127205. * @returns the recycled particle
  127206. */
  127207. recycleParticle(particle: CloudPoint): CloudPoint;
  127208. /**
  127209. * Updates a particle : this function should be overwritten by the user.
  127210. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  127211. * doc :
  127212. * @example : just set a particle position or velocity and recycle conditions
  127213. * @param particle The particle to update
  127214. * @returns the updated particle
  127215. */
  127216. updateParticle(particle: CloudPoint): CloudPoint;
  127217. /**
  127218. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  127219. * This does nothing and may be overwritten by the user.
  127220. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  127221. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  127222. * @param update the boolean update value actually passed to setParticles()
  127223. */
  127224. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  127225. /**
  127226. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  127227. * This will be passed three parameters.
  127228. * This does nothing and may be overwritten by the user.
  127229. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  127230. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  127231. * @param update the boolean update value actually passed to setParticles()
  127232. */
  127233. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  127234. }
  127235. }
  127236. declare module BABYLON {
  127237. /**
  127238. * Represents one particle of a points cloud system.
  127239. */
  127240. export class CloudPoint {
  127241. /**
  127242. * particle global index
  127243. */
  127244. idx: number;
  127245. /**
  127246. * The color of the particle
  127247. */
  127248. color: Nullable<Color4>;
  127249. /**
  127250. * The world space position of the particle.
  127251. */
  127252. position: Vector3;
  127253. /**
  127254. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  127255. */
  127256. rotation: Vector3;
  127257. /**
  127258. * The world space rotation quaternion of the particle.
  127259. */
  127260. rotationQuaternion: Nullable<Quaternion>;
  127261. /**
  127262. * The uv of the particle.
  127263. */
  127264. uv: Nullable<Vector2>;
  127265. /**
  127266. * The current speed of the particle.
  127267. */
  127268. velocity: Vector3;
  127269. /**
  127270. * The pivot point in the particle local space.
  127271. */
  127272. pivot: Vector3;
  127273. /**
  127274. * Must the particle be translated from its pivot point in its local space ?
  127275. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  127276. * Default : false
  127277. */
  127278. translateFromPivot: boolean;
  127279. /**
  127280. * Index of this particle in the global "positions" array (Internal use)
  127281. * @hidden
  127282. */
  127283. _pos: number;
  127284. /**
  127285. * @hidden Index of this particle in the global "indices" array (Internal use)
  127286. */
  127287. _ind: number;
  127288. /**
  127289. * Group this particle belongs to
  127290. */
  127291. _group: PointsGroup;
  127292. /**
  127293. * Group id of this particle
  127294. */
  127295. groupId: number;
  127296. /**
  127297. * Index of the particle in its group id (Internal use)
  127298. */
  127299. idxInGroup: number;
  127300. /**
  127301. * @hidden Particle BoundingInfo object (Internal use)
  127302. */
  127303. _boundingInfo: BoundingInfo;
  127304. /**
  127305. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  127306. */
  127307. _pcs: PointsCloudSystem;
  127308. /**
  127309. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  127310. */
  127311. _stillInvisible: boolean;
  127312. /**
  127313. * @hidden Last computed particle rotation matrix
  127314. */
  127315. _rotationMatrix: number[];
  127316. /**
  127317. * Parent particle Id, if any.
  127318. * Default null.
  127319. */
  127320. parentId: Nullable<number>;
  127321. /**
  127322. * @hidden Internal global position in the PCS.
  127323. */
  127324. _globalPosition: Vector3;
  127325. /**
  127326. * Creates a Point Cloud object.
  127327. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  127328. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  127329. * @param group (PointsGroup) is the group the particle belongs to
  127330. * @param groupId (integer) is the group identifier in the PCS.
  127331. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  127332. * @param pcs defines the PCS it is associated to
  127333. */
  127334. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  127335. /**
  127336. * get point size
  127337. */
  127338. /**
  127339. * Set point size
  127340. */
  127341. size: Vector3;
  127342. /**
  127343. * Legacy support, changed quaternion to rotationQuaternion
  127344. */
  127345. /**
  127346. * Legacy support, changed quaternion to rotationQuaternion
  127347. */
  127348. quaternion: Nullable<Quaternion>;
  127349. /**
  127350. * Returns a boolean. True if the particle intersects a mesh, else false
  127351. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  127352. * @param target is the object (point or mesh) what the intersection is computed against
  127353. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  127354. * @returns true if it intersects
  127355. */
  127356. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  127357. /**
  127358. * get the rotation matrix of the particle
  127359. * @hidden
  127360. */
  127361. getRotationMatrix(m: Matrix): void;
  127362. }
  127363. /**
  127364. * Represents a group of points in a points cloud system
  127365. * * PCS internal tool, don't use it manually.
  127366. */
  127367. export class PointsGroup {
  127368. /**
  127369. * The group id
  127370. * @hidden
  127371. */
  127372. groupID: number;
  127373. /**
  127374. * image data for group (internal use)
  127375. * @hidden
  127376. */
  127377. _groupImageData: Nullable<ArrayBufferView>;
  127378. /**
  127379. * Image Width (internal use)
  127380. * @hidden
  127381. */
  127382. _groupImgWidth: number;
  127383. /**
  127384. * Image Height (internal use)
  127385. * @hidden
  127386. */
  127387. _groupImgHeight: number;
  127388. /**
  127389. * Custom position function (internal use)
  127390. * @hidden
  127391. */
  127392. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  127393. /**
  127394. * density per facet for surface points
  127395. * @hidden
  127396. */
  127397. _groupDensity: number[];
  127398. /**
  127399. * Only when points are colored by texture carries pointer to texture list array
  127400. * @hidden
  127401. */
  127402. _textureNb: number;
  127403. /**
  127404. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  127405. * PCS internal tool, don't use it manually.
  127406. * @hidden
  127407. */
  127408. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  127409. }
  127410. }
  127411. declare module BABYLON {
  127412. interface Scene {
  127413. /** @hidden (Backing field) */
  127414. _physicsEngine: Nullable<IPhysicsEngine>;
  127415. /**
  127416. * Gets the current physics engine
  127417. * @returns a IPhysicsEngine or null if none attached
  127418. */
  127419. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  127420. /**
  127421. * Enables physics to the current scene
  127422. * @param gravity defines the scene's gravity for the physics engine
  127423. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  127424. * @return a boolean indicating if the physics engine was initialized
  127425. */
  127426. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  127427. /**
  127428. * Disables and disposes the physics engine associated with the scene
  127429. */
  127430. disablePhysicsEngine(): void;
  127431. /**
  127432. * Gets a boolean indicating if there is an active physics engine
  127433. * @returns a boolean indicating if there is an active physics engine
  127434. */
  127435. isPhysicsEnabled(): boolean;
  127436. /**
  127437. * Deletes a physics compound impostor
  127438. * @param compound defines the compound to delete
  127439. */
  127440. deleteCompoundImpostor(compound: any): void;
  127441. /**
  127442. * An event triggered when physic simulation is about to be run
  127443. */
  127444. onBeforePhysicsObservable: Observable<Scene>;
  127445. /**
  127446. * An event triggered when physic simulation has been done
  127447. */
  127448. onAfterPhysicsObservable: Observable<Scene>;
  127449. }
  127450. interface AbstractMesh {
  127451. /** @hidden */
  127452. _physicsImpostor: Nullable<PhysicsImpostor>;
  127453. /**
  127454. * Gets or sets impostor used for physic simulation
  127455. * @see http://doc.babylonjs.com/features/physics_engine
  127456. */
  127457. physicsImpostor: Nullable<PhysicsImpostor>;
  127458. /**
  127459. * Gets the current physics impostor
  127460. * @see http://doc.babylonjs.com/features/physics_engine
  127461. * @returns a physics impostor or null
  127462. */
  127463. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  127464. /** Apply a physic impulse to the mesh
  127465. * @param force defines the force to apply
  127466. * @param contactPoint defines where to apply the force
  127467. * @returns the current mesh
  127468. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  127469. */
  127470. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  127471. /**
  127472. * Creates a physic joint between two meshes
  127473. * @param otherMesh defines the other mesh to use
  127474. * @param pivot1 defines the pivot to use on this mesh
  127475. * @param pivot2 defines the pivot to use on the other mesh
  127476. * @param options defines additional options (can be plugin dependent)
  127477. * @returns the current mesh
  127478. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  127479. */
  127480. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  127481. /** @hidden */
  127482. _disposePhysicsObserver: Nullable<Observer<Node>>;
  127483. }
  127484. /**
  127485. * Defines the physics engine scene component responsible to manage a physics engine
  127486. */
  127487. export class PhysicsEngineSceneComponent implements ISceneComponent {
  127488. /**
  127489. * The component name helpful to identify the component in the list of scene components.
  127490. */
  127491. readonly name: string;
  127492. /**
  127493. * The scene the component belongs to.
  127494. */
  127495. scene: Scene;
  127496. /**
  127497. * Creates a new instance of the component for the given scene
  127498. * @param scene Defines the scene to register the component in
  127499. */
  127500. constructor(scene: Scene);
  127501. /**
  127502. * Registers the component in a given scene
  127503. */
  127504. register(): void;
  127505. /**
  127506. * Rebuilds the elements related to this component in case of
  127507. * context lost for instance.
  127508. */
  127509. rebuild(): void;
  127510. /**
  127511. * Disposes the component and the associated ressources
  127512. */
  127513. dispose(): void;
  127514. }
  127515. }
  127516. declare module BABYLON {
  127517. /**
  127518. * A helper for physics simulations
  127519. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127520. */
  127521. export class PhysicsHelper {
  127522. private _scene;
  127523. private _physicsEngine;
  127524. /**
  127525. * Initializes the Physics helper
  127526. * @param scene Babylon.js scene
  127527. */
  127528. constructor(scene: Scene);
  127529. /**
  127530. * Applies a radial explosion impulse
  127531. * @param origin the origin of the explosion
  127532. * @param radiusOrEventOptions the radius or the options of radial explosion
  127533. * @param strength the explosion strength
  127534. * @param falloff possible options: Constant & Linear. Defaults to Constant
  127535. * @returns A physics radial explosion event, or null
  127536. */
  127537. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  127538. /**
  127539. * Applies a radial explosion force
  127540. * @param origin the origin of the explosion
  127541. * @param radiusOrEventOptions the radius or the options of radial explosion
  127542. * @param strength the explosion strength
  127543. * @param falloff possible options: Constant & Linear. Defaults to Constant
  127544. * @returns A physics radial explosion event, or null
  127545. */
  127546. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  127547. /**
  127548. * Creates a gravitational field
  127549. * @param origin the origin of the explosion
  127550. * @param radiusOrEventOptions the radius or the options of radial explosion
  127551. * @param strength the explosion strength
  127552. * @param falloff possible options: Constant & Linear. Defaults to Constant
  127553. * @returns A physics gravitational field event, or null
  127554. */
  127555. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  127556. /**
  127557. * Creates a physics updraft event
  127558. * @param origin the origin of the updraft
  127559. * @param radiusOrEventOptions the radius or the options of the updraft
  127560. * @param strength the strength of the updraft
  127561. * @param height the height of the updraft
  127562. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  127563. * @returns A physics updraft event, or null
  127564. */
  127565. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  127566. /**
  127567. * Creates a physics vortex event
  127568. * @param origin the of the vortex
  127569. * @param radiusOrEventOptions the radius or the options of the vortex
  127570. * @param strength the strength of the vortex
  127571. * @param height the height of the vortex
  127572. * @returns a Physics vortex event, or null
  127573. * A physics vortex event or null
  127574. */
  127575. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  127576. }
  127577. /**
  127578. * Represents a physics radial explosion event
  127579. */
  127580. class PhysicsRadialExplosionEvent {
  127581. private _scene;
  127582. private _options;
  127583. private _sphere;
  127584. private _dataFetched;
  127585. /**
  127586. * Initializes a radial explosioin event
  127587. * @param _scene BabylonJS scene
  127588. * @param _options The options for the vortex event
  127589. */
  127590. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  127591. /**
  127592. * Returns the data related to the radial explosion event (sphere).
  127593. * @returns The radial explosion event data
  127594. */
  127595. getData(): PhysicsRadialExplosionEventData;
  127596. /**
  127597. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  127598. * @param impostor A physics imposter
  127599. * @param origin the origin of the explosion
  127600. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  127601. */
  127602. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  127603. /**
  127604. * Triggers affecterd impostors callbacks
  127605. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  127606. */
  127607. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  127608. /**
  127609. * Disposes the sphere.
  127610. * @param force Specifies if the sphere should be disposed by force
  127611. */
  127612. dispose(force?: boolean): void;
  127613. /*** Helpers ***/
  127614. private _prepareSphere;
  127615. private _intersectsWithSphere;
  127616. }
  127617. /**
  127618. * Represents a gravitational field event
  127619. */
  127620. class PhysicsGravitationalFieldEvent {
  127621. private _physicsHelper;
  127622. private _scene;
  127623. private _origin;
  127624. private _options;
  127625. private _tickCallback;
  127626. private _sphere;
  127627. private _dataFetched;
  127628. /**
  127629. * Initializes the physics gravitational field event
  127630. * @param _physicsHelper A physics helper
  127631. * @param _scene BabylonJS scene
  127632. * @param _origin The origin position of the gravitational field event
  127633. * @param _options The options for the vortex event
  127634. */
  127635. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  127636. /**
  127637. * Returns the data related to the gravitational field event (sphere).
  127638. * @returns A gravitational field event
  127639. */
  127640. getData(): PhysicsGravitationalFieldEventData;
  127641. /**
  127642. * Enables the gravitational field.
  127643. */
  127644. enable(): void;
  127645. /**
  127646. * Disables the gravitational field.
  127647. */
  127648. disable(): void;
  127649. /**
  127650. * Disposes the sphere.
  127651. * @param force The force to dispose from the gravitational field event
  127652. */
  127653. dispose(force?: boolean): void;
  127654. private _tick;
  127655. }
  127656. /**
  127657. * Represents a physics updraft event
  127658. */
  127659. class PhysicsUpdraftEvent {
  127660. private _scene;
  127661. private _origin;
  127662. private _options;
  127663. private _physicsEngine;
  127664. private _originTop;
  127665. private _originDirection;
  127666. private _tickCallback;
  127667. private _cylinder;
  127668. private _cylinderPosition;
  127669. private _dataFetched;
  127670. /**
  127671. * Initializes the physics updraft event
  127672. * @param _scene BabylonJS scene
  127673. * @param _origin The origin position of the updraft
  127674. * @param _options The options for the updraft event
  127675. */
  127676. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  127677. /**
  127678. * Returns the data related to the updraft event (cylinder).
  127679. * @returns A physics updraft event
  127680. */
  127681. getData(): PhysicsUpdraftEventData;
  127682. /**
  127683. * Enables the updraft.
  127684. */
  127685. enable(): void;
  127686. /**
  127687. * Disables the updraft.
  127688. */
  127689. disable(): void;
  127690. /**
  127691. * Disposes the cylinder.
  127692. * @param force Specifies if the updraft should be disposed by force
  127693. */
  127694. dispose(force?: boolean): void;
  127695. private getImpostorHitData;
  127696. private _tick;
  127697. /*** Helpers ***/
  127698. private _prepareCylinder;
  127699. private _intersectsWithCylinder;
  127700. }
  127701. /**
  127702. * Represents a physics vortex event
  127703. */
  127704. class PhysicsVortexEvent {
  127705. private _scene;
  127706. private _origin;
  127707. private _options;
  127708. private _physicsEngine;
  127709. private _originTop;
  127710. private _tickCallback;
  127711. private _cylinder;
  127712. private _cylinderPosition;
  127713. private _dataFetched;
  127714. /**
  127715. * Initializes the physics vortex event
  127716. * @param _scene The BabylonJS scene
  127717. * @param _origin The origin position of the vortex
  127718. * @param _options The options for the vortex event
  127719. */
  127720. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  127721. /**
  127722. * Returns the data related to the vortex event (cylinder).
  127723. * @returns The physics vortex event data
  127724. */
  127725. getData(): PhysicsVortexEventData;
  127726. /**
  127727. * Enables the vortex.
  127728. */
  127729. enable(): void;
  127730. /**
  127731. * Disables the cortex.
  127732. */
  127733. disable(): void;
  127734. /**
  127735. * Disposes the sphere.
  127736. * @param force
  127737. */
  127738. dispose(force?: boolean): void;
  127739. private getImpostorHitData;
  127740. private _tick;
  127741. /*** Helpers ***/
  127742. private _prepareCylinder;
  127743. private _intersectsWithCylinder;
  127744. }
  127745. /**
  127746. * Options fot the radial explosion event
  127747. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127748. */
  127749. export class PhysicsRadialExplosionEventOptions {
  127750. /**
  127751. * The radius of the sphere for the radial explosion.
  127752. */
  127753. radius: number;
  127754. /**
  127755. * The strenth of the explosion.
  127756. */
  127757. strength: number;
  127758. /**
  127759. * The strenght of the force in correspondence to the distance of the affected object
  127760. */
  127761. falloff: PhysicsRadialImpulseFalloff;
  127762. /**
  127763. * Sphere options for the radial explosion.
  127764. */
  127765. sphere: {
  127766. segments: number;
  127767. diameter: number;
  127768. };
  127769. /**
  127770. * Sphere options for the radial explosion.
  127771. */
  127772. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  127773. }
  127774. /**
  127775. * Options fot the updraft event
  127776. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127777. */
  127778. export class PhysicsUpdraftEventOptions {
  127779. /**
  127780. * The radius of the cylinder for the vortex
  127781. */
  127782. radius: number;
  127783. /**
  127784. * The strenth of the updraft.
  127785. */
  127786. strength: number;
  127787. /**
  127788. * The height of the cylinder for the updraft.
  127789. */
  127790. height: number;
  127791. /**
  127792. * The mode for the the updraft.
  127793. */
  127794. updraftMode: PhysicsUpdraftMode;
  127795. }
  127796. /**
  127797. * Options fot the vortex event
  127798. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127799. */
  127800. export class PhysicsVortexEventOptions {
  127801. /**
  127802. * The radius of the cylinder for the vortex
  127803. */
  127804. radius: number;
  127805. /**
  127806. * The strenth of the vortex.
  127807. */
  127808. strength: number;
  127809. /**
  127810. * The height of the cylinder for the vortex.
  127811. */
  127812. height: number;
  127813. /**
  127814. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  127815. */
  127816. centripetalForceThreshold: number;
  127817. /**
  127818. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  127819. */
  127820. centripetalForceMultiplier: number;
  127821. /**
  127822. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  127823. */
  127824. centrifugalForceMultiplier: number;
  127825. /**
  127826. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  127827. */
  127828. updraftForceMultiplier: number;
  127829. }
  127830. /**
  127831. * The strenght of the force in correspondence to the distance of the affected object
  127832. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127833. */
  127834. export enum PhysicsRadialImpulseFalloff {
  127835. /** Defines that impulse is constant in strength across it's whole radius */
  127836. Constant = 0,
  127837. /** Defines that impulse gets weaker if it's further from the origin */
  127838. Linear = 1
  127839. }
  127840. /**
  127841. * The strength of the force in correspondence to the distance of the affected object
  127842. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127843. */
  127844. export enum PhysicsUpdraftMode {
  127845. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  127846. Center = 0,
  127847. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  127848. Perpendicular = 1
  127849. }
  127850. /**
  127851. * Interface for a physics hit data
  127852. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127853. */
  127854. export interface PhysicsHitData {
  127855. /**
  127856. * The force applied at the contact point
  127857. */
  127858. force: Vector3;
  127859. /**
  127860. * The contact point
  127861. */
  127862. contactPoint: Vector3;
  127863. /**
  127864. * The distance from the origin to the contact point
  127865. */
  127866. distanceFromOrigin: number;
  127867. }
  127868. /**
  127869. * Interface for radial explosion event data
  127870. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127871. */
  127872. export interface PhysicsRadialExplosionEventData {
  127873. /**
  127874. * A sphere used for the radial explosion event
  127875. */
  127876. sphere: Mesh;
  127877. }
  127878. /**
  127879. * Interface for gravitational field event data
  127880. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127881. */
  127882. export interface PhysicsGravitationalFieldEventData {
  127883. /**
  127884. * A sphere mesh used for the gravitational field event
  127885. */
  127886. sphere: Mesh;
  127887. }
  127888. /**
  127889. * Interface for updraft event data
  127890. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127891. */
  127892. export interface PhysicsUpdraftEventData {
  127893. /**
  127894. * A cylinder used for the updraft event
  127895. */
  127896. cylinder: Mesh;
  127897. }
  127898. /**
  127899. * Interface for vortex event data
  127900. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127901. */
  127902. export interface PhysicsVortexEventData {
  127903. /**
  127904. * A cylinder used for the vortex event
  127905. */
  127906. cylinder: Mesh;
  127907. }
  127908. /**
  127909. * Interface for an affected physics impostor
  127910. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  127911. */
  127912. export interface PhysicsAffectedImpostorWithData {
  127913. /**
  127914. * The impostor affected by the effect
  127915. */
  127916. impostor: PhysicsImpostor;
  127917. /**
  127918. * The data about the hit/horce from the explosion
  127919. */
  127920. hitData: PhysicsHitData;
  127921. }
  127922. }
  127923. declare module BABYLON {
  127924. /** @hidden */
  127925. export var blackAndWhitePixelShader: {
  127926. name: string;
  127927. shader: string;
  127928. };
  127929. }
  127930. declare module BABYLON {
  127931. /**
  127932. * Post process used to render in black and white
  127933. */
  127934. export class BlackAndWhitePostProcess extends PostProcess {
  127935. /**
  127936. * Linear about to convert he result to black and white (default: 1)
  127937. */
  127938. degree: number;
  127939. /**
  127940. * Creates a black and white post process
  127941. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  127942. * @param name The name of the effect.
  127943. * @param options The required width/height ratio to downsize to before computing the render pass.
  127944. * @param camera The camera to apply the render pass to.
  127945. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  127946. * @param engine The engine which the post process will be applied. (default: current engine)
  127947. * @param reusable If the post process can be reused on the same frame. (default: false)
  127948. */
  127949. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  127950. }
  127951. }
  127952. declare module BABYLON {
  127953. /**
  127954. * This represents a set of one or more post processes in Babylon.
  127955. * A post process can be used to apply a shader to a texture after it is rendered.
  127956. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  127957. */
  127958. export class PostProcessRenderEffect {
  127959. private _postProcesses;
  127960. private _getPostProcesses;
  127961. private _singleInstance;
  127962. private _cameras;
  127963. private _indicesForCamera;
  127964. /**
  127965. * Name of the effect
  127966. * @hidden
  127967. */
  127968. _name: string;
  127969. /**
  127970. * Instantiates a post process render effect.
  127971. * A post process can be used to apply a shader to a texture after it is rendered.
  127972. * @param engine The engine the effect is tied to
  127973. * @param name The name of the effect
  127974. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  127975. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  127976. */
  127977. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  127978. /**
  127979. * Checks if all the post processes in the effect are supported.
  127980. */
  127981. readonly isSupported: boolean;
  127982. /**
  127983. * Updates the current state of the effect
  127984. * @hidden
  127985. */
  127986. _update(): void;
  127987. /**
  127988. * Attaches the effect on cameras
  127989. * @param cameras The camera to attach to.
  127990. * @hidden
  127991. */
  127992. _attachCameras(cameras: Camera): void;
  127993. /**
  127994. * Attaches the effect on cameras
  127995. * @param cameras The camera to attach to.
  127996. * @hidden
  127997. */
  127998. _attachCameras(cameras: Camera[]): void;
  127999. /**
  128000. * Detaches the effect on cameras
  128001. * @param cameras The camera to detatch from.
  128002. * @hidden
  128003. */
  128004. _detachCameras(cameras: Camera): void;
  128005. /**
  128006. * Detatches the effect on cameras
  128007. * @param cameras The camera to detatch from.
  128008. * @hidden
  128009. */
  128010. _detachCameras(cameras: Camera[]): void;
  128011. /**
  128012. * Enables the effect on given cameras
  128013. * @param cameras The camera to enable.
  128014. * @hidden
  128015. */
  128016. _enable(cameras: Camera): void;
  128017. /**
  128018. * Enables the effect on given cameras
  128019. * @param cameras The camera to enable.
  128020. * @hidden
  128021. */
  128022. _enable(cameras: Nullable<Camera[]>): void;
  128023. /**
  128024. * Disables the effect on the given cameras
  128025. * @param cameras The camera to disable.
  128026. * @hidden
  128027. */
  128028. _disable(cameras: Camera): void;
  128029. /**
  128030. * Disables the effect on the given cameras
  128031. * @param cameras The camera to disable.
  128032. * @hidden
  128033. */
  128034. _disable(cameras: Nullable<Camera[]>): void;
  128035. /**
  128036. * Gets a list of the post processes contained in the effect.
  128037. * @param camera The camera to get the post processes on.
  128038. * @returns The list of the post processes in the effect.
  128039. */
  128040. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  128041. }
  128042. }
  128043. declare module BABYLON {
  128044. /** @hidden */
  128045. export var extractHighlightsPixelShader: {
  128046. name: string;
  128047. shader: string;
  128048. };
  128049. }
  128050. declare module BABYLON {
  128051. /**
  128052. * The extract highlights post process sets all pixels to black except pixels above the specified luminance threshold. Used as the first step for a bloom effect.
  128053. */
  128054. export class ExtractHighlightsPostProcess extends PostProcess {
  128055. /**
  128056. * The luminance threshold, pixels below this value will be set to black.
  128057. */
  128058. threshold: number;
  128059. /** @hidden */
  128060. _exposure: number;
  128061. /**
  128062. * Post process which has the input texture to be used when performing highlight extraction
  128063. * @hidden
  128064. */
  128065. _inputPostProcess: Nullable<PostProcess>;
  128066. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128067. }
  128068. }
  128069. declare module BABYLON {
  128070. /** @hidden */
  128071. export var bloomMergePixelShader: {
  128072. name: string;
  128073. shader: string;
  128074. };
  128075. }
  128076. declare module BABYLON {
  128077. /**
  128078. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  128079. */
  128080. export class BloomMergePostProcess extends PostProcess {
  128081. /** Weight of the bloom to be added to the original input. */
  128082. weight: number;
  128083. /**
  128084. * Creates a new instance of @see BloomMergePostProcess
  128085. * @param name The name of the effect.
  128086. * @param originalFromInput Post process which's input will be used for the merge.
  128087. * @param blurred Blurred highlights post process which's output will be used.
  128088. * @param weight Weight of the bloom to be added to the original input.
  128089. * @param options The required width/height ratio to downsize to before computing the render pass.
  128090. * @param camera The camera to apply the render pass to.
  128091. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128092. * @param engine The engine which the post process will be applied. (default: current engine)
  128093. * @param reusable If the post process can be reused on the same frame. (default: false)
  128094. * @param textureType Type of textures used when performing the post process. (default: 0)
  128095. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  128096. */
  128097. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  128098. /** Weight of the bloom to be added to the original input. */
  128099. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128100. }
  128101. }
  128102. declare module BABYLON {
  128103. /**
  128104. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  128105. */
  128106. export class BloomEffect extends PostProcessRenderEffect {
  128107. private bloomScale;
  128108. /**
  128109. * @hidden Internal
  128110. */
  128111. _effects: Array<PostProcess>;
  128112. /**
  128113. * @hidden Internal
  128114. */
  128115. _downscale: ExtractHighlightsPostProcess;
  128116. private _blurX;
  128117. private _blurY;
  128118. private _merge;
  128119. /**
  128120. * The luminance threshold to find bright areas of the image to bloom.
  128121. */
  128122. threshold: number;
  128123. /**
  128124. * The strength of the bloom.
  128125. */
  128126. weight: number;
  128127. /**
  128128. * Specifies the size of the bloom blur kernel, relative to the final output size
  128129. */
  128130. kernel: number;
  128131. /**
  128132. * Creates a new instance of @see BloomEffect
  128133. * @param scene The scene the effect belongs to.
  128134. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  128135. * @param bloomKernel The size of the kernel to be used when applying the blur.
  128136. * @param bloomWeight The the strength of bloom.
  128137. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  128138. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  128139. */
  128140. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  128141. /**
  128142. * Disposes each of the internal effects for a given camera.
  128143. * @param camera The camera to dispose the effect on.
  128144. */
  128145. disposeEffects(camera: Camera): void;
  128146. /**
  128147. * @hidden Internal
  128148. */
  128149. _updateEffects(): void;
  128150. /**
  128151. * Internal
  128152. * @returns if all the contained post processes are ready.
  128153. * @hidden
  128154. */
  128155. _isReady(): boolean;
  128156. }
  128157. }
  128158. declare module BABYLON {
  128159. /** @hidden */
  128160. export var chromaticAberrationPixelShader: {
  128161. name: string;
  128162. shader: string;
  128163. };
  128164. }
  128165. declare module BABYLON {
  128166. /**
  128167. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  128168. */
  128169. export class ChromaticAberrationPostProcess extends PostProcess {
  128170. /**
  128171. * The amount of seperation of rgb channels (default: 30)
  128172. */
  128173. aberrationAmount: number;
  128174. /**
  128175. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  128176. */
  128177. radialIntensity: number;
  128178. /**
  128179. * The normilized direction in which the rgb channels should be seperated. If set to 0,0 radial direction will be used. (default: Vector2(0.707,0.707))
  128180. */
  128181. direction: Vector2;
  128182. /**
  128183. * The center position where the radialIntensity should be around. [0.5,0.5 is center of screen, 1,1 is top right corder] (default: Vector2(0.5 ,0.5))
  128184. */
  128185. centerPosition: Vector2;
  128186. /**
  128187. * Creates a new instance ChromaticAberrationPostProcess
  128188. * @param name The name of the effect.
  128189. * @param screenWidth The width of the screen to apply the effect on.
  128190. * @param screenHeight The height of the screen to apply the effect on.
  128191. * @param options The required width/height ratio to downsize to before computing the render pass.
  128192. * @param camera The camera to apply the render pass to.
  128193. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128194. * @param engine The engine which the post process will be applied. (default: current engine)
  128195. * @param reusable If the post process can be reused on the same frame. (default: false)
  128196. * @param textureType Type of textures used when performing the post process. (default: 0)
  128197. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  128198. */
  128199. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128200. }
  128201. }
  128202. declare module BABYLON {
  128203. /** @hidden */
  128204. export var circleOfConfusionPixelShader: {
  128205. name: string;
  128206. shader: string;
  128207. };
  128208. }
  128209. declare module BABYLON {
  128210. /**
  128211. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  128212. */
  128213. export class CircleOfConfusionPostProcess extends PostProcess {
  128214. /**
  128215. * Max lens size in scene units/1000 (eg. millimeter). Standard cameras are 50mm. (default: 50) The diamater of the resulting aperture can be computed by lensSize/fStop.
  128216. */
  128217. lensSize: number;
  128218. /**
  128219. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  128220. */
  128221. fStop: number;
  128222. /**
  128223. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  128224. */
  128225. focusDistance: number;
  128226. /**
  128227. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  128228. */
  128229. focalLength: number;
  128230. private _depthTexture;
  128231. /**
  128232. * Creates a new instance CircleOfConfusionPostProcess
  128233. * @param name The name of the effect.
  128234. * @param depthTexture The depth texture of the scene to compute the circle of confusion. This must be set in order for this to function but may be set after initialization if needed.
  128235. * @param options The required width/height ratio to downsize to before computing the render pass.
  128236. * @param camera The camera to apply the render pass to.
  128237. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128238. * @param engine The engine which the post process will be applied. (default: current engine)
  128239. * @param reusable If the post process can be reused on the same frame. (default: false)
  128240. * @param textureType Type of textures used when performing the post process. (default: 0)
  128241. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  128242. */
  128243. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128244. /**
  128245. * Depth texture to be used to compute the circle of confusion. This must be set here or in the constructor in order for the post process to function.
  128246. */
  128247. depthTexture: RenderTargetTexture;
  128248. }
  128249. }
  128250. declare module BABYLON {
  128251. /** @hidden */
  128252. export var colorCorrectionPixelShader: {
  128253. name: string;
  128254. shader: string;
  128255. };
  128256. }
  128257. declare module BABYLON {
  128258. /**
  128259. *
  128260. * This post-process allows the modification of rendered colors by using
  128261. * a 'look-up table' (LUT). This effect is also called Color Grading.
  128262. *
  128263. * The object needs to be provided an url to a texture containing the color
  128264. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  128265. * Use an image editing software to tweak the LUT to match your needs.
  128266. *
  128267. * For an example of a color LUT, see here:
  128268. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  128269. * For explanations on color grading, see here:
  128270. * @see http://udn.epicgames.com/Three/ColorGrading.html
  128271. *
  128272. */
  128273. export class ColorCorrectionPostProcess extends PostProcess {
  128274. private _colorTableTexture;
  128275. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128276. }
  128277. }
  128278. declare module BABYLON {
  128279. /** @hidden */
  128280. export var convolutionPixelShader: {
  128281. name: string;
  128282. shader: string;
  128283. };
  128284. }
  128285. declare module BABYLON {
  128286. /**
  128287. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  128288. * input texture to perform effects such as edge detection or sharpening
  128289. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  128290. */
  128291. export class ConvolutionPostProcess extends PostProcess {
  128292. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  128293. kernel: number[];
  128294. /**
  128295. * Creates a new instance ConvolutionPostProcess
  128296. * @param name The name of the effect.
  128297. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  128298. * @param options The required width/height ratio to downsize to before computing the render pass.
  128299. * @param camera The camera to apply the render pass to.
  128300. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128301. * @param engine The engine which the post process will be applied. (default: current engine)
  128302. * @param reusable If the post process can be reused on the same frame. (default: false)
  128303. * @param textureType Type of textures used when performing the post process. (default: 0)
  128304. */
  128305. constructor(name: string,
  128306. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  128307. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  128308. /**
  128309. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128310. */
  128311. static EdgeDetect0Kernel: number[];
  128312. /**
  128313. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128314. */
  128315. static EdgeDetect1Kernel: number[];
  128316. /**
  128317. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128318. */
  128319. static EdgeDetect2Kernel: number[];
  128320. /**
  128321. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128322. */
  128323. static SharpenKernel: number[];
  128324. /**
  128325. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128326. */
  128327. static EmbossKernel: number[];
  128328. /**
  128329. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128330. */
  128331. static GaussianKernel: number[];
  128332. }
  128333. }
  128334. declare module BABYLON {
  128335. /**
  128336. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  128337. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  128338. * based on samples that have a large difference in distance than the center pixel.
  128339. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  128340. */
  128341. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  128342. direction: Vector2;
  128343. /**
  128344. * Creates a new instance CircleOfConfusionPostProcess
  128345. * @param name The name of the effect.
  128346. * @param scene The scene the effect belongs to.
  128347. * @param direction The direction the blur should be applied.
  128348. * @param kernel The size of the kernel used to blur.
  128349. * @param options The required width/height ratio to downsize to before computing the render pass.
  128350. * @param camera The camera to apply the render pass to.
  128351. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  128352. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  128353. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128354. * @param engine The engine which the post process will be applied. (default: current engine)
  128355. * @param reusable If the post process can be reused on the same frame. (default: false)
  128356. * @param textureType Type of textures used when performing the post process. (default: 0)
  128357. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  128358. */
  128359. constructor(name: string, scene: Scene, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, circleOfConfusion: PostProcess, imageToBlur?: Nullable<PostProcess>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128360. }
  128361. }
  128362. declare module BABYLON {
  128363. /** @hidden */
  128364. export var depthOfFieldMergePixelShader: {
  128365. name: string;
  128366. shader: string;
  128367. };
  128368. }
  128369. declare module BABYLON {
  128370. /**
  128371. * Options to be set when merging outputs from the default pipeline.
  128372. */
  128373. export class DepthOfFieldMergePostProcessOptions {
  128374. /**
  128375. * The original image to merge on top of
  128376. */
  128377. originalFromInput: PostProcess;
  128378. /**
  128379. * Parameters to perform the merge of the depth of field effect
  128380. */
  128381. depthOfField?: {
  128382. circleOfConfusion: PostProcess;
  128383. blurSteps: Array<PostProcess>;
  128384. };
  128385. /**
  128386. * Parameters to perform the merge of bloom effect
  128387. */
  128388. bloom?: {
  128389. blurred: PostProcess;
  128390. weight: number;
  128391. };
  128392. }
  128393. /**
  128394. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  128395. */
  128396. export class DepthOfFieldMergePostProcess extends PostProcess {
  128397. private blurSteps;
  128398. /**
  128399. * Creates a new instance of DepthOfFieldMergePostProcess
  128400. * @param name The name of the effect.
  128401. * @param originalFromInput Post process which's input will be used for the merge.
  128402. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  128403. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  128404. * @param options The required width/height ratio to downsize to before computing the render pass.
  128405. * @param camera The camera to apply the render pass to.
  128406. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128407. * @param engine The engine which the post process will be applied. (default: current engine)
  128408. * @param reusable If the post process can be reused on the same frame. (default: false)
  128409. * @param textureType Type of textures used when performing the post process. (default: 0)
  128410. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  128411. */
  128412. constructor(name: string, originalFromInput: PostProcess, circleOfConfusion: PostProcess, blurSteps: Array<PostProcess>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128413. /**
  128414. * Updates the effect with the current post process compile time values and recompiles the shader.
  128415. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  128416. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  128417. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  128418. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  128419. * @param onCompiled Called when the shader has been compiled.
  128420. * @param onError Called if there is an error when compiling a shader.
  128421. */
  128422. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  128423. }
  128424. }
  128425. declare module BABYLON {
  128426. /**
  128427. * Specifies the level of max blur that should be applied when using the depth of field effect
  128428. */
  128429. export enum DepthOfFieldEffectBlurLevel {
  128430. /**
  128431. * Subtle blur
  128432. */
  128433. Low = 0,
  128434. /**
  128435. * Medium blur
  128436. */
  128437. Medium = 1,
  128438. /**
  128439. * Large blur
  128440. */
  128441. High = 2
  128442. }
  128443. /**
  128444. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  128445. */
  128446. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  128447. private _circleOfConfusion;
  128448. /**
  128449. * @hidden Internal, blurs from high to low
  128450. */
  128451. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  128452. private _depthOfFieldBlurY;
  128453. private _dofMerge;
  128454. /**
  128455. * @hidden Internal post processes in depth of field effect
  128456. */
  128457. _effects: Array<PostProcess>;
  128458. /**
  128459. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  128460. */
  128461. focalLength: number;
  128462. /**
  128463. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  128464. */
  128465. fStop: number;
  128466. /**
  128467. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  128468. */
  128469. focusDistance: number;
  128470. /**
  128471. * Max lens size in scene units/1000 (eg. millimeter). Standard cameras are 50mm. (default: 50) The diamater of the resulting aperture can be computed by lensSize/fStop.
  128472. */
  128473. lensSize: number;
  128474. /**
  128475. * Creates a new instance DepthOfFieldEffect
  128476. * @param scene The scene the effect belongs to.
  128477. * @param depthTexture The depth texture of the scene to compute the circle of confusion.This must be set in order for this to function but may be set after initialization if needed.
  128478. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  128479. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  128480. */
  128481. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  128482. /**
  128483. * Get the current class name of the current effet
  128484. * @returns "DepthOfFieldEffect"
  128485. */
  128486. getClassName(): string;
  128487. /**
  128488. * Depth texture to be used to compute the circle of confusion. This must be set here or in the constructor in order for the post process to function.
  128489. */
  128490. depthTexture: RenderTargetTexture;
  128491. /**
  128492. * Disposes each of the internal effects for a given camera.
  128493. * @param camera The camera to dispose the effect on.
  128494. */
  128495. disposeEffects(camera: Camera): void;
  128496. /**
  128497. * @hidden Internal
  128498. */
  128499. _updateEffects(): void;
  128500. /**
  128501. * Internal
  128502. * @returns if all the contained post processes are ready.
  128503. * @hidden
  128504. */
  128505. _isReady(): boolean;
  128506. }
  128507. }
  128508. declare module BABYLON {
  128509. /** @hidden */
  128510. export var displayPassPixelShader: {
  128511. name: string;
  128512. shader: string;
  128513. };
  128514. }
  128515. declare module BABYLON {
  128516. /**
  128517. * DisplayPassPostProcess which produces an output the same as it's input
  128518. */
  128519. export class DisplayPassPostProcess extends PostProcess {
  128520. /**
  128521. * Creates the DisplayPassPostProcess
  128522. * @param name The name of the effect.
  128523. * @param options The required width/height ratio to downsize to before computing the render pass.
  128524. * @param camera The camera to apply the render pass to.
  128525. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128526. * @param engine The engine which the post process will be applied. (default: current engine)
  128527. * @param reusable If the post process can be reused on the same frame. (default: false)
  128528. */
  128529. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128530. }
  128531. }
  128532. declare module BABYLON {
  128533. /** @hidden */
  128534. export var filterPixelShader: {
  128535. name: string;
  128536. shader: string;
  128537. };
  128538. }
  128539. declare module BABYLON {
  128540. /**
  128541. * Applies a kernel filter to the image
  128542. */
  128543. export class FilterPostProcess extends PostProcess {
  128544. /** The matrix to be applied to the image */
  128545. kernelMatrix: Matrix;
  128546. /**
  128547. *
  128548. * @param name The name of the effect.
  128549. * @param kernelMatrix The matrix to be applied to the image
  128550. * @param options The required width/height ratio to downsize to before computing the render pass.
  128551. * @param camera The camera to apply the render pass to.
  128552. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128553. * @param engine The engine which the post process will be applied. (default: current engine)
  128554. * @param reusable If the post process can be reused on the same frame. (default: false)
  128555. */
  128556. constructor(name: string,
  128557. /** The matrix to be applied to the image */
  128558. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128559. }
  128560. }
  128561. declare module BABYLON {
  128562. /** @hidden */
  128563. export var fxaaPixelShader: {
  128564. name: string;
  128565. shader: string;
  128566. };
  128567. }
  128568. declare module BABYLON {
  128569. /** @hidden */
  128570. export var fxaaVertexShader: {
  128571. name: string;
  128572. shader: string;
  128573. };
  128574. }
  128575. declare module BABYLON {
  128576. /**
  128577. * Fxaa post process
  128578. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  128579. */
  128580. export class FxaaPostProcess extends PostProcess {
  128581. /** @hidden */
  128582. texelWidth: number;
  128583. /** @hidden */
  128584. texelHeight: number;
  128585. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  128586. private _getDefines;
  128587. }
  128588. }
  128589. declare module BABYLON {
  128590. /** @hidden */
  128591. export var grainPixelShader: {
  128592. name: string;
  128593. shader: string;
  128594. };
  128595. }
  128596. declare module BABYLON {
  128597. /**
  128598. * The GrainPostProcess adds noise to the image at mid luminance levels
  128599. */
  128600. export class GrainPostProcess extends PostProcess {
  128601. /**
  128602. * The intensity of the grain added (default: 30)
  128603. */
  128604. intensity: number;
  128605. /**
  128606. * If the grain should be randomized on every frame
  128607. */
  128608. animated: boolean;
  128609. /**
  128610. * Creates a new instance of @see GrainPostProcess
  128611. * @param name The name of the effect.
  128612. * @param options The required width/height ratio to downsize to before computing the render pass.
  128613. * @param camera The camera to apply the render pass to.
  128614. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128615. * @param engine The engine which the post process will be applied. (default: current engine)
  128616. * @param reusable If the post process can be reused on the same frame. (default: false)
  128617. * @param textureType Type of textures used when performing the post process. (default: 0)
  128618. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  128619. */
  128620. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128621. }
  128622. }
  128623. declare module BABYLON {
  128624. /** @hidden */
  128625. export var highlightsPixelShader: {
  128626. name: string;
  128627. shader: string;
  128628. };
  128629. }
  128630. declare module BABYLON {
  128631. /**
  128632. * Extracts highlights from the image
  128633. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  128634. */
  128635. export class HighlightsPostProcess extends PostProcess {
  128636. /**
  128637. * Extracts highlights from the image
  128638. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  128639. * @param name The name of the effect.
  128640. * @param options The required width/height ratio to downsize to before computing the render pass.
  128641. * @param camera The camera to apply the render pass to.
  128642. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128643. * @param engine The engine which the post process will be applied. (default: current engine)
  128644. * @param reusable If the post process can be reused on the same frame. (default: false)
  128645. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  128646. */
  128647. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  128648. }
  128649. }
  128650. declare module BABYLON {
  128651. /** @hidden */
  128652. export var mrtFragmentDeclaration: {
  128653. name: string;
  128654. shader: string;
  128655. };
  128656. }
  128657. declare module BABYLON {
  128658. /** @hidden */
  128659. export var geometryPixelShader: {
  128660. name: string;
  128661. shader: string;
  128662. };
  128663. }
  128664. declare module BABYLON {
  128665. /** @hidden */
  128666. export var geometryVertexShader: {
  128667. name: string;
  128668. shader: string;
  128669. };
  128670. }
  128671. declare module BABYLON {
  128672. /** @hidden */
  128673. interface ISavedTransformationMatrix {
  128674. world: Matrix;
  128675. viewProjection: Matrix;
  128676. }
  128677. /**
  128678. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  128679. */
  128680. export class GeometryBufferRenderer {
  128681. /**
  128682. * Constant used to retrieve the position texture index in the G-Buffer textures array
  128683. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  128684. */
  128685. static readonly POSITION_TEXTURE_TYPE: number;
  128686. /**
  128687. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  128688. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  128689. */
  128690. static readonly VELOCITY_TEXTURE_TYPE: number;
  128691. /**
  128692. * Dictionary used to store the previous transformation matrices of each rendered mesh
  128693. * in order to compute objects velocities when enableVelocity is set to "true"
  128694. * @hidden
  128695. */
  128696. _previousTransformationMatrices: {
  128697. [index: number]: ISavedTransformationMatrix;
  128698. };
  128699. /**
  128700. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  128701. * in order to compute objects velocities when enableVelocity is set to "true"
  128702. * @hidden
  128703. */
  128704. _previousBonesTransformationMatrices: {
  128705. [index: number]: Float32Array;
  128706. };
  128707. /**
  128708. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  128709. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  128710. */
  128711. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  128712. private _scene;
  128713. private _multiRenderTarget;
  128714. private _ratio;
  128715. private _enablePosition;
  128716. private _enableVelocity;
  128717. private _positionIndex;
  128718. private _velocityIndex;
  128719. protected _effect: Effect;
  128720. protected _cachedDefines: string;
  128721. /**
  128722. * Set the render list (meshes to be rendered) used in the G buffer.
  128723. */
  128724. renderList: Mesh[];
  128725. /**
  128726. * Gets wether or not G buffer are supported by the running hardware.
  128727. * This requires draw buffer supports
  128728. */
  128729. readonly isSupported: boolean;
  128730. /**
  128731. * Returns the index of the given texture type in the G-Buffer textures array
  128732. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  128733. * @returns the index of the given texture type in the G-Buffer textures array
  128734. */
  128735. getTextureIndex(textureType: number): number;
  128736. /**
  128737. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  128738. */
  128739. /**
  128740. * Sets whether or not objects positions are enabled for the G buffer.
  128741. */
  128742. enablePosition: boolean;
  128743. /**
  128744. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  128745. */
  128746. /**
  128747. * Sets wether or not objects velocities are enabled for the G buffer.
  128748. */
  128749. enableVelocity: boolean;
  128750. /**
  128751. * Gets the scene associated with the buffer.
  128752. */
  128753. readonly scene: Scene;
  128754. /**
  128755. * Gets the ratio used by the buffer during its creation.
  128756. * How big is the buffer related to the main canvas.
  128757. */
  128758. readonly ratio: number;
  128759. /** @hidden */
  128760. static _SceneComponentInitialization: (scene: Scene) => void;
  128761. /**
  128762. * Creates a new G Buffer for the scene
  128763. * @param scene The scene the buffer belongs to
  128764. * @param ratio How big is the buffer related to the main canvas.
  128765. */
  128766. constructor(scene: Scene, ratio?: number);
  128767. /**
  128768. * Checks wether everything is ready to render a submesh to the G buffer.
  128769. * @param subMesh the submesh to check readiness for
  128770. * @param useInstances is the mesh drawn using instance or not
  128771. * @returns true if ready otherwise false
  128772. */
  128773. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  128774. /**
  128775. * Gets the current underlying G Buffer.
  128776. * @returns the buffer
  128777. */
  128778. getGBuffer(): MultiRenderTarget;
  128779. /**
  128780. * Gets the number of samples used to render the buffer (anti aliasing).
  128781. */
  128782. /**
  128783. * Sets the number of samples used to render the buffer (anti aliasing).
  128784. */
  128785. samples: number;
  128786. /**
  128787. * Disposes the renderer and frees up associated resources.
  128788. */
  128789. dispose(): void;
  128790. protected _createRenderTargets(): void;
  128791. private _copyBonesTransformationMatrices;
  128792. }
  128793. }
  128794. declare module BABYLON {
  128795. interface Scene {
  128796. /** @hidden (Backing field) */
  128797. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  128798. /**
  128799. * Gets or Sets the current geometry buffer associated to the scene.
  128800. */
  128801. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  128802. /**
  128803. * Enables a GeometryBufferRender and associates it with the scene
  128804. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  128805. * @returns the GeometryBufferRenderer
  128806. */
  128807. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  128808. /**
  128809. * Disables the GeometryBufferRender associated with the scene
  128810. */
  128811. disableGeometryBufferRenderer(): void;
  128812. }
  128813. /**
  128814. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  128815. * in several rendering techniques.
  128816. */
  128817. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  128818. /**
  128819. * The component name helpful to identify the component in the list of scene components.
  128820. */
  128821. readonly name: string;
  128822. /**
  128823. * The scene the component belongs to.
  128824. */
  128825. scene: Scene;
  128826. /**
  128827. * Creates a new instance of the component for the given scene
  128828. * @param scene Defines the scene to register the component in
  128829. */
  128830. constructor(scene: Scene);
  128831. /**
  128832. * Registers the component in a given scene
  128833. */
  128834. register(): void;
  128835. /**
  128836. * Rebuilds the elements related to this component in case of
  128837. * context lost for instance.
  128838. */
  128839. rebuild(): void;
  128840. /**
  128841. * Disposes the component and the associated ressources
  128842. */
  128843. dispose(): void;
  128844. private _gatherRenderTargets;
  128845. }
  128846. }
  128847. declare module BABYLON {
  128848. /** @hidden */
  128849. export var motionBlurPixelShader: {
  128850. name: string;
  128851. shader: string;
  128852. };
  128853. }
  128854. declare module BABYLON {
  128855. /**
  128856. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  128857. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  128858. * As an example, all you have to do is to create the post-process:
  128859. * var mb = new BABYLON.MotionBlurPostProcess(
  128860. * 'mb', // The name of the effect.
  128861. * scene, // The scene containing the objects to blur according to their velocity.
  128862. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  128863. * camera // The camera to apply the render pass to.
  128864. * );
  128865. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  128866. */
  128867. export class MotionBlurPostProcess extends PostProcess {
  128868. /**
  128869. * Defines how much the image is blurred by the movement. Default value is equal to 1
  128870. */
  128871. motionStrength: number;
  128872. /**
  128873. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  128874. */
  128875. /**
  128876. * Sets the number of iterations to be used for motion blur quality
  128877. */
  128878. motionBlurSamples: number;
  128879. private _motionBlurSamples;
  128880. private _geometryBufferRenderer;
  128881. /**
  128882. * Creates a new instance MotionBlurPostProcess
  128883. * @param name The name of the effect.
  128884. * @param scene The scene containing the objects to blur according to their velocity.
  128885. * @param options The required width/height ratio to downsize to before computing the render pass.
  128886. * @param camera The camera to apply the render pass to.
  128887. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128888. * @param engine The engine which the post process will be applied. (default: current engine)
  128889. * @param reusable If the post process can be reused on the same frame. (default: false)
  128890. * @param textureType Type of textures used when performing the post process. (default: 0)
  128891. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  128892. */
  128893. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128894. /**
  128895. * Excludes the given skinned mesh from computing bones velocities.
  128896. * Computing bones velocities can have a cost and that cost. The cost can be saved by calling this function and by passing the skinned mesh reference to ignore.
  128897. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  128898. */
  128899. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  128900. /**
  128901. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  128902. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  128903. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  128904. */
  128905. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  128906. /**
  128907. * Disposes the post process.
  128908. * @param camera The camera to dispose the post process on.
  128909. */
  128910. dispose(camera?: Camera): void;
  128911. }
  128912. }
  128913. declare module BABYLON {
  128914. /** @hidden */
  128915. export var refractionPixelShader: {
  128916. name: string;
  128917. shader: string;
  128918. };
  128919. }
  128920. declare module BABYLON {
  128921. /**
  128922. * Post process which applies a refractin texture
  128923. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  128924. */
  128925. export class RefractionPostProcess extends PostProcess {
  128926. /** the base color of the refraction (used to taint the rendering) */
  128927. color: Color3;
  128928. /** simulated refraction depth */
  128929. depth: number;
  128930. /** the coefficient of the base color (0 to remove base color tainting) */
  128931. colorLevel: number;
  128932. private _refTexture;
  128933. private _ownRefractionTexture;
  128934. /**
  128935. * Gets or sets the refraction texture
  128936. * Please note that you are responsible for disposing the texture if you set it manually
  128937. */
  128938. refractionTexture: Texture;
  128939. /**
  128940. * Initializes the RefractionPostProcess
  128941. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  128942. * @param name The name of the effect.
  128943. * @param refractionTextureUrl Url of the refraction texture to use
  128944. * @param color the base color of the refraction (used to taint the rendering)
  128945. * @param depth simulated refraction depth
  128946. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  128947. * @param camera The camera to apply the render pass to.
  128948. * @param options The required width/height ratio to downsize to before computing the render pass.
  128949. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128950. * @param engine The engine which the post process will be applied. (default: current engine)
  128951. * @param reusable If the post process can be reused on the same frame. (default: false)
  128952. */
  128953. constructor(name: string, refractionTextureUrl: string,
  128954. /** the base color of the refraction (used to taint the rendering) */
  128955. color: Color3,
  128956. /** simulated refraction depth */
  128957. depth: number,
  128958. /** the coefficient of the base color (0 to remove base color tainting) */
  128959. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128960. /**
  128961. * Disposes of the post process
  128962. * @param camera Camera to dispose post process on
  128963. */
  128964. dispose(camera: Camera): void;
  128965. }
  128966. }
  128967. declare module BABYLON {
  128968. /** @hidden */
  128969. export var sharpenPixelShader: {
  128970. name: string;
  128971. shader: string;
  128972. };
  128973. }
  128974. declare module BABYLON {
  128975. /**
  128976. * The SharpenPostProcess applies a sharpen kernel to every pixel
  128977. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  128978. */
  128979. export class SharpenPostProcess extends PostProcess {
  128980. /**
  128981. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  128982. */
  128983. colorAmount: number;
  128984. /**
  128985. * How much sharpness should be applied (default: 0.3)
  128986. */
  128987. edgeAmount: number;
  128988. /**
  128989. * Creates a new instance ConvolutionPostProcess
  128990. * @param name The name of the effect.
  128991. * @param options The required width/height ratio to downsize to before computing the render pass.
  128992. * @param camera The camera to apply the render pass to.
  128993. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128994. * @param engine The engine which the post process will be applied. (default: current engine)
  128995. * @param reusable If the post process can be reused on the same frame. (default: false)
  128996. * @param textureType Type of textures used when performing the post process. (default: 0)
  128997. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  128998. */
  128999. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  129000. }
  129001. }
  129002. declare module BABYLON {
  129003. /**
  129004. * PostProcessRenderPipeline
  129005. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129006. */
  129007. export class PostProcessRenderPipeline {
  129008. private engine;
  129009. private _renderEffects;
  129010. private _renderEffectsForIsolatedPass;
  129011. /**
  129012. * List of inspectable custom properties (used by the Inspector)
  129013. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  129014. */
  129015. inspectableCustomProperties: IInspectable[];
  129016. /**
  129017. * @hidden
  129018. */
  129019. protected _cameras: Camera[];
  129020. /** @hidden */
  129021. _name: string;
  129022. /**
  129023. * Gets pipeline name
  129024. */
  129025. readonly name: string;
  129026. /** Gets the list of attached cameras */
  129027. readonly cameras: Camera[];
  129028. /**
  129029. * Initializes a PostProcessRenderPipeline
  129030. * @param engine engine to add the pipeline to
  129031. * @param name name of the pipeline
  129032. */
  129033. constructor(engine: Engine, name: string);
  129034. /**
  129035. * Gets the class name
  129036. * @returns "PostProcessRenderPipeline"
  129037. */
  129038. getClassName(): string;
  129039. /**
  129040. * If all the render effects in the pipeline are supported
  129041. */
  129042. readonly isSupported: boolean;
  129043. /**
  129044. * Adds an effect to the pipeline
  129045. * @param renderEffect the effect to add
  129046. */
  129047. addEffect(renderEffect: PostProcessRenderEffect): void;
  129048. /** @hidden */
  129049. _rebuild(): void;
  129050. /** @hidden */
  129051. _enableEffect(renderEffectName: string, cameras: Camera): void;
  129052. /** @hidden */
  129053. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  129054. /** @hidden */
  129055. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  129056. /** @hidden */
  129057. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  129058. /** @hidden */
  129059. _attachCameras(cameras: Camera, unique: boolean): void;
  129060. /** @hidden */
  129061. _attachCameras(cameras: Camera[], unique: boolean): void;
  129062. /** @hidden */
  129063. _detachCameras(cameras: Camera): void;
  129064. /** @hidden */
  129065. _detachCameras(cameras: Nullable<Camera[]>): void;
  129066. /** @hidden */
  129067. _update(): void;
  129068. /** @hidden */
  129069. _reset(): void;
  129070. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  129071. /**
  129072. * Disposes of the pipeline
  129073. */
  129074. dispose(): void;
  129075. }
  129076. }
  129077. declare module BABYLON {
  129078. /**
  129079. * PostProcessRenderPipelineManager class
  129080. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129081. */
  129082. export class PostProcessRenderPipelineManager {
  129083. private _renderPipelines;
  129084. /**
  129085. * Initializes a PostProcessRenderPipelineManager
  129086. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129087. */
  129088. constructor();
  129089. /**
  129090. * Gets the list of supported render pipelines
  129091. */
  129092. readonly supportedPipelines: PostProcessRenderPipeline[];
  129093. /**
  129094. * Adds a pipeline to the manager
  129095. * @param renderPipeline The pipeline to add
  129096. */
  129097. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  129098. /**
  129099. * Attaches a camera to the pipeline
  129100. * @param renderPipelineName The name of the pipeline to attach to
  129101. * @param cameras the camera to attach
  129102. * @param unique if the camera can be attached multiple times to the pipeline
  129103. */
  129104. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  129105. /**
  129106. * Detaches a camera from the pipeline
  129107. * @param renderPipelineName The name of the pipeline to detach from
  129108. * @param cameras the camera to detach
  129109. */
  129110. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  129111. /**
  129112. * Enables an effect by name on a pipeline
  129113. * @param renderPipelineName the name of the pipeline to enable the effect in
  129114. * @param renderEffectName the name of the effect to enable
  129115. * @param cameras the cameras that the effect should be enabled on
  129116. */
  129117. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  129118. /**
  129119. * Disables an effect by name on a pipeline
  129120. * @param renderPipelineName the name of the pipeline to disable the effect in
  129121. * @param renderEffectName the name of the effect to disable
  129122. * @param cameras the cameras that the effect should be disabled on
  129123. */
  129124. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  129125. /**
  129126. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  129127. */
  129128. update(): void;
  129129. /** @hidden */
  129130. _rebuild(): void;
  129131. /**
  129132. * Disposes of the manager and pipelines
  129133. */
  129134. dispose(): void;
  129135. }
  129136. }
  129137. declare module BABYLON {
  129138. interface Scene {
  129139. /** @hidden (Backing field) */
  129140. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  129141. /**
  129142. * Gets the postprocess render pipeline manager
  129143. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129144. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  129145. */
  129146. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  129147. }
  129148. /**
  129149. * Defines the Render Pipeline scene component responsible to rendering pipelines
  129150. */
  129151. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  129152. /**
  129153. * The component name helpfull to identify the component in the list of scene components.
  129154. */
  129155. readonly name: string;
  129156. /**
  129157. * The scene the component belongs to.
  129158. */
  129159. scene: Scene;
  129160. /**
  129161. * Creates a new instance of the component for the given scene
  129162. * @param scene Defines the scene to register the component in
  129163. */
  129164. constructor(scene: Scene);
  129165. /**
  129166. * Registers the component in a given scene
  129167. */
  129168. register(): void;
  129169. /**
  129170. * Rebuilds the elements related to this component in case of
  129171. * context lost for instance.
  129172. */
  129173. rebuild(): void;
  129174. /**
  129175. * Disposes the component and the associated ressources
  129176. */
  129177. dispose(): void;
  129178. private _gatherRenderTargets;
  129179. }
  129180. }
  129181. declare module BABYLON {
  129182. /**
  129183. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  129184. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  129185. */
  129186. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  129187. private _scene;
  129188. private _camerasToBeAttached;
  129189. /**
  129190. * ID of the sharpen post process,
  129191. */
  129192. private readonly SharpenPostProcessId;
  129193. /**
  129194. * @ignore
  129195. * ID of the image processing post process;
  129196. */
  129197. readonly ImageProcessingPostProcessId: string;
  129198. /**
  129199. * @ignore
  129200. * ID of the Fast Approximate Anti-Aliasing post process;
  129201. */
  129202. readonly FxaaPostProcessId: string;
  129203. /**
  129204. * ID of the chromatic aberration post process,
  129205. */
  129206. private readonly ChromaticAberrationPostProcessId;
  129207. /**
  129208. * ID of the grain post process
  129209. */
  129210. private readonly GrainPostProcessId;
  129211. /**
  129212. * Sharpen post process which will apply a sharpen convolution to enhance edges
  129213. */
  129214. sharpen: SharpenPostProcess;
  129215. private _sharpenEffect;
  129216. private bloom;
  129217. /**
  129218. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  129219. */
  129220. depthOfField: DepthOfFieldEffect;
  129221. /**
  129222. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  129223. */
  129224. fxaa: FxaaPostProcess;
  129225. /**
  129226. * Image post processing pass used to perform operations such as tone mapping or color grading.
  129227. */
  129228. imageProcessing: ImageProcessingPostProcess;
  129229. /**
  129230. * Chromatic aberration post process which will shift rgb colors in the image
  129231. */
  129232. chromaticAberration: ChromaticAberrationPostProcess;
  129233. private _chromaticAberrationEffect;
  129234. /**
  129235. * Grain post process which add noise to the image
  129236. */
  129237. grain: GrainPostProcess;
  129238. private _grainEffect;
  129239. /**
  129240. * Glow post process which adds a glow to emissive areas of the image
  129241. */
  129242. private _glowLayer;
  129243. /**
  129244. * Animations which can be used to tweak settings over a period of time
  129245. */
  129246. animations: Animation[];
  129247. private _imageProcessingConfigurationObserver;
  129248. private _sharpenEnabled;
  129249. private _bloomEnabled;
  129250. private _depthOfFieldEnabled;
  129251. private _depthOfFieldBlurLevel;
  129252. private _fxaaEnabled;
  129253. private _imageProcessingEnabled;
  129254. private _defaultPipelineTextureType;
  129255. private _bloomScale;
  129256. private _chromaticAberrationEnabled;
  129257. private _grainEnabled;
  129258. private _buildAllowed;
  129259. /**
  129260. * Gets active scene
  129261. */
  129262. readonly scene: Scene;
  129263. /**
  129264. * Enable or disable the sharpen process from the pipeline
  129265. */
  129266. sharpenEnabled: boolean;
  129267. private _resizeObserver;
  129268. private _hardwareScaleLevel;
  129269. private _bloomKernel;
  129270. /**
  129271. * Specifies the size of the bloom blur kernel, relative to the final output size
  129272. */
  129273. bloomKernel: number;
  129274. /**
  129275. * Specifies the weight of the bloom in the final rendering
  129276. */
  129277. private _bloomWeight;
  129278. /**
  129279. * Specifies the luma threshold for the area that will be blurred by the bloom
  129280. */
  129281. private _bloomThreshold;
  129282. private _hdr;
  129283. /**
  129284. * The strength of the bloom.
  129285. */
  129286. bloomWeight: number;
  129287. /**
  129288. * The strength of the bloom.
  129289. */
  129290. bloomThreshold: number;
  129291. /**
  129292. * The scale of the bloom, lower value will provide better performance.
  129293. */
  129294. bloomScale: number;
  129295. /**
  129296. * Enable or disable the bloom from the pipeline
  129297. */
  129298. bloomEnabled: boolean;
  129299. private _rebuildBloom;
  129300. /**
  129301. * If the depth of field is enabled.
  129302. */
  129303. depthOfFieldEnabled: boolean;
  129304. /**
  129305. * Blur level of the depth of field effect. (Higher blur will effect performance)
  129306. */
  129307. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  129308. /**
  129309. * If the anti aliasing is enabled.
  129310. */
  129311. fxaaEnabled: boolean;
  129312. private _samples;
  129313. /**
  129314. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  129315. */
  129316. samples: number;
  129317. /**
  129318. * If image processing is enabled.
  129319. */
  129320. imageProcessingEnabled: boolean;
  129321. /**
  129322. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  129323. */
  129324. glowLayerEnabled: boolean;
  129325. /**
  129326. * Gets the glow layer (or null if not defined)
  129327. */
  129328. readonly glowLayer: Nullable<GlowLayer>;
  129329. /**
  129330. * Enable or disable the chromaticAberration process from the pipeline
  129331. */
  129332. chromaticAberrationEnabled: boolean;
  129333. /**
  129334. * Enable or disable the grain process from the pipeline
  129335. */
  129336. grainEnabled: boolean;
  129337. /**
  129338. * @constructor
  129339. * @param name - The rendering pipeline name (default: "")
  129340. * @param hdr - If high dynamic range textures should be used (default: true)
  129341. * @param scene - The scene linked to this pipeline (default: the last created scene)
  129342. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  129343. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  129344. */
  129345. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  129346. /**
  129347. * Get the class name
  129348. * @returns "DefaultRenderingPipeline"
  129349. */
  129350. getClassName(): string;
  129351. /**
  129352. * Force the compilation of the entire pipeline.
  129353. */
  129354. prepare(): void;
  129355. private _hasCleared;
  129356. private _prevPostProcess;
  129357. private _prevPrevPostProcess;
  129358. private _setAutoClearAndTextureSharing;
  129359. private _depthOfFieldSceneObserver;
  129360. private _buildPipeline;
  129361. private _disposePostProcesses;
  129362. /**
  129363. * Adds a camera to the pipeline
  129364. * @param camera the camera to be added
  129365. */
  129366. addCamera(camera: Camera): void;
  129367. /**
  129368. * Removes a camera from the pipeline
  129369. * @param camera the camera to remove
  129370. */
  129371. removeCamera(camera: Camera): void;
  129372. /**
  129373. * Dispose of the pipeline and stop all post processes
  129374. */
  129375. dispose(): void;
  129376. /**
  129377. * Serialize the rendering pipeline (Used when exporting)
  129378. * @returns the serialized object
  129379. */
  129380. serialize(): any;
  129381. /**
  129382. * Parse the serialized pipeline
  129383. * @param source Source pipeline.
  129384. * @param scene The scene to load the pipeline to.
  129385. * @param rootUrl The URL of the serialized pipeline.
  129386. * @returns An instantiated pipeline from the serialized object.
  129387. */
  129388. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  129389. }
  129390. }
  129391. declare module BABYLON {
  129392. /** @hidden */
  129393. export var lensHighlightsPixelShader: {
  129394. name: string;
  129395. shader: string;
  129396. };
  129397. }
  129398. declare module BABYLON {
  129399. /** @hidden */
  129400. export var depthOfFieldPixelShader: {
  129401. name: string;
  129402. shader: string;
  129403. };
  129404. }
  129405. declare module BABYLON {
  129406. /**
  129407. * BABYLON.JS Chromatic Aberration GLSL Shader
  129408. * Author: Olivier Guyot
  129409. * Separates very slightly R, G and B colors on the edges of the screen
  129410. * Inspired by Francois Tarlier & Martins Upitis
  129411. */
  129412. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  129413. /**
  129414. * @ignore
  129415. * The chromatic aberration PostProcess id in the pipeline
  129416. */
  129417. LensChromaticAberrationEffect: string;
  129418. /**
  129419. * @ignore
  129420. * The highlights enhancing PostProcess id in the pipeline
  129421. */
  129422. HighlightsEnhancingEffect: string;
  129423. /**
  129424. * @ignore
  129425. * The depth-of-field PostProcess id in the pipeline
  129426. */
  129427. LensDepthOfFieldEffect: string;
  129428. private _scene;
  129429. private _depthTexture;
  129430. private _grainTexture;
  129431. private _chromaticAberrationPostProcess;
  129432. private _highlightsPostProcess;
  129433. private _depthOfFieldPostProcess;
  129434. private _edgeBlur;
  129435. private _grainAmount;
  129436. private _chromaticAberration;
  129437. private _distortion;
  129438. private _highlightsGain;
  129439. private _highlightsThreshold;
  129440. private _dofDistance;
  129441. private _dofAperture;
  129442. private _dofDarken;
  129443. private _dofPentagon;
  129444. private _blurNoise;
  129445. /**
  129446. * @constructor
  129447. *
  129448. * Effect parameters are as follow:
  129449. * {
  129450. * chromatic_aberration: number; // from 0 to x (1 for realism)
  129451. * edge_blur: number; // from 0 to x (1 for realism)
  129452. * distortion: number; // from 0 to x (1 for realism)
  129453. * grain_amount: number; // from 0 to 1
  129454. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  129455. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  129456. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  129457. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  129458. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  129459. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  129460. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  129461. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  129462. * }
  129463. * Note: if an effect parameter is unset, effect is disabled
  129464. *
  129465. * @param name The rendering pipeline name
  129466. * @param parameters - An object containing all parameters (see above)
  129467. * @param scene The scene linked to this pipeline
  129468. * @param ratio The size of the postprocesses (0.5 means that your postprocess will have a width = canvas.width 0.5 and a height = canvas.height 0.5)
  129469. * @param cameras The array of cameras that the rendering pipeline will be attached to
  129470. */
  129471. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  129472. /**
  129473. * Get the class name
  129474. * @returns "LensRenderingPipeline"
  129475. */
  129476. getClassName(): string;
  129477. /**
  129478. * Gets associated scene
  129479. */
  129480. readonly scene: Scene;
  129481. /**
  129482. * Gets or sets the edge blur
  129483. */
  129484. edgeBlur: number;
  129485. /**
  129486. * Gets or sets the grain amount
  129487. */
  129488. grainAmount: number;
  129489. /**
  129490. * Gets or sets the chromatic aberration amount
  129491. */
  129492. chromaticAberration: number;
  129493. /**
  129494. * Gets or sets the depth of field aperture
  129495. */
  129496. dofAperture: number;
  129497. /**
  129498. * Gets or sets the edge distortion
  129499. */
  129500. edgeDistortion: number;
  129501. /**
  129502. * Gets or sets the depth of field distortion
  129503. */
  129504. dofDistortion: number;
  129505. /**
  129506. * Gets or sets the darken out of focus amount
  129507. */
  129508. darkenOutOfFocus: number;
  129509. /**
  129510. * Gets or sets a boolean indicating if blur noise is enabled
  129511. */
  129512. blurNoise: boolean;
  129513. /**
  129514. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  129515. */
  129516. pentagonBokeh: boolean;
  129517. /**
  129518. * Gets or sets the highlight grain amount
  129519. */
  129520. highlightsGain: number;
  129521. /**
  129522. * Gets or sets the highlight threshold
  129523. */
  129524. highlightsThreshold: number;
  129525. /**
  129526. * Sets the amount of blur at the edges
  129527. * @param amount blur amount
  129528. */
  129529. setEdgeBlur(amount: number): void;
  129530. /**
  129531. * Sets edge blur to 0
  129532. */
  129533. disableEdgeBlur(): void;
  129534. /**
  129535. * Sets the amout of grain
  129536. * @param amount Amount of grain
  129537. */
  129538. setGrainAmount(amount: number): void;
  129539. /**
  129540. * Set grain amount to 0
  129541. */
  129542. disableGrain(): void;
  129543. /**
  129544. * Sets the chromatic aberration amount
  129545. * @param amount amount of chromatic aberration
  129546. */
  129547. setChromaticAberration(amount: number): void;
  129548. /**
  129549. * Sets chromatic aberration amount to 0
  129550. */
  129551. disableChromaticAberration(): void;
  129552. /**
  129553. * Sets the EdgeDistortion amount
  129554. * @param amount amount of EdgeDistortion
  129555. */
  129556. setEdgeDistortion(amount: number): void;
  129557. /**
  129558. * Sets edge distortion to 0
  129559. */
  129560. disableEdgeDistortion(): void;
  129561. /**
  129562. * Sets the FocusDistance amount
  129563. * @param amount amount of FocusDistance
  129564. */
  129565. setFocusDistance(amount: number): void;
  129566. /**
  129567. * Disables depth of field
  129568. */
  129569. disableDepthOfField(): void;
  129570. /**
  129571. * Sets the Aperture amount
  129572. * @param amount amount of Aperture
  129573. */
  129574. setAperture(amount: number): void;
  129575. /**
  129576. * Sets the DarkenOutOfFocus amount
  129577. * @param amount amount of DarkenOutOfFocus
  129578. */
  129579. setDarkenOutOfFocus(amount: number): void;
  129580. private _pentagonBokehIsEnabled;
  129581. /**
  129582. * Creates a pentagon bokeh effect
  129583. */
  129584. enablePentagonBokeh(): void;
  129585. /**
  129586. * Disables the pentagon bokeh effect
  129587. */
  129588. disablePentagonBokeh(): void;
  129589. /**
  129590. * Enables noise blur
  129591. */
  129592. enableNoiseBlur(): void;
  129593. /**
  129594. * Disables noise blur
  129595. */
  129596. disableNoiseBlur(): void;
  129597. /**
  129598. * Sets the HighlightsGain amount
  129599. * @param amount amount of HighlightsGain
  129600. */
  129601. setHighlightsGain(amount: number): void;
  129602. /**
  129603. * Sets the HighlightsThreshold amount
  129604. * @param amount amount of HighlightsThreshold
  129605. */
  129606. setHighlightsThreshold(amount: number): void;
  129607. /**
  129608. * Disables highlights
  129609. */
  129610. disableHighlights(): void;
  129611. /**
  129612. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  129613. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  129614. */
  129615. dispose(disableDepthRender?: boolean): void;
  129616. private _createChromaticAberrationPostProcess;
  129617. private _createHighlightsPostProcess;
  129618. private _createDepthOfFieldPostProcess;
  129619. private _createGrainTexture;
  129620. }
  129621. }
  129622. declare module BABYLON {
  129623. /** @hidden */
  129624. export var ssao2PixelShader: {
  129625. name: string;
  129626. shader: string;
  129627. };
  129628. }
  129629. declare module BABYLON {
  129630. /** @hidden */
  129631. export var ssaoCombinePixelShader: {
  129632. name: string;
  129633. shader: string;
  129634. };
  129635. }
  129636. declare module BABYLON {
  129637. /**
  129638. * Render pipeline to produce ssao effect
  129639. */
  129640. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  129641. /**
  129642. * @ignore
  129643. * The PassPostProcess id in the pipeline that contains the original scene color
  129644. */
  129645. SSAOOriginalSceneColorEffect: string;
  129646. /**
  129647. * @ignore
  129648. * The SSAO PostProcess id in the pipeline
  129649. */
  129650. SSAORenderEffect: string;
  129651. /**
  129652. * @ignore
  129653. * The horizontal blur PostProcess id in the pipeline
  129654. */
  129655. SSAOBlurHRenderEffect: string;
  129656. /**
  129657. * @ignore
  129658. * The vertical blur PostProcess id in the pipeline
  129659. */
  129660. SSAOBlurVRenderEffect: string;
  129661. /**
  129662. * @ignore
  129663. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  129664. */
  129665. SSAOCombineRenderEffect: string;
  129666. /**
  129667. * The output strength of the SSAO post-process. Default value is 1.0.
  129668. */
  129669. totalStrength: number;
  129670. /**
  129671. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  129672. */
  129673. maxZ: number;
  129674. /**
  129675. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  129676. */
  129677. minZAspect: number;
  129678. private _samples;
  129679. /**
  129680. * Number of samples used for the SSAO calculations. Default value is 8
  129681. */
  129682. samples: number;
  129683. private _textureSamples;
  129684. /**
  129685. * Number of samples to use for antialiasing
  129686. */
  129687. textureSamples: number;
  129688. /**
  129689. * Ratio object used for SSAO ratio and blur ratio
  129690. */
  129691. private _ratio;
  129692. /**
  129693. * Dynamically generated sphere sampler.
  129694. */
  129695. private _sampleSphere;
  129696. /**
  129697. * Blur filter offsets
  129698. */
  129699. private _samplerOffsets;
  129700. private _expensiveBlur;
  129701. /**
  129702. * If bilateral blur should be used
  129703. */
  129704. expensiveBlur: boolean;
  129705. /**
  129706. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  129707. */
  129708. radius: number;
  129709. /**
  129710. * The base color of the SSAO post-process
  129711. * The final result is "base + ssao" between [0, 1]
  129712. */
  129713. base: number;
  129714. /**
  129715. * Support test.
  129716. */
  129717. static readonly IsSupported: boolean;
  129718. private _scene;
  129719. private _depthTexture;
  129720. private _normalTexture;
  129721. private _randomTexture;
  129722. private _originalColorPostProcess;
  129723. private _ssaoPostProcess;
  129724. private _blurHPostProcess;
  129725. private _blurVPostProcess;
  129726. private _ssaoCombinePostProcess;
  129727. private _firstUpdate;
  129728. /**
  129729. * Gets active scene
  129730. */
  129731. readonly scene: Scene;
  129732. /**
  129733. * @constructor
  129734. * @param name The rendering pipeline name
  129735. * @param scene The scene linked to this pipeline
  129736. * @param ratio The size of the postprocesses. Can be a number shared between passes or an object for more precision: { ssaoRatio: 0.5, blurRatio: 1.0 }
  129737. * @param cameras The array of cameras that the rendering pipeline will be attached to
  129738. */
  129739. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  129740. /**
  129741. * Get the class name
  129742. * @returns "SSAO2RenderingPipeline"
  129743. */
  129744. getClassName(): string;
  129745. /**
  129746. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  129747. */
  129748. dispose(disableGeometryBufferRenderer?: boolean): void;
  129749. private _createBlurPostProcess;
  129750. /** @hidden */
  129751. _rebuild(): void;
  129752. private _bits;
  129753. private _radicalInverse_VdC;
  129754. private _hammersley;
  129755. private _hemisphereSample_uniform;
  129756. private _generateHemisphere;
  129757. private _createSSAOPostProcess;
  129758. private _createSSAOCombinePostProcess;
  129759. private _createRandomTexture;
  129760. /**
  129761. * Serialize the rendering pipeline (Used when exporting)
  129762. * @returns the serialized object
  129763. */
  129764. serialize(): any;
  129765. /**
  129766. * Parse the serialized pipeline
  129767. * @param source Source pipeline.
  129768. * @param scene The scene to load the pipeline to.
  129769. * @param rootUrl The URL of the serialized pipeline.
  129770. * @returns An instantiated pipeline from the serialized object.
  129771. */
  129772. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  129773. }
  129774. }
  129775. declare module BABYLON {
  129776. /** @hidden */
  129777. export var ssaoPixelShader: {
  129778. name: string;
  129779. shader: string;
  129780. };
  129781. }
  129782. declare module BABYLON {
  129783. /**
  129784. * Render pipeline to produce ssao effect
  129785. */
  129786. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  129787. /**
  129788. * @ignore
  129789. * The PassPostProcess id in the pipeline that contains the original scene color
  129790. */
  129791. SSAOOriginalSceneColorEffect: string;
  129792. /**
  129793. * @ignore
  129794. * The SSAO PostProcess id in the pipeline
  129795. */
  129796. SSAORenderEffect: string;
  129797. /**
  129798. * @ignore
  129799. * The horizontal blur PostProcess id in the pipeline
  129800. */
  129801. SSAOBlurHRenderEffect: string;
  129802. /**
  129803. * @ignore
  129804. * The vertical blur PostProcess id in the pipeline
  129805. */
  129806. SSAOBlurVRenderEffect: string;
  129807. /**
  129808. * @ignore
  129809. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  129810. */
  129811. SSAOCombineRenderEffect: string;
  129812. /**
  129813. * The output strength of the SSAO post-process. Default value is 1.0.
  129814. */
  129815. totalStrength: number;
  129816. /**
  129817. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  129818. */
  129819. radius: number;
  129820. /**
  129821. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  129822. * Must not be equal to fallOff and superior to fallOff.
  129823. * Default value is 0.0075
  129824. */
  129825. area: number;
  129826. /**
  129827. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  129828. * Must not be equal to area and inferior to area.
  129829. * Default value is 0.000001
  129830. */
  129831. fallOff: number;
  129832. /**
  129833. * The base color of the SSAO post-process
  129834. * The final result is "base + ssao" between [0, 1]
  129835. */
  129836. base: number;
  129837. private _scene;
  129838. private _depthTexture;
  129839. private _randomTexture;
  129840. private _originalColorPostProcess;
  129841. private _ssaoPostProcess;
  129842. private _blurHPostProcess;
  129843. private _blurVPostProcess;
  129844. private _ssaoCombinePostProcess;
  129845. private _firstUpdate;
  129846. /**
  129847. * Gets active scene
  129848. */
  129849. readonly scene: Scene;
  129850. /**
  129851. * @constructor
  129852. * @param name - The rendering pipeline name
  129853. * @param scene - The scene linked to this pipeline
  129854. * @param ratio - The size of the postprocesses. Can be a number shared between passes or an object for more precision: { ssaoRatio: 0.5, combineRatio: 1.0 }
  129855. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  129856. */
  129857. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  129858. /**
  129859. * Get the class name
  129860. * @returns "SSAORenderingPipeline"
  129861. */
  129862. getClassName(): string;
  129863. /**
  129864. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  129865. */
  129866. dispose(disableDepthRender?: boolean): void;
  129867. private _createBlurPostProcess;
  129868. /** @hidden */
  129869. _rebuild(): void;
  129870. private _createSSAOPostProcess;
  129871. private _createSSAOCombinePostProcess;
  129872. private _createRandomTexture;
  129873. }
  129874. }
  129875. declare module BABYLON {
  129876. /** @hidden */
  129877. export var standardPixelShader: {
  129878. name: string;
  129879. shader: string;
  129880. };
  129881. }
  129882. declare module BABYLON {
  129883. /**
  129884. * Standard rendering pipeline
  129885. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  129886. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  129887. */
  129888. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  129889. /**
  129890. * Public members
  129891. */
  129892. /**
  129893. * Post-process which contains the original scene color before the pipeline applies all the effects
  129894. */
  129895. originalPostProcess: Nullable<PostProcess>;
  129896. /**
  129897. * Post-process used to down scale an image x4
  129898. */
  129899. downSampleX4PostProcess: Nullable<PostProcess>;
  129900. /**
  129901. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  129902. */
  129903. brightPassPostProcess: Nullable<PostProcess>;
  129904. /**
  129905. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  129906. */
  129907. blurHPostProcesses: PostProcess[];
  129908. /**
  129909. * Post-process array storing all the vertical blur post-processes used by the pipeline
  129910. */
  129911. blurVPostProcesses: PostProcess[];
  129912. /**
  129913. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  129914. */
  129915. textureAdderPostProcess: Nullable<PostProcess>;
  129916. /**
  129917. * Post-process used to create volumetric lighting effect
  129918. */
  129919. volumetricLightPostProcess: Nullable<PostProcess>;
  129920. /**
  129921. * Post-process used to smooth the previous volumetric light post-process on the X axis
  129922. */
  129923. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  129924. /**
  129925. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  129926. */
  129927. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  129928. /**
  129929. * Post-process used to merge the volumetric light effect and the real scene color
  129930. */
  129931. volumetricLightMergePostProces: Nullable<PostProcess>;
  129932. /**
  129933. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  129934. */
  129935. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  129936. /**
  129937. * Base post-process used to calculate the average luminance of the final image for HDR
  129938. */
  129939. luminancePostProcess: Nullable<PostProcess>;
  129940. /**
  129941. * Post-processes used to create down sample post-processes in order to get
  129942. * the average luminance of the final image for HDR
  129943. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  129944. */
  129945. luminanceDownSamplePostProcesses: PostProcess[];
  129946. /**
  129947. * Post-process used to create a HDR effect (light adaptation)
  129948. */
  129949. hdrPostProcess: Nullable<PostProcess>;
  129950. /**
  129951. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  129952. */
  129953. textureAdderFinalPostProcess: Nullable<PostProcess>;
  129954. /**
  129955. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  129956. */
  129957. lensFlareFinalPostProcess: Nullable<PostProcess>;
  129958. /**
  129959. * Post-process used to merge the final HDR post-process and the real scene color
  129960. */
  129961. hdrFinalPostProcess: Nullable<PostProcess>;
  129962. /**
  129963. * Post-process used to create a lens flare effect
  129964. */
  129965. lensFlarePostProcess: Nullable<PostProcess>;
  129966. /**
  129967. * Post-process that merges the result of the lens flare post-process and the real scene color
  129968. */
  129969. lensFlareComposePostProcess: Nullable<PostProcess>;
  129970. /**
  129971. * Post-process used to create a motion blur effect
  129972. */
  129973. motionBlurPostProcess: Nullable<PostProcess>;
  129974. /**
  129975. * Post-process used to create a depth of field effect
  129976. */
  129977. depthOfFieldPostProcess: Nullable<PostProcess>;
  129978. /**
  129979. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  129980. */
  129981. fxaaPostProcess: Nullable<FxaaPostProcess>;
  129982. /**
  129983. * Represents the brightness threshold in order to configure the illuminated surfaces
  129984. */
  129985. brightThreshold: number;
  129986. /**
  129987. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  129988. */
  129989. blurWidth: number;
  129990. /**
  129991. * Sets if the blur for highlighted surfaces must be only horizontal
  129992. */
  129993. horizontalBlur: boolean;
  129994. /**
  129995. * Gets the overall exposure used by the pipeline
  129996. */
  129997. /**
  129998. * Sets the overall exposure used by the pipeline
  129999. */
  130000. exposure: number;
  130001. /**
  130002. * Texture used typically to simulate "dirty" on camera lens
  130003. */
  130004. lensTexture: Nullable<Texture>;
  130005. /**
  130006. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  130007. */
  130008. volumetricLightCoefficient: number;
  130009. /**
  130010. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  130011. */
  130012. volumetricLightPower: number;
  130013. /**
  130014. * Used the set the blur intensity to smooth the volumetric lights
  130015. */
  130016. volumetricLightBlurScale: number;
  130017. /**
  130018. * Light (spot or directional) used to generate the volumetric lights rays
  130019. * The source light must have a shadow generate so the pipeline can get its
  130020. * depth map
  130021. */
  130022. sourceLight: Nullable<SpotLight | DirectionalLight>;
  130023. /**
  130024. * For eye adaptation, represents the minimum luminance the eye can see
  130025. */
  130026. hdrMinimumLuminance: number;
  130027. /**
  130028. * For eye adaptation, represents the decrease luminance speed
  130029. */
  130030. hdrDecreaseRate: number;
  130031. /**
  130032. * For eye adaptation, represents the increase luminance speed
  130033. */
  130034. hdrIncreaseRate: number;
  130035. /**
  130036. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  130037. */
  130038. /**
  130039. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  130040. */
  130041. hdrAutoExposure: boolean;
  130042. /**
  130043. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  130044. */
  130045. lensColorTexture: Nullable<Texture>;
  130046. /**
  130047. * The overall strengh for the lens flare effect
  130048. */
  130049. lensFlareStrength: number;
  130050. /**
  130051. * Dispersion coefficient for lens flare ghosts
  130052. */
  130053. lensFlareGhostDispersal: number;
  130054. /**
  130055. * Main lens flare halo width
  130056. */
  130057. lensFlareHaloWidth: number;
  130058. /**
  130059. * Based on the lens distortion effect, defines how much the lens flare result
  130060. * is distorted
  130061. */
  130062. lensFlareDistortionStrength: number;
  130063. /**
  130064. * Configures the blur intensity used for for lens flare (halo)
  130065. */
  130066. lensFlareBlurWidth: number;
  130067. /**
  130068. * Lens star texture must be used to simulate rays on the flares and is available
  130069. * in the documentation
  130070. */
  130071. lensStarTexture: Nullable<Texture>;
  130072. /**
  130073. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  130074. * flare effect by taking account of the dirt texture
  130075. */
  130076. lensFlareDirtTexture: Nullable<Texture>;
  130077. /**
  130078. * Represents the focal length for the depth of field effect
  130079. */
  130080. depthOfFieldDistance: number;
  130081. /**
  130082. * Represents the blur intensity for the blurred part of the depth of field effect
  130083. */
  130084. depthOfFieldBlurWidth: number;
  130085. /**
  130086. * Gets how much the image is blurred by the movement while using the motion blur post-process
  130087. */
  130088. /**
  130089. * Sets how much the image is blurred by the movement while using the motion blur post-process
  130090. */
  130091. motionStrength: number;
  130092. /**
  130093. * Gets wether or not the motion blur post-process is object based or screen based.
  130094. */
  130095. /**
  130096. * Sets wether or not the motion blur post-process should be object based or screen based
  130097. */
  130098. objectBasedMotionBlur: boolean;
  130099. /**
  130100. * List of animations for the pipeline (IAnimatable implementation)
  130101. */
  130102. animations: Animation[];
  130103. /**
  130104. * Private members
  130105. */
  130106. private _scene;
  130107. private _currentDepthOfFieldSource;
  130108. private _basePostProcess;
  130109. private _fixedExposure;
  130110. private _currentExposure;
  130111. private _hdrAutoExposure;
  130112. private _hdrCurrentLuminance;
  130113. private _motionStrength;
  130114. private _isObjectBasedMotionBlur;
  130115. private _floatTextureType;
  130116. private _camerasToBeAttached;
  130117. private _ratio;
  130118. private _bloomEnabled;
  130119. private _depthOfFieldEnabled;
  130120. private _vlsEnabled;
  130121. private _lensFlareEnabled;
  130122. private _hdrEnabled;
  130123. private _motionBlurEnabled;
  130124. private _fxaaEnabled;
  130125. private _motionBlurSamples;
  130126. private _volumetricLightStepsCount;
  130127. private _samples;
  130128. /**
  130129. * @ignore
  130130. * Specifies if the bloom pipeline is enabled
  130131. */
  130132. BloomEnabled: boolean;
  130133. /**
  130134. * @ignore
  130135. * Specifies if the depth of field pipeline is enabed
  130136. */
  130137. DepthOfFieldEnabled: boolean;
  130138. /**
  130139. * @ignore
  130140. * Specifies if the lens flare pipeline is enabed
  130141. */
  130142. LensFlareEnabled: boolean;
  130143. /**
  130144. * @ignore
  130145. * Specifies if the HDR pipeline is enabled
  130146. */
  130147. HDREnabled: boolean;
  130148. /**
  130149. * @ignore
  130150. * Specifies if the volumetric lights scattering effect is enabled
  130151. */
  130152. VLSEnabled: boolean;
  130153. /**
  130154. * @ignore
  130155. * Specifies if the motion blur effect is enabled
  130156. */
  130157. MotionBlurEnabled: boolean;
  130158. /**
  130159. * Specifies if anti-aliasing is enabled
  130160. */
  130161. fxaaEnabled: boolean;
  130162. /**
  130163. * Specifies the number of steps used to calculate the volumetric lights
  130164. * Typically in interval [50, 200]
  130165. */
  130166. volumetricLightStepsCount: number;
  130167. /**
  130168. * Specifies the number of samples used for the motion blur effect
  130169. * Typically in interval [16, 64]
  130170. */
  130171. motionBlurSamples: number;
  130172. /**
  130173. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  130174. */
  130175. samples: number;
  130176. /**
  130177. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  130178. * @constructor
  130179. * @param name The rendering pipeline name
  130180. * @param scene The scene linked to this pipeline
  130181. * @param ratio The size of the postprocesses (0.5 means that your postprocess will have a width = canvas.width 0.5 and a height = canvas.height 0.5)
  130182. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  130183. * @param cameras The array of cameras that the rendering pipeline will be attached to
  130184. */
  130185. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  130186. private _buildPipeline;
  130187. private _createDownSampleX4PostProcess;
  130188. private _createBrightPassPostProcess;
  130189. private _createBlurPostProcesses;
  130190. private _createTextureAdderPostProcess;
  130191. private _createVolumetricLightPostProcess;
  130192. private _createLuminancePostProcesses;
  130193. private _createHdrPostProcess;
  130194. private _createLensFlarePostProcess;
  130195. private _createDepthOfFieldPostProcess;
  130196. private _createMotionBlurPostProcess;
  130197. private _getDepthTexture;
  130198. private _disposePostProcesses;
  130199. /**
  130200. * Dispose of the pipeline and stop all post processes
  130201. */
  130202. dispose(): void;
  130203. /**
  130204. * Serialize the rendering pipeline (Used when exporting)
  130205. * @returns the serialized object
  130206. */
  130207. serialize(): any;
  130208. /**
  130209. * Parse the serialized pipeline
  130210. * @param source Source pipeline.
  130211. * @param scene The scene to load the pipeline to.
  130212. * @param rootUrl The URL of the serialized pipeline.
  130213. * @returns An instantiated pipeline from the serialized object.
  130214. */
  130215. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  130216. /**
  130217. * Luminance steps
  130218. */
  130219. static LuminanceSteps: number;
  130220. }
  130221. }
  130222. declare module BABYLON {
  130223. /** @hidden */
  130224. export var tonemapPixelShader: {
  130225. name: string;
  130226. shader: string;
  130227. };
  130228. }
  130229. declare module BABYLON {
  130230. /** Defines operator used for tonemapping */
  130231. export enum TonemappingOperator {
  130232. /** Hable */
  130233. Hable = 0,
  130234. /** Reinhard */
  130235. Reinhard = 1,
  130236. /** HejiDawson */
  130237. HejiDawson = 2,
  130238. /** Photographic */
  130239. Photographic = 3
  130240. }
  130241. /**
  130242. * Defines a post process to apply tone mapping
  130243. */
  130244. export class TonemapPostProcess extends PostProcess {
  130245. private _operator;
  130246. /** Defines the required exposure adjustement */
  130247. exposureAdjustment: number;
  130248. /**
  130249. * Creates a new TonemapPostProcess
  130250. * @param name defines the name of the postprocess
  130251. * @param _operator defines the operator to use
  130252. * @param exposureAdjustment defines the required exposure adjustement
  130253. * @param camera defines the camera to use (can be null)
  130254. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  130255. * @param engine defines the hosting engine (can be ignore if camera is set)
  130256. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  130257. */
  130258. constructor(name: string, _operator: TonemappingOperator,
  130259. /** Defines the required exposure adjustement */
  130260. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  130261. }
  130262. }
  130263. declare module BABYLON {
  130264. /** @hidden */
  130265. export var depthVertexShader: {
  130266. name: string;
  130267. shader: string;
  130268. };
  130269. }
  130270. declare module BABYLON {
  130271. /** @hidden */
  130272. export var volumetricLightScatteringPixelShader: {
  130273. name: string;
  130274. shader: string;
  130275. };
  130276. }
  130277. declare module BABYLON {
  130278. /** @hidden */
  130279. export var volumetricLightScatteringPassVertexShader: {
  130280. name: string;
  130281. shader: string;
  130282. };
  130283. }
  130284. declare module BABYLON {
  130285. /** @hidden */
  130286. export var volumetricLightScatteringPassPixelShader: {
  130287. name: string;
  130288. shader: string;
  130289. };
  130290. }
  130291. declare module BABYLON {
  130292. /**
  130293. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  130294. */
  130295. export class VolumetricLightScatteringPostProcess extends PostProcess {
  130296. private _volumetricLightScatteringPass;
  130297. private _volumetricLightScatteringRTT;
  130298. private _viewPort;
  130299. private _screenCoordinates;
  130300. private _cachedDefines;
  130301. /**
  130302. * If not undefined, the mesh position is computed from the attached node position
  130303. */
  130304. attachedNode: {
  130305. position: Vector3;
  130306. };
  130307. /**
  130308. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  130309. */
  130310. customMeshPosition: Vector3;
  130311. /**
  130312. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  130313. */
  130314. useCustomMeshPosition: boolean;
  130315. /**
  130316. * If the post-process should inverse the light scattering direction
  130317. */
  130318. invert: boolean;
  130319. /**
  130320. * The internal mesh used by the post-process
  130321. */
  130322. mesh: Mesh;
  130323. /**
  130324. * @hidden
  130325. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  130326. */
  130327. useDiffuseColor: boolean;
  130328. /**
  130329. * Array containing the excluded meshes not rendered in the internal pass
  130330. */
  130331. excludedMeshes: AbstractMesh[];
  130332. /**
  130333. * Controls the overall intensity of the post-process
  130334. */
  130335. exposure: number;
  130336. /**
  130337. * Dissipates each sample's contribution in range [0, 1]
  130338. */
  130339. decay: number;
  130340. /**
  130341. * Controls the overall intensity of each sample
  130342. */
  130343. weight: number;
  130344. /**
  130345. * Controls the density of each sample
  130346. */
  130347. density: number;
  130348. /**
  130349. * @constructor
  130350. * @param name The post-process name
  130351. * @param ratio The size of the post-process and/or internal pass (0.5 means that your postprocess will have a width = canvas.width 0.5 and a height = canvas.height 0.5)
  130352. * @param camera The camera that the post-process will be attached to
  130353. * @param mesh The mesh used to create the light scattering
  130354. * @param samples The post-process quality, default 100
  130355. * @param samplingModeThe post-process filtering mode
  130356. * @param engine The babylon engine
  130357. * @param reusable If the post-process is reusable
  130358. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  130359. */
  130360. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  130361. /**
  130362. * Returns the string "VolumetricLightScatteringPostProcess"
  130363. * @returns "VolumetricLightScatteringPostProcess"
  130364. */
  130365. getClassName(): string;
  130366. private _isReady;
  130367. /**
  130368. * Sets the new light position for light scattering effect
  130369. * @param position The new custom light position
  130370. */
  130371. setCustomMeshPosition(position: Vector3): void;
  130372. /**
  130373. * Returns the light position for light scattering effect
  130374. * @return Vector3 The custom light position
  130375. */
  130376. getCustomMeshPosition(): Vector3;
  130377. /**
  130378. * Disposes the internal assets and detaches the post-process from the camera
  130379. */
  130380. dispose(camera: Camera): void;
  130381. /**
  130382. * Returns the render target texture used by the post-process
  130383. * @return the render target texture used by the post-process
  130384. */
  130385. getPass(): RenderTargetTexture;
  130386. private _meshExcluded;
  130387. private _createPass;
  130388. private _updateMeshScreenCoordinates;
  130389. /**
  130390. * Creates a default mesh for the Volumeric Light Scattering post-process
  130391. * @param name The mesh name
  130392. * @param scene The scene where to create the mesh
  130393. * @return the default mesh
  130394. */
  130395. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  130396. }
  130397. }
  130398. declare module BABYLON {
  130399. interface Scene {
  130400. /** @hidden (Backing field) */
  130401. _boundingBoxRenderer: BoundingBoxRenderer;
  130402. /** @hidden (Backing field) */
  130403. _forceShowBoundingBoxes: boolean;
  130404. /**
  130405. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  130406. */
  130407. forceShowBoundingBoxes: boolean;
  130408. /**
  130409. * Gets the bounding box renderer associated with the scene
  130410. * @returns a BoundingBoxRenderer
  130411. */
  130412. getBoundingBoxRenderer(): BoundingBoxRenderer;
  130413. }
  130414. interface AbstractMesh {
  130415. /** @hidden (Backing field) */
  130416. _showBoundingBox: boolean;
  130417. /**
  130418. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  130419. */
  130420. showBoundingBox: boolean;
  130421. }
  130422. /**
  130423. * Component responsible of rendering the bounding box of the meshes in a scene.
  130424. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  130425. */
  130426. export class BoundingBoxRenderer implements ISceneComponent {
  130427. /**
  130428. * The component name helpfull to identify the component in the list of scene components.
  130429. */
  130430. readonly name: string;
  130431. /**
  130432. * The scene the component belongs to.
  130433. */
  130434. scene: Scene;
  130435. /**
  130436. * Color of the bounding box lines placed in front of an object
  130437. */
  130438. frontColor: Color3;
  130439. /**
  130440. * Color of the bounding box lines placed behind an object
  130441. */
  130442. backColor: Color3;
  130443. /**
  130444. * Defines if the renderer should show the back lines or not
  130445. */
  130446. showBackLines: boolean;
  130447. /**
  130448. * @hidden
  130449. */
  130450. renderList: SmartArray<BoundingBox>;
  130451. private _colorShader;
  130452. private _vertexBuffers;
  130453. private _indexBuffer;
  130454. private _fillIndexBuffer;
  130455. private _fillIndexData;
  130456. /**
  130457. * Instantiates a new bounding box renderer in a scene.
  130458. * @param scene the scene the renderer renders in
  130459. */
  130460. constructor(scene: Scene);
  130461. /**
  130462. * Registers the component in a given scene
  130463. */
  130464. register(): void;
  130465. private _evaluateSubMesh;
  130466. private _activeMesh;
  130467. private _prepareRessources;
  130468. private _createIndexBuffer;
  130469. /**
  130470. * Rebuilds the elements related to this component in case of
  130471. * context lost for instance.
  130472. */
  130473. rebuild(): void;
  130474. /**
  130475. * @hidden
  130476. */
  130477. reset(): void;
  130478. /**
  130479. * Render the bounding boxes of a specific rendering group
  130480. * @param renderingGroupId defines the rendering group to render
  130481. */
  130482. render(renderingGroupId: number): void;
  130483. /**
  130484. * In case of occlusion queries, we can render the occlusion bounding box through this method
  130485. * @param mesh Define the mesh to render the occlusion bounding box for
  130486. */
  130487. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  130488. /**
  130489. * Dispose and release the resources attached to this renderer.
  130490. */
  130491. dispose(): void;
  130492. }
  130493. }
  130494. declare module BABYLON {
  130495. /** @hidden */
  130496. export var depthPixelShader: {
  130497. name: string;
  130498. shader: string;
  130499. };
  130500. }
  130501. declare module BABYLON {
  130502. /**
  130503. * This represents a depth renderer in Babylon.
  130504. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  130505. */
  130506. export class DepthRenderer {
  130507. private _scene;
  130508. private _depthMap;
  130509. private _effect;
  130510. private readonly _storeNonLinearDepth;
  130511. private readonly _clearColor;
  130512. /** Get if the depth renderer is using packed depth or not */
  130513. readonly isPacked: boolean;
  130514. private _cachedDefines;
  130515. private _camera;
  130516. /**
  130517. * Specifiess that the depth renderer will only be used within
  130518. * the camera it is created for.
  130519. * This can help forcing its rendering during the camera processing.
  130520. */
  130521. useOnlyInActiveCamera: boolean;
  130522. /** @hidden */
  130523. static _SceneComponentInitialization: (scene: Scene) => void;
  130524. /**
  130525. * Instantiates a depth renderer
  130526. * @param scene The scene the renderer belongs to
  130527. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  130528. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  130529. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  130530. */
  130531. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  130532. /**
  130533. * Creates the depth rendering effect and checks if the effect is ready.
  130534. * @param subMesh The submesh to be used to render the depth map of
  130535. * @param useInstances If multiple world instances should be used
  130536. * @returns if the depth renderer is ready to render the depth map
  130537. */
  130538. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  130539. /**
  130540. * Gets the texture which the depth map will be written to.
  130541. * @returns The depth map texture
  130542. */
  130543. getDepthMap(): RenderTargetTexture;
  130544. /**
  130545. * Disposes of the depth renderer.
  130546. */
  130547. dispose(): void;
  130548. }
  130549. }
  130550. declare module BABYLON {
  130551. interface Scene {
  130552. /** @hidden (Backing field) */
  130553. _depthRenderer: {
  130554. [id: string]: DepthRenderer;
  130555. };
  130556. /**
  130557. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  130558. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  130559. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  130560. * @returns the created depth renderer
  130561. */
  130562. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  130563. /**
  130564. * Disables a depth renderer for a given camera
  130565. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  130566. */
  130567. disableDepthRenderer(camera?: Nullable<Camera>): void;
  130568. }
  130569. /**
  130570. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  130571. * in several rendering techniques.
  130572. */
  130573. export class DepthRendererSceneComponent implements ISceneComponent {
  130574. /**
  130575. * The component name helpfull to identify the component in the list of scene components.
  130576. */
  130577. readonly name: string;
  130578. /**
  130579. * The scene the component belongs to.
  130580. */
  130581. scene: Scene;
  130582. /**
  130583. * Creates a new instance of the component for the given scene
  130584. * @param scene Defines the scene to register the component in
  130585. */
  130586. constructor(scene: Scene);
  130587. /**
  130588. * Registers the component in a given scene
  130589. */
  130590. register(): void;
  130591. /**
  130592. * Rebuilds the elements related to this component in case of
  130593. * context lost for instance.
  130594. */
  130595. rebuild(): void;
  130596. /**
  130597. * Disposes the component and the associated ressources
  130598. */
  130599. dispose(): void;
  130600. private _gatherRenderTargets;
  130601. private _gatherActiveCameraRenderTargets;
  130602. }
  130603. }
  130604. declare module BABYLON {
  130605. /** @hidden */
  130606. export var outlinePixelShader: {
  130607. name: string;
  130608. shader: string;
  130609. };
  130610. }
  130611. declare module BABYLON {
  130612. /** @hidden */
  130613. export var outlineVertexShader: {
  130614. name: string;
  130615. shader: string;
  130616. };
  130617. }
  130618. declare module BABYLON {
  130619. interface Scene {
  130620. /** @hidden */
  130621. _outlineRenderer: OutlineRenderer;
  130622. /**
  130623. * Gets the outline renderer associated with the scene
  130624. * @returns a OutlineRenderer
  130625. */
  130626. getOutlineRenderer(): OutlineRenderer;
  130627. }
  130628. interface AbstractMesh {
  130629. /** @hidden (Backing field) */
  130630. _renderOutline: boolean;
  130631. /**
  130632. * Gets or sets a boolean indicating if the outline must be rendered as well
  130633. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  130634. */
  130635. renderOutline: boolean;
  130636. /** @hidden (Backing field) */
  130637. _renderOverlay: boolean;
  130638. /**
  130639. * Gets or sets a boolean indicating if the overlay must be rendered as well
  130640. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  130641. */
  130642. renderOverlay: boolean;
  130643. }
  130644. /**
  130645. * This class is responsible to draw bothe outline/overlay of meshes.
  130646. * It should not be used directly but through the available method on mesh.
  130647. */
  130648. export class OutlineRenderer implements ISceneComponent {
  130649. /**
  130650. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  130651. */
  130652. private static _StencilReference;
  130653. /**
  130654. * The name of the component. Each component must have a unique name.
  130655. */
  130656. name: string;
  130657. /**
  130658. * The scene the component belongs to.
  130659. */
  130660. scene: Scene;
  130661. /**
  130662. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  130663. */
  130664. zOffset: number;
  130665. private _engine;
  130666. private _effect;
  130667. private _cachedDefines;
  130668. private _savedDepthWrite;
  130669. /**
  130670. * Instantiates a new outline renderer. (There could be only one per scene).
  130671. * @param scene Defines the scene it belongs to
  130672. */
  130673. constructor(scene: Scene);
  130674. /**
  130675. * Register the component to one instance of a scene.
  130676. */
  130677. register(): void;
  130678. /**
  130679. * Rebuilds the elements related to this component in case of
  130680. * context lost for instance.
  130681. */
  130682. rebuild(): void;
  130683. /**
  130684. * Disposes the component and the associated ressources.
  130685. */
  130686. dispose(): void;
  130687. /**
  130688. * Renders the outline in the canvas.
  130689. * @param subMesh Defines the sumesh to render
  130690. * @param batch Defines the batch of meshes in case of instances
  130691. * @param useOverlay Defines if the rendering is for the overlay or the outline
  130692. */
  130693. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  130694. /**
  130695. * Returns whether or not the outline renderer is ready for a given submesh.
  130696. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  130697. * @param subMesh Defines the submesh to check readyness for
  130698. * @param useInstances Defines wheter wee are trying to render instances or not
  130699. * @returns true if ready otherwise false
  130700. */
  130701. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  130702. private _beforeRenderingMesh;
  130703. private _afterRenderingMesh;
  130704. }
  130705. }
  130706. declare module BABYLON {
  130707. /**
  130708. * Class used to manage multiple sprites of different sizes on the same spritesheet
  130709. * @see http://doc.babylonjs.com/babylon101/sprites
  130710. */
  130711. export class SpritePackedManager extends SpriteManager {
  130712. /** defines the packed manager's name */
  130713. name: string;
  130714. /**
  130715. * Creates a new sprite manager from a packed sprite sheet
  130716. * @param name defines the manager's name
  130717. * @param imgUrl defines the sprite sheet url
  130718. * @param capacity defines the maximum allowed number of sprites
  130719. * @param scene defines the hosting scene
  130720. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  130721. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  130722. * @param samplingMode defines the smapling mode to use with spritesheet
  130723. * @param fromPacked set to true; do not alter
  130724. */
  130725. constructor(
  130726. /** defines the packed manager's name */
  130727. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  130728. }
  130729. }
  130730. declare module BABYLON {
  130731. /**
  130732. * Defines the list of states available for a task inside a AssetsManager
  130733. */
  130734. export enum AssetTaskState {
  130735. /**
  130736. * Initialization
  130737. */
  130738. INIT = 0,
  130739. /**
  130740. * Running
  130741. */
  130742. RUNNING = 1,
  130743. /**
  130744. * Done
  130745. */
  130746. DONE = 2,
  130747. /**
  130748. * Error
  130749. */
  130750. ERROR = 3
  130751. }
  130752. /**
  130753. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  130754. */
  130755. export abstract class AbstractAssetTask {
  130756. /**
  130757. * Task name
  130758. */ name: string;
  130759. /**
  130760. * Callback called when the task is successful
  130761. */
  130762. onSuccess: (task: any) => void;
  130763. /**
  130764. * Callback called when the task is not successful
  130765. */
  130766. onError: (task: any, message?: string, exception?: any) => void;
  130767. /**
  130768. * Creates a new AssetsManager
  130769. * @param name defines the name of the task
  130770. */
  130771. constructor(
  130772. /**
  130773. * Task name
  130774. */ name: string);
  130775. private _isCompleted;
  130776. private _taskState;
  130777. private _errorObject;
  130778. /**
  130779. * Get if the task is completed
  130780. */
  130781. readonly isCompleted: boolean;
  130782. /**
  130783. * Gets the current state of the task
  130784. */
  130785. readonly taskState: AssetTaskState;
  130786. /**
  130787. * Gets the current error object (if task is in error)
  130788. */
  130789. readonly errorObject: {
  130790. message?: string;
  130791. exception?: any;
  130792. };
  130793. /**
  130794. * Internal only
  130795. * @hidden
  130796. */
  130797. _setErrorObject(message?: string, exception?: any): void;
  130798. /**
  130799. * Execute the current task
  130800. * @param scene defines the scene where you want your assets to be loaded
  130801. * @param onSuccess is a callback called when the task is successfully executed
  130802. * @param onError is a callback called if an error occurs
  130803. */
  130804. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130805. /**
  130806. * Execute the current task
  130807. * @param scene defines the scene where you want your assets to be loaded
  130808. * @param onSuccess is a callback called when the task is successfully executed
  130809. * @param onError is a callback called if an error occurs
  130810. */
  130811. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130812. /**
  130813. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  130814. * This can be used with failed tasks that have the reason for failure fixed.
  130815. */
  130816. reset(): void;
  130817. private onErrorCallback;
  130818. private onDoneCallback;
  130819. }
  130820. /**
  130821. * Define the interface used by progress events raised during assets loading
  130822. */
  130823. export interface IAssetsProgressEvent {
  130824. /**
  130825. * Defines the number of remaining tasks to process
  130826. */
  130827. remainingCount: number;
  130828. /**
  130829. * Defines the total number of tasks
  130830. */
  130831. totalCount: number;
  130832. /**
  130833. * Defines the task that was just processed
  130834. */
  130835. task: AbstractAssetTask;
  130836. }
  130837. /**
  130838. * Class used to share progress information about assets loading
  130839. */
  130840. export class AssetsProgressEvent implements IAssetsProgressEvent {
  130841. /**
  130842. * Defines the number of remaining tasks to process
  130843. */
  130844. remainingCount: number;
  130845. /**
  130846. * Defines the total number of tasks
  130847. */
  130848. totalCount: number;
  130849. /**
  130850. * Defines the task that was just processed
  130851. */
  130852. task: AbstractAssetTask;
  130853. /**
  130854. * Creates a AssetsProgressEvent
  130855. * @param remainingCount defines the number of remaining tasks to process
  130856. * @param totalCount defines the total number of tasks
  130857. * @param task defines the task that was just processed
  130858. */
  130859. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  130860. }
  130861. /**
  130862. * Define a task used by AssetsManager to load meshes
  130863. */
  130864. export class MeshAssetTask extends AbstractAssetTask {
  130865. /**
  130866. * Defines the name of the task
  130867. */
  130868. name: string;
  130869. /**
  130870. * Defines the list of mesh's names you want to load
  130871. */
  130872. meshesNames: any;
  130873. /**
  130874. * Defines the root url to use as a base to load your meshes and associated resources
  130875. */
  130876. rootUrl: string;
  130877. /**
  130878. * Defines the filename of the scene to load from
  130879. */
  130880. sceneFilename: string;
  130881. /**
  130882. * Gets the list of loaded meshes
  130883. */
  130884. loadedMeshes: Array<AbstractMesh>;
  130885. /**
  130886. * Gets the list of loaded particle systems
  130887. */
  130888. loadedParticleSystems: Array<IParticleSystem>;
  130889. /**
  130890. * Gets the list of loaded skeletons
  130891. */
  130892. loadedSkeletons: Array<Skeleton>;
  130893. /**
  130894. * Gets the list of loaded animation groups
  130895. */
  130896. loadedAnimationGroups: Array<AnimationGroup>;
  130897. /**
  130898. * Callback called when the task is successful
  130899. */
  130900. onSuccess: (task: MeshAssetTask) => void;
  130901. /**
  130902. * Callback called when the task is successful
  130903. */
  130904. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  130905. /**
  130906. * Creates a new MeshAssetTask
  130907. * @param name defines the name of the task
  130908. * @param meshesNames defines the list of mesh's names you want to load
  130909. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  130910. * @param sceneFilename defines the filename of the scene to load from
  130911. */
  130912. constructor(
  130913. /**
  130914. * Defines the name of the task
  130915. */
  130916. name: string,
  130917. /**
  130918. * Defines the list of mesh's names you want to load
  130919. */
  130920. meshesNames: any,
  130921. /**
  130922. * Defines the root url to use as a base to load your meshes and associated resources
  130923. */
  130924. rootUrl: string,
  130925. /**
  130926. * Defines the filename of the scene to load from
  130927. */
  130928. sceneFilename: string);
  130929. /**
  130930. * Execute the current task
  130931. * @param scene defines the scene where you want your assets to be loaded
  130932. * @param onSuccess is a callback called when the task is successfully executed
  130933. * @param onError is a callback called if an error occurs
  130934. */
  130935. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130936. }
  130937. /**
  130938. * Define a task used by AssetsManager to load text content
  130939. */
  130940. export class TextFileAssetTask extends AbstractAssetTask {
  130941. /**
  130942. * Defines the name of the task
  130943. */
  130944. name: string;
  130945. /**
  130946. * Defines the location of the file to load
  130947. */
  130948. url: string;
  130949. /**
  130950. * Gets the loaded text string
  130951. */
  130952. text: string;
  130953. /**
  130954. * Callback called when the task is successful
  130955. */
  130956. onSuccess: (task: TextFileAssetTask) => void;
  130957. /**
  130958. * Callback called when the task is successful
  130959. */
  130960. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  130961. /**
  130962. * Creates a new TextFileAssetTask object
  130963. * @param name defines the name of the task
  130964. * @param url defines the location of the file to load
  130965. */
  130966. constructor(
  130967. /**
  130968. * Defines the name of the task
  130969. */
  130970. name: string,
  130971. /**
  130972. * Defines the location of the file to load
  130973. */
  130974. url: string);
  130975. /**
  130976. * Execute the current task
  130977. * @param scene defines the scene where you want your assets to be loaded
  130978. * @param onSuccess is a callback called when the task is successfully executed
  130979. * @param onError is a callback called if an error occurs
  130980. */
  130981. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  130982. }
  130983. /**
  130984. * Define a task used by AssetsManager to load binary data
  130985. */
  130986. export class BinaryFileAssetTask extends AbstractAssetTask {
  130987. /**
  130988. * Defines the name of the task
  130989. */
  130990. name: string;
  130991. /**
  130992. * Defines the location of the file to load
  130993. */
  130994. url: string;
  130995. /**
  130996. * Gets the lodaded data (as an array buffer)
  130997. */
  130998. data: ArrayBuffer;
  130999. /**
  131000. * Callback called when the task is successful
  131001. */
  131002. onSuccess: (task: BinaryFileAssetTask) => void;
  131003. /**
  131004. * Callback called when the task is successful
  131005. */
  131006. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  131007. /**
  131008. * Creates a new BinaryFileAssetTask object
  131009. * @param name defines the name of the new task
  131010. * @param url defines the location of the file to load
  131011. */
  131012. constructor(
  131013. /**
  131014. * Defines the name of the task
  131015. */
  131016. name: string,
  131017. /**
  131018. * Defines the location of the file to load
  131019. */
  131020. url: string);
  131021. /**
  131022. * Execute the current task
  131023. * @param scene defines the scene where you want your assets to be loaded
  131024. * @param onSuccess is a callback called when the task is successfully executed
  131025. * @param onError is a callback called if an error occurs
  131026. */
  131027. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131028. }
  131029. /**
  131030. * Define a task used by AssetsManager to load images
  131031. */
  131032. export class ImageAssetTask extends AbstractAssetTask {
  131033. /**
  131034. * Defines the name of the task
  131035. */
  131036. name: string;
  131037. /**
  131038. * Defines the location of the image to load
  131039. */
  131040. url: string;
  131041. /**
  131042. * Gets the loaded images
  131043. */
  131044. image: HTMLImageElement;
  131045. /**
  131046. * Callback called when the task is successful
  131047. */
  131048. onSuccess: (task: ImageAssetTask) => void;
  131049. /**
  131050. * Callback called when the task is successful
  131051. */
  131052. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  131053. /**
  131054. * Creates a new ImageAssetTask
  131055. * @param name defines the name of the task
  131056. * @param url defines the location of the image to load
  131057. */
  131058. constructor(
  131059. /**
  131060. * Defines the name of the task
  131061. */
  131062. name: string,
  131063. /**
  131064. * Defines the location of the image to load
  131065. */
  131066. url: string);
  131067. /**
  131068. * Execute the current task
  131069. * @param scene defines the scene where you want your assets to be loaded
  131070. * @param onSuccess is a callback called when the task is successfully executed
  131071. * @param onError is a callback called if an error occurs
  131072. */
  131073. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131074. }
  131075. /**
  131076. * Defines the interface used by texture loading tasks
  131077. */
  131078. export interface ITextureAssetTask<TEX extends BaseTexture> {
  131079. /**
  131080. * Gets the loaded texture
  131081. */
  131082. texture: TEX;
  131083. }
  131084. /**
  131085. * Define a task used by AssetsManager to load 2D textures
  131086. */
  131087. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  131088. /**
  131089. * Defines the name of the task
  131090. */
  131091. name: string;
  131092. /**
  131093. * Defines the location of the file to load
  131094. */
  131095. url: string;
  131096. /**
  131097. * Defines if mipmap should not be generated (default is false)
  131098. */
  131099. noMipmap?: boolean | undefined;
  131100. /**
  131101. * Defines if texture must be inverted on Y axis (default is false)
  131102. */
  131103. invertY?: boolean | undefined;
  131104. /**
  131105. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  131106. */
  131107. samplingMode: number;
  131108. /**
  131109. * Gets the loaded texture
  131110. */
  131111. texture: Texture;
  131112. /**
  131113. * Callback called when the task is successful
  131114. */
  131115. onSuccess: (task: TextureAssetTask) => void;
  131116. /**
  131117. * Callback called when the task is successful
  131118. */
  131119. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  131120. /**
  131121. * Creates a new TextureAssetTask object
  131122. * @param name defines the name of the task
  131123. * @param url defines the location of the file to load
  131124. * @param noMipmap defines if mipmap should not be generated (default is false)
  131125. * @param invertY defines if texture must be inverted on Y axis (default is false)
  131126. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  131127. */
  131128. constructor(
  131129. /**
  131130. * Defines the name of the task
  131131. */
  131132. name: string,
  131133. /**
  131134. * Defines the location of the file to load
  131135. */
  131136. url: string,
  131137. /**
  131138. * Defines if mipmap should not be generated (default is false)
  131139. */
  131140. noMipmap?: boolean | undefined,
  131141. /**
  131142. * Defines if texture must be inverted on Y axis (default is false)
  131143. */
  131144. invertY?: boolean | undefined,
  131145. /**
  131146. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  131147. */
  131148. samplingMode?: number);
  131149. /**
  131150. * Execute the current task
  131151. * @param scene defines the scene where you want your assets to be loaded
  131152. * @param onSuccess is a callback called when the task is successfully executed
  131153. * @param onError is a callback called if an error occurs
  131154. */
  131155. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131156. }
  131157. /**
  131158. * Define a task used by AssetsManager to load cube textures
  131159. */
  131160. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  131161. /**
  131162. * Defines the name of the task
  131163. */
  131164. name: string;
  131165. /**
  131166. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  131167. */
  131168. url: string;
  131169. /**
  131170. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  131171. */
  131172. extensions?: string[] | undefined;
  131173. /**
  131174. * Defines if mipmaps should not be generated (default is false)
  131175. */
  131176. noMipmap?: boolean | undefined;
  131177. /**
  131178. * Defines the explicit list of files (undefined by default)
  131179. */
  131180. files?: string[] | undefined;
  131181. /**
  131182. * Gets the loaded texture
  131183. */
  131184. texture: CubeTexture;
  131185. /**
  131186. * Callback called when the task is successful
  131187. */
  131188. onSuccess: (task: CubeTextureAssetTask) => void;
  131189. /**
  131190. * Callback called when the task is successful
  131191. */
  131192. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  131193. /**
  131194. * Creates a new CubeTextureAssetTask
  131195. * @param name defines the name of the task
  131196. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  131197. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  131198. * @param noMipmap defines if mipmaps should not be generated (default is false)
  131199. * @param files defines the explicit list of files (undefined by default)
  131200. */
  131201. constructor(
  131202. /**
  131203. * Defines the name of the task
  131204. */
  131205. name: string,
  131206. /**
  131207. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  131208. */
  131209. url: string,
  131210. /**
  131211. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  131212. */
  131213. extensions?: string[] | undefined,
  131214. /**
  131215. * Defines if mipmaps should not be generated (default is false)
  131216. */
  131217. noMipmap?: boolean | undefined,
  131218. /**
  131219. * Defines the explicit list of files (undefined by default)
  131220. */
  131221. files?: string[] | undefined);
  131222. /**
  131223. * Execute the current task
  131224. * @param scene defines the scene where you want your assets to be loaded
  131225. * @param onSuccess is a callback called when the task is successfully executed
  131226. * @param onError is a callback called if an error occurs
  131227. */
  131228. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131229. }
  131230. /**
  131231. * Define a task used by AssetsManager to load HDR cube textures
  131232. */
  131233. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  131234. /**
  131235. * Defines the name of the task
  131236. */
  131237. name: string;
  131238. /**
  131239. * Defines the location of the file to load
  131240. */
  131241. url: string;
  131242. /**
  131243. * Defines the desired size (the more it increases the longer the generation will be)
  131244. */
  131245. size: number;
  131246. /**
  131247. * Defines if mipmaps should not be generated (default is false)
  131248. */
  131249. noMipmap: boolean;
  131250. /**
  131251. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  131252. */
  131253. generateHarmonics: boolean;
  131254. /**
  131255. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  131256. */
  131257. gammaSpace: boolean;
  131258. /**
  131259. * Internal Use Only
  131260. */
  131261. reserved: boolean;
  131262. /**
  131263. * Gets the loaded texture
  131264. */
  131265. texture: HDRCubeTexture;
  131266. /**
  131267. * Callback called when the task is successful
  131268. */
  131269. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  131270. /**
  131271. * Callback called when the task is successful
  131272. */
  131273. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  131274. /**
  131275. * Creates a new HDRCubeTextureAssetTask object
  131276. * @param name defines the name of the task
  131277. * @param url defines the location of the file to load
  131278. * @param size defines the desired size (the more it increases the longer the generation will be) If the size is omitted this implies you are using a preprocessed cubemap.
  131279. * @param noMipmap defines if mipmaps should not be generated (default is false)
  131280. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  131281. * @param gammaSpace specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  131282. * @param reserved Internal use only
  131283. */
  131284. constructor(
  131285. /**
  131286. * Defines the name of the task
  131287. */
  131288. name: string,
  131289. /**
  131290. * Defines the location of the file to load
  131291. */
  131292. url: string,
  131293. /**
  131294. * Defines the desired size (the more it increases the longer the generation will be)
  131295. */
  131296. size: number,
  131297. /**
  131298. * Defines if mipmaps should not be generated (default is false)
  131299. */
  131300. noMipmap?: boolean,
  131301. /**
  131302. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  131303. */
  131304. generateHarmonics?: boolean,
  131305. /**
  131306. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  131307. */
  131308. gammaSpace?: boolean,
  131309. /**
  131310. * Internal Use Only
  131311. */
  131312. reserved?: boolean);
  131313. /**
  131314. * Execute the current task
  131315. * @param scene defines the scene where you want your assets to be loaded
  131316. * @param onSuccess is a callback called when the task is successfully executed
  131317. * @param onError is a callback called if an error occurs
  131318. */
  131319. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131320. }
  131321. /**
  131322. * Define a task used by AssetsManager to load Equirectangular cube textures
  131323. */
  131324. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  131325. /**
  131326. * Defines the name of the task
  131327. */
  131328. name: string;
  131329. /**
  131330. * Defines the location of the file to load
  131331. */
  131332. url: string;
  131333. /**
  131334. * Defines the desired size (the more it increases the longer the generation will be)
  131335. */
  131336. size: number;
  131337. /**
  131338. * Defines if mipmaps should not be generated (default is false)
  131339. */
  131340. noMipmap: boolean;
  131341. /**
  131342. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  131343. * but the standard material would require them in Gamma space) (default is true)
  131344. */
  131345. gammaSpace: boolean;
  131346. /**
  131347. * Gets the loaded texture
  131348. */
  131349. texture: EquiRectangularCubeTexture;
  131350. /**
  131351. * Callback called when the task is successful
  131352. */
  131353. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  131354. /**
  131355. * Callback called when the task is successful
  131356. */
  131357. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  131358. /**
  131359. * Creates a new EquiRectangularCubeTextureAssetTask object
  131360. * @param name defines the name of the task
  131361. * @param url defines the location of the file to load
  131362. * @param size defines the desired size (the more it increases the longer the generation will be)
  131363. * If the size is omitted this implies you are using a preprocessed cubemap.
  131364. * @param noMipmap defines if mipmaps should not be generated (default is false)
  131365. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  131366. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  131367. * (default is true)
  131368. */
  131369. constructor(
  131370. /**
  131371. * Defines the name of the task
  131372. */
  131373. name: string,
  131374. /**
  131375. * Defines the location of the file to load
  131376. */
  131377. url: string,
  131378. /**
  131379. * Defines the desired size (the more it increases the longer the generation will be)
  131380. */
  131381. size: number,
  131382. /**
  131383. * Defines if mipmaps should not be generated (default is false)
  131384. */
  131385. noMipmap?: boolean,
  131386. /**
  131387. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  131388. * but the standard material would require them in Gamma space) (default is true)
  131389. */
  131390. gammaSpace?: boolean);
  131391. /**
  131392. * Execute the current task
  131393. * @param scene defines the scene where you want your assets to be loaded
  131394. * @param onSuccess is a callback called when the task is successfully executed
  131395. * @param onError is a callback called if an error occurs
  131396. */
  131397. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131398. }
  131399. /**
  131400. * This class can be used to easily import assets into a scene
  131401. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  131402. */
  131403. export class AssetsManager {
  131404. private _scene;
  131405. private _isLoading;
  131406. protected _tasks: AbstractAssetTask[];
  131407. protected _waitingTasksCount: number;
  131408. protected _totalTasksCount: number;
  131409. /**
  131410. * Callback called when all tasks are processed
  131411. */
  131412. onFinish: (tasks: AbstractAssetTask[]) => void;
  131413. /**
  131414. * Callback called when a task is successful
  131415. */
  131416. onTaskSuccess: (task: AbstractAssetTask) => void;
  131417. /**
  131418. * Callback called when a task had an error
  131419. */
  131420. onTaskError: (task: AbstractAssetTask) => void;
  131421. /**
  131422. * Callback called when a task is done (whatever the result is)
  131423. */
  131424. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  131425. /**
  131426. * Observable called when all tasks are processed
  131427. */
  131428. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  131429. /**
  131430. * Observable called when a task had an error
  131431. */
  131432. onTaskErrorObservable: Observable<AbstractAssetTask>;
  131433. /**
  131434. * Observable called when all tasks were executed
  131435. */
  131436. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  131437. /**
  131438. * Observable called when a task is done (whatever the result is)
  131439. */
  131440. onProgressObservable: Observable<IAssetsProgressEvent>;
  131441. /**
  131442. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  131443. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  131444. */
  131445. useDefaultLoadingScreen: boolean;
  131446. /**
  131447. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  131448. * when all assets have been downloaded.
  131449. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  131450. */
  131451. autoHideLoadingUI: boolean;
  131452. /**
  131453. * Creates a new AssetsManager
  131454. * @param scene defines the scene to work on
  131455. */
  131456. constructor(scene: Scene);
  131457. /**
  131458. * Add a MeshAssetTask to the list of active tasks
  131459. * @param taskName defines the name of the new task
  131460. * @param meshesNames defines the name of meshes to load
  131461. * @param rootUrl defines the root url to use to locate files
  131462. * @param sceneFilename defines the filename of the scene file
  131463. * @returns a new MeshAssetTask object
  131464. */
  131465. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  131466. /**
  131467. * Add a TextFileAssetTask to the list of active tasks
  131468. * @param taskName defines the name of the new task
  131469. * @param url defines the url of the file to load
  131470. * @returns a new TextFileAssetTask object
  131471. */
  131472. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  131473. /**
  131474. * Add a BinaryFileAssetTask to the list of active tasks
  131475. * @param taskName defines the name of the new task
  131476. * @param url defines the url of the file to load
  131477. * @returns a new BinaryFileAssetTask object
  131478. */
  131479. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  131480. /**
  131481. * Add a ImageAssetTask to the list of active tasks
  131482. * @param taskName defines the name of the new task
  131483. * @param url defines the url of the file to load
  131484. * @returns a new ImageAssetTask object
  131485. */
  131486. addImageTask(taskName: string, url: string): ImageAssetTask;
  131487. /**
  131488. * Add a TextureAssetTask to the list of active tasks
  131489. * @param taskName defines the name of the new task
  131490. * @param url defines the url of the file to load
  131491. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  131492. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  131493. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  131494. * @returns a new TextureAssetTask object
  131495. */
  131496. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  131497. /**
  131498. * Add a CubeTextureAssetTask to the list of active tasks
  131499. * @param taskName defines the name of the new task
  131500. * @param url defines the url of the file to load
  131501. * @param extensions defines the extension to use to load the cube map (can be null)
  131502. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  131503. * @param files defines the list of files to load (can be null)
  131504. * @returns a new CubeTextureAssetTask object
  131505. */
  131506. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  131507. /**
  131508. *
  131509. * Add a HDRCubeTextureAssetTask to the list of active tasks
  131510. * @param taskName defines the name of the new task
  131511. * @param url defines the url of the file to load
  131512. * @param size defines the size you want for the cubemap (can be null)
  131513. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  131514. * @param generateHarmonics defines if you want to automatically generate (true by default)
  131515. * @param gammaSpace specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space) (default is false)
  131516. * @param reserved Internal use only
  131517. * @returns a new HDRCubeTextureAssetTask object
  131518. */
  131519. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  131520. /**
  131521. *
  131522. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  131523. * @param taskName defines the name of the new task
  131524. * @param url defines the url of the file to load
  131525. * @param size defines the size you want for the cubemap (can be null)
  131526. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  131527. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  131528. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  131529. * @returns a new EquiRectangularCubeTextureAssetTask object
  131530. */
  131531. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  131532. /**
  131533. * Remove a task from the assets manager.
  131534. * @param task the task to remove
  131535. */
  131536. removeTask(task: AbstractAssetTask): void;
  131537. private _decreaseWaitingTasksCount;
  131538. private _runTask;
  131539. /**
  131540. * Reset the AssetsManager and remove all tasks
  131541. * @return the current instance of the AssetsManager
  131542. */
  131543. reset(): AssetsManager;
  131544. /**
  131545. * Start the loading process
  131546. * @return the current instance of the AssetsManager
  131547. */
  131548. load(): AssetsManager;
  131549. /**
  131550. * Start the loading process as an async operation
  131551. * @return a promise returning the list of failed tasks
  131552. */
  131553. loadAsync(): Promise<void>;
  131554. }
  131555. }
  131556. declare module BABYLON {
  131557. /**
  131558. * Wrapper class for promise with external resolve and reject.
  131559. */
  131560. export class Deferred<T> {
  131561. /**
  131562. * The promise associated with this deferred object.
  131563. */
  131564. readonly promise: Promise<T>;
  131565. private _resolve;
  131566. private _reject;
  131567. /**
  131568. * The resolve method of the promise associated with this deferred object.
  131569. */
  131570. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  131571. /**
  131572. * The reject method of the promise associated with this deferred object.
  131573. */
  131574. readonly reject: (reason?: any) => void;
  131575. /**
  131576. * Constructor for this deferred object.
  131577. */
  131578. constructor();
  131579. }
  131580. }
  131581. declare module BABYLON {
  131582. /**
  131583. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  131584. */
  131585. export class MeshExploder {
  131586. private _centerMesh;
  131587. private _meshes;
  131588. private _meshesOrigins;
  131589. private _toCenterVectors;
  131590. private _scaledDirection;
  131591. private _newPosition;
  131592. private _centerPosition;
  131593. /**
  131594. * Explodes meshes from a center mesh.
  131595. * @param meshes The meshes to explode.
  131596. * @param centerMesh The mesh to be center of explosion.
  131597. */
  131598. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  131599. private _setCenterMesh;
  131600. /**
  131601. * Get class name
  131602. * @returns "MeshExploder"
  131603. */
  131604. getClassName(): string;
  131605. /**
  131606. * "Exploded meshes"
  131607. * @returns Array of meshes with the centerMesh at index 0.
  131608. */
  131609. getMeshes(): Array<Mesh>;
  131610. /**
  131611. * Explodes meshes giving a specific direction
  131612. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  131613. */
  131614. explode(direction?: number): void;
  131615. }
  131616. }
  131617. declare module BABYLON {
  131618. /**
  131619. * Class used to help managing file picking and drag'n'drop
  131620. */
  131621. export class FilesInput {
  131622. /**
  131623. * List of files ready to be loaded
  131624. */
  131625. static readonly FilesToLoad: {
  131626. [key: string]: File;
  131627. };
  131628. /**
  131629. * Callback called when a file is processed
  131630. */
  131631. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  131632. private _engine;
  131633. private _currentScene;
  131634. private _sceneLoadedCallback;
  131635. private _progressCallback;
  131636. private _additionalRenderLoopLogicCallback;
  131637. private _textureLoadingCallback;
  131638. private _startingProcessingFilesCallback;
  131639. private _onReloadCallback;
  131640. private _errorCallback;
  131641. private _elementToMonitor;
  131642. private _sceneFileToLoad;
  131643. private _filesToLoad;
  131644. /**
  131645. * Creates a new FilesInput
  131646. * @param engine defines the rendering engine
  131647. * @param scene defines the hosting scene
  131648. * @param sceneLoadedCallback callback called when scene is loaded
  131649. * @param progressCallback callback called to track progress
  131650. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  131651. * @param textureLoadingCallback callback called when a texture is loading
  131652. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  131653. * @param onReloadCallback callback called when a reload is requested
  131654. * @param errorCallback callback call if an error occurs
  131655. */
  131656. constructor(engine: Engine, scene: Scene, sceneLoadedCallback: (sceneFile: File, scene: Scene) => void, progressCallback: (progress: SceneLoaderProgressEvent) => void, additionalRenderLoopLogicCallback: () => void, textureLoadingCallback: (remaining: number) => void, startingProcessingFilesCallback: (files?: File[]) => void, onReloadCallback: (sceneFile: File) => void, errorCallback: (sceneFile: File, scene: Scene, message: string) => void);
  131657. private _dragEnterHandler;
  131658. private _dragOverHandler;
  131659. private _dropHandler;
  131660. /**
  131661. * Calls this function to listen to drag'n'drop events on a specific DOM element
  131662. * @param elementToMonitor defines the DOM element to track
  131663. */
  131664. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  131665. /**
  131666. * Release all associated resources
  131667. */
  131668. dispose(): void;
  131669. private renderFunction;
  131670. private drag;
  131671. private drop;
  131672. private _traverseFolder;
  131673. private _processFiles;
  131674. /**
  131675. * Load files from a drop event
  131676. * @param event defines the drop event to use as source
  131677. */
  131678. loadFiles(event: any): void;
  131679. private _processReload;
  131680. /**
  131681. * Reload the current scene from the loaded files
  131682. */
  131683. reload(): void;
  131684. }
  131685. }
  131686. declare module BABYLON {
  131687. /**
  131688. * Defines the root class used to create scene optimization to use with SceneOptimizer
  131689. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131690. */
  131691. export class SceneOptimization {
  131692. /**
  131693. * Defines the priority of this optimization (0 by default which means first in the list)
  131694. */
  131695. priority: number;
  131696. /**
  131697. * Gets a string describing the action executed by the current optimization
  131698. * @returns description string
  131699. */
  131700. getDescription(): string;
  131701. /**
  131702. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131703. * @param scene defines the current scene where to apply this optimization
  131704. * @param optimizer defines the current optimizer
  131705. * @returns true if everything that can be done was applied
  131706. */
  131707. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131708. /**
  131709. * Creates the SceneOptimization object
  131710. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131711. * @param desc defines the description associated with the optimization
  131712. */
  131713. constructor(
  131714. /**
  131715. * Defines the priority of this optimization (0 by default which means first in the list)
  131716. */
  131717. priority?: number);
  131718. }
  131719. /**
  131720. * Defines an optimization used to reduce the size of render target textures
  131721. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131722. */
  131723. export class TextureOptimization extends SceneOptimization {
  131724. /**
  131725. * Defines the priority of this optimization (0 by default which means first in the list)
  131726. */
  131727. priority: number;
  131728. /**
  131729. * Defines the maximum sized allowed for textures (1024 is the default value). If a texture is bigger, it will be scaled down using a factor defined by the step parameter
  131730. */
  131731. maximumSize: number;
  131732. /**
  131733. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  131734. */
  131735. step: number;
  131736. /**
  131737. * Gets a string describing the action executed by the current optimization
  131738. * @returns description string
  131739. */
  131740. getDescription(): string;
  131741. /**
  131742. * Creates the TextureOptimization object
  131743. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131744. * @param maximumSize defines the maximum sized allowed for textures (1024 is the default value). If a texture is bigger, it will be scaled down using a factor defined by the step parameter
  131745. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  131746. */
  131747. constructor(
  131748. /**
  131749. * Defines the priority of this optimization (0 by default which means first in the list)
  131750. */
  131751. priority?: number,
  131752. /**
  131753. * Defines the maximum sized allowed for textures (1024 is the default value). If a texture is bigger, it will be scaled down using a factor defined by the step parameter
  131754. */
  131755. maximumSize?: number,
  131756. /**
  131757. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  131758. */
  131759. step?: number);
  131760. /**
  131761. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131762. * @param scene defines the current scene where to apply this optimization
  131763. * @param optimizer defines the current optimizer
  131764. * @returns true if everything that can be done was applied
  131765. */
  131766. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131767. }
  131768. /**
  131769. * Defines an optimization used to increase or decrease the rendering resolution
  131770. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131771. */
  131772. export class HardwareScalingOptimization extends SceneOptimization {
  131773. /**
  131774. * Defines the priority of this optimization (0 by default which means first in the list)
  131775. */
  131776. priority: number;
  131777. /**
  131778. * Defines the maximum scale to use (2 by default)
  131779. */
  131780. maximumScale: number;
  131781. /**
  131782. * Defines the step to use between two passes (0.5 by default)
  131783. */
  131784. step: number;
  131785. private _currentScale;
  131786. private _directionOffset;
  131787. /**
  131788. * Gets a string describing the action executed by the current optimization
  131789. * @return description string
  131790. */
  131791. getDescription(): string;
  131792. /**
  131793. * Creates the HardwareScalingOptimization object
  131794. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  131795. * @param maximumScale defines the maximum scale to use (2 by default)
  131796. * @param step defines the step to use between two passes (0.5 by default)
  131797. */
  131798. constructor(
  131799. /**
  131800. * Defines the priority of this optimization (0 by default which means first in the list)
  131801. */
  131802. priority?: number,
  131803. /**
  131804. * Defines the maximum scale to use (2 by default)
  131805. */
  131806. maximumScale?: number,
  131807. /**
  131808. * Defines the step to use between two passes (0.5 by default)
  131809. */
  131810. step?: number);
  131811. /**
  131812. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131813. * @param scene defines the current scene where to apply this optimization
  131814. * @param optimizer defines the current optimizer
  131815. * @returns true if everything that can be done was applied
  131816. */
  131817. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131818. }
  131819. /**
  131820. * Defines an optimization used to remove shadows
  131821. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131822. */
  131823. export class ShadowsOptimization extends SceneOptimization {
  131824. /**
  131825. * Gets a string describing the action executed by the current optimization
  131826. * @return description string
  131827. */
  131828. getDescription(): string;
  131829. /**
  131830. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131831. * @param scene defines the current scene where to apply this optimization
  131832. * @param optimizer defines the current optimizer
  131833. * @returns true if everything that can be done was applied
  131834. */
  131835. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131836. }
  131837. /**
  131838. * Defines an optimization used to turn post-processes off
  131839. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131840. */
  131841. export class PostProcessesOptimization extends SceneOptimization {
  131842. /**
  131843. * Gets a string describing the action executed by the current optimization
  131844. * @return description string
  131845. */
  131846. getDescription(): string;
  131847. /**
  131848. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131849. * @param scene defines the current scene where to apply this optimization
  131850. * @param optimizer defines the current optimizer
  131851. * @returns true if everything that can be done was applied
  131852. */
  131853. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131854. }
  131855. /**
  131856. * Defines an optimization used to turn lens flares off
  131857. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131858. */
  131859. export class LensFlaresOptimization extends SceneOptimization {
  131860. /**
  131861. * Gets a string describing the action executed by the current optimization
  131862. * @return description string
  131863. */
  131864. getDescription(): string;
  131865. /**
  131866. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131867. * @param scene defines the current scene where to apply this optimization
  131868. * @param optimizer defines the current optimizer
  131869. * @returns true if everything that can be done was applied
  131870. */
  131871. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131872. }
  131873. /**
  131874. * Defines an optimization based on user defined callback.
  131875. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131876. */
  131877. export class CustomOptimization extends SceneOptimization {
  131878. /**
  131879. * Callback called to apply the custom optimization.
  131880. */
  131881. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  131882. /**
  131883. * Callback called to get custom description
  131884. */
  131885. onGetDescription: () => string;
  131886. /**
  131887. * Gets a string describing the action executed by the current optimization
  131888. * @returns description string
  131889. */
  131890. getDescription(): string;
  131891. /**
  131892. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131893. * @param scene defines the current scene where to apply this optimization
  131894. * @param optimizer defines the current optimizer
  131895. * @returns true if everything that can be done was applied
  131896. */
  131897. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131898. }
  131899. /**
  131900. * Defines an optimization used to turn particles off
  131901. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131902. */
  131903. export class ParticlesOptimization extends SceneOptimization {
  131904. /**
  131905. * Gets a string describing the action executed by the current optimization
  131906. * @return description string
  131907. */
  131908. getDescription(): string;
  131909. /**
  131910. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131911. * @param scene defines the current scene where to apply this optimization
  131912. * @param optimizer defines the current optimizer
  131913. * @returns true if everything that can be done was applied
  131914. */
  131915. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131916. }
  131917. /**
  131918. * Defines an optimization used to turn render targets off
  131919. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131920. */
  131921. export class RenderTargetsOptimization extends SceneOptimization {
  131922. /**
  131923. * Gets a string describing the action executed by the current optimization
  131924. * @return description string
  131925. */
  131926. getDescription(): string;
  131927. /**
  131928. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131929. * @param scene defines the current scene where to apply this optimization
  131930. * @param optimizer defines the current optimizer
  131931. * @returns true if everything that can be done was applied
  131932. */
  131933. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  131934. }
  131935. /**
  131936. * Defines an optimization used to merge meshes with compatible materials
  131937. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131938. */
  131939. export class MergeMeshesOptimization extends SceneOptimization {
  131940. private static _UpdateSelectionTree;
  131941. /**
  131942. * Gets or sets a boolean which defines if optimization octree has to be updated
  131943. */
  131944. /**
  131945. * Gets or sets a boolean which defines if optimization octree has to be updated
  131946. */
  131947. static UpdateSelectionTree: boolean;
  131948. /**
  131949. * Gets a string describing the action executed by the current optimization
  131950. * @return description string
  131951. */
  131952. getDescription(): string;
  131953. private _canBeMerged;
  131954. /**
  131955. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  131956. * @param scene defines the current scene where to apply this optimization
  131957. * @param optimizer defines the current optimizer
  131958. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  131959. * @returns true if everything that can be done was applied
  131960. */
  131961. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  131962. }
  131963. /**
  131964. * Defines a list of options used by SceneOptimizer
  131965. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  131966. */
  131967. export class SceneOptimizerOptions {
  131968. /**
  131969. * Defines the target frame rate to reach (60 by default)
  131970. */
  131971. targetFrameRate: number;
  131972. /**
  131973. * Defines the interval between two checkes (2000ms by default)
  131974. */
  131975. trackerDuration: number;
  131976. /**
  131977. * Gets the list of optimizations to apply
  131978. */
  131979. optimizations: SceneOptimization[];
  131980. /**
  131981. * Creates a new list of options used by SceneOptimizer
  131982. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  131983. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  131984. */
  131985. constructor(
  131986. /**
  131987. * Defines the target frame rate to reach (60 by default)
  131988. */
  131989. targetFrameRate?: number,
  131990. /**
  131991. * Defines the interval between two checkes (2000ms by default)
  131992. */
  131993. trackerDuration?: number);
  131994. /**
  131995. * Add a new optimization
  131996. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  131997. * @returns the current SceneOptimizerOptions
  131998. */
  131999. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  132000. /**
  132001. * Add a new custom optimization
  132002. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  132003. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  132004. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  132005. * @returns the current SceneOptimizerOptions
  132006. */
  132007. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  132008. /**
  132009. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  132010. * @param targetFrameRate defines the target frame rate (60 by default)
  132011. * @returns a SceneOptimizerOptions object
  132012. */
  132013. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  132014. /**
  132015. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  132016. * @param targetFrameRate defines the target frame rate (60 by default)
  132017. * @returns a SceneOptimizerOptions object
  132018. */
  132019. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  132020. /**
  132021. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  132022. * @param targetFrameRate defines the target frame rate (60 by default)
  132023. * @returns a SceneOptimizerOptions object
  132024. */
  132025. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  132026. }
  132027. /**
  132028. * Class used to run optimizations in order to reach a target frame rate
  132029. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132030. */
  132031. export class SceneOptimizer implements IDisposable {
  132032. private _isRunning;
  132033. private _options;
  132034. private _scene;
  132035. private _currentPriorityLevel;
  132036. private _targetFrameRate;
  132037. private _trackerDuration;
  132038. private _currentFrameRate;
  132039. private _sceneDisposeObserver;
  132040. private _improvementMode;
  132041. /**
  132042. * Defines an observable called when the optimizer reaches the target frame rate
  132043. */
  132044. onSuccessObservable: Observable<SceneOptimizer>;
  132045. /**
  132046. * Defines an observable called when the optimizer enables an optimization
  132047. */
  132048. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  132049. /**
  132050. * Defines an observable called when the optimizer is not able to reach the target frame rate
  132051. */
  132052. onFailureObservable: Observable<SceneOptimizer>;
  132053. /**
  132054. * Gets a boolean indicating if the optimizer is in improvement mode
  132055. */
  132056. readonly isInImprovementMode: boolean;
  132057. /**
  132058. * Gets the current priority level (0 at start)
  132059. */
  132060. readonly currentPriorityLevel: number;
  132061. /**
  132062. * Gets the current frame rate checked by the SceneOptimizer
  132063. */
  132064. readonly currentFrameRate: number;
  132065. /**
  132066. * Gets or sets the current target frame rate (60 by default)
  132067. */
  132068. /**
  132069. * Gets or sets the current target frame rate (60 by default)
  132070. */
  132071. targetFrameRate: number;
  132072. /**
  132073. * Gets or sets the current interval between two checks (every 2000ms by default)
  132074. */
  132075. /**
  132076. * Gets or sets the current interval between two checks (every 2000ms by default)
  132077. */
  132078. trackerDuration: number;
  132079. /**
  132080. * Gets the list of active optimizations
  132081. */
  132082. readonly optimizations: SceneOptimization[];
  132083. /**
  132084. * Creates a new SceneOptimizer
  132085. * @param scene defines the scene to work on
  132086. * @param options defines the options to use with the SceneOptimizer
  132087. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  132088. * @param improvementMode defines if the scene optimizer must run the maximum optimization while staying over a target frame instead of trying to reach the target framerate (false by default)
  132089. */
  132090. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  132091. /**
  132092. * Stops the current optimizer
  132093. */
  132094. stop(): void;
  132095. /**
  132096. * Reset the optimizer to initial step (current priority level = 0)
  132097. */
  132098. reset(): void;
  132099. /**
  132100. * Start the optimizer. By default it will try to reach a specific framerate
  132101. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  132102. */
  132103. start(): void;
  132104. private _checkCurrentState;
  132105. /**
  132106. * Release all resources
  132107. */
  132108. dispose(): void;
  132109. /**
  132110. * Helper function to create a SceneOptimizer with one single line of code
  132111. * @param scene defines the scene to work on
  132112. * @param options defines the options to use with the SceneOptimizer
  132113. * @param onSuccess defines a callback to call on success
  132114. * @param onFailure defines a callback to call on failure
  132115. * @returns the new SceneOptimizer object
  132116. */
  132117. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  132118. }
  132119. }
  132120. declare module BABYLON {
  132121. /**
  132122. * Class used to serialize a scene into a string
  132123. */
  132124. export class SceneSerializer {
  132125. /**
  132126. * Clear cache used by a previous serialization
  132127. */
  132128. static ClearCache(): void;
  132129. /**
  132130. * Serialize a scene into a JSON compatible object
  132131. * @param scene defines the scene to serialize
  132132. * @returns a JSON compatible object
  132133. */
  132134. static Serialize(scene: Scene): any;
  132135. /**
  132136. * Serialize a mesh into a JSON compatible object
  132137. * @param toSerialize defines the mesh to serialize
  132138. * @param withParents defines if parents must be serialized as well
  132139. * @param withChildren defines if children must be serialized as well
  132140. * @returns a JSON compatible object
  132141. */
  132142. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  132143. }
  132144. }
  132145. declare module BABYLON {
  132146. /**
  132147. * Class used to host texture specific utilities
  132148. */
  132149. export class TextureTools {
  132150. /**
  132151. * Uses the GPU to create a copy texture rescaled at a given size
  132152. * @param texture Texture to copy from
  132153. * @param width defines the desired width
  132154. * @param height defines the desired height
  132155. * @param useBilinearMode defines if bilinear mode has to be used
  132156. * @return the generated texture
  132157. */
  132158. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  132159. }
  132160. }
  132161. declare module BABYLON {
  132162. /**
  132163. * This represents the different options available for the video capture.
  132164. */
  132165. export interface VideoRecorderOptions {
  132166. /** Defines the mime type of the video. */
  132167. mimeType: string;
  132168. /** Defines the FPS the video should be recorded at. */
  132169. fps: number;
  132170. /** Defines the chunk size for the recording data. */
  132171. recordChunckSize: number;
  132172. /** The audio tracks to attach to the recording. */
  132173. audioTracks?: MediaStreamTrack[];
  132174. }
  132175. /**
  132176. * This can help with recording videos from BabylonJS.
  132177. * This is based on the available WebRTC functionalities of the browser.
  132178. *
  132179. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  132180. */
  132181. export class VideoRecorder {
  132182. private static readonly _defaultOptions;
  132183. /**
  132184. * Returns whether or not the VideoRecorder is available in your browser.
  132185. * @param engine Defines the Babylon Engine.
  132186. * @returns true if supported otherwise false.
  132187. */
  132188. static IsSupported(engine: Engine): boolean;
  132189. private readonly _options;
  132190. private _canvas;
  132191. private _mediaRecorder;
  132192. private _recordedChunks;
  132193. private _fileName;
  132194. private _resolve;
  132195. private _reject;
  132196. /**
  132197. * True when a recording is already in progress.
  132198. */
  132199. readonly isRecording: boolean;
  132200. /**
  132201. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  132202. * @param engine Defines the BabylonJS Engine you wish to record.
  132203. * @param options Defines options that can be used to customize the capture.
  132204. */
  132205. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  132206. /**
  132207. * Stops the current recording before the default capture timeout passed in the startRecording function.
  132208. */
  132209. stopRecording(): void;
  132210. /**
  132211. * Starts recording the canvas for a max duration specified in parameters.
  132212. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  132213. * If null no automatic download will start and you can rely on the promise to get the data back.
  132214. * @param maxDuration Defines the maximum recording time in seconds.
  132215. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  132216. * @return A promise callback at the end of the recording with the video data in Blob.
  132217. */
  132218. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  132219. /**
  132220. * Releases internal resources used during the recording.
  132221. */
  132222. dispose(): void;
  132223. private _handleDataAvailable;
  132224. private _handleError;
  132225. private _handleStop;
  132226. }
  132227. }
  132228. declare module BABYLON {
  132229. /**
  132230. * Class containing a set of static utilities functions for screenshots
  132231. */
  132232. export class ScreenshotTools {
  132233. /**
  132234. * Captures a screenshot of the current rendering
  132235. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132236. * @param engine defines the rendering engine
  132237. * @param camera defines the source camera
  132238. * @param size This parameter can be set to a single number or to an object with the
  132239. * following (optional) properties: precision, width, height. If a single number is passed,
  132240. * it will be used for both width and height. If an object is passed, the screenshot size
  132241. * will be derived from the parameters. The precision property is a multiplier allowing
  132242. * rendering at a higher or lower resolution
  132243. * @param successCallback defines the callback receives a single parameter which contains the
  132244. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  132245. * src parameter of an <img> to display it
  132246. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  132247. * Check your browser for supported MIME types
  132248. */
  132249. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  132250. /**
  132251. * Captures a screenshot of the current rendering
  132252. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132253. * @param engine defines the rendering engine
  132254. * @param camera defines the source camera
  132255. * @param size This parameter can be set to a single number or to an object with the
  132256. * following (optional) properties: precision, width, height. If a single number is passed,
  132257. * it will be used for both width and height. If an object is passed, the screenshot size
  132258. * will be derived from the parameters. The precision property is a multiplier allowing
  132259. * rendering at a higher or lower resolution
  132260. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  132261. * Check your browser for supported MIME types
  132262. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  132263. * to the src parameter of an <img> to display it
  132264. */
  132265. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  132266. /**
  132267. * Generates an image screenshot from the specified camera.
  132268. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132269. * @param engine The engine to use for rendering
  132270. * @param camera The camera to use for rendering
  132271. * @param size This parameter can be set to a single number or to an object with the
  132272. * following (optional) properties: precision, width, height. If a single number is passed,
  132273. * it will be used for both width and height. If an object is passed, the screenshot size
  132274. * will be derived from the parameters. The precision property is a multiplier allowing
  132275. * rendering at a higher or lower resolution
  132276. * @param successCallback The callback receives a single parameter which contains the
  132277. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  132278. * src parameter of an <img> to display it
  132279. * @param mimeType The MIME type of the screenshot image (default: image/png).
  132280. * Check your browser for supported MIME types
  132281. * @param samples Texture samples (default: 1)
  132282. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  132283. * @param fileName A name for for the downloaded file.
  132284. */
  132285. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  132286. /**
  132287. * Generates an image screenshot from the specified camera.
  132288. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132289. * @param engine The engine to use for rendering
  132290. * @param camera The camera to use for rendering
  132291. * @param size This parameter can be set to a single number or to an object with the
  132292. * following (optional) properties: precision, width, height. If a single number is passed,
  132293. * it will be used for both width and height. If an object is passed, the screenshot size
  132294. * will be derived from the parameters. The precision property is a multiplier allowing
  132295. * rendering at a higher or lower resolution
  132296. * @param mimeType The MIME type of the screenshot image (default: image/png).
  132297. * Check your browser for supported MIME types
  132298. * @param samples Texture samples (default: 1)
  132299. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  132300. * @param fileName A name for for the downloaded file.
  132301. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  132302. * to the src parameter of an <img> to display it
  132303. */
  132304. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  132305. /**
  132306. * Gets height and width for screenshot size
  132307. * @private
  132308. */
  132309. private static _getScreenshotSize;
  132310. }
  132311. }
  132312. declare module BABYLON {
  132313. /**
  132314. * Interface for a data buffer
  132315. */
  132316. export interface IDataBuffer {
  132317. /**
  132318. * Reads bytes from the data buffer.
  132319. * @param byteOffset The byte offset to read
  132320. * @param byteLength The byte length to read
  132321. * @returns A promise that resolves when the bytes are read
  132322. */
  132323. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  132324. /**
  132325. * The byte length of the buffer.
  132326. */
  132327. readonly byteLength: number;
  132328. }
  132329. /**
  132330. * Utility class for reading from a data buffer
  132331. */
  132332. export class DataReader {
  132333. /**
  132334. * The data buffer associated with this data reader.
  132335. */
  132336. readonly buffer: IDataBuffer;
  132337. /**
  132338. * The current byte offset from the beginning of the data buffer.
  132339. */
  132340. byteOffset: number;
  132341. private _dataView;
  132342. private _dataByteOffset;
  132343. /**
  132344. * Constructor
  132345. * @param buffer The buffer to read
  132346. */
  132347. constructor(buffer: IDataBuffer);
  132348. /**
  132349. * Loads the given byte length.
  132350. * @param byteLength The byte length to load
  132351. * @returns A promise that resolves when the load is complete
  132352. */
  132353. loadAsync(byteLength: number): Promise<void>;
  132354. /**
  132355. * Read a unsigned 32-bit integer from the currently loaded data range.
  132356. * @returns The 32-bit integer read
  132357. */
  132358. readUint32(): number;
  132359. /**
  132360. * Read a byte array from the currently loaded data range.
  132361. * @param byteLength The byte length to read
  132362. * @returns The byte array read
  132363. */
  132364. readUint8Array(byteLength: number): Uint8Array;
  132365. /**
  132366. * Read a string from the currently loaded data range.
  132367. * @param byteLength The byte length to read
  132368. * @returns The string read
  132369. */
  132370. readString(byteLength: number): string;
  132371. /**
  132372. * Skips the given byte length the currently loaded data range.
  132373. * @param byteLength The byte length to skip
  132374. */
  132375. skipBytes(byteLength: number): void;
  132376. }
  132377. }
  132378. declare module BABYLON {
  132379. /**
  132380. * A cursor which tracks a point on a path
  132381. */
  132382. export class PathCursor {
  132383. private path;
  132384. /**
  132385. * Stores path cursor callbacks for when an onchange event is triggered
  132386. */
  132387. private _onchange;
  132388. /**
  132389. * The value of the path cursor
  132390. */
  132391. value: number;
  132392. /**
  132393. * The animation array of the path cursor
  132394. */
  132395. animations: Animation[];
  132396. /**
  132397. * Initializes the path cursor
  132398. * @param path The path to track
  132399. */
  132400. constructor(path: Path2);
  132401. /**
  132402. * Gets the cursor point on the path
  132403. * @returns A point on the path cursor at the cursor location
  132404. */
  132405. getPoint(): Vector3;
  132406. /**
  132407. * Moves the cursor ahead by the step amount
  132408. * @param step The amount to move the cursor forward
  132409. * @returns This path cursor
  132410. */
  132411. moveAhead(step?: number): PathCursor;
  132412. /**
  132413. * Moves the cursor behind by the step amount
  132414. * @param step The amount to move the cursor back
  132415. * @returns This path cursor
  132416. */
  132417. moveBack(step?: number): PathCursor;
  132418. /**
  132419. * Moves the cursor by the step amount
  132420. * If the step amount is greater than one, an exception is thrown
  132421. * @param step The amount to move the cursor
  132422. * @returns This path cursor
  132423. */
  132424. move(step: number): PathCursor;
  132425. /**
  132426. * Ensures that the value is limited between zero and one
  132427. * @returns This path cursor
  132428. */
  132429. private ensureLimits;
  132430. /**
  132431. * Runs onchange callbacks on change (used by the animation engine)
  132432. * @returns This path cursor
  132433. */
  132434. private raiseOnChange;
  132435. /**
  132436. * Executes a function on change
  132437. * @param f A path cursor onchange callback
  132438. * @returns This path cursor
  132439. */
  132440. onchange(f: (cursor: PathCursor) => void): PathCursor;
  132441. }
  132442. }
  132443. declare module BABYLON {
  132444. /** @hidden */
  132445. export var blurPixelShader: {
  132446. name: string;
  132447. shader: string;
  132448. };
  132449. }
  132450. declare module BABYLON {
  132451. /** @hidden */
  132452. export var pointCloudVertexDeclaration: {
  132453. name: string;
  132454. shader: string;
  132455. };
  132456. }
  132457. // Mixins
  132458. interface Window {
  132459. mozIndexedDB: IDBFactory;
  132460. webkitIndexedDB: IDBFactory;
  132461. msIndexedDB: IDBFactory;
  132462. webkitURL: typeof URL;
  132463. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  132464. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  132465. WebGLRenderingContext: WebGLRenderingContext;
  132466. MSGesture: MSGesture;
  132467. CANNON: any;
  132468. AudioContext: AudioContext;
  132469. webkitAudioContext: AudioContext;
  132470. PointerEvent: any;
  132471. Math: Math;
  132472. Uint8Array: Uint8ArrayConstructor;
  132473. Float32Array: Float32ArrayConstructor;
  132474. mozURL: typeof URL;
  132475. msURL: typeof URL;
  132476. VRFrameData: any; // WebVR, from specs 1.1
  132477. DracoDecoderModule: any;
  132478. setImmediate(handler: (...args: any[]) => void): number;
  132479. }
  132480. interface HTMLCanvasElement {
  132481. requestPointerLock(): void;
  132482. msRequestPointerLock?(): void;
  132483. mozRequestPointerLock?(): void;
  132484. webkitRequestPointerLock?(): void;
  132485. /** Track wether a record is in progress */
  132486. isRecording: boolean;
  132487. /** Capture Stream method defined by some browsers */
  132488. captureStream(fps?: number): MediaStream;
  132489. }
  132490. interface CanvasRenderingContext2D {
  132491. msImageSmoothingEnabled: boolean;
  132492. }
  132493. interface MouseEvent {
  132494. mozMovementX: number;
  132495. mozMovementY: number;
  132496. webkitMovementX: number;
  132497. webkitMovementY: number;
  132498. msMovementX: number;
  132499. msMovementY: number;
  132500. }
  132501. interface Navigator {
  132502. mozGetVRDevices: (any: any) => any;
  132503. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  132504. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  132505. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  132506. webkitGetGamepads(): Gamepad[];
  132507. msGetGamepads(): Gamepad[];
  132508. webkitGamepads(): Gamepad[];
  132509. }
  132510. interface HTMLVideoElement {
  132511. mozSrcObject: any;
  132512. }
  132513. interface Math {
  132514. fround(x: number): number;
  132515. imul(a: number, b: number): number;
  132516. }
  132517. interface WebGLRenderingContext {
  132518. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  132519. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  132520. vertexAttribDivisor(index: number, divisor: number): void;
  132521. createVertexArray(): any;
  132522. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  132523. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  132524. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  132525. renderbufferStorageMultisample(target: number, samples: number, internalformat: number, width: number, height: number): void;
  132526. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  132527. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  132528. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  132529. // Queries
  132530. createQuery(): WebGLQuery;
  132531. deleteQuery(query: WebGLQuery): void;
  132532. beginQuery(target: number, query: WebGLQuery): void;
  132533. endQuery(target: number): void;
  132534. getQueryParameter(query: WebGLQuery, pname: number): any;
  132535. getQuery(target: number, pname: number): any;
  132536. MAX_SAMPLES: number;
  132537. RGBA8: number;
  132538. READ_FRAMEBUFFER: number;
  132539. DRAW_FRAMEBUFFER: number;
  132540. UNIFORM_BUFFER: number;
  132541. HALF_FLOAT_OES: number;
  132542. RGBA16F: number;
  132543. RGBA32F: number;
  132544. R32F: number;
  132545. RG32F: number;
  132546. RGB32F: number;
  132547. R16F: number;
  132548. RG16F: number;
  132549. RGB16F: number;
  132550. RED: number;
  132551. RG: number;
  132552. R8: number;
  132553. RG8: number;
  132554. UNSIGNED_INT_24_8: number;
  132555. DEPTH24_STENCIL8: number;
  132556. MIN: number;
  132557. MAX: number;
  132558. /* Multiple Render Targets */
  132559. drawBuffers(buffers: number[]): void;
  132560. readBuffer(src: number): void;
  132561. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  132562. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  132563. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  132564. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  132565. // Occlusion Query
  132566. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  132567. ANY_SAMPLES_PASSED: number;
  132568. QUERY_RESULT_AVAILABLE: number;
  132569. QUERY_RESULT: number;
  132570. }
  132571. interface WebGLProgram {
  132572. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  132573. }
  132574. interface EXT_disjoint_timer_query {
  132575. QUERY_COUNTER_BITS_EXT: number;
  132576. TIME_ELAPSED_EXT: number;
  132577. TIMESTAMP_EXT: number;
  132578. GPU_DISJOINT_EXT: number;
  132579. QUERY_RESULT_EXT: number;
  132580. QUERY_RESULT_AVAILABLE_EXT: number;
  132581. queryCounterEXT(query: WebGLQuery, target: number): void;
  132582. createQueryEXT(): WebGLQuery;
  132583. beginQueryEXT(target: number, query: WebGLQuery): void;
  132584. endQueryEXT(target: number): void;
  132585. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  132586. deleteQueryEXT(query: WebGLQuery): void;
  132587. }
  132588. interface WebGLUniformLocation {
  132589. _currentState: any;
  132590. }
  132591. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  132592. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  132593. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  132594. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  132595. interface WebGLRenderingContext {
  132596. readonly RASTERIZER_DISCARD: number;
  132597. readonly DEPTH_COMPONENT24: number;
  132598. readonly TEXTURE_3D: number;
  132599. readonly TEXTURE_2D_ARRAY: number;
  132600. readonly TEXTURE_COMPARE_FUNC: number;
  132601. readonly TEXTURE_COMPARE_MODE: number;
  132602. readonly COMPARE_REF_TO_TEXTURE: number;
  132603. readonly TEXTURE_WRAP_R: number;
  132604. readonly HALF_FLOAT: number;
  132605. readonly RGB8: number;
  132606. readonly RED_INTEGER: number;
  132607. readonly RG_INTEGER: number;
  132608. readonly RGB_INTEGER: number;
  132609. readonly RGBA_INTEGER: number;
  132610. readonly R8_SNORM: number;
  132611. readonly RG8_SNORM: number;
  132612. readonly RGB8_SNORM: number;
  132613. readonly RGBA8_SNORM: number;
  132614. readonly R8I: number;
  132615. readonly RG8I: number;
  132616. readonly RGB8I: number;
  132617. readonly RGBA8I: number;
  132618. readonly R8UI: number;
  132619. readonly RG8UI: number;
  132620. readonly RGB8UI: number;
  132621. readonly RGBA8UI: number;
  132622. readonly R16I: number;
  132623. readonly RG16I: number;
  132624. readonly RGB16I: number;
  132625. readonly RGBA16I: number;
  132626. readonly R16UI: number;
  132627. readonly RG16UI: number;
  132628. readonly RGB16UI: number;
  132629. readonly RGBA16UI: number;
  132630. readonly R32I: number;
  132631. readonly RG32I: number;
  132632. readonly RGB32I: number;
  132633. readonly RGBA32I: number;
  132634. readonly R32UI: number;
  132635. readonly RG32UI: number;
  132636. readonly RGB32UI: number;
  132637. readonly RGBA32UI: number;
  132638. readonly RGB10_A2UI: number;
  132639. readonly R11F_G11F_B10F: number;
  132640. readonly RGB9_E5: number;
  132641. readonly RGB10_A2: number;
  132642. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  132643. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  132644. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  132645. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  132646. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  132647. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  132648. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ImageBitmap | ImageData | HTMLVideoElement | HTMLImageElement | HTMLCanvasElement): void;
  132649. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  132650. readonly TRANSFORM_FEEDBACK: number;
  132651. readonly INTERLEAVED_ATTRIBS: number;
  132652. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  132653. createTransformFeedback(): WebGLTransformFeedback;
  132654. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  132655. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  132656. beginTransformFeedback(primitiveMode: number): void;
  132657. endTransformFeedback(): void;
  132658. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  132659. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  132660. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  132661. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  132662. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  132663. }
  132664. interface ImageBitmap {
  132665. readonly width: number;
  132666. readonly height: number;
  132667. close(): void;
  132668. }
  132669. interface WebGLQuery extends WebGLObject {
  132670. }
  132671. declare var WebGLQuery: {
  132672. prototype: WebGLQuery;
  132673. new(): WebGLQuery;
  132674. };
  132675. interface WebGLSampler extends WebGLObject {
  132676. }
  132677. declare var WebGLSampler: {
  132678. prototype: WebGLSampler;
  132679. new(): WebGLSampler;
  132680. };
  132681. interface WebGLSync extends WebGLObject {
  132682. }
  132683. declare var WebGLSync: {
  132684. prototype: WebGLSync;
  132685. new(): WebGLSync;
  132686. };
  132687. interface WebGLTransformFeedback extends WebGLObject {
  132688. }
  132689. declare var WebGLTransformFeedback: {
  132690. prototype: WebGLTransformFeedback;
  132691. new(): WebGLTransformFeedback;
  132692. };
  132693. interface WebGLVertexArrayObject extends WebGLObject {
  132694. }
  132695. declare var WebGLVertexArrayObject: {
  132696. prototype: WebGLVertexArrayObject;
  132697. new(): WebGLVertexArrayObject;
  132698. };
  132699. // Type definitions for WebVR API
  132700. // Project: https://w3c.github.io/webvr/
  132701. // Definitions by: six a <https://github.com/lostfictions>
  132702. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  132703. interface VRDisplay extends EventTarget {
  132704. /**
  132705. * Dictionary of capabilities describing the VRDisplay.
  132706. */
  132707. readonly capabilities: VRDisplayCapabilities;
  132708. /**
  132709. * z-depth defining the far plane of the eye view frustum
  132710. * enables mapping of values in the render target depth
  132711. * attachment to scene coordinates. Initially set to 10000.0.
  132712. */
  132713. depthFar: number;
  132714. /**
  132715. * z-depth defining the near plane of the eye view frustum
  132716. * enables mapping of values in the render target depth
  132717. * attachment to scene coordinates. Initially set to 0.01.
  132718. */
  132719. depthNear: number;
  132720. /**
  132721. * An identifier for this distinct VRDisplay. Used as an
  132722. * association point in the Gamepad API.
  132723. */
  132724. readonly displayId: number;
  132725. /**
  132726. * A display name, a user-readable name identifying it.
  132727. */
  132728. readonly displayName: string;
  132729. readonly isConnected: boolean;
  132730. readonly isPresenting: boolean;
  132731. /**
  132732. * If this VRDisplay supports room-scale experiences, the optional
  132733. * stage attribute contains details on the room-scale parameters.
  132734. */
  132735. readonly stageParameters: VRStageParameters | null;
  132736. /**
  132737. * Passing the value returned by `requestAnimationFrame` to
  132738. * `cancelAnimationFrame` will unregister the callback.
  132739. * @param handle Define the hanle of the request to cancel
  132740. */
  132741. cancelAnimationFrame(handle: number): void;
  132742. /**
  132743. * Stops presenting to the VRDisplay.
  132744. * @returns a promise to know when it stopped
  132745. */
  132746. exitPresent(): Promise<void>;
  132747. /**
  132748. * Return the current VREyeParameters for the given eye.
  132749. * @param whichEye Define the eye we want the parameter for
  132750. * @returns the eye parameters
  132751. */
  132752. getEyeParameters(whichEye: string): VREyeParameters;
  132753. /**
  132754. * Populates the passed VRFrameData with the information required to render
  132755. * the current frame.
  132756. * @param frameData Define the data structure to populate
  132757. * @returns true if ok otherwise false
  132758. */
  132759. getFrameData(frameData: VRFrameData): boolean;
  132760. /**
  132761. * Get the layers currently being presented.
  132762. * @returns the list of VR layers
  132763. */
  132764. getLayers(): VRLayer[];
  132765. /**
  132766. * Return a VRPose containing the future predicted pose of the VRDisplay
  132767. * when the current frame will be presented. The value returned will not
  132768. * change until JavaScript has returned control to the browser.
  132769. *
  132770. * The VRPose will contain the position, orientation, velocity,
  132771. * and acceleration of each of these properties.
  132772. * @returns the pose object
  132773. */
  132774. getPose(): VRPose;
  132775. /**
  132776. * Return the current instantaneous pose of the VRDisplay, with no
  132777. * prediction applied.
  132778. * @returns the current instantaneous pose
  132779. */
  132780. getImmediatePose(): VRPose;
  132781. /**
  132782. * The callback passed to `requestAnimationFrame` will be called
  132783. * any time a new frame should be rendered. When the VRDisplay is
  132784. * presenting the callback will be called at the native refresh
  132785. * rate of the HMD. When not presenting this function acts
  132786. * identically to how window.requestAnimationFrame acts. Content should
  132787. * make no assumptions of frame rate or vsync behavior as the HMD runs
  132788. * asynchronously from other displays and at differing refresh rates.
  132789. * @param callback Define the eaction to run next frame
  132790. * @returns the request handle it
  132791. */
  132792. requestAnimationFrame(callback: FrameRequestCallback): number;
  132793. /**
  132794. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  132795. * Repeat calls while already presenting will update the VRLayers being displayed.
  132796. * @param layers Define the list of layer to present
  132797. * @returns a promise to know when the request has been fulfilled
  132798. */
  132799. requestPresent(layers: VRLayer[]): Promise<void>;
  132800. /**
  132801. * Reset the pose for this display, treating its current position and
  132802. * orientation as the "origin/zero" values. VRPose.position,
  132803. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  132804. * updated when calling resetPose(). This should be called in only
  132805. * sitting-space experiences.
  132806. */
  132807. resetPose(): void;
  132808. /**
  132809. * The VRLayer provided to the VRDisplay will be captured and presented
  132810. * in the HMD. Calling this function has the same effect on the source
  132811. * canvas as any other operation that uses its source image, and canvases
  132812. * created without preserveDrawingBuffer set to true will be cleared.
  132813. * @param pose Define the pose to submit
  132814. */
  132815. submitFrame(pose?: VRPose): void;
  132816. }
  132817. declare var VRDisplay: {
  132818. prototype: VRDisplay;
  132819. new(): VRDisplay;
  132820. };
  132821. interface VRLayer {
  132822. leftBounds?: number[] | Float32Array | null;
  132823. rightBounds?: number[] | Float32Array | null;
  132824. source?: HTMLCanvasElement | null;
  132825. }
  132826. interface VRDisplayCapabilities {
  132827. readonly canPresent: boolean;
  132828. readonly hasExternalDisplay: boolean;
  132829. readonly hasOrientation: boolean;
  132830. readonly hasPosition: boolean;
  132831. readonly maxLayers: number;
  132832. }
  132833. interface VREyeParameters {
  132834. /** @deprecated */
  132835. readonly fieldOfView: VRFieldOfView;
  132836. readonly offset: Float32Array;
  132837. readonly renderHeight: number;
  132838. readonly renderWidth: number;
  132839. }
  132840. interface VRFieldOfView {
  132841. readonly downDegrees: number;
  132842. readonly leftDegrees: number;
  132843. readonly rightDegrees: number;
  132844. readonly upDegrees: number;
  132845. }
  132846. interface VRFrameData {
  132847. readonly leftProjectionMatrix: Float32Array;
  132848. readonly leftViewMatrix: Float32Array;
  132849. readonly pose: VRPose;
  132850. readonly rightProjectionMatrix: Float32Array;
  132851. readonly rightViewMatrix: Float32Array;
  132852. readonly timestamp: number;
  132853. }
  132854. interface VRPose {
  132855. readonly angularAcceleration: Float32Array | null;
  132856. readonly angularVelocity: Float32Array | null;
  132857. readonly linearAcceleration: Float32Array | null;
  132858. readonly linearVelocity: Float32Array | null;
  132859. readonly orientation: Float32Array | null;
  132860. readonly position: Float32Array | null;
  132861. readonly timestamp: number;
  132862. }
  132863. interface VRStageParameters {
  132864. sittingToStandingTransform?: Float32Array;
  132865. sizeX?: number;
  132866. sizeY?: number;
  132867. }
  132868. interface Navigator {
  132869. getVRDisplays(): Promise<VRDisplay[]>;
  132870. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  132871. }
  132872. interface Window {
  132873. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  132874. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  132875. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  132876. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  132877. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  132878. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  132879. }
  132880. interface Gamepad {
  132881. readonly displayId: number;
  132882. }
  132883. type XRSessionMode =
  132884. | "inline"
  132885. | "immersive-vr"
  132886. | "immersive-ar";
  132887. type XRReferenceSpaceType =
  132888. | "viewer"
  132889. | "local"
  132890. | "local-floor"
  132891. | "bounded-floor"
  132892. | "unbounded";
  132893. type XREnvironmentBlendMode =
  132894. | "opaque"
  132895. | "additive"
  132896. | "alpha-blend";
  132897. type XRVisibilityState =
  132898. | "visible"
  132899. | "visible-blurred"
  132900. | "hidden";
  132901. type XRHandedness =
  132902. | "none"
  132903. | "left"
  132904. | "right";
  132905. type XRTargetRayMode =
  132906. | "gaze"
  132907. | "tracked-pointer"
  132908. | "screen";
  132909. type XREye =
  132910. | "none"
  132911. | "left"
  132912. | "right";
  132913. interface XRSpace extends EventTarget {
  132914. }
  132915. interface XRRenderState {
  132916. depthNear?: number;
  132917. depthFar?: number;
  132918. inlineVerticalFieldOfView?: number;
  132919. baseLayer?: XRWebGLLayer;
  132920. }
  132921. interface XRInputSource {
  132922. handedness: XRHandedness;
  132923. targetRayMode: XRTargetRayMode;
  132924. targetRaySpace: XRSpace;
  132925. gripSpace: XRSpace | undefined;
  132926. gamepad: Gamepad | undefined;
  132927. profiles: Array<string>;
  132928. }
  132929. interface XRSession {
  132930. addEventListener: Function;
  132931. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  132932. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  132933. requestAnimationFrame: Function;
  132934. end(): Promise<void>;
  132935. renderState: XRRenderState;
  132936. inputSources: Array<XRInputSource>;
  132937. }
  132938. interface XRReferenceSpace extends XRSpace {
  132939. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  132940. onreset: any;
  132941. }
  132942. interface XRFrame {
  132943. session: XRSession;
  132944. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  132945. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  132946. }
  132947. interface XRViewerPose extends XRPose {
  132948. views: Array<XRView>;
  132949. }
  132950. interface XRPose {
  132951. transform: XRRigidTransform;
  132952. emulatedPosition: boolean;
  132953. }
  132954. declare var XRWebGLLayer: {
  132955. prototype: XRWebGLLayer;
  132956. new(session: XRSession, context: WebGLRenderingContext | undefined): XRWebGLLayer;
  132957. };
  132958. interface XRWebGLLayer {
  132959. framebuffer: WebGLFramebuffer;
  132960. framebufferWidth: number;
  132961. framebufferHeight: number;
  132962. getViewport: Function;
  132963. }
  132964. interface XRRigidTransform {
  132965. position: DOMPointReadOnly;
  132966. orientation: DOMPointReadOnly;
  132967. matrix: Float32Array;
  132968. inverse: XRRigidTransform;
  132969. }
  132970. interface XRView {
  132971. eye: XREye;
  132972. projectionMatrix: Float32Array;
  132973. transform: XRRigidTransform;
  132974. }
  132975. interface XRInputSourceChangeEvent {
  132976. session: XRSession;
  132977. removed: Array<XRInputSource>;
  132978. added: Array<XRInputSource>;
  132979. }